Switch to pyproject.toml and Ruff for PEP 621/660

.github/workflows/push_build_to_prod_pypi.yml

@@ -37,14 +37,11 @@ jobs:
         with:
           python-version: 3.x
       - name: Install dependencies
-        run: |
-          python3 -m pip install --upgrade pip
-          python3 -m pip install setuptools wheel twine
-          python3 -m pip install pyogg pymunk
-          python3 -m pip install -e .
+        run: >-
+          python -m pip install build twine
       - name: Build and Upload to Prod PyPI
         run: |
-          python3 setup.py sdist bdist_wheel
+          python -m build --sdist --wheel --outdir dist/
           python3 -m twine upload dist/*
         env:
           TWINE_USERNAME: __token__

.github/workflows/push_build_to_test_pypi.yml

@@ -35,14 +35,11 @@ jobs:
         with:
           python-version: 3.x
       - name: Install dependencies
-        run: |
-          python3 -m pip install --upgrade pip
-          python3 -m pip install setuptools wheel twine
-          python3 -m pip install pyogg pymunk
-          python3 -m pip install -e .
+        run: >-
+          python3 -m pip install build twine
       - name: Build and Upload to Test PyPI
         run: |
-          python3 setup.py sdist bdist_wheel
+          python3 -m build --sdist --wheel --outdir dist/
           python3 -m twine upload dist/*
         env:
           TWINE_USERNAME: __token__

.github/workflows/selfhosted_runner.yml

@@ -34,7 +34,7 @@ jobs:
         run: | 
           source .venv/bin/activate
           mypy arcade
-          flake8 arcade
+          ruff arcade
       - name: build-docs
         run: |
           source .venv/bin/activate

.github/workflows/test.yml

@@ -36,7 +36,7 @@ jobs:
       - name: code-inspection
         run: | 
           mypy arcade
-          flake8 arcade
+          ruff arcade
       - name: build-docs
         run: |
           sphinx-build doc build -W

CONTRIBUTING.md

@@ -26,7 +26,7 @@ Discussion can happen in a GitHub issue's comments or on [Arcade's Discord serve
 ## After Making Changes
 
 After you finish your changes, you should do the following:
-1. Test your changes with Arcade's test suite as well as with `mypy arcade` & `flake8 arcade`
+1. Test your changes with Arcade's test suite as well as with `mypy arcade` & `ruff arcade`
 2. Submit a [pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests)
 from your fork to Arcade's development branch.
 
@@ -63,7 +63,7 @@ in this repo for current tests.
 
 ### Testing Code Changes
 
-First, run `mypy arcade` and then `flake8 arcade` from inside the arcade folder. You should fix
+First, run `mypy arcade` and then `ruff arcade` from inside the arcade folder. You should fix
 any issues they report.
 
 Then run the framework's automated tests with the following command:

arcade/examples/procedural_caves_bsp.py

@@ -205,7 +205,7 @@ def find_closest_unconnect_groups(self, groups, room_dict):
             for room in group:
                 key = (room.row, room.col)
                 for other in room_dict[key]:
-                    if not other[0] in group and other[3] < shortest_distance:
+                    if other[0] not in group and other[3] < shortest_distance:
                         shortest_distance = other[3]
                         start = room
                         nearest = other

doc/programming_guide/release_checklist.rst

@@ -4,7 +4,7 @@ Release Checklist
 =================
 
 #. Check for updated libraries, and if we need to pin a more recent version.
-#. Run ``flake8 arcade``
+#. Run ``ruff arcade``
 #. Run ``mypy arcade``
 #. In docs folder, type  ``make clean`` then  ``make html`` and confirm no warnings/errors.
 #. Run unit tests in ``tests`` folder.

pyproject.toml

@@ -1,7 +1,140 @@
+[project]
+name = "arcade"
+description = "Arcade Game Development Library"
+readme = "README.rst"
+authors = [
+    {name="Paul Vincent Craven", email="paul@cravenfamily.com"}
+]
+license = {file = "license.rst"}
+requires-python = ">=3.8"
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: Implementation :: CPython",
+    "Topic :: Software Development :: Libraries :: Python Modules"
+]
+dependencies = [
+    "pyglet>=2.0.3,<2.1",
+    "pillow~=9.4.0",
+    "pymunk~=6.4.0",
+    "pytiled-parser~=2.2.0"
+]
+dynamic = ["version"]
+
+[project.urls]
+Homepage = "https://api.arcade.academy"
+Documentation = "https://api.arcade.academy/"
+Examples = "https://api.arcade.academy/en/latest/examples/index.html"
+Issues = "https://github.com/pythonarcade/arcade/issues"
+Source = "https://github.com/pythonarcade/arcade"
+Book = "https://learn.arcade.academy"
+
+[project.optional-dependencies]
+dev = [
+    "pytest",
+    "mypy",
+    "ruff",
+    "coverage",
+    "coveralls",
+    "pytest-mock",
+    "pytest-cov",
+    "pygments==2.14.0",
+    "docutils==0.19",
+    "furo",
+    "pyyaml==6.0",
+    "sphinx==6.1.3",
+    "sphinx-copybutton==0.5.1",
+    "sphinx-sitemap==2.5.0",
+    "wheel",
+]
+
+docs = [
+    "pygments==2.14.0",
+    "docutils==0.19",
+    "furo",
+    "pyyaml==6.0",
+    "sphinx==6.1.3",
+    "sphinx-copybutton==0.5.1",
+    "sphinx-sitemap==2.5.0",
+    "wheel",
+]
+
+[project.scripts]
+arcade = "arcade.management:execute_from_command_line"
+
+[project.entry-points.pyinstaller40]
+hook-dirs = "arcade.__pyinstaller:get_hook_dirs"
+
+[tool.setuptools.packages.find]
+include = ["arcade", "arcade.*"]
+
+[tool.setuptools.dynamic]
+version = {attr = "arcade.version.VERSION"}
+
 [build-system]
 requires = ["setuptools", "wheel"]
 build-backend = "setuptools.build_meta"
 
+[tool.distutils.bdist_wheel]
+universal = true
+
+[tool.ruff]
+# --- Description of what we ignore ---
+#
+# E731 do not assign a lambda expression, use a def
+# E741 Ambiguous variable name
+# F811: redefinition
+ignore = ["F811", "E731", "E741"]
+show-source = true
+line-length = 120
+exclude = ["venv", ".venv*", "tests", "build", "doc", "util", ".mypy_cache", ".pytest_cache", "temp", "bugs"]
+
+[tool.mypy]
+disable_error_code = "annotation_unchecked"
+
+[tool.pytest.ini_options]
+norecursedirs = ["doc", "holding", "arcade/examples", "build", ".venv", "env", "dist", "tempt"]
+
 [tool.pyright]
 include = ["arcade"]
 exclude = ["venv", "arcade/examples", "arcade/experimental", "tests", "doc"]
+
+[tool.coverage.run]
+source = ["arcade"]
+omit = ["./arcade/examples/*", "./arcade/gui/examples/*", "./arcade/experimental/*", "./env/*", "./tests/*", "./doc/*", "./Win*/*"]
+
+[[tool.mypy.overrides]]
+module = "pyglet.*"
+ignore_missing_imports = true
+
+[[tool.mypy.overrides]]
+module = "PIL.*"
+ignore_missing_imports = true
+
+[[tool.mypy.overrides]]
+module = "pymunk"
+ignore_missing_imports = true
+
+[[tool.mypy.overrides]]
+module = "pytiled_parser.*"
+ignore_missing_imports = true
+
+[[tool.mypy.overrides]]
+module = "shapely.*"
+ignore_missing_imports = true
+
+[[tool.mypy.overrides]]
+module = "PyInstaller.*"
+ignore_missing_imports = true
+
+
+
+
+