Follow Python standard packaging guidelines (#846)

* Follow Python standard packaging guidelines

* Update pipeline.yml to use 'src' directory

* Update pipeline.yml

* fix tests

* Specify source for coverage

* link src as default source

* name package just executorlib

* skip version file

* clean up

* Update path for git assume-unchanged command

* Configure Hatch build settings for executorlib

* Update pyreverse command to use src directory

* Fix pyreverse path in GitHub Actions workflow

Author: jan-janssen

.github/workflows/deploy.yml

@@ -31,7 +31,7 @@ jobs:
       run: |
         cp .ci_support/environment-old.yml environment.yml
         python .ci_support/release.py; cat pyproject.toml
-        git update-index --assume-unchanged pyproject.toml executorlib/_version.py
+        git update-index --assume-unchanged pyproject.toml src/executorlib/_version.py
         hatchling build -t sdist -t wheel
     - name: Publish distribution 📦 to PyPI
       uses: pypa/gh-action-pypi-publish@release/v1

.github/workflows/pipeline.yml

@@ -13,7 +13,7 @@ jobs:
     - uses: psf/black@stable
       with:
         options: "--check --diff"
-        src: ./${{ github.event.repository.name }}
+        src: ./src/${{ github.event.repository.name }}
 
   black_fix:  # in most cases pre-commit is faster
     needs: [black]
@@ -29,7 +29,7 @@ jobs:
       uses: psf/black@stable
       with:
         options: ""
-        src: "./${{ github.event.repository.name }}"
+        src: "./src/${{ github.event.repository.name }}"
     - name: commit
       run: |
         git config --local user.email "[email protected]"
@@ -55,7 +55,7 @@ jobs:
       - name: Install mypy
         run: pip install mypy
       - name: Test
-        run: mypy --ignore-missing-imports ${{ github.event.repository.name }}
+        run: mypy --ignore-missing-imports src/${{ github.event.repository.name }}
 
   minimal:
     needs: [black]
@@ -451,7 +451,7 @@ jobs:
       timeout-minutes: 10
       run: |
         conda install -y pylint graphviz
-        pyreverse -o png -p ./${{ github.event.repository.name }} ./${{ github.event.repository.name }}
+        pyreverse -o png -p ./src/${{ github.event.repository.name }} ./src/${{ github.event.repository.name }}
         zip -m uml.zip *.png
     - uses: actions/upload-artifact@v4
       with:

pyproject.toml

@@ -103,26 +103,26 @@ ignore = [
 
 [tool.hatch.build]
 include = [
-    "executorlib"
+    "src/executorlib"
 ]
 
 [tool.hatch.build.hooks.vcs]
-version-file = "executorlib/_version.py"
+version-file = "src/executorlib/_version.py"
 
 [tool.hatch.build.targets.sdist]
 include = [
-    "executorlib"
+    "src/executorlib"
 ]
 
 [tool.hatch.build.targets.wheel]
 packages = [
-    "executorlib"
+    "src/executorlib"
 ]
 
 [tool.hatch.version]
 source = "vcs"
-path = "executorlib/_version.py"
+path = "src/executorlib/_version.py"
 
 [tool.coverage.run]
-omit = ["executorlib/_version.py", "tests/*"]
+source = ["executorlib"]
 command_line = "-m unittest discover tests"