Skip to main content
# django navigen
#### Brandon R. Stoner <monokrome@monokro.me>

## What is this?

This application provides components that simplify the creation of dynamic navigation menus in django. You can use to to have django automatically generate menus with menu items that reflect the permissions of the currently logged in user.

## Getting started

Just like other django apps, django-navigen is really easy to get started with. Simply install it with:

python setup.py install

After this is installed, open up your project's settings.py file and add 'navigen' to your INSTALLED_APPS.

INSTALLED_APPS = (
# Your other apps listed here
'navigen',
)

Now, as a final step - have django synchronize your database:

./manage.py syncdb

## How does this work?

You should now have all that you need to use django-navigen within your application. In order to test this it is good to know the terminology used by the navigation system or you might be confused or think that the application is overly complicated. However, remember that django-navigen was made with the following goals in mind:

* All menus are generated dynamically
* Menu items reflect the context of the user, and their related permissions. Users shouldn't see what they can't access.
* The application should support as many dynamic menus as required by the design out-of-the-box.
* Drop-down menus should be easily created without any extra code.

These are established by organizing each menu as a *"navigation tree"*, and relating each tree's top-level *"menu items"* to a navigation tree. A tree is accessed by your template by it's *"access name"*, and multiple trees can make use of the same *"menu item"* when necessary.

Trees are represented in django's ORM with the **NavigationTree** model. This model is fairly simple, and only contains the following properties:

* name - The human readable name for this specific **NavigationTree** instance.
* access_name - The name that will be supplied as a string to access this tree.

Leaves in the tree are represented by the **NavigationItem** model which describes a single link that can be assigned to a tree, and can also be assigned to a parent menu item for dropdowns.

Metadata

Release files for django-navigen 0.1.2-hotfix

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-navigen 0.1.2-hotfix
File Size Uploaded
django-navigen-0.1.2-hotfix.tar.gz 4.8 kB Details

Release files / django-navigen-0.1.2-hotfix.tar.gz

Download URL django-navigen-0.1.2-hotfix.tar.gz
Size 4.8 kB
Tags Source
SHA-256 checksum
How to use checksums
eca06267b707da60b417af1d2f834212aa33d14e8085e17563dbd0a2ba4d60f8
BLAKE2b-256 checksum
How to use checksums
758172b23abc199805726bffaad931278c946516b38014792cb87933a3567391
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

0.1.3

1 release file

This release

0.1.2-hotfix This release

1 release file

0.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