Switch project builds to hatch (#259)

* Adopt Hatch for packaging

* Add black config

* Formatting

* Replicate requirements in pyproject.toml

* Update project file

* Order classifiers

* Use hatch for PyPI publishing

* Update tox to use hatch, extra dependencies

.github/workflows/release.yml

@@ -1,6 +1,6 @@
 name: Publish package to PyPI
 
-on: 
+on:
   push:
     branches: [master]
   release:
@@ -21,13 +21,13 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install setuptools wheel twine
+        pip install hatch
 
     - name: Build and publish distribution
       if: (github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags')) || github.event_name == 'release'
-      env: 
+      env:
         TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
         TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
       run: |
-        python setup.py sdist bdist_wheel
-        twine upload dist/*
+        hatch build
+        hatch publish

HISTORY.rst

@@ -3,6 +3,11 @@
 History
 =======
 
+2.4.0
+-----
+
+* Adopted Hatch as packaging tool with pyproject.toml
+
 2.3.1
 -----
 

pyproject.toml

@@ -0,0 +1,75 @@
+[project]
+name = "django-organizations"
+authors = [
+  { name="Ben Lopatin", email="[email protected]" },
+]
+description = "Group accounts for Django"
+readme = "README.rst"
+requires-python = ">=3.8"
+license = {text = "BSD License"}
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Environment :: Web Environment",
+    "Framework :: Django",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: BSD 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 :: 3.12",
+    "Programming Language :: Python :: Implementation :: CPython",
+]
+dependencies = [
+    "Django>=3.2",
+    "django-extensions>=2.0.8",
+]
+dynamic = ["version"]
+
+[project.urls]
+"Source" = "https://github.com/bennylope/django-organizations"
+"Issues" = "https://github.com/bennylope/django-organizations/issues"
+"Documentation" = "https://django-organizations.readthedocs.io/en/latest/"
+
+[project.optional-dependencies]
+tests = [
+    "pytest>=6.0",
+    "coverage",
+    "pytest-django>=3.0.0",
+    "pytest-cov>=2.4.0",
+    # Required to test default models
+    "django-extensions>=2.0.8",
+    "django-autoslug>=1.9.8,",
+    # Required for mocking signals
+    "mock-django==0.6.9",
+]
+docs = [
+    "Sphinx==3.5.4",
+    "furo==2021.4.11b34",
+]
+dev = [
+    "django-organizations[tests]",
+    "tox",
+    "black",
+    "ruff",
+]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build]
+sources = ["src"]
+directory = "dist/"
+
+[tool.hatch.version]
+path = "src/organizations/__init__.py"
+
+[tool.hatch.build.targets.wheel]
+only-include = ["src/organizations"]
+packages = ["src/oranizations"]
+
+[tool.black]
+target-version = ["py311"]

src/organizations/__init__.py

@@ -2,4 +2,4 @@
 
 __author__ = "Ben Lopatin"
 __email__ = "[email protected]"
-__version__ = "2.3.1"
+__version__ = "2.4.0"

src/organizations/apps.py

@@ -5,4 +5,4 @@
 class OrganizationsConfig(AppConfig):
     name = "organizations"
     verbose_name = "Organizations"
-    default_auto_field = 'django.db.models.AutoField'
+    default_auto_field = "django.db.models.AutoField"

src/organizations/backends/defaults.py

@@ -140,7 +140,7 @@ def email_message(
         body_template,
         sender=None,
         message_class=EmailMessage,
-        **kwargs
+        **kwargs,
     ):
         """
         Returns an email message for a new user. This can be easily overridden.

src/organizations/backends/modeled.py

@@ -157,7 +157,7 @@ def send_invitation(self, invitation, **kwargs):
             self.invitation_subject,
             self.invitation_body,
             invitation.invited_by,
-            **kwargs
+            **kwargs,
         ).send()
 
     def email_message(
@@ -167,7 +167,7 @@ def email_message(
         body_template,  # type: Text
         sender=None,  # type: Optional[AbstractUser]
         message_class=EmailMessage,
-        **kwargs
+        **kwargs,
     ):
         """
         Returns an invitation email message. This can be easily overridden.

src/organizations/exceptions.py

@@ -1,4 +1,5 @@
 
+
 class OwnershipRequired(Exception):
     """
     Exception to raise if the owner is being removed before the

src/organizations/forms.py

@@ -91,7 +91,7 @@ def save(self, *args, **kwargs):
                     "domain": get_current_site(self.request),
                     "organization": self.organization,
                     "sender": self.request.user,
-                }
+                },
             )
         # Send a notification email to this user to inform them that they
         # have been added to a new organization.
@@ -101,7 +101,7 @@ def save(self, *args, **kwargs):
                 "domain": get_current_site(self.request),
                 "organization": self.organization,
                 "sender": self.request.user,
-            }
+            },
         )
         return OrganizationUser.objects.create(
             user=user,
@@ -156,7 +156,7 @@ def save(self, **kwargs):
                     "organization": self.cleaned_data["name"],
                     "sender": self.request.user,
                     "created": True,
-                }
+                },
             )
             is_active = False
         return create_organization(

src/organizations/utils.py

@@ -35,7 +35,7 @@ def create_organization(
     is_active=None,
     org_defaults=None,
     org_user_defaults=None,
-    **kwargs
+    **kwargs,
 ):
     """
     Returns a new organization, also creating an initial organization user who

src/organizations/views/base.py

@@ -142,7 +142,7 @@ def post(self, request, *args, **kwargs):
                 "domain": get_current_site(self.request),
                 "organization": self.organization,
                 "sender": request.user,
-            }
+            },
         )
         return redirect(self.get_success_url())
 

tox.ini

@@ -14,7 +14,12 @@ python =
     3.11: py311
     3.12: py312
 
+[build-system]
+build-backend = "hatchling.build"
+requires = ["hatchling>=0.22", "hatch-vcs>=0.2"]
+
 [testenv]
+package = wheel
 setenv =
     PYTHONPATH = {toxinidir}:{toxinidir}/organizations
 commands = pytest {posargs} --cov=organizations
@@ -25,11 +30,11 @@ basepython =
     py311: python3.11
     py312: python3.12
 deps =
-    setuptools>=49.6.0
+    hatch>=1.7.0
     django32: Django>=3.2,<4
     django41: Django>=4.1,<4.2
     django42: Django>=4.2,<4.3
-    -r{toxinidir}/requirements-test.txt
+extras = tests
 
 [testenv:flake8]
 basepython=python3