Skip to main content

Minimal API for defining pages of Flask-based backends independently from the actual backend infrastructure

Project description

Mara page

mara-page PyPI - License PyPI version Slack Status

Minimal API for defining pages of Flask-based backends independently from the actual backend infrastructure.

When a web app is spread across many independent Flask blueprints, then this library can be used to add

  • navigation entries
  • page titles
  • resource-based ACL protection
  • page-specific CSS and JS files

without having access to a global layout or the Flask app.

The library provides a drop-in werkzeug Response class that is enriched with additional information that a backend can use to render the final html page.

Example

This is a simple web ui for displaying the current time:

"""Clock UI"""

import flask
from awesome_clock import clock
from mara_page import acl, navigation, response, bootstrap, _

# The flask blueprint that handles
blueprint = flask.Blueprint('awesome_clock', __name__, url_prefix='/clock', static_folder='static')

# Defines an ACL resource (needs to be handled by the application)
acl_resource = acl.AclResource('Clock')


def navigation_entry():
    """Defines a part of the navigation tree (needs to be handled by the application)"""
    return navigation.NavigationEntry(
        label='Awesome clock', icon='clock-o', description='Something that tells the time',
        children=[
            navigation.NavigationEntry(
                label='What time is it now?',
                uri_fn=lambda: flask.url_for('awesome_clock.clock_page', when='now'),
                icon='question-circle', description='Should be able to display the current time'),

            navigation.NavigationEntry(
                label='And now?', icon='refresh', description='For the impatient',
                uri_fn=lambda: flask.url_for('awesome_clock.clock_page', when='and-now'))
        ])


@blueprint.route('/<string:when>')
@acl.require_permission(acl_resource)  # Requires permission to the `'Clock'` resource
def clock_page(when: str):
    """Defines the `/clock` page"""
    return response.Response(
        # The actual page content (can be also a call to `flask.render_template`
        # or anything else that produces a string)
        html=bootstrap.card(header_left=_.h1['What time is it now?'],
                            body=[_.p['The current time is ', str(clock.what_time_is_it_now())],
                                  _.img(src=flask.url_for('awesome_clock.static', filename='cuckoo-clock.jpg'),
                                        style='max-width:100%')]),
        # The page title
        title='Awesome clock',

        # Action buttons
        action_buttons=[
            response.ActionButton('javascript:location.reload()', 'Refresh', 'Refresh clock', 'refresh'),
            response.ActionButton('javascript:location.reload()', 'Update', 'Refresh clock', 'clock-o')
        ]
    )

It is up to the actual Flask app to define how to render such a response and what to do with the ACL resources and navigation entries. The mara app will render the response like this:

Example backend

Links

Project details


Download files

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

Source Distribution

mara-page-1.7.0.tar.gz (10.2 kB view details)

Uploaded Source

Built Distribution

mara_page-1.7.0-py3-none-any.whl (10.6 kB view details)

Uploaded Python 3

File details

Details for the file mara-page-1.7.0.tar.gz.

File metadata

  • Download URL: mara-page-1.7.0.tar.gz
  • Upload date:
  • Size: 10.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.2

File hashes

Hashes for mara-page-1.7.0.tar.gz
Algorithm Hash digest
SHA256 cf1c2657d63360c9853c3e79c0dccb551d3d19f0fdff0ba3a9209f1fdc7a29f7
MD5 05d9c1d9d9156802b695cceb0aaed583
BLAKE2b-256 8beb7753f7c9c4d788cf7e3cf31f604c490d2200906812ca8457b35bd1a551ae

See more details on using hashes here.

File details

Details for the file mara_page-1.7.0-py3-none-any.whl.

File metadata

  • Download URL: mara_page-1.7.0-py3-none-any.whl
  • Upload date:
  • Size: 10.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.2

File hashes

Hashes for mara_page-1.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a8df2da1a933623ca05cb775eb3eb64befe981fb450945ff85aebb6d8bd4490d
MD5 7e1246ca0d439966b1c59432df60c607
BLAKE2b-256 ee6df52495dd388ccc3a76781065854d32619b858b0d650a6a677b372aa2f57c

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page