flask-menu

============ Flask-Menu

.. image:: https://github.com/inveniosoftware/flask-menu/workflows/CI/badge.svg :target: https://github.com/inveniosoftware/flask-menu/actions .. image:: https://coveralls.io/repos/inveniosoftware/flask-menu/badge.png?branch=master :target: https://coveralls.io/r/inveniosoftware/flask-menu .. image:: https://pypip.in/v/Flask-Menu/badge.png :target: https://pypi.python.org/pypi/Flask-Menu/ .. image:: https://pypip.in/d/Flask-Menu/badge.png :target: https://pypi.python.org/pypi/Flask-Menu/

About

Flask-Menu is a Flask extension that adds support for generating menus.

Installation

Flask-Menu is on PyPI so all you need is: ::

pip install Flask-Menu

Documentation

Documentation is readable at https://flask-menu.readthedocs.io/ or can be build using Sphinx: ::

git submodule init
git submodule update
pip install Sphinx
python setup.py build_sphinx

Testing

Running the test suite is as simple as: ::

python setup.py test

or, to also show code coverage: ::

./run-tests.sh

Changes

Version 2.0.0 (released 2024-11-19)

• break: remove decorator
• setup: remove flask upper pin

Version 1.0.1 (released 2024-03-22)

• menu: skip error when same and equal menu value exists

Version 1.0.0 (released 2023-08-21)

• Large module refactor for allowing contextless usage.
• Removed Flask-Classy support.
• Preparation for compatibility with Flask v2.3.x deprecations.

Version 0.7.2 (released 2020-05-07)

• Deprecated Python versions lower than 3.6.0. Now supporting 3.6.0 and 3.7.0.

Version 0.7.1 (released 2019-02-11)

• Fixes problem with returning an active menu item.

Version 0.7.0 (released 2017-12-12)

• Uses whole segment of the URL instead of a prefix to determine active menu item. Currently the menu item is marked as active when there is a prefix match on the URL. This creates situations where multiple different menu items appear to be active just because they share a prefix. (#62)

Version 0.6.0 (released 2017-08-03)

• Fixes Python 3 deprecation warnings.
• Adds the external_url parameter to MenuEntryMixin's register function, allowing menu items with external urls not tied to an endpoint.

Version 0.5.1 (released 2016-01-04)

• Improves tests for checking when an item is active.

Version 0.5.0 (released 2015-10-30)

• Drops support for Python 2.6.
• Adds new property to MenuEntryMixin which allows the user to retrieve the current active item from the MenuEntryMixin's tree. (#43)
• Modifies project structure to be in line with other newer Invenio project packages. This includes renaming files to match with files in other projects, revising structures of certain files and adding more tools for testing. (#42)
• Fixes incompatibility with pytest>=2.8.0 which removed the method consider_setuptools_entrypoints(). (#41)
• Updates to the new standard greeting phrase

Version 0.4.0 (released 2015-07-23)

• Flask-Classy support and automatic detection of parameters for url_for. (#33)
• Improves how the default active state of items is determined. (#32)
• Adds .dockerignore excluding among others Python cache files. This solves a problem when using both tox and docker to run the test suite on the same host. (#29)

Version 0.3.0 (released 2015-03-17)

• New method has_active_child(recursive=True) in MenuEntryMixin. (#25)
• Fixed documentation of blueprint example. (#21)
• Configuration for Docker and demo app. (#22 #29)
• Fixed template example and added code block types. (#14)

Version 0.2.0 (released 2014-11-04)

• The Flask-Menu extension is now released under more permissive Revised BSD License. (#12)
• New support for additional keyword arguments stored as MenuItem attributes. (#19)
• Richer quick-start usage example. (#16)
• Support for Python 3.4. (#6)
• Documentation improvements. (#3)

Version 0.1.0 (released 2014-06-27)

• Initial public release.