From 2faddc038204d06e57afbcf099d370056cae6caf Mon Sep 17 00:00:00 2001 From: harryswift01 Date: Mon, 19 Jan 2026 15:47:31 +0000 Subject: [PATCH 1/5] remove `src` and bring `example_package_YOUR_USERNAME_HERE/` to the top of directory --- .../__init__.py | 0 .../example.py | 0 2 files changed, 0 insertions(+), 0 deletions(-) rename {src/example_package_YOUR_USERNAME_HERE => example_package_YOUR_USERNAME_HERE}/__init__.py (100%) rename {src/example_package_YOUR_USERNAME_HERE => example_package_YOUR_USERNAME_HERE}/example.py (100%) diff --git a/src/example_package_YOUR_USERNAME_HERE/__init__.py b/example_package_YOUR_USERNAME_HERE/__init__.py similarity index 100% rename from src/example_package_YOUR_USERNAME_HERE/__init__.py rename to example_package_YOUR_USERNAME_HERE/__init__.py diff --git a/src/example_package_YOUR_USERNAME_HERE/example.py b/example_package_YOUR_USERNAME_HERE/example.py similarity index 100% rename from src/example_package_YOUR_USERNAME_HERE/example.py rename to example_package_YOUR_USERNAME_HERE/example.py From e6bba8e81662ac9a3ecfcfddff62204353e0abe3 Mon Sep 17 00:00:00 2001 From: harryswift01 Date: Mon, 19 Jan 2026 16:03:10 +0000 Subject: [PATCH 2/5] replace all `example_package_YOUR_USERNAME_HERE` with `example_package` for simplicity --- .../__init__.py | 0 .../example.py | 2 +- tests/conftest.py | 2 +- .../test_example.py | 6 +++--- 4 files changed, 5 insertions(+), 5 deletions(-) rename {example_package_YOUR_USERNAME_HERE => example_package}/__init__.py (100%) rename {example_package_YOUR_USERNAME_HERE => example_package}/example.py (67%) rename tests/{test_example_package_YOUR_USERNAME_HERE => test_example_package}/test_example.py (66%) diff --git a/example_package_YOUR_USERNAME_HERE/__init__.py b/example_package/__init__.py similarity index 100% rename from example_package_YOUR_USERNAME_HERE/__init__.py rename to example_package/__init__.py diff --git a/example_package_YOUR_USERNAME_HERE/example.py b/example_package/example.py similarity index 67% rename from example_package_YOUR_USERNAME_HERE/example.py rename to example_package/example.py index 589c7d7..e56c8c7 100644 --- a/example_package_YOUR_USERNAME_HERE/example.py +++ b/example_package/example.py @@ -1,4 +1,4 @@ -# src/example_package_YOUR_USERNAME_HERE/example.py +# src/example_package/example.py def placeholder(): diff --git a/tests/conftest.py b/tests/conftest.py index 4faceaf..2edb7d1 100644 --- a/tests/conftest.py +++ b/tests/conftest.py @@ -11,7 +11,7 @@ def temp_test_dir(): Provides a temporary test directory with a 'logs' subfolder. Automatically cleans up after the test. """ - test_dir = tempfile.mkdtemp(prefix="example_package_YOUR_USERNAME_HERE_") + test_dir = tempfile.mkdtemp(prefix="example_package_") logs_path = os.path.join(test_dir, "logs") os.makedirs(logs_path, exist_ok=True) diff --git a/tests/test_example_package_YOUR_USERNAME_HERE/test_example.py b/tests/test_example_package/test_example.py similarity index 66% rename from tests/test_example_package_YOUR_USERNAME_HERE/test_example.py rename to tests/test_example_package/test_example.py index 4cb79d0..9802219 100644 --- a/tests/test_example_package_YOUR_USERNAME_HERE/test_example.py +++ b/tests/test_example_package/test_example.py @@ -1,11 +1,11 @@ -# tests/test_example_package_YOUR_USERNAME_HERE/test_example.py +# tests/test_example_package/test_example.py -from example_package_YOUR_USERNAME_HERE.example import placeholder +from example_package.example import placeholder class TestExamplePackage: """ - Class-based placeholder tests for example_package_YOUR_USERNAME_HERE. + Class-based placeholder tests for example_package. - Demonstrates using a test class with pytest. - Can easily be extended with more methods for real tests. From f1466c81ddf3b7b938cc330bff0d8b2d38f9e626 Mon Sep 17 00:00:00 2001 From: harryswift01 Date: Mon, 19 Jan 2026 16:07:45 +0000 Subject: [PATCH 3/5] remove all references to `example_package_example_package_example_package` within CI --- .github/workflows/example_package_project-ci.yaml | 6 +++--- .github/workflows/release.yaml | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/workflows/example_package_project-ci.yaml b/.github/workflows/example_package_project-ci.yaml index b333e26..ed13ddd 100644 --- a/.github/workflows/example_package_project-ci.yaml +++ b/.github/workflows/example_package_project-ci.yaml @@ -1,4 +1,4 @@ -name: example_package_YOUR_USERNAME_HERE CI +name: example_package CI on: push: @@ -25,11 +25,11 @@ jobs: with: python-version: ${{ matrix.python-version }} - - name: Install example_package_YOUR_USERNAME_HERE and its testing dependencies + - name: Install example_package_example_package and its testing dependencies run: pip install -e .[testing] - name: Run test suite - run: pytest --cov example_package_YOUR_USERNAME_HERE --cov-report term-missing --cov-append . + run: pytest --cov example_package_example_package --cov-report term-missing --cov-append . - name: Coveralls GitHub Action uses: coverallsapp/github-action@5cbfd81b66ca5d10c19b062c04de0199c215fb6e # v2.3.7 diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml index 87ebdd2..4730a6d 100644 --- a/.github/workflows/release.yaml +++ b/.github/workflows/release.yaml @@ -51,7 +51,7 @@ jobs: - name: Change version in repo and CITATION.cff run: | # Update Python package version - sed -i "s/__version__ =.*/__version__ = \"${{ github.event.inputs.version }}\"/g" src/example_package_YOUR_USERNAME_HERE/__init__.py + sed -i "s/__version__ =.*/__version__ = \"${{ github.event.inputs.version }}\"/g" src/example_package/__init__.py # Update CITATION.cff version and date-released if [ -f CITATION.cff ]; then From 959b5eead972f3f06ef331d4066eaa126a1a48e7 Mon Sep 17 00:00:00 2001 From: harryswift01 Date: Mon, 19 Jan 2026 16:09:54 +0000 Subject: [PATCH 4/5] ensure correct pip package is being installed --- .github/workflows/example_package_project-ci.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/example_package_project-ci.yaml b/.github/workflows/example_package_project-ci.yaml index ed13ddd..6481b2b 100644 --- a/.github/workflows/example_package_project-ci.yaml +++ b/.github/workflows/example_package_project-ci.yaml @@ -25,11 +25,11 @@ jobs: with: python-version: ${{ matrix.python-version }} - - name: Install example_package_example_package and its testing dependencies + - name: Install example_package and its testing dependencies run: pip install -e .[testing] - name: Run test suite - run: pytest --cov example_package_example_package --cov-report term-missing --cov-append . + run: pytest --cov example_package --cov-report term-missing --cov-append . - name: Coveralls GitHub Action uses: coverallsapp/github-action@5cbfd81b66ca5d10c19b062c04de0199c215fb6e # v2.3.7 From e12933b1fbdb9600f18cc1147b22418a10480811 Mon Sep 17 00:00:00 2001 From: harryswift01 Date: Mon, 19 Jan 2026 16:17:48 +0000 Subject: [PATCH 5/5] update `--cov` package location within `pyproject.toml` --- pyproject.toml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/pyproject.toml b/pyproject.toml index 1d7dddc..8993c6a 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -3,7 +3,7 @@ requires = ["flit_core>=3.4,<4"] build-backend = "flit_core.buildapi" [project] -name = "example_package_YOUR_USERNAME_HERE" +name = "example_package" dynamic = ["version"] description = "Short description of your package" @@ -100,5 +100,5 @@ docstring-code-format = true [tool.pytest.ini_options] minversion = "9.0" -addopts = "--cov=example_package_YOUR_USERNAME_HERE --cov-report=term-missing" +addopts = "--cov=example_package --cov-report=term-missing" testpaths = ["tests"]