phx-filters-django 3.3.0

Extends phx-filters, adding filters useful for Django applications.

Django Filters

Adds filters for for Django-specific features, including:

• filters.ext.Model: Search for a DB model instance matching the incoming value.

Requirements

Django Filters is known to be compatible with the following Python versions:

• 3.14

• 3.13

• 3.12

Only Django LTS versions are supported.

Note

I’m only one person, so to keep from getting overwhelmed, I’m only committing to supporting the 3 most recent minor versions of Python and current Django LTS versions. Django Filters may work with versions of Python and/or Django not listed here — there just won’t be any test coverage to prove it 😇

Installation

This package is an extension for the Filters library, so you can install it as an extra to phx-filters:

pip install phx-filters[django]

Important

Make sure to install phx-filters, not filters. I created the latter at a previous job years ago, and after I left they never touched that project again and stopped responding to my emails — so in the end I had to fork it 🤷

If desired, you can install this package separately. This allows you to control the package version separately from phx-filters:

pip install phx-filters-django

Maintainers

To set up a local development environment:

1. Install uv (once per machine).

2. Install dependencies:

   uv sync

3. Activate pre-commit hooks:

   uv run autohooks activate --mode=pythonpath

Run tests for all supported Python versions using tox:

uv run tox -p

To run tests in the current virtualenv:

uv run python manage.py test

Documentation

Documentation is available on ReadTheDocs.

Source files for this project’s documentation can be found in the phx-filters repo.

Releases

Important

Make sure to build releases off of the main branch, and check that all changes from develop have been merged before creating the release!

1. One-time setup

Create a PyPI API token if you don’t have one, then install keyring as a global tool and store the token:

uv tool install keyring
uv tool update-shell
keyring set https://upload.pypi.org/legacy/ __token__

Paste your pypi-... token when prompted.

2. Publish to PyPI

1. Bump the version (updates pyproject.toml and uv.lock):

   uv version <version>

2. Commit the changes:

   git add pyproject.toml uv.lock
   git commit

3. Publish to PyPI:

   uv publish --username __token__

3. Create GitHub Release

1. Create an annotated tag and push to GitHub:

   git tag -a <version> -m "Release <version>"
   git push origin <version>

   <version> must match the updated version number in pyproject.toml.

2. Go to the Releases page for the repo.

3. Click Draft a new release.

4. Select the tag that you created in step 1.

5. Specify the title of the release (e.g., Django Filters v1.2.3).

6. Write a description for the release. Make sure to include: - Credit for code contributed by community members. - Significant functionality that was added/changed/removed. - Any backwards-incompatible changes and/or migration instructions. - SHA256 hashes of the build artefacts.

7. GPG-sign the description for the release (ASCII-armoured).

8. Attach the build artefacts to the release.

9. Click Publish release.