refactor: PEP-518 and use uv

.flake8

@@ -0,0 +1,3 @@
+[flake8]
+exclude = docs
+max-line-length = 120

.gitignore

@@ -71,9 +71,6 @@ target/
 # Jupyter Notebook
 .ipynb_checkpoints
 
-# pyenv
-.python-version
-
 # celery beat schedule file
 celerybeat-schedule
 

.python-version

@@ -0,0 +1 @@
+3.12

AUTHORS.md

@@ -6,4 +6,4 @@
 
 ## Contributors
 
-None yet. Why not be the first?
+-   Gary Reynolds \<<[email protected]>\>

CONTRIBUTING.md

@@ -42,58 +42,49 @@ The best way to send feedback is to file an issue at https://github.com/namespac
 If you are proposing a feature:
 
 -   Explain in detail how it would work.
--   Keep the scope as narrow as possible, to make it easier to
-    implement.
--   Remember that this is a volunteer-driven project, and that
-    contributions are welcome :)
+-   Keep the scope as narrow as possible, to make it easier to implement.
+-   Remember that this is a volunteer-driven project, and that contributions are welcome :)
 
 ## Get Started!
 
 Ready to contribute? Here's how to set up django-datadog-logger for local development.
 
 1.  Fork the repo on GitHub.
 
+    https://github.com/namespace-ee/django-datadog-logger/fork
+
 2.  Clone your fork locally:
 
     ``` shell
-    $ git clone [email protected]:your_name_here/django-datadog-logger.git
+    git clone [email protected]:your_name_here/django-datadog-logger.git
     ```
 
-3.  Install your local copy into a virtualenv. Assuming you have
-    virtualenvwrapper installed, this is how you set up your fork for
-    local development:
+3.  Install your local copy into a virtualenv. Assuming you have `uv` installed, this is how you set up your fork for development:
 
     ``` shell
-    $ mkvirtualenv django-datadog-logger
-    $ cd django-datadog-logger/
-    $ python setup.py develop
+    uv sync
     ```
 
 4.  Create a branch for local development:
 
     ``` shell
-    $ git checkout -b name-of-your-bugfix-or-feature
+    git switch -c name-of-your-bugfix-or-feature
     ```
 
     Now you can make your changes locally.
 
-5.  When you're done making changes, check that your changes pass flake8
-    and the tests, including testing other Python versions with tox:
+5.  When you're done making changes, check that your changes pass `flake8` and the tests, including testing other Python versions with `tox`. For convenience, that is wrapped up as `make test-all`:
 
     ``` shell
-    $ flake8 django_datadog_logger tests
-    $ make test
-    $ tox
+    make test-all
     ```
 
-    To get flake8 and tox, just pip install them into your virtualenv.
-
 6.  Commit your changes and push your branch to GitHub:
 
     ``` shell
-    $ git add .
-    $ git commit -m "Your detailed description of your changes."
-    $ git push origin name-of-your-bugfix-or-feature
+    git add .
+    git commit -m "Your detailed description of your changes."
+    git push origin name-of-your-bugfix-or-feature
     ```
 
 7.  Submit a pull request through the GitHub website.
@@ -103,23 +94,18 @@ Ready to contribute? Here's how to set up django-datadog-logger for local develo
 Before you submit a pull request, check that it meets these guidelines:
 
 1.  The pull request should include tests.
-2.  If the pull request adds functionality, the docs should be updated.
-    Put your new functionality into a function with a docstring, and add
-    the feature to the list in README.md.
-3.  The pull request should work for Python 3.6, 3.7 and 3.8, and for
-    PyPy. Check
-    <https://github.com/namespace-ee/django-datadog-logger/actions> and
-    make sure that the tests pass for all supported Python versions.
+2.  If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in `README.md`.
+3.  The pull request should work for CPython 3.7, 3.8, 3.9, 3.10, 3.11, 3.12, 3.13, and for PyPy 3.8, 3.9, 3.10, 3.11. Check https://github.com/namespace-ee/django-datadog-logger/actions and make sure that the tests pass for all supported Python versions.
 
 ## Deploying
 
-A reminder for the maintainers on how to deploy. Make sure all your
-changes are committed (including an entry in HISTORY.md). Then run:
+A reminder for the maintainers on how to deploy.
+
+Make sure all your changes are committed (including an entry in `HISTORY.md`). Then run:
 
 ``` shell
-$ bump2version patch # possible: major / minor / patch
-$ git push
-$ git push --tags
+git push
+git push --tags
 ```
 
 GitHub Actions will then deploy to PyPI if tests pass.

HISTORY.md

@@ -1,5 +1,9 @@
 # History
 
+## Unreleased
+
+-   Converted to PEP-518 with `pyproject.toml` and preference for `uv`
+
 ## 0.6.2 (2023-04-27)
 
 -   Fixed case where accessing request.auth may raise errors

Makefile

@@ -21,12 +21,12 @@ for line in sys.stdin:
 endef
 export PRINT_HELP_PYSCRIPT
 
-BROWSER := python -c "$$BROWSER_PYSCRIPT"
+BROWSER := uv run python -c "$$BROWSER_PYSCRIPT"
 
 help:
