Skip to main content

django-pragmatic

Build Status

Pragmatic tools and utilities for Django projects.

Requirements

Optional dependencies are required only for the modules that use them (see Installation).

Installation

pip install django-pragmatic

Add pragmatic to INSTALLED_APPS:

INSTALLED_APPS = [
    ...
    'pragmatic',
]

Run migrations (needed only if you use deleted-object tracking):

python manage.py migrate pragmatic

What's included

Module Description
Models DeletedObject — audit trail for deleted instances
Mixins CBV/form mixins: permissions, delete, pagination, sorting, display modes, PDF, slugs
Decorators permissions_required, permission_required, PostgreSQL lock, Cached
Template tags {% load pragmatic_tags %} — filter display, sorting, pagination, URL tools
Fields RangeField, SliderField, MultiSelectField, ChoiceArrayField
Filters SliderFilter, OneFieldRangeFilter, ArrayFilter and more
Widgets GroupedCheckboxSelectMultiple, SliderWidget, map widgets
Middleware MaintenanceModeMiddleware — serve 503 during downtime
Managers EmailManager — template-based email with optional RQ queue
Context processors Date formats, installed apps, URL identifier, settings
Signals SignalsHelper, apm_custom_context, disable_signals
Utils build_absolute_uri, get_task_decorator, zip compression
Jobs Background email via RQ, ConnectionClosingWorker
REST Framework ContentTypeSerializer, HybridRouter, BearerAuthentication
Management commands clean_migrations, rqscheduler

Quick examples

Maintenance mode:

# settings.py
MAINTENANCE_MODE = True
MAINTENANCE_MODE_BYPASS_USERS = [1]  # superuser can still log in

Send an email from a template:

from pragmatic.managers import EmailManager

EmailManager.send_mail(
    to=user,
    template_prefix='emails/welcome',
    subject='Welcome!',
    data={'activation_link': url},
    request=request,
)

List view with display modes and sorting:

from pragmatic.mixins import DisplayListViewMixin, SortingListViewMixin

class ArticleListView(SortingListViewMixin, DisplayListViewMixin, ListView):
    model = Article
    displays = ['list', 'table']
    paginate_by_display = {'list': [10, 25], 'table': 100}
    sorting_options = {'-created': 'Newest', 'title': 'Title A–Z'}

Template filter values display:

{% load pragmatic_tags %}
{% filter_values filter %}
{% num_applied_filters filter request.GET as n %}
{{ n }} active filter{{ n|pluralize }}

Background task decorator:

# settings.py
PRAGMATIC_TASK_DECORATOR = 'django_rq.job'  # or 'celery.shared_task'
from pragmatic.utils import get_task_decorator

task = get_task_decorator(queue='default')

@task
def process_export(export_id):
    ...

Documentation

Full documentation is at django-pragmatic.readthedocs.io.

License

BSD License — see LICENSE for details.

Release files for django-pragmatic 7.2.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for django-pragmatic 7.2.0
File Size Uploaded
django_pragmatic-7.2.0.tar.gz 48.9 kB Details

Release files / django_pragmatic-7.2.0.tar.gz

Download URL django_pragmatic-7.2.0.tar.gz
Size 48.9 kB
Tags Source
SHA-256 checksum
How to use checksums
2b76350f9d587f1aac50e33dd778b48483fc255357d4999df9fa1a4b868fa25e
BLAKE2b-256 checksum
How to use checksums
f53f5ba41d5cd1ce44e6f343c7678ed5046243545f24f987980cc410585159ba
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.12

Release history Release notifications | RSS feed

This release

7.2.0 This release

1 release file

7.1.0

1 release file

7.0.1

1 release file

7.0.0

1 release file

6.0.3

1 release file

6.0.2

1 release file

6.0.1

1 release file

6.0.0

1 release file

5.0.0

1 release file

4.8.0

1 release file

4.7.0

1 release file

4.6.0

1 release file

4.5.0

1 release file

4.4.0

1 release file

4.3.0

1 release file

4.2.0

1 release file

4.1.0

1 release file

4.0.0

1 release file

3.5.0

1 release file

3.4.1

1 release file

3.4.0

1 release file

3.3.4

1 release file

3.3.3

1 release file

3.3.2

1 release file

3.3.1

1 release file

3.3.0

1 release file

3.2.2

1 release file

3.2.1

1 release file

3.2.0

1 release file

3.1.0

1 release file

3.0.0

1 release file

2.22.0

1 release file

2.21.1

1 release file

2.21.0

1 release file

2.20.0

1 release file

2.19.0

1 release file

2.18.1

1 release file

2.18.0

1 release file

2.17.0

1 release file

2.16.0

1 release file

2.15.0

1 release file

2.14.0

1 release file

2.13.0

1 release file

2.12.0

1 release file

2.11.0

1 release file

2.10.0

1 release file

2.9.1

1 release file

2.9.0

1 release file

2.8.0

1 release file

2.7.2

1 release file

2.7.1

1 release file

2.7.0

1 release file

2.6.0

1 release file

2.5.0

1 release file

2.4.0

1 release file

2.3.1

1 release file

2.3.0

1 release file

2.2.4

1 release file

2.2.3

1 release file

2.2.2

1 release file

2.2.1

1 release file

2.2.0

1 release file

2.1.0

1 release file

2.0.0

1 release file

1.9.0

1 release file

1.8.1

1 release file

1.8.0

1 release file

1.7.4

1 release file

1.7.3

1 release file

1.7.2

1 release file

1.7.1

1 release file

1.7.0

1 release file

1.6.2

1 release file

1.6.1

1 release file

1.6.0

1 release file

1.5.0

1 release file

1.4.0

1 release file

1.3.0

1 release file

1.2.1

1 release file

1.2.0

1 release file

1.1.1

1 release file

1.1.0

1 release file

1.0.0

1 release file

0.9.8

1 release file

0.9.7

1 release file

0.9.6

1 release file

0.8.6

1 release file

0.8.5

1 release file

0.7.5

1 release file

0.7.4

1 release file

0.7.3

1 release file

0.7.2

1 release file

0.7.1

1 release file

0.7.0

1 release file

0.6.3

1 release file

0.6.2

1 release file

0.6.1

1 release file

0.6.0

1 release file

0.5.3

1 release file

0.5.2

1 release file

0.4.2

1 release file

0.4.1

1 release file

0.3.1

1 release file

0.3.0

1 release file

0.2.1

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page