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.3.tar.gz (184.0 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: django-simple-menu-2.0.3.tar.gz
  • Upload date:
  • Size: 184.0 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.3.tar.gz
Algorithm Hash digest
SHA256 c6caad184c14b6bef07596dfc35bf24026c9fdc0d39ba38a707fd2f9557f5c5b
MD5 205976945e36d4846534c52886a006ce
BLAKE2b-256 663774e228ea74aa8dae7f1a5b5449046c0769f5d5ae288074cbf9beba9e3e20

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for django_simple_menu-2.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 bae57bdc82042d46877f30fa37af546d6e6ef9812e402522a2cf4ff1e5c12e22
MD5 4228e2099d6b4260bc35bbb33aea5698
BLAKE2b-256 21926c9c9ca98f5b63e75bc7e32eaa9468031670cf75c70a4fa3e669568df5a1

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