splent_feature_legal

The legal feature of a SPLENT product line.

A SPLENT feature is a Python package that a product composes with others: its models, routes, services, templates and hooks are registered when the product starts. What this feature provides and requires is listed in the [tool.splent.contract] section of pyproject.toml, which splent feature:contract --write keeps in sync with the source.

What it does

The legal pages of the site, such as the privacy policy, the terms of use or the cookie policy. Each published page is served at /legal/<slug> and gets a link in the footer through the layout.footer hook. A page that is not published answers 404 and has no footer link. A page's content is stored HTML, and the page draws it through the framework's rich_text filter, which keeps the formatting and drops scripts, event handlers and javascript: links.

The panel manages the pages at /admin/legal, where they are added, edited and deleted.

Access

The screens under /admin/legal open for the accounts whose role is admin or staff, the same pair the admin dashboard lets in. Any other signed-in account gets 403 and does not see the Legal pages link in the sidebar, and an anonymous visitor is sent to log in. The published pages under /legal and their footer links stay open to everyone, signed in or not, and a page that is not published answers 404 to everyone.

There is no setting for these roles, and a refinement cannot replace the views that check them, because it may add routes to this feature but never replace one of its own. Another feature can decide for these screens with an access policy registered for the prefix legal.admin (register_access_policy, splent_framework 1.20.0). The framework asks the policy before the roles. It answers True to let an account in, False to refuse it, or None to leave the decision to the roles, and the sidebar link follows the same answer. That is the way to let a group of accounts manage only this section, for example the people who keep the legal texts, without giving them a panel role. See Access control.

Without such a feature, give the person's account the staff role. Staff opens every panel screen that asks for PANEL_ROLES, not only this one, so a person who should manage nothing but the legal pages needs a policy instead.

splent feature:auth set-role someone@example.com staff

Use it in a product

splent feature:add splent_feature_legal

Develop

splent feature:test splent_feature_legal
splent feature:contract splent_feature_legal

Release

splent feature:release splent_feature_legal --dry-run --bump patch
splent feature:release splent_feature_legal

The first command rehearses the release and changes nothing. The second publishes it to the git forge and to PyPI, and a PyPI version is permanent.