Flask-Copilot

Installation

python -m pip install flask-copilot

Quickstart

1. Initialize the Copilot extension on your Flask app.
2. Add URL routes normally. Include navbar_kwargs to register routes to your navbar.

from flask import Flask
from flask_copilot import Copilot

app = Flask(__name__)
copilot = Copilot(app)

@app.route('/', navbar_kwargs={'path': 'Home'})
def index():
    """Render the home page."""
    return render_template('index.html')

3. Render your navbar using the navbar object automatically injected into your template context.

<ul>
  {% for entry in navbar recursive %}
    <li>
      <a href="{{ entry.url() }}">
        {{ entry.name }}
      </a>
      {% if entry.children %}
        <ul class="dropdown">{{ loop(entry.children) }}</ul>
      {% endif %}
    </li>
  {% endfor %}
</ul>

Contents:

API

The public API for Flask-Copilot.

Copilot

class flask_copilot.Copilot(app=None)

The Flask-Copilot extension.

Parameters:app (Optional[flask.Flask]) – The application instance that this copilot should be registered to.

init_app(app)

Register the extension with the application.

Parameters:app (flask.Flask) – The application to register with.

inject_context()

Return a dict used for a template context.

register_entry(navbar_kwargs)

Register a navbar entry with the copilot.

Parameters:navbar_kwargs (dict) – Arguments passed to the NavbarEntry instance.

NavbarEntry

class flask_copilot.NavbarEntry(name, endpoint, url_for_kwargs=None, order=None, when=None)

Stores information related to a routing rule’s navbar position.

Parameters:

• name (str) – The text of the link in the navbar. This element is converted to a str when added to the navbar and used for display and sorting purposes. This value should be unique within a group (i.e. a single name should not have more than one URL rule associated with it).
• endpoint (str) – The endpoint assigned to the URL rule this NavbarEntry belongs to. This should be used to generate the URL for the link.
• url_for_kwargs (dict) – Keyword arguments to be passed to url_for when generating URLs from endpoint.
• order – An object used to sort the navigation entries. If not provided, the entry’s name (the last element of path) will be used. All entries in the same group must be orderable together.
• when (Optional[callable]) – If provided, the link will appear only when the value returned by when() is truthy.

url(default_href='#')

Return a rendered URL for this entry.

Parameters:default_href (str) – The value to return if no endpoint is assigned to this entry. Defaults to '#'.

visible

Return True when this entry should be visible.

Rules dictating visibility, in order or precedence:

1. If an entry has a when method, its result is returned.
2. If an entry has children and no endpoint (i.e. it exists solely as a container for other links), it is visible when any of its children are.
3. Finally, when the first two rules don’t apply, visibility defaults to True.

Changelog

Version 0.1.0

Released 2016-02-21

• Initial release

Indices and tables

• Index
• Module Index
• Search Page