django-query-parameters 0.2.3

Django templatetags to simplify creating, updating, and removing query parameters from querystring

django-query-parameters

Adds two template tags that simplify the manipulation of GET parameters on a querystring. Allows easy addition, manipulation, and deletion of parameters onto an existing querystring.

The module is comprised of two template tags: set_query_parameters and del_query_parameters.

set_query_parameters

Takes a 1+ list of key=value pairs and generates an updated querystring that includes those pairs. If a key does not already exist in the querystring, it will be added. If a key exists, it will be updated with the new value. For example:

# current page is http://localhost/?page=1&limit=20
{% load query_parameters %}
<a href="?{% set_query_parameters page=2 order=desc %}">...</a>
# => <a href="?page=2&limit=20&order=desc">...</a>

del_query_parameters

Takes a 1+ list of keys and generates an updated querystring that removes those keys. If a key does not exist in the query string, it will be ignored. For example:

# current page is http://localhost/?page=1&limit=20
{% load query_parameters %}
<a href="?{% del_query_parameters page order %}">...</a>
# => <a href="?limit=20">...</a>

Installing

Installing is a simple as running an easy_install or pip install command:

pip install django-query-parameters

Include the project in the INSTALLED_APPS list in your project’s settings.py file:

INSTALLED_APPS = (..., 'query_parameters', ...)

Storing the output in the template context

By default, both template tags output the result directly. If an optional as key is specified, the results will be stored in a context variable instead. For example:

{% set_query_parameters page=2 as=next_page %}
<a href="?{{ next_page }}">Next Page</a>

{% del_query_parameters color size as=reset_filters %}
<a href="?{{ reset_filters }}">Reset Filters</a>

The as key may be modified in Django’s settings.py file:

QUERY_PARAMETERS_VARIABLE_OUTPUT_KEY = 'output'

...

{% set_query_parameters color=red output=next_page %}

Using a user defined query string

By default, both template tags pull the query string from the request context. If an optional with key is specified, the query string will be loaded from the context variable instead. For example:

{% set_query_parameters color=red as=filter %}
{% set_query_parameters size=large with=filter as=modified_filter %}
<a href="?{{ modified_filter }}">Apply Filter</a>

The with key may be modified in Django’s settings.py file:

QUERY_PARAMETERS_VARIABLE_INPUT_KEY = 'input'

...

{% set_query_parameters color=red input=custom_querystring %}