Introduction¶
To get started using Django-Site-Utils, follow the instructions below to install it and add it to your Django project.
Installation¶
Install the django-site-utils package using pip:
pip install django-site-utils
Using a virtual environment is highly recommended instead of installing into your system wide site-packages directory.
Configuration¶
Add site_utils to your project’s INSTALLED_APPS:
INSTALLED_APPS = (
...
'site_utils',
...
)
Usage¶
Django-Site-Utils is typically used by invoking one of its management commands:
./manage.py *<command>*
Where <command> is one of the following:
site_cleanupsite_configsite_error_pagesite_notifysite_update
Any command can be followed with the --help option to view the available
command line arguments.
Next Steps¶
To learn more about a specific command, read its detailed documentation under Commands or configure it with custom Settings. Refer to Views to learn more about the included error handlers and views and Context Processors to learn about the available context processors.