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+

Note: While this package does support Python 3.6 and 3.7 as well as Django 4.0, we do not test the package under these versions and may miss some bugs.

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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

Details for the file django_simple_menu-2.1.4.tar.gz.

File metadata

  • Download URL: django_simple_menu-2.1.4.tar.gz
  • Upload date:
  • Size: 184.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.4

File hashes

Hashes for django_simple_menu-2.1.4.tar.gz
Algorithm Hash digest
SHA256 4f9cc5edbf75c5ed6067b9a227134b21404d57f88ef899050d2cadb21e277fef
MD5 161d98e8aa6791e572f85763354a463c
BLAKE2b-256 34a8fc21e909e2fa7527afb38ccc80f1411c6efea3ea8cdd23b0007435aa7964

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for django_simple_menu-2.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 53b2c39d2248297f92fe1eeeae4f6333ec43d2ae5bb19001d2f20ecd8b42bda4
MD5 1367197914362007437048ea9eed4931
BLAKE2b-256 de4e0bedf1103950276076aeb3844851f0306c46323ad5127cbb786f06cba897

See more details on using hashes here.

Supported by

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