ericziethen / django-property-filter Goto Github PK

• Write Documentation
• Create Documentation with saphire
• Upload to readthedocs.io Deferred
• Add Documentation to PyPi project Deferred
• Add Reademe.Md Instructions, Development, Testing, Linting ...

• Check https://django-filter.readthedocs.io/en/latest/ref/filters.html for Base Filter Details
• Data Population for Django Test Project
• Test Page for Django Test Project
• Filter Support
• Document Filter in Docs, add if COmbining with other Property Filters
• Filter Test Coverage

• Check https://django-filter.readthedocs.io/en/latest/ref/filters.html for Base Filter Details
• Data Population for Django Test Project
• Test Page for Django Test Project
• Filter Support
• Document Filter in Docs
• Filter Test Coverage

HOW IT WORKS

• Explain Better the difference to django-filter
• Explain Non DB Values Usage and Filter
• explain filter in memory
• Map Django-filter filters to Property Filters

FILTER OVERVIEW

• Table/Matrix with all supported Lookupvalues, highlight the default lookup
• Point out Which Filters cannot be declared Implicitly, e.g. ChoiceFilter -> Maybe use a Matrix?

LIMITATIONS and DRAWBACKS

• explain filter in memory, so potentially issues for very large data sets
• Document drawbacks of properties, unexpected file types
• Document slower, in memory, large set, type convertions might reduce speed
• document sqlite limitations, e.g. 999 max params limit, or higher depending on sqlite version...
• Mention if any Filters are particular slow, like Using AllValue and AllValueMultipleChoice, document the field property to create a form and mixing filters, slow if large numbers

TIPS

• Guideline on how to select the correct filter

DEV TOOLS

• Add Section how to Run Benchmarks in Dev Documentation

TODO

• Highlight Supported Fields (See django-filter doc for details) - Highlight Supporting same fields
• Add limitations also to Readme.MD
• Review Content

CODE DOCUMENTATION

• document mixins in code properly, purpose, Inheritance Structure (Mirroring django filters) ...

• Check https://django-filter.readthedocs.io/en/latest/ref/filters.html for Base Filter Details
• Data Population for Django Test Project
• Test Page for Django Test Project
• Filter Support
• Document Filter in Docs
• Filter Test Coverage

• Check https://django-filter.readthedocs.io/en/latest/ref/filters.html for Base Filter Details
• Data Population for Django Test Project
• Test Page for Django Test Project
• Filter Support
• Document Filter in Docs
• Filter Test Coverage

• Check https://django-filter.readthedocs.io/en/latest/ref/filters.html for Base Filter Details
• Data Population for Django Test Project
• Test Page for Django Test Project
• Filter Support
• Document Filter in Docs
• Filter Test Coverage

