Skip to main content
Python Software Foundation 20th Year Anniversary Fundraiser  Donate today!

A firefox-like about:config implementation for one-off settings in Django apps.

Project description

License: GPL v3 CI codecov PyPI version Openhub

A firefox-like about:config implementation for one-off settings in Django apps.

Compatible Python versions

3.6+

Compatible Django versions

2.0 - 3.0

Installation

You can install aboutconfig either from source or via pip:

pip install django-aboutconfig

The only thing you need to do to configure it is add it to your INSTALLED_APPS like all other django applications:

INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    ...
    'aboutconfig',
]

Then just run manage.py migrate and you’re good to go.

Note: aboutconfig relies on having a good caching mechanism to be fast (all configured values are preloaded into cache on start-up). You should ideally have something like memcached configured to avoid slowdowns. See Django documentation for details.

Usage

By default, aboutconfig comes with four supported data-types: integer, boolean, string and decimal. All data types are configurable and you can add your own if necesessary.

To add some configuration values, head over to the django admin and add an instance of the Config model.

Having done this, you can access the configuration value via aboutconfig.get_config() in Python code or the get_config template filter (load config before using).

Python code:

from aboutconfig import get_config

def my_view(request):
    # some code...
    admin_email = get_config('admin.details.email')
    # some more code...

Template code:

{% load config %}

The website admin's email is {{ 'admin.details.email'|get_config }}.

>>> An assignment tag also exists for convenience:

{% get_config 'admin.details.email' as email %}
The website admin's email is <a href="mailto:{{ email }}">{{ email }}</a>.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for django-aboutconfig, version 1.1.0
Filename, size File type Python version Upload date Hashes
Filename, size django_aboutconfig-1.1.0-py3-none-any.whl (19.3 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size django-aboutconfig-1.1.0.tar.gz (24.1 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page