Use Flit for packaging

.circleci/config.yml

@@ -40,7 +40,8 @@ jobs:
           - pip-{{ .Branch }}-
           - pip-main-
 
-      - run: pip install -e .[testing]
+      - run: pip install flit
+      - run: flit install --deps production --extras testing
 
       - type: cache-save
         key: pip-{{ .Branch }}-{{ epoch }}
@@ -56,7 +57,8 @@ jobs:
       - checkout
       - run: git clone [email protected]:wagtail/wagtail.git
 
-      - run: pip install -e .[testing]
+      - run: pip install flit
+      - run: flit install --deps production --extras testing
       - run: pip install ./wagtail
 
       - run: python testmanage.py test

.github/workflows/test.yml

@@ -61,7 +61,7 @@ jobs:
         uses: actions/cache@v3
         with:
           path: .tox
-          key: tox-${{ hashFiles('setup.py') }}-py${{ matrix.python }}-dj${{ matrix.django }}-w${{ matrix.wagtail }}-sqlite
+          key: tox-${{ hashFiles('pyproject.toml') }}-py${{ matrix.python }}-dj${{ matrix.django }}-w${{ matrix.wagtail }}-sqlite
       - name: Test
         run: |
           tox
@@ -132,7 +132,7 @@ jobs:
         uses: actions/cache@v3
         with:
           path: .tox
-          key: tox-${{ hashFiles('setup.py') }}-py${{ matrix.python }}-dj${{ matrix.django }}-w${{ matrix.wagtail }}-postgres
+          key: tox-${{ hashFiles('pyproject.toml') }}-py${{ matrix.python }}-dj${{ matrix.django }}-w${{ matrix.wagtail }}-postgres
       - name: Test
         run: |
           tox
@@ -155,8 +155,8 @@ jobs:
           python-version: ${{ matrix.python }}
       - name: Install dependencies
         run: |
-          pip install django~=3.2
-          pip install -e.[testing]
+          pip install flit
+          flit install --deps production --extras testing
           pip install coverage==5.4
       - name: Test
         run: |

.gitignore

@@ -1,4 +1,5 @@
-*.pyc
+__pycache__/
+*.py[co]
 /build
 /dist
 /wagtail_localize.egg-info

Makefile

@@ -38,7 +38,7 @@ clean:	## 🗑️  - Remove __pycache__ and test artifacts
 
 package-setup:
 	@echo "📦 - Packaging for PyPI"
-	python3 setup.py clean --all sdist bdist_wheel
+	flit build --setup-py
 
 package: clean package-setup  ## 📦 - Package for PyPI
 

README.md

@@ -56,10 +56,20 @@ cd wagtail-localize
 
 With your preferred virtualenv activated, install testing dependencies:
 
+#### Using pip
+
 ```sh
+pip install pip>=21.3
 pip install -e .[testing] -U
 ```
 
+#### Using flit
+
+```sh
+pip install flit
+flit install
+```
+
 ### pre-commit
 
 Note that this project uses [pre-commit](https://github.com/pre-commit/pre-commit). To set up locally:

netlify.toml

@@ -3,6 +3,7 @@ publish = "site"
 ignore = "git diff --quiet HEAD^ HEAD {readme.md,mkdocs.yml,netlify.toml,docs/,*.py}"
 command = """
 pip install django~=3.2
-pip install -e.[testing,documentation]
+pip install flit
+flit install --deps production --extras documentation,testing
 mkdocs build -d site
 """

pyproject.toml

@@ -0,0 +1,86 @@
+[build-system]
+requires = ["flit_core >=3.2,<4"]
+build-backend = "flit_core.buildapi"
+
+[project]
+name = "wagtail-localize"
+authors = [{name = "Karl Hobley", email = "[email protected]"}]
+description = "Translation plugin for Wagtail CMS"
+readme = "README.md"
+license = {file = "LICENSE"}
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: BSD License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.7",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Framework :: Django",
+    "Framework :: Django :: 2.2",
+    "Framework :: Django :: 3.2",
+    "Framework :: Django :: 4.0",
+    "Framework :: Wagtail",
+    "Framework :: Wagtail :: 2",
+    "Framework :: Wagtail :: 3"
+]
+dynamic = ["version"]
+requires-python = ">=3.7"
+dependencies = [
+    "Django>=2.2,<4.1",
+    "Wagtail>=2.11,<4.0",
+    "polib>=1.1,<2.0",
+    "typing_extensions>=4.0"
+]
+
+[project.optional-dependencies]
+testing = [
+    "dj-database-url==0.5.0",
+    "freezegun==1.1.0",
+    "django-rq>=2.5,<3.0"
+]
+documentation = [
+    "mkdocs==1.1.2",
+    "mkdocs-material==6.2.8",
+    "mkdocs-mermaid2-plugin==0.5.1",
+    "mkdocstrings==0.14.0",
+    "mkdocs-include-markdown-plugin==2.8.0",
+    "pygments==2.11.2"
+]
+google = [
+    "google-cloud-translate>=3.0.0"
+]
+
+[project.urls]
+Home = "https://www.wagtail-localize.org"
+Source = "https://github.com/wagtail/wagtail-localize"
+Documentation = "https://www.wagtail-localize.org"
+
+[tool.flit.module]
+name = "wagtail_localize"
+
+[tool.flit.sdist]
+exclude = [
+    "wagtail_localize/static_src",
+    "wagtail_localize/test",
+    "wagtail_localize/tests",
+    "wagtail_localize/machine_translators/tests",
+    "wagtail_localize/segments/tests",
+    "wagtail_localize/static/.gitignore",
+    "Makefile",
+    "scripts",
+    "docs",
+    ".*",
+    "*.js",
+    "*.json",
+    "*.ini",
+    "*.yml",
+    "netlify.toml",
+    "testmanage.py",
+]
+include = [
+    "wagtail_localize/static"
+]