Publ: Python API

Last updated: 2018-06-01 3:48 PM (6 years ago)

Library calls

The publ library provides the publ.Publ class. Its constructor is called as follows:

Publ(name, cfg): Creates a Publ application object.
name is the internal name for the application; this is more or less arbitrary although it’s useful if you’re setting up multiple Publ applications for some reason (Note: multiple Publ apps are not currently supported). Generally you just pass in __name__ for this.
cfg is the configuration options for Publ; it is a dictionary which holds the following values:
- secret_key: The secret signing key used for the authentication subsystem
- database_config: The parameters sent to PonyORM’s db.bind() method. Defaults to an in-memory sqlite database.
- index_rescan_interval: How frequently Publ should do a maintenance rescan of the content files. Defaults to 7200 (2 hours); set to 0 or None to disable.
- index_wait_time: How long to wait to start updating the index after a change is detected, in seconds. Defaults to 1.
- index_enable_watchdog: Whether to watch the filesystem for live content changes. Defaults to True. In production settings it’s preferred to set this to False and then use the reindex CLI tool to apply updates.
- content_folder: The directory which contains the root of your site’s content files. Defaults to content
- template_folder: The directory which contains the root of your site’s template files. Defaults to templates
- static_folder: The directory which contains the root of your site’s static files. Defaults to static
- static_url_path: The root path that browsers will be directed to for static content files. Defaults to /static. If you want to use a separate CDN/image server/etc., you would configure this to be the URL that would correspond to your static asset directory for the public (and configure some other mechanism for that external service to actually retrieve your origin content).
- image_output_subdir: The subdirectory of static_folder that will be used to store the image rendition cache. Defaults to _img.
  Be careful not to set this to a directory you want to store static files in, as they risk being deleted.
- image_cache_interval: How frequently to clean the image rendition cache, in seconds. Defaults to 7200 (3 hours).
- image_cache_age: The maximum age of image renditions to keep, in seconds. Defaults to one month.
- image_render_threads: The maximum number of threads to use for image rendering; defaults to the number of CPUs in the system. Set this to None to use the Python default for ThreadPoolExecutor.
- timezone: The timezone to use for dates with no specified time zone. Defaults to the server’s local timezone.
- cache: A dictionary with the page caching configuration; see the deplyment guide for more information. Defaults to {} (i.e. no caching).
- markdown_extensions: A list of extensions to use with the Markdown processor; see the misaka documentation for a list of accepted values. Defaults to ('tables', 'fenced-code', 'footnotes', 'strikethrough', 'highlight', 'superscript', 'math').
  Generally you will only want to configure this globally, but you can also override these settings at the template level by passing markdown_extensions in as configuration to the entry properties (entry.body, entry.text, entry.title, etc.).
- layout: Default layout parameters to send to all templates on the site to use for entry.body, entry.more, and entry.footnotes; for example,
```
{
    'layout': {
        'max_width': 1024,
        'quality': 80,
        'heading_link_class': 'toc'
    }
}
```
  will make the default arguments to entry.body equivalent to:
```
{{entry.body(max_width=1024, quality=80, heading_link_class='toc')}}
```
- auth: The configuration values for the authentication system. Defaults to no configuration.
  Note that if this option is selected, the authl library must be installed into your environment. If you are using poetry this can be added by specifying the “auth” extra when adding the dependency on Publ with poetry add publ -E auth; otherwise you can add it directly with pip install authl or the like.
- user_list: The filename of the configuration file that stores the user configuration. Defaults to users.cfg
- admin_group: The name of the user group that will have administrative access; defaults to admin
- auth_log_prune_interval: How frequently to clean out the authentication log, in seconds. Defaults to 3600 (one hour).
- auth_log_prune_age: The maximum age of authentication log entries to keep, in seconds. Defaults to one month.
- ticket_lifetime: How long a Ticket Auth ticket can stay in-flight, in seconds. Defaults to 60 (one minute).
- token_lifetime: How long an authorization token will remain valid, in seconds. Defaults to one month.
- refresh_token_lifetime: How long a refresh token will remain valid, in seconds. Defaults to three months.
- search_index: The directory to keep the full-text search index data in; defaults to None, disabling full-text search.
  Note that if this option is selected, the Whoosh library must be installed into your environment. If you are using poetry this can be added by specifying the “search” extra when adding the dependency on Publ with poetry add publ -E search; otherwise you can add it directly with pip install whoosh or the like.

Application object

A Publ application object is an extension of a Flask application object; you can do all the same things to it as you could to a Flask object, although it’s a good idea to not modify any of the configuration values that Publ expects to see.

This mostly exists to provide the @path_alias_regex decorator and its related add_path_regex function; here is an example from my site, used to remap legacy URLs (like /d/20060606.php) to newer URLs (like /comics/?date=20060606):

app = publ.publ(__name__, {})

@app.path_alias_regex(r'/d/([0-9]{8}(_w)?)\.php')
def redirect_date(match):
    return flask.url_for('category', category='comics', date=match.group(1)), True

The path alias function takes a re.match object and returns a tuple of (url, is_permanent). This function can also make use of the various Flask request context things (e.g. request.args) and if it doesn’t want to redirect after all it can return (None,None).

