django CMS Navigation requires that you have a django CMS 4.0 (or higher) project already running and set up.

Run:

pip install djangocms-navigation

Add djangocms_navigation to your project's INSTALLED_APPS.

Run:

python manage.py migrate djangocms_navigation

to perform the application's database migrations.

You can run all the tests by executing:

python -m venv venv source venv/bin/activate python setup.py test

# Alternatively you could run the test runner stand-alone pip install -r tests/requirements.txt python tests.settings.py

To register model to use navigation app, app should provide class in cms_config.py which inherit CMSAppConfig class. It should have djangocms_navigation_enabled flag True which register to use djangocms_navigation and provide model mapping object, navigation_models.

Mapping object should provide Model class as key and list of model fields which will be used for autocomplete form fields. E.g. if you have a PageContent model and an Article model, when you are choosing the Content_Object to link a menu item to, you may want the "title" field for the PageContent model and the "slug" field for the Article model. Example of configuration defined below.

class CoreCMSAppConfig(CMSAppConfig):
    djangocms_navigation_enabled = True
    navigation_models = {
        Model: ["model_field", ],
    }