dev: review the structure of the repository to fix packaging issues (#244)

Author: BoboTiG

.github/workflows/tests.yml

@@ -74,11 +74,15 @@ jobs:
         with:
           python-version: ${{ matrix.python.runs-on }}
           cache: pip
-          cache-dependency-path: dev-requirements.txt
+          cache-dependency-path: |
+            dev-requirements.txt
+            tests-requirements.txt
+          check-latest: true
       - name: Install test dependencies
         run: |
           python -m pip install -U pip wheel 
           python -m pip install -r dev-requirements.txt
+          python -m pip install -r tests-requirements.txt
       - name: Install Xvfb
         if: matrix.os.emoji == '🐧'
         run: sudo apt install xvfb

CHANGELOG.md

@@ -4,6 +4,7 @@ See Git checking messages for full history.
 
 ## 8.0.3 (2023/xx/xx)
 - added support for Python 3.12
+- dev: review the structure of the repository to fix packaging issues (#243)
 - MSS: added PEP 561 compatible
 - MSS: include more files in the sdist package (#240)
 - MSS: remove `venv` files from the sdist package

MANIFEST.in

@@ -5,7 +5,7 @@ include LICENSE.txt
 include README.md
 include dev-requirements.txt
 include tests-requirements.txt
-include mss/tests/*.py
-include mss/py.typed
+include src/tests/*.py
+include src/mss/py.typed
 recursive-include docs/source *
-recursive-include mss/tests/res *
+recursive-include src/tests/res *

check.sh

@@ -2,9 +2,9 @@
 #
 # Small script to ensure quality checks pass before submitting a commit/PR.
 #
-python -m isort docs mss
-python -m black --line-length=120 docs mss
-python -m flake8 docs mss
-python -m pylint mss
+python -m isort docs src
+python -m black --line-length=120 docs src
+python -m flake8 docs src
+python -m pylint src/mss
 # "--platform win32" to not fail on ctypes.windll (it does not affect the overall check on other OSes)
-python -m mypy --platform win32 --exclude mss/tests mss docs/source/examples
+python -m mypy --platform win32 --exclude src/tests src docs/source/examples

setup.cfg

@@ -43,15 +43,16 @@ classifiers =
     Topic :: Software Development :: Libraries
 
 [options]
-zip_safe = False
-include_package_data = True
-packages = find_namespace:
 python_requires = >=3.8
+package_dir = 
+    = src
+packages = find:
 
 [options.packages.find]
-include =
-    mss
-    mss.*
+where = src
+
+[options.package_data]
+mss = py.typed
 
 [options.entry_points]
 console_scripts =
@@ -85,6 +86,7 @@ output-format = colorized
 reports = no
 
 [tool:pytest]
+pythonpath = src
 addopts =
     --showlocals
     --strict-markers