Remove Django filters

[agjohnson]

We aren't using Django Filters project anymore, this dependency should be removed. This will require some updates to the code where it is expected.

[ericholscher]

I believe it's used in REST Framework, but the in page filters aren't being used. It broke our pagination on Builds in #2633, so it might also be breaking other stuff, and is unnecessary complexity.

[ericholscher]

I believe it's used in REST Framework, but the in page filters aren't being used. It broke our pagination on Builds in #2633, so it might also be breaking other stuff, and is unnecessary complexity.

[vardhan26]

I would like to fix this bug but I am new and do not know how to start. how can I fix this?

[vardhan26]

I would like to fix this bug but I am new and do not know how to start. how can I fix this?

[humitos]

@vardhan26 I started today to take a look at the code, but what I would do is something like:

1. read this http://docs.readthedocs.io/en/latest/contribute.html
2. install readthedocs project in my computer following http://docs.readthedocs.io/en/latest/install.html#installing-read-the-docs
3. remove django-filter (pip uninstall django-filter)
4. run tests (python manage.py test)
5. see what fails
6. try to fix them
7. runserver (python manage.py runserver)
8. try to build different projects again (python manage.py update_repos pip)
9. create a PR
10. be happy to be a contributor :)

[humitos]

@vardhan26 I started today to take a look at the code, but what I would do is something like:

1. read this http://docs.readthedocs.io/en/latest/contribute.html
2. install readthedocs project in my computer following http://docs.readthedocs.io/en/latest/install.html#installing-read-the-docs
3. remove django-filter (pip uninstall django-filter)
4. run tests (python manage.py test)
5. see what fails
6. try to fix them
7. runserver (python manage.py runserver)
8. try to build different projects again (python manage.py update_repos pip)
9. create a PR
10. be happy to be a contributor :)

[ChamanAgrawal]

hey @agjohnson , @humitos do i have to debug all the 174 errors and 25 failures and then send PR or I can debug few and contribute ?

[ChamanAgrawal]

hey @agjohnson , @humitos do i have to debug all the 174 errors and 25 failures and then send PR or I can debug few and contribute ?

[rixx]

@vardhan26, @humitos, @ChamanAgrawal: are you working on this issue atm?

[rixx]

@vardhan26, @humitos, @ChamanAgrawal: are you working on this issue atm?

[humitos]

@rixx No, I'm not. Would you like to?

I would like to fix my previous command to run the tests: tox -e py27, since they are using tox in RTD :)

[humitos]

@rixx No, I'm not. Would you like to?

I would like to fix my previous command to run the tests: tox -e py27, since they are using tox in RTD :)

[rixx]

@agjohnson

I found the following uses of django_filters:

• core.urls uses views from django_filters.views in deprecated_urls; I assume those are to be deleted?
• projects.filters and builds.filters define lots of filters that are used as filter_class in restapi.views.model_views, and are passed as context sometimes in projects.views.public

I'd appreciate guidance as to what to do with those, especially those used in restapi.views.model_filters and projects.views.public.

[rixx]

@agjohnson

I found the following uses of django_filters:

• core.urls uses views from django_filters.views in deprecated_urls; I assume those are to be deleted?
• projects.filters and builds.filters define lots of filters that are used as filter_class in restapi.views.model_views, and are passed as context sometimes in projects.views.public

I'd appreciate guidance as to what to do with those, especially those used in restapi.views.model_filters and projects.views.public.

[JLorne]

Sorry to write a comment in a closed issue, but I don't know where to put it.

We are using readthedocs as our documentation build system and we are using the REST API to monitoring the build status of the different versions of our repositories. Now that you removed django-filter, do you have another way to use the REST API without having to parse all builds from the beginning of time?

[JLorne]

Sorry to write a comment in a closed issue, but I don't know where to put it.

We are using readthedocs as our documentation build system and we are using the REST API to monitoring the build status of the different versions of our repositories. Now that you removed django-filter, do you have another way to use the REST API without having to parse all builds from the beginning of time?

[davidfischer]

@JLorne while going through some of these issues I found this. It is now possible to filter builds by project. For example, you can do something like https://readthedocs.org/api/v2/build/?project__slug=pip (that's a double underscore). Hopefully this meets your needs.

APIv2 is also now documented. Since the RTD team is going through some initial design on a v3 API, I'd love to understand your use case a bit better so we can better meet it.

[davidfischer]

@JLorne while going through some of these issues I found this. It is now possible to filter builds by project. For example, you can do something like https://readthedocs.org/api/v2/build/?project__slug=pip (that's a double underscore). Hopefully this meets your needs.

APIv2 is also now documented. Since the RTD team is going through some initial design on a v3 API, I'd love to understand your use case a bit better so we can better meet it.

[JLorne]

Thank you @davidfischer for the filterable v2 API.
We are using it to monitor documentation build status for our 160 internal repositories and display build fail on TV. But we need to keep track of the build status of some versions in addition of the latest. I add a custom API that add build API with some query parameters:

• api/build?slug=pip&version=v9.0.3 => returns all pip v9.0.3 builds ordered by dates (latest first)

[JLorne]

Thank you @davidfischer for the filterable v2 API.
We are using it to monitor documentation build status for our 160 internal repositories and display build fail on TV. But we need to keep track of the build status of some versions in addition of the latest. I add a custom API that add build API with some query parameters:

• api/build?slug=pip&version=v9.0.3 => returns all pip v9.0.3 builds ordered by dates (latest first)

[davidfischer]

Currently only the slug is used for filtering. For performance reasons, we wanted to make sure that things you can filter on are indexed in the database. I don't believe the version parameter in https://readthedocs.org/api/v2/build/?project__slug=pip&version=v9.0.3 does anything.

[davidfischer]

Currently only the slug is used for filtering. For performance reasons, we wanted to make sure that things you can filter on are indexed in the database. I don't believe the version parameter in https://readthedocs.org/api/v2/build/?project__slug=pip&version=v9.0.3 does anything.