• Increase version Number to 0.3.0
• Release Wheel to Pypi Test
• Release Wheel to Pypi
• Tag git with v0.3.0 (After Master Merge) from Github
• Ensure latest Documentation points to the Tagged Version (https://readthedocs.org/projects/django-property-filter/)

• Check https://django-filter.readthedocs.io/en/latest/ref/filters.html for Base Filter Details
• Data Population for Django Test Project
• Test Page for Django Test Project
• Filter Support
• Document Filter in Docs (Add a section for Non Matching filter)
• Filter Test Coverage

• Increase version Number to 0.2.0 (without 'v')
• Point PyPi documentation to stable documentation (https://django-property-filter.readthedocs.io/en/stable/)
• Point Readme.MD to stable documentation (https://django-property-filter.readthedocs.io/en/stable/)
• Release Wheel to Pypi
• Tag git with v0.2.0 (After Master Merge)

• Check https://docs.djangoproject.com/en/3.0/ref/contrib/postgres/fields/#integerrangefield
• Check https://django-filter.readthedocs.io/en/latest/ref/filters.html#numericrangefilter
• Data Population for Django Test Project
• Test Page for Django Test Project
• Filter Support
• Document Filter in Docs
• Filter Test Coverage
• Add Filter to Benchmark Filters

• Check https://django-filter.readthedocs.io/en/latest/ref/filters.html for Base Filter Details
• Data Population for Django Test Project
• Test Page for Django Test Project
• Filter Support
• Document Filter in Docs
• Filter Test Coverage

• Check https://django-filter.readthedocs.io/en/latest/ref/filters.html for Base Filter Details
• Filter Support
• Filter Test Coverage
• Document Filter in Docs
• Data Population for Django Test Project
• Test Page for Django Test Project

There should be a test class for each available Filter so that we can multiple Fields for Tests on the test page.

E.g. There should be a NumberFilterClass and a NumberFilterList which can include multiple fields.

• Review existing Filters
• Display All fields in the Filters
• Review Additional Tests needed
• Display Filters for all Fields

• Check https://django-filter.readthedocs.io/en/latest/ref/filters.html for Base Filter Details
• Data Population for Django Test Project
• Test Page for Django Test Project
• Filter Support
• Document Filter in Docs
• Filter Test Coverage

• Check https://django-filter.readthedocs.io/en/latest/ref/filters.html for Base Filter Details
• Data Population for Django Test Project
• Test Page for Django Test Project
• Filter Support
• Document Filter in Docs
• Filter Test Coverage

• Review implementation
• Review Test Project Filters, (init)

• Create Wheel & Installation as Django App Succesfull
• Test with PiPy-test

• Check https://django-filter.readthedocs.io/en/latest/ref/filters.html for Base Filter Details
• Data Population for Django Test Project
• Test Page for Django Test Project
• Filter Support
• Document Filter in Docs
• Filter Test Coverage

• Check https://django-filter.readthedocs.io/en/latest/ref/filters.html for Base Filter Details
• Data Population for Django Test Project
• Test Page for Django Test Project
• Filter Support
• Document Filter in Docs, Only Explicit, Usage...
• Filter Test Coverage

• use sphinx_rtd_theme theme
• Add link to documentation to Pypi

• Check https://django-filter.readthedocs.io/en/latest/ref/filters.html for Base Filter Details
• Check if any Implementation Needed otherwise put in documentary with explanation
• Data Population for Django Test Project
• Test Page for Django Test Project
• Filter Support
• Document Filter in Docs
• Filter Test Coverage

• Check https://django-filter.readthedocs.io/en/latest/ref/filters.html for Base Filter Details
• Data Population for Django Test Project
• Test Page for Django Test Project
• Filter Support
• Document Filter in Docs
• Filter Test Coverage

• Check https://django-filter.readthedocs.io/en/latest/ref/filters.html for Base Filter Details
• Data Population for Django Test Project
• Test Page for Django Test Project
• Filter Support
• Document Filter in Docs
• Test coverage with Default "or"
• Test coverage with "conjoined=True" and

• Data Population for Django Test Project
• Test Page for Django Test Project
• Filter Support
• Document Filter in Docs
• Document that ordering in memory, so might not be apropriate for large datasets
• Document because of in memory sorting, only sorting by a single attribute is supported
• Check https://django-filter.readthedocs.io/en/latest/ref/filters.html for Base Filter Details
• Add Filter for Special Fields of this Filter, e.g. arguments (list, tuple ...)
• Filter Test Coverage

• Check https://django-filter.readthedocs.io/en/latest/ref/filters.html for Base Filter Details
• Data Population for Django Test Project
• Test Page for Django Test Project
• Filter Support
• Document Filter in Docs
• Filter Test Coverage

e.g. Number = 10.
Endswith Filter = '00'
10 is still shown
Even if multiple 0s are shown it's still including

This might be because the default filter is a number filter and 000 might be reduced to 0.
Maybe it should fallback to a string filter?

The original Number filter behaves in the same way.

• Check https://django-filter.readthedocs.io/en/latest/ref/filters.html for Base Filter Details
• Data Population for Django Test Project
• Test Page for Django Test Project
• Filter Support
• Document Filter in Docs
• Filter Test Coverage

• Check https://django-filter.readthedocs.io/en/latest/ref/filters.html for Base Filter Details
• Data Population for Django Test Project
• Test Page for Django Test Project
• Filter Support
• Document Filter in Docs
• Filter Test Coverage

• Generate NumberClass Data for Testing

• Clean up Migration Files, reduce to 1

• Check https://django-filter.readthedocs.io/en/latest/ref/filters.html for Base Filter Details
• Data Population for Django Test Project
• Test Page for Django Test Project
• Filter Support
• Document Filter in Docs
• Filter Test Coverage

When filtering 0 - 20.
Filtering 'lt' 10

• DJango-Filter: 0 - 9
• Property Filter 1 - 9

• Check https://django-filter.readthedocs.io/en/latest/ref/filters.html for Base Filter Details
• Check if any Implementation Needed otherwise put in documentary with explanation
• Data Population for Django Test Project
• Test Page for Django Test Project
• Filter Support
• Don't Allow Choice Filters to be declared Implicitely
• Document Filter in Docs, only Explicit Declaration since choices need to be passed
• Filter Test Coverage

• Filter Support
• Filter Test Coverage
• Document Filter in Docs
• Data Population for Django Test Project
• Test Page for Django Test Project

• Complete & Release Documentation to readthedocs.io
• Complete Readme.MD
• Add documentation to Pypi project
• Release initial version to Pypi
• Documentation to Include Populate Test data for Test Django Project
• Test with Project install from PyPi

• Subclass Base Filterset that takes a meta Property List and type
• At initiation, create all filters for that type

• Setup Project Structure
• Setup Test Framework (pytest)
• Setup Linters

• Check https://django-filter.readthedocs.io/en/latest/ref/filters.html for Base Filter Details
• Data Population for Django Test Project
• Test Page for Django Test Project
• Filter Support
• Document Filter in Docs
• Filter Test Coverage

• Check https://django-filter.readthedocs.io/en/latest/ref/filters.html for Base Filter Details
• Data Population for Django Test Project
• Test Page for Django Test Project
• Filter Support
• Document Filter in Docs
• Filter Test Coverage

• Filter Support
• Filter Test Coverage
• Document Filter in Docs
• Data Population for Django Test Project
• Test Page for Django Test Project

• either try to use args/kwargs and pop - or -
• use "https://docs.python.org/3.5/library/inspect.html#inspect.signature" to test the correct number of arguments and names

Either tox or travis matrix moght be a better suite

• https://pypi.org/project/tox/
• https://stackoverflow.com/questions/37016688/how-to-run-tox-with-travis-ci
• https://tox.readthedocs.io/en/latest/example/basic.html
• Add Testscripts to call tox for development (Windows at least)
• Document Tox Testing
• Document Django and Filter combinations supported/tested against

• Check https://django-filter.readthedocs.io/en/latest/ref/filters.html for Base Filter Details
• Data Population for Django Test Project
• Test Page for Django Test Project
• Filter Support
• Document Filter in Docs
• Filter Test Coverage

• Check https://django-filter.readthedocs.io/en/latest/ref/filters.html for Base Filter Details
• Data Population for Django Test Project
• Test Page for Django Test Project
• Filter Support
• Document Filter in Docs
• Filter Test Coverage