Installation¶
Requirements¶
- Django 4.2
- Postgres or Mariadb
- Django Admin -
django.contrib.admin
- Humanize -
django.contrib.humanize
Note
Django Name is intended to be installed within a Django project. If you are unfamiliar with Django, check out the docs.
Installation¶
Install the package from PyPI.
$ pip install django-name
Add
name
to yourINSTALLED_APPS
. Be sure to adddjango.contrib.admin
anddjango.contrib.humanize
if they are not already present.INSTALLED_APPS = ( 'django.contrib.admin', 'django.contrib.humanize', # ... 'name', )
Configure the context processors.
TEMPLATES = [ { 'BACKEND': '...', 'APP_DIRS': True, 'OPTIONS': { 'context_processors': [ # ... 'django.contrib.auth.context_processors.auth', 'django.template.context_processors.request', 'name.context_processors.name' ], # ... }, }, ]
Note
The request
context processor is required by the Name app. The built-in templates require access to request parameters.
The name
processor enables the filter component of the search action as well as some optional branding (see Branding).
Include the URLs.
from name import urls as name_urls urlpatterns = [ # ... path('name/', include(name_urls)) ]
Migrate the database.
$ ./manage.py migrate name
Optional: Load the Identifier Type fixtures. See Loading Fixtures.
Loading Fixtures¶
Note
This is an optional installation step.
The app comes with a fixture of predefined Indentifier Types. Issue one of the following commands below install them.
$ ./manage.py loaddata --app name identifier_types