Skip to main content

Simple, yet powerful, code-based menus for Django applications

Project description

Jazzband Build Status Test coverage status Documentation status Supported Python versions Supported Django versions

django-simple-menu is an entirely code based menu system, because, who really wants to define their menus inside Django Admin?..

It’s simple to use, yet provides enough flexibility to provide unlimited children menus, per-request generation and checking of menu items, badges, and more.

Quickstart

Requirements: Python 3.6+, Django 3.2+

  1. Install the django-simple-menu package.

  2. Add simple_menu to your INSTALLED_APPS.

    • please ensure that you have django.template.context_processors.request listed under TEMPLATES[...]["OPTIONS"]["context_processors"].

  3. Create menus.py inside each app you want to create a menu for and define said menus using the Menu and MenuItem classes you can import from the simple_menu package.

  4. In your templates, load the template tags ({% load simple_menu %}) and call {% generate_menu %} inside a block. Your context will be populated with a new object named menus. You can now iterate over it to render your menus.

To quickly see django-simple-menu in action, check out the example project.

More

Full documentation, including installation and configuration instructions, is available at https://django-simple-menu.readthedocs.io/.

django-simple-menu is released under the BSD 2-Clause “Simplified” License. If you like it, please consider contributing!

django-simple-menu was originally created by Evan Borgstom <evan@borgstrom.ca> and was further developed by many contributors.

Project details


Download files

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

Source Distribution

django-simple-menu-2.0.1.tar.gz (183.8 kB view details)

Uploaded Source

Built Distribution

django_simple_menu-2.0.1-py3-none-any.whl (13.9 kB view details)

Uploaded Python 3

File details

Details for the file django-simple-menu-2.0.1.tar.gz.

File metadata

  • Download URL: django-simple-menu-2.0.1.tar.gz
  • Upload date:
  • Size: 183.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.6

File hashes

Hashes for django-simple-menu-2.0.1.tar.gz
Algorithm Hash digest
SHA256 8cc00f33177d0d4d64b2c3a4f394184eb7e84a159d29fb95d1457f27c5f7da00
MD5 26356af842d285207fd4f2fd5f2e6eb8
BLAKE2b-256 d21fbe2957bee43f07cc6590a9f7fec3e3921823206a7dd0652ad744011a537e

See more details on using hashes here.

File details

Details for the file django_simple_menu-2.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for django_simple_menu-2.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 1ef56791a31ef05a2dbcddcd1eab3ed0561a891f1712c3788659e65e3b801062
MD5 e99c9244d933ce1da015968e7ad0c5f5
BLAKE2b-256 84ebc1088083e96176416a7b4a04e0e2813b75c601b5fc40a6bef1ecbfd6e213

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page