Welcome to Django flexible filter conditions’s documentation!¶

Contents:

Django flexible filter conditions¶

Flexible query filter conditions, that can be defined from django-admin and used for segmentation of date (i.e. Profiles).

Documentation¶

The full documentation is at https://django-flexible-filter-conditions.readthedocs.io.

Quickstart¶

Install Django flexible filter conditions:

pip install django-flexible-filter_conditions

Add it to your INSTALLED_APPS:

INSTALLED_APPS = (
    ...
    'flexible_filter_conditions.apps.FlexibleFilterConditionsConfig',
    ...
)

Add Django flexible filter conditions’s URL patterns:

FLEXIBLE_FILTER_CONDITIONS_FIELD_MAP = {
    'User': ('aklub.models', 'User'),
    'Profile': ('aklub.models', 'Profile'),
    'Payment': ('aklub.models', 'Payment'),
    'User.last_payment': ('aklub.models', 'Payment'),
    'User.userchannels': ('aklub.models', 'DonorPaymentChannel'),
}

Features¶

TODO

Running Tests¶

Does the code actually work?

source <YOURVIRTUALENV>/bin/activate
(myenv) $ pip install tox
(myenv) $ tox

Credits¶

Tools used in rendering this package:

Installation¶

At the command line:

$ easy_install django-flexible-filter-conditions

Or, if you have virtualenvwrapper installed:

$ mkvirtualenv django-flexible-filter-conditions
$ pip install django-flexible-filter-conditions

Usage¶

To use Django flexible filter conditions in a project, add it to your INSTALLED_APPS:

INSTALLED_APPS = (
    ...
    'flexible_filter_conditions.apps.FlexibleFilterConditionsConfig',
    ...
)

Configure fields that you want to filter on in your settings:

FLEXIBLE_FILTER_CONDITIONS_FIELD_MAP = {
    'User': ('aklub.models', 'User'),
    'Profile': ('aklub.models', 'Profile'),
    'Payment': ('aklub.models', 'Payment'),
    'User.last_payment': ('aklub.models', 'Payment'),
    'User.userchannels': ('aklub.models', 'DonorPaymentChannel'),
}

Contributing¶

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions¶

Report Bugs¶

Report bugs at https://github.com/PetrDlouhy/django-flexible-filter-conditions/issues.

If you are reporting a bug, please include:

Your operating system name and version.
Any details about your local setup that might be helpful in troubleshooting.
Detailed steps to reproduce the bug.

Fix Bugs¶

Look through the GitHub issues for bugs. Anything tagged with “bug” is open to whoever wants to implement it.

Implement Features¶

Look through the GitHub issues for features. Anything tagged with “feature” is open to whoever wants to implement it.

Write Documentation¶

Django flexible filter conditions could always use more documentation, whether as part of the official Django flexible filter conditions docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback¶

The best way to send feedback is to file an issue at https://github.com/PetrDlouhy/django-flexible-filter-conditions/issues.

If you are proposing a feature:

Explain in detail how it would work.
Keep the scope as narrow as possible, to make it easier to implement.
Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!¶

Ready to contribute? Here’s how to set up django-flexible-filter-conditions for local development.

Fork the django-flexible-filter-conditions repo on GitHub.

Clone your fork locally:

$ git clone git@github.com:your_name_here/django-flexible-filter-conditions.git

Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:
```
$ mkvirtualenv django-flexible-filter-conditions
$ cd django-flexible-filter-conditions/
$ python setup.py develop
```
Create a branch for local development:
```
$ git checkout -b name-of-your-bugfix-or-feature
```
Now you can make your changes locally.
When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:
```
$ flake8 flexible_filter_conditions tests
$ python setup.py test
$ tox
```
To get flake8 and tox, just pip install them into your virtualenv.

Commit your changes and push your branch to GitHub:

$ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature

Submit a pull request through the GitHub website.

Pull Request Guidelines¶

Before you submit a pull request, check that it meets these guidelines:

The pull request should include tests.
If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
The pull request should work for Python 2.6, 2.7, and 3.3, and for PyPy. Check https://travis-ci.org/PetrDlouhy/django-flexible-filter-conditions/pull_requests and make sure that the tests pass for all supported Python versions.

Tips¶

To run a subset of tests:

$ python -m unittest tests.test_flexible_filter_conditions

Credits¶

Development Lead¶

Petr Dlouhý <petr.dlouhy@email.cz>

Contributors¶

None yet. Why not be the first?

History¶

0.5.0 (2020-02-19)¶

refactor: remove filter_by_condition(), make it NamedCondition class method filter_by_query()
fix contains operator
add more testing

0.4.0 (2020-02-18)¶

added support for new operators: in, list, date
mutlipe conditions in one named comdition can be added to support subsequent filters
add xor operator
add negate to condtition (and remove nor)

0.3.0 (2020-01-23)¶

fixes and improvements for better user orientation

0.2.0 (2020-01-21)¶

Added blank paremeter value
Added isnull filter

0.1.0 (2020-01-14)¶

First release on PyPI.