-	@python -c "$$PRINT_HELP_PYSCRIPT" < $(MAKEFILE_LIST)
+	@uv run python -c "$$PRINT_HELP_PYSCRIPT" < $(MAKEFILE_LIST)
 
-clean: clean-build clean-pyc clean-test ## remove all build, test, coverage and Python artifacts
+clean: clean-test clean-build clean-pyc ## remove all build, test, coverage and Python artifacts
 
 clean-build: ## remove build artifacts
 	rm -fr build/
@@ -48,38 +48,37 @@ clean-test: ## remove test and coverage artifacts
 	rm -fr .pytest_cache
 
 lint: ## check style with flake8
-	flake8 django_datadog_logger tests
+	uv run tox -e flake8
 
 test: ## run tests quickly with the default Python
-	DJANGO_SETTINGS_MODULE=tests.settings python -m unittest discover
+	DJANGO_SETTINGS_MODULE=tests.settings uv run -m unittest discover -v
 
 test-all: ## run tests on every Python version with tox
-	tox
+	uv run tox
 
 coverage: ## check code coverage quickly with the default Python
-	DJANGO_SETTINGS_MODULE=tests.settings coverage run --source django_datadog_logger setup.py test
-	coverage report -m
-	coverage html
+	DJANGO_SETTINGS_MODULE=tests.settings uv run coverage run --source django_datadog_logger -m unittest discover -v
+	uv run coverage report -m
+	uv run coverage html
 	$(BROWSER) htmlcov/index.html
 
 docs: ## generate Sphinx HTML documentation, including API docs
 	rm -f docs/django_datadog_logger.rst
 	rm -f docs/modules.rst
-	sphinx-apidoc -o docs/ django_datadog_logger
+	uv run sphinx-apidoc -o docs/ django_datadog_logger
 	$(MAKE) -C docs clean
 	$(MAKE) -C docs html
 	$(BROWSER) docs/_build/html/index.html
 
 servedocs: docs ## compile the docs watching for changes
-	watchmedo shell-command -p '*.rst' -c '$(MAKE) -C docs html' -R -D .
+	uv run watchmedo shell-command -p '*.rst' -c '$(MAKE) -C docs html' -R -D .
 
 release: dist ## package and upload a release
-	twine upload dist/*
+	uv publish
 
 dist: clean ## builds source and wheel package
-	python setup.py sdist
-	python setup.py bdist_wheel
+	uv build
 	ls -l dist
 
 install: clean ## install the package to the active Python's site-packages
-	python setup.py install
+	uv sync --frozen

django_datadog_logger/__init__.py

@@ -1 +0,0 @@
-__version__ = "0.7.3"

docs/.gitignore

@@ -0,0 +1,3 @@
+django_datadog_logger.*.rst
+django_datadog_logger.rst
+modules.rst

docs/Makefile

@@ -3,7 +3,7 @@
 
 # You can set these variables from the command line.
 SPHINXOPTS    =
-SPHINXBUILD   = python -msphinx
+SPHINXBUILD   = uv run -m sphinx
 SPHINXPROJ    = django_datadog_logger
 SOURCEDIR     = .
 BUILDDIR      = _build

docs/conf.py

@@ -19,6 +19,7 @@
 #
 import os
 import sys
+import importlib.metadata
 
 sys.path.insert(0, os.path.abspath(".."))
 
@@ -57,9 +58,9 @@
 # the built documents.
 #
 # The short X.Y version.
-version = django_datadog_logger.__version__
+version = importlib.metadata.version("django_datadog_logger")
 # The full version, including alpha/beta/rc tags.
-release = django_datadog_logger.__version__
+release = importlib.metadata.version("django_datadog_logger")
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

pyproject.toml

@@ -1,3 +1,65 @@
+[build-system]
+requires = ["setuptools>=42", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "django-datadog-logger"
+version = "0.7.3"
+description = "Django DataDog Logger integration package."
+readme = {file = "README.md", content-type = "text/markdown"}
+requires-python = ">=3.7"
+license = {file = "LICENSE"}
+authors = [
+    {name = "Lenno Nagel", email = "[email protected]"}
+]
+keywords = ["django_datadog_logger"]
+classifiers = [
+    "Development Status :: 2 - Pre-Alpha",
+    "Intended Audience :: Developers",
+    "Natural Language :: English",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.7",
+    "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 :: 3.13",
+    "Programming Language :: Python :: Implementation :: CPython",
+    "Programming Language :: Python :: Implementation :: PyPy",
+]
+dependencies = [
+    "backports.zoneinfo; python_version<'3.9'",
+    "Django",
+    "djangorestframework",
+    "JSON-log-formatter",
+]
+
+[project.urls]
+Homepage = "https://github.com/namespace-ee/django-datadog-logger"
+
+[dependency-groups]
+dev = [
+    "coverage",
+    "tox",
+    "watchdog",
+]
+docs = [
+    # Documentation will be built with the Python from .python-version
+    "sphinx>=7,<8; python_version>'3.8'",
+    "myst-parser>=2,<3; python_version>'3.8'",
+]
+pep8 = [
+    "black",
+    "flake8",
+    "isort",
+]
+
+[tool.setuptools]
+packages = ["django_datadog_logger"]
+zip-safe = false
+include-package-data = true
+
 [tool.black]
 line-length = 120
 target-version = ["py37", "py38"]