Note that you can also use @app.route like any typical Flask application, but due to Flask routing rules it may not work with variadic routes. For example:

@app.route('/favicon.ico')
def favicon():
    """ Static route should work """
    return flask.send_file('favicon.ico')

@app.route('/foo/<path:path>')
def redirect_foo(path):
    """ Dynamic route will likely fail, as the 'category' route is a stronger match """
    return "We are invisible: {}".format(path)

is unlikely to work. Currently Flask doesn’t provide any clean mechanism for adjusting a routing rule’s priority; this StackOverflow question discusses the issue and some possible workarounds.

Sample `app.py`

This is based on the app.py that configures beesbuzz.biz. It configures basic logging, sets the in-process cache to store up to 500 items for up to 300 seconds, and only does a maintenance rescan once per day. It also maps a bunch of legacy URLs as well as forwarding ActivityPub requests to fed.brid.gy’s handler.

""" Main Publ application """

import os
import logging
import logging.handlers

import publ
import flask

if os.path.isfile('logging.conf'):
    logging.config.fileConfig('logging.conf')
else:
    if not os.path.isdir('logs'):
        os.makedirs('logs')
    logging.basicConfig(level=logging.INFO,
                        handlers=[
                            logging.handlers.TimedRotatingFileHandler(
                                'logs/publ.log', when='D'),
                            logging.StreamHandler()
                        ],
                        format="%(levelname)s:%(threadName)s:%(name)s:%(message)s")

logging.info("Setting up")

APP_PATH = os.path.dirname(os.path.abspath(__file__))

config = {
    'database_config': {
        'provider': 'sqlite',
        'filename': os.path.join(APP_PATH, 'index.db')
    },
    'timezone': 'US/Pacific',
    'cache': {
        'CACHE_TYPE': 'simple',
        'CACHE_DEFAULT_TIMEOUT': 300,
        'CACHE_THRESHOLD': 500
    } if not os.environ.get('FLASK_DEBUG') else {},
    'index_rescan_interval': 86400
}

app = publ.publ(__name__, config)


@app.route('/favicon.ico')
def favicon():
    """ Send the favicon.ico file directly from this directory """
    return flask.send_file('favicon.ico')


@app.path_alias_regex(r'/d/([0-9]{8}(_w)?)\.php')
def redirect_date(match):
    ''' legacy comic url '''
    return flask.url_for('category', category='comics', date=match.group(1)), True


@app.path_alias_regex(r'/blog/e/')
def redirect_blog_entry(match):
    ''' missing blog entry -- put up the apology page '''
    return flask.url_for('entry', entry_id=7821), False


@app.path_alias_regex(r'/\.well-known/(host-meta|webfinger).*')
def redirect_bridgy(match):
    ''' support ActivityPub via fed.brid.gy '''
    return 'https://fed.brid.gy' + flask.request.full_path, False

if __name__ == "__main__":
    app.run(port=os.environ.get('PORT', 5000))

Flask endpoints

If you’re writing Python code that extends Publ, you might need to use flask.url_for. Here are Publ’s usable endpoints:

category: Routes to a category page; options are:
- category: The category’s path
- template: The template to render
- The pagination parameters for get_view()
entry: Routes to an entry page; options are:
- entry_id: The numeric ID of the entry (this is the only one that’s useful to specify in url_for)
- slug_text: The SEO slug text
- category: The category the entry lives in
login: Routes to the login page; options are:
- redir: The path to redirect to after login completes.
  Note that this must not start with a /. Typical usage will be something like:
```
{# login and redirect back to this page #}
{{ url_for('login', redir=request.full_path[1:]) }}

{# login and redirect to a specific entry #}
{{ url_for('login', redir=url_for('entry', entry_id=12345)[1:])}}
```
  The [1:] is to trim the initial / off the path.
- me: An identity to initiate sign-in as. This is equivalent to submitting the login form with this value set, and is only really useful for testing.
logout: Routes to the logout page; takes the redir option with the same usage as login.
login and logout have a helper available in publ.utils.auth_endpoint, which simplifies the usage of the endpoints; it takes an endpoint name and returns a function which routes to that endpoint with an optional redirection parameter. If no redirection parameter is provided, it defaults to flask.request.full_path.
```
import publ.utils

# get the login helper
login_helper = publ.utils.auth_endpoint('login')

# log in and redirect back to the current page
flask.redirect(login_link())

# log in and redirect to a different page
flask.redirect(login_link('/path/to/something'))

# get the logout helper
logout_helper = publ.utils.auth_endpoint('logout')

# log out and redirect to the same page
flask.redirect(logout_link())

# log out and redirect to server root
flask.redirect(logout_link('/'))
```
Also note that the redirection target must be a local URL; external URLs will not work. (This prevents your site from being used as a malicious URL redirector.)
tokens: Routes to the IndieAuth token endpoint.
Accepts a parameter, me, which initiates a TicketAuth transaction. This parameter works both via POST and via GET.

Other useful API functions

If you need the current user object, use the function publ.user.get_active().

Library calls

Application object

Sample app.py

Flask endpoints

Other useful API functions

Sample `app.py`