Switch to pyproject.toml

With [PEP 621 support added to setuptools](pypa/setuptools#2970) last year, and with pip supporting editable installs as of 21.3, we can move to `pyproject.toml` and deprecate `setup.py`. The file remains for legacy pip support. Because [flake8 does not want to support pyproject.tml yet](PyCQA/flake8#234), unlike all the other tools we use, I’m removing it in favor of [ruff](https://github.com/charliermarsh/ruff).
cfpb · Jan 11, 2023 · 78c3560 · 78c3560
1 parent a25621c
commit 78c3560
Show file tree

Hide file tree

Showing 5 changed files with 110 additions and 111 deletions.
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -13,7 +13,7 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v4
         with:
-          python-version: "3.10"
+          python-version: "3.8"
 
       - name: Install dependencies
         run: |
@@ -33,22 +33,22 @@ jobs:
       matrix:
         toxenv:
           # Legacy versions
-          - py39-dj32-wag215
+          - py38-dj32-wag215
 
           # Current and latest versions
-          - py310-dj32-wag30
-          - py310-dj40-wag30
-          - py310-dj40-waglatest
+          - py311-dj32-wag30
+          - py311-dj40-wag30
+          - py311-dj40-waglatest
 
         include:
-          - toxenv: py39-dj32-wag215
-            python-version: "3.9"
-          - toxenv: py310-dj32-wag30
-            python-version: "3.10"
-          - toxenv: py310-dj40-wag30
-            python-version: "3.10"
-          - toxenv: py310-dj40-waglatest
-            python-version: "3.10"
+          - toxenv: py38-dj32-wag215
+            python-version: "3.8"
+          - toxenv: py311-dj32-wag30
+            python-version: "3.11"
+          - toxenv: py311-dj40-wag30
+            python-version: "3.11"
+          - toxenv: py311-dj40-waglatest
+            python-version: "3.11"
 
     steps:
       - uses: actions/checkout@v3
@@ -89,7 +89,7 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v4
         with:
-          python-version: "3.10"
+          python-version: "3.8"
 
       - name: Install dependencies
         run: |

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -5,11 +5,10 @@ repos:
     - id: black
       args: ["wagtailflags", "setup.py", "--line-length=79"]
       exclude: migrations
--   repo: https://gitlab.com/pycqa/flake8
-    rev: 4.0.1
+-   repo: https://github.com/charliermarsh/ruff-pre-commit
+    rev: v0.0.188
     hooks:
-    - id: flake8
-      additional_dependencies: [flake8-bugbear==22.1.11]
+    - id: ruff
 -   repo: https://github.com/pycqa/isort
     rev: 5.10.1
     hooks:

diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,54 @@
+[project]
+name = "wagtail-flags"
+version = "5.3.0"
+description = "Feature flags for Wagtail sites"
+readme = "README.md"
+requires-python = ">=3.8"
+license = {text = "CC0"}
+authors = [
+    {name = "CFPB", email = "[email protected]" }
+]
+dependencies = [
+    "wagtail>2.15,<4",
+    "django-flags>4.2,<5.1"
+]
+classifiers = [
+    "Framework :: Django",
+    "Framework :: Django :: 3.2",
+    "Framework :: Django :: 4",
+    "Framework :: Wagtail",
+    "Framework :: Wagtail :: 3",
+    "License :: CC0 1.0 Universal (CC0 1.0) Public Domain Dedication",
+    "License :: Public Domain",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+]
+
+[project.optional-dependencies]
+testing = [
+    "coverage[toml]",
+]
+
+[project.urls]
+"Homepage" = "https://github.com/cfpb/wagtail-flags"
+"Bug Reports" = "https://github.com/cfpb/wagtail-flags/issues"
+"Source" = "https://github.com/cfpb/wagtail-flags"
+
+[build-system]
+requires = ["setuptools>=43.0.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools.package-data]
+treemodeladmin = [
+    "templates/wagtailflags/*",
+    "templates/wagtailflags/flags/*",
+    "templates/wagtailflags/includes/*",
+    "static/wagtailflags/css/*",
+]
+
 [tool.black]
 line-length = 79
-target-version = ['py36', 'py38']
+target-version = ["py38"]
 include = '\.pyi?$'
 exclude = '''
 (
@@ -14,15 +62,43 @@ exclude = '''
     | dist
     | migrations
     | site
-    | \*.json
-    | \*.csv
   )/
 )
 '''
 
-[build-system]
-requires = [
-    "setuptools>=42",
-    "wheel"
+[tool.isort]
+profile = "black"
+line_length = 79
+lines_after_imports = 2
+skip = [".tox", "migrations", ".venv", "venv"]
+known_django = ["django"]
+known_wagtail = ["wagtail"]
+default_section = "THIRDPARTY"
+sections = [
+    "STDLIB",
+    "DJANGO",
+    "WAGTAIL",
+    "THIRDPARTY",
+    "FIRSTPARTY",
+    "LOCALFOLDER"
+]
+
+[tool.ruff]
+exclude = [
+    ".git",
+    ".tox",
+    "__pycache__",
+    "*/migrations/*.py",
+    "*/tests/treemodeladmintest/migrations/*",
+]
+ignore = []
+select = [
+    "E",
+    "F",
+    "W",
+]
+
+[tool.coverage.run]
+omit = [
+    "treemodeladmin/tests/*",
 ]
-build-backend = "setuptools.build_meta"
diff --git a/setup.cfg b/setup.cfg
diff --git a/tox.ini b/tox.ini
@@ -2,8 +2,8 @@
 skipsdist=True
 envlist=
     lint,
-    py{39,310}-dj{32}-wag{215},
-    py{39,310}-dj{32,40}-wag{30,latest},
+    py{38,311}-dj{32}-wag{215},
+    py{38,311}-dj{32,40}-wag{30,latest},
     coverage
 
 [testenv]
@@ -14,29 +14,29 @@ setenv=
     DJANGO_SETTINGS_MODULE=wagtailflags.tests.settings
 
 basepython=
-    py39:  python3.9
-    py310: python3.10
+    py38:  python3.8
+    py311: python3.11
 
 deps=
     dj32:  Django>=3.2,<3.3
     dj40:  Django>=4.0,<4.1
-    wag215: wagtail>=2.15,<2.16
+    wag215: wagtail>=2.15,<4
     wag30: wagtail>=3.0,<3.1
     waglatest: wagtail<4
 
 [testenv:lint]
-basepython=python3.10
+basepython=python3.8
 deps=
     black
-    flake8
+    ruff
     isort
 commands=
     black --check wagtailflags
-    flake8 wagtailflags
+    ruff wagtailflags
     isort --check-only --diff wagtailflags
 
 [testenv:coverage]
-basepython=python3.10
+basepython=python3.8
 deps=
     coverage
     diff_cover