Breadcrumbs navigation helpers.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs
paka
tests
.coveragerc
.flake8
.gitignore
.travis.yml
LICENSE
MANIFEST.in
README.rst
setup.cfg
setup.py
tox.ini

README.rst

paka.breadcrumbs

https://travis-ci.org/PavloKapyshin/paka.breadcrumbs.svg?branch=master

paka.breadcrumbs is a Python library with helpers (currently few data structures) for breadcrumbs navigation building.

Features

  • Python 2.7 and 3.5 are supported
  • PyPy (Python 2.7) is supported
  • does not depend on any web framework
  • does not require use of WSGI

Examples

>>> from paka import breadcrumbs

Create breadcrumbs container:

>>> bcrumbs = breadcrumbs.Bread("Example Site")

Add crumbs for parent (with url_path) and current (without url_path, as there is no need to link to yourself) pages:

>>> bcrumbs.add("Some category", url_path="/some/")
>>> bcrumbs.add("Some page")

Now breadcrumbs container can be iterated over:

>>> [crumb.label for crumb in bcrumbs]
['Example Site', 'Some category', 'Some page']

And value you can put into <title></title> may be constructed (it is actually an instance of markupsafe.Markup):

>>> print(bcrumbs.get_title("<-"))
Some page &lt;- Some category &lt;- Example Site

Installation

Library is available on PyPI, you can use pip for installation:

$ pip install paka.breadcrumbs

Getting documentation

Build HTML docs:

$ tox -e docs

View built docs:

$ sensible-browser .tox/docs/tmp/docs_html/index.html

Running tests

$ tox

Getting coverage

Collect info:

$ tox -e coverage

View HTML report:

$ sensible-browser .tox/coverage/tmp/cov_html/index.html

Checking code style

Run code checkers:

$ tox -e checks