Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Make it more clear to add django_filters to INSTALLED_APPS #7535

Merged
merged 2 commits into from
Sep 14, 2020
Merged

Make it more clear to add django_filters to INSTALLED_APPS #7535

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
552ae5a
Make it more clear to add django_filters to INSTALLED_APPS
johnthagen Sep 14, 2020
f5b746e
Quote string value
johnthagen Sep 14, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
12 changes: 10 additions & 2 deletions docs/api-guide/filtering.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,10 +145,18 @@ Note that you can use both an overridden `.get_queryset()` and generic filtering
The [`django-filter`][django-filter-docs] library includes a `DjangoFilterBackend` class which
supports highly customizable field filtering for REST framework.

To use `DjangoFilterBackend`, first install `django-filter`. Then add `django_filters` to Django's `INSTALLED_APPS`
To use `DjangoFilterBackend`, first install `django-filter`.

pip install django-filter

Then add `'django_filters'` to Django's `INSTALLED_APPS`:

INSTALLED_APPS = [
...
'django_filters',
...
]

You should now either add the filter backend to your settings:

REST_FRAMEWORK = {
Expand Down Expand Up @@ -365,4 +373,4 @@ The [djangorestframework-word-filter][django-rest-framework-word-search-filter]
[django-url-filter]: https://github.com/miki725/django-url-filter
[drf-url-filter]: https://github.com/manjitkumar/drf-url-filters
[HStoreField]: https://docs.djangoproject.com/en/3.0/ref/contrib/postgres/fields/#hstorefield
[JSONField]: https://docs.djangoproject.com/en/3.0/ref/contrib/postgres/fields/#jsonfield
[JSONField]: https://docs.djangoproject.com/en/3.0/ref/contrib/postgres/fields/#jsonfield