Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!


Project description

Introduction is component for pyramid, that provides management of menu urls.


You can install with pip.

$ pip install

Usage provides include hook.:


register and use Menu

To add menu, use add_route_menu directive.:

config.add_route('menu1', '/menus/menu1')
config.add_route('menu2', '/menus/menu2')
config.add_route_menu(menu_name="system", route_name="menu1", display_name="system menu item1")

Or use route_menu_config decorator.:

class SystemMenu3(object):
    display_name = "system menu item3"

To get menu, use get_menu API:

from import get_menu

def menu(request):
    system_menu = get_menu(request, system)
    return dict(menu=system_menu)

get_menu returns the object that provides IMenu has a property named menu_items that is list including IMenuItem.

IMenuItem has some property, display_name, name and url. Maybe you use menu items in template such as below:

<ul class="nav">
%for m in system_menu.menu_items:
    <li><a href="${m.url}">${m.display_name}</a></li>


Registering menu with permission

class SystemMenu3(object):
    display_name = "system menu item3"
    permission = 'menu3-permission'

get_menu check permission of request with has_permission, causes that menu_items includes menu items passed permission check.


If route has placeholder, the menu url fills values from request.matchdict.

config.add_route("menu1", 'menus/menu1/{testing_vars}')
menu_factory.add_item(route_name="menu1", display_name="testing-menu1")

When matchdict has values for testing_vars as “that-is-testing”, menu1’s url is “menus/menu1/that-is-testing”.


  • Atsushi Odagiri, Original Author


0.1 (2013-10-13)

  • first release

Project details

Release history Release notifications

This version


Download files

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

Files for, version 0.1
Filename, size File type Python version Upload date Hashes
Filename, size (9.2 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page