django-graphene-filters 0.3.1

Advanced auto related filters for Graphene Django

Django Graphene Filters (Beta)

This package contains Advanced auto related filters for graphene-django.

This package takes inspiration from:

• https://pypi.org/project/graphene-django-filter
• https://pypi.org/project/djangorestframework-filters

Installation

# pip
pip install django-graphene-filters
# uv
uv add django-graphene-filters

Development Setup

# Install uv (if not already installed)
# https://docs.astral.sh/uv/getting-started/installation/

# Clone and install
git clone https://github.com/riodw/django-graphene-filters.git
cd django-graphene-filters
uv sync

Running

uv run python examples/cookbook/manage.py runserver

Testing

uv run coverage run -m pytest
uv run coverage report --fail-under=100
uv run coverage report --show-missing

uv run coverage run -m pytest tests/test_input_data_factories.py && uv run coverage report -m django_graphene_filters/input_data_factories.py
# Run Full Test Pipeline
https://github.com/riodw/django-graphene-filters/actions/workflows/django.yml

Formatting and Linting:

# pyproject.toml [tool.black]
uv run black .
# pyproject.toml [tool.ruff]
uv run ruff check --fix .

Build

uv lock
uv build

Updating Version:

• pyproject.toml:4
• django_graphene_filters/init.py:21
• tests/test_django_graphene_filters.py:8

Publish

uv publish --token PASSWORD

Updating:

# Show outdated packages
uv pip list --outdated

# Add a dev dependency
uv add --group dev <package>

# Remove the virtual environment
rm -rf .venv

Local usage

1. go to the project you want to install the package
2. add django-graphene-filters to your pyproject.toml dependencies
3. point it at your local checkout:

# In your project's pyproject.toml
[tool.uv.sources]
django-graphene-filters = { path = "../django-graphene-filters", editable = true }

Then run:

uv sync

Notes:

Files to do:

• filterset.py AdvancedFilterSet
• input_data_factories.py