/flask-breadcrumbs

Flask-Breadcrumbs is a Flask extension that adds support for generating site breadcrumb navigation.

Primary LanguagePythonOtherNOASSERTION

Flask-Breadcrumbs

https://travis-ci.org/inveniosoftware/flask-breadcrumbs.png?branch=master https://coveralls.io/repos/inveniosoftware/flask-breadcrumbs/badge.png?branch=master https://pypip.in/v/Flask-Breadcrumbs/badge.png https://pypip.in/d/Flask-Breadcrumbs/badge.png

About

Flask-Breadcrumbs is a Flask extension that adds support for generating site breadcrumb navigation.

Installation

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

pip install Flask-Breadcrumbs

Documentation

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

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

Example

To view an example of breadcrumbs in action, see examples/app.py:

cd examples
FLASK_APP=app.py flask run

Testing

Running the test suite is as simple as:

python setup.py test

or, to also show code coverage:

./run-tests.sh