Switch to setuptools_scm (#331)

* Switch to setuptools_scm * Fix directories for lint * Remove duplicate flake8 config * Run test with pytest * Install project before running tests
lordmauve · Jan 18, 2025 · bde0fbe · bde0fbe
1 parent 5b68f3d
commit bde0fbe
Show file tree

Hide file tree

Showing 34 changed files with 49 additions and 66 deletions.
diff --git a/.flake8 b/.flake8
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -1,5 +1,5 @@
 name: "Run tests"
-on: [push, pull_request]
+on: [pull_request, workflow_call]
 jobs:
   build:
     runs-on: ubuntu-latest
@@ -13,12 +13,14 @@ jobs:
       run: |
         python -m pip install --upgrade pip
         pip install -r requirements.txt -r requirements-dev.txt
+    - name: Install project
+      run: pip install .
     - name: Lint with flake8
       run: |
         # stop the build if there are Python syntax errors or undefined names in the entire repo
         flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
         # stricter tests for mission critical code
-        flake8 --count pgzero pgzrun.py test
+        flake8 --count src test
 
     - name: Install xvfb and pulseaudio
       run: |
@@ -27,7 +29,7 @@ jobs:
       run: |
         export XDG_RUNTIME_DIR="$RUNNER_TEMP"
         pulseaudio -D --start
-        xvfb-run --auto-servernum python setup.py test
+        xvfb-run --auto-servernum pytest
     - name: Cleanup xvfb pidx
       uses: bcomnes/cleanup-xvfb@v1
     - uses: actions/upload-artifact@master

diff --git a/.gitignore b/.gitignore
@@ -17,3 +17,5 @@ examples_dev
 /venv*/
 /notebooks
 /test/failed-image
+__pycache__
+src/pgzero/_version.py
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -8,8 +8,8 @@ repos:
     -   id: end-of-file-fixer
     -   id: check-yaml
     -   id: check-added-large-files
-- repo: https://github.com/PyCQA/flake8
-  rev: "4.0.1"
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  rev: "v0.9.2"
   hooks:
-    - id: flake8
+    - id: ruff
       exclude: "^(doc|examples)/"
diff --git a/MANIFEST.in b/MANIFEST.in
diff --git a/pyproject.toml b/pyproject.toml
@@ -0,0 +1,25 @@
+[project]
+name = "pgzero"
+description = "A zero-boilerplate 2D games framework"
+readme = "README.rst"
+requires-python = ">=3.6"
+dependencies = [
+    "pygame>=2.1",
+    "numpy",
+    "pyfxr",
+]
+dynamic = ["version"]
+
+[project.urls]
+Documentation = "https://pygame-zero.readthedocs.io/"
+Source = "https://github.com/lordmauve/pgzero"
+
+[project.scripts]
+pgzrun = "pgzero.runner:main"
+
+[build-system]
+requires = ["setuptools>=64", "setuptools-scm>=8"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools_scm]
+write_to = "src/pgzero/_version.py"
diff --git a/setup.cfg b/setup.cfg
diff --git a/setup.py b/setup.py
diff --git a/pgzero/__init__.py → src/pgzero/__init__.py b/pgzero/__init__.py → src/pgzero/__init__.py
@@ -5,4 +5,6 @@
 
 """
 
-__version__ = '1.3.dev0'
+from ._version import __version__
+
+__all__ = ['__version__']
diff --git a/pgzero/__main__.py → src/pgzero/__main__.py b/pgzero/__main__.py → src/pgzero/__main__.py
diff --git a/pgzero/actor.py → src/pgzero/actor.py b/pgzero/actor.py → src/pgzero/actor.py
diff --git a/pgzero/animation.py → src/pgzero/animation.py b/pgzero/animation.py → src/pgzero/animation.py
diff --git a/pgzero/builtins.py → src/pgzero/builtins.py b/pgzero/builtins.py → src/pgzero/builtins.py
diff --git a/pgzero/clock.py → src/pgzero/clock.py b/pgzero/clock.py → src/pgzero/clock.py
diff --git a/pgzero/constants.py → src/pgzero/constants.py b/pgzero/constants.py → src/pgzero/constants.py
diff --git a/pgzero/data/icon.png → src/pgzero/data/icon.png b/pgzero/data/icon.png → src/pgzero/data/icon.png
diff --git a/pgzero/data/joypad.png → src/pgzero/data/joypad.png b/pgzero/data/joypad.png → src/pgzero/data/joypad.png
diff --git a/pgzero/game.py → src/pgzero/game.py b/pgzero/game.py → src/pgzero/game.py
diff --git a/pgzero/keyboard.py → src/pgzero/keyboard.py b/pgzero/keyboard.py → src/pgzero/keyboard.py
diff --git a/pgzero/loaders.py → src/pgzero/loaders.py b/pgzero/loaders.py → src/pgzero/loaders.py
@@ -194,7 +194,11 @@ def _load(self, path):
         try:
             return pygame.mixer.Sound(path)
         except pygame.error as err:
-            if not err.args[0].startswith('Unable to open file'):
+            if not err.args[0].startswith((
+                'Unable to open file',
+                'Unknown WAVE format tag',
+                'MPEG formats not supported',
+            )):
                 raise
             from .soundfmt import identify
             try:

diff --git a/pgzero/music.py → src/pgzero/music.py b/pgzero/music.py → src/pgzero/music.py
diff --git a/pgzero/ptext.py → src/pgzero/ptext.py b/pgzero/ptext.py → src/pgzero/ptext.py
diff --git a/pgzero/rect.py → src/pgzero/rect.py b/pgzero/rect.py → src/pgzero/rect.py
diff --git a/pgzero/runner.py → src/pgzero/runner.py b/pgzero/runner.py → src/pgzero/runner.py
diff --git a/pgzero/screen.py → src/pgzero/screen.py b/pgzero/screen.py → src/pgzero/screen.py
@@ -81,7 +81,7 @@ def rect(self, rect, color, width=1):
         c = make_color(color)
 
         hw = width / 2
-        l, t, w, h = rect
+        l, t, w, h = rect  # noqa: E741
         l1, l2 = round(l - hw), round(l + hw)
         r1, r2 = round(l + w - hw), round(l + w + hw)
         t1, t2 = round(t - hw), round(t + hw)

diff --git a/pgzero/soundfmt.py → src/pgzero/soundfmt.py b/pgzero/soundfmt.py → src/pgzero/soundfmt.py
diff --git a/pgzero/spellcheck.py → src/pgzero/spellcheck.py b/pgzero/spellcheck.py → src/pgzero/spellcheck.py
diff --git a/pgzero/storage.py → src/pgzero/storage.py b/pgzero/storage.py → src/pgzero/storage.py
diff --git a/pgzero/tone.py → src/pgzero/tone.py b/pgzero/tone.py → src/pgzero/tone.py
diff --git a/pgzrun.py → src/pgzrun.py b/pgzrun.py → src/pgzrun.py
diff --git a/test/expected-image/circle.png b/test/expected-image/circle.png
diff --git a/test/expected-image/filled_polygon.png b/test/expected-image/filled_polygon.png
diff --git a/test/expected-image/wrapped_gradient_text.png b/test/expected-image/wrapped_gradient_text.png
diff --git a/tox.ini b/tox.ini
@@ -4,7 +4,7 @@ envlist = py36, py37, py38, py39, py310, flake8
 [testenv:flake8]
 basepython=python
 deps=flake8
-commands=flake8 pgzero pgzrun.py test examples
+commands=flake8 src test examples
 
 [testenv]
 passenv=
@@ -17,4 +17,7 @@ commands =
     py.test --cov=pgzero --basetemp={envtmpdir}
 
 [flake8]
-builtins = Actor,Rect,ZRect,animate,clock,exit,images,keyboard,keymods,keys,mouse,music,screen,sounds,storage,tone
+max-line-length = 88
+builtins =
+        Actor, Rect, ZRect, animate, clock, exit, images, keyboard, keymods,
+        keys, mouse, music, screen, sounds, storage, tone