Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mara/mara-page
Minimal API for defining pages of Flask-based backends independently from the actual backend infrastructure
https://github.com/mara/mara-page
acl backend flask mara navigation
Last synced: 3 months ago
JSON representation
Minimal API for defining pages of Flask-based backends independently from the actual backend infrastructure
- Host: GitHub
- URL: https://github.com/mara/mara-page
- Owner: mara
- License: mit
- Created: 2017-03-10T23:10:45.000Z (almost 8 years ago)
- Default Branch: main
- Last Pushed: 2023-11-21T15:25:50.000Z (about 1 year ago)
- Last Synced: 2024-11-02T01:46:31.112Z (3 months ago)
- Topics: acl, backend, flask, mara, navigation
- Language: Python
- Size: 2.28 MB
- Stars: 4
- Watchers: 5
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Mara page
[](https://github.com/mara/mara-page/actions/workflows/build.yaml)
[](https://github.com/mara/mara-page/blob/main/LICENSE)
[](https://badge.fury.io/py/mara-page)
[](https://communityinviter.com/apps/mara-users/public-invite)
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:
```python
"""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('/')
@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](https://github.com/mara/mara-app) will render the response like this:
## Links
* Documentation: https://mara-page.readthedocs.io/
* Changes: https://mara-page.readthedocs.io/en/latest/changes.html
* PyPI Releases: https://pypi.org/project/mara-page/
* Source Code: https://github.com/mara/mara-page
* Issue Tracker: https://github.com/mara/mara-page/issues