Documentation

Source code and markdown docs, combined.

All of Plain's docs are written directly in the source code. You're encouraged to read the source — either on this site, the GitHub repo, or in your local virtual environment for the version of Plain you're using.

Core

By itself, this is the bare minimum to get a Python web app up and running. It can respond to HTTP requests and render templates, but doesn't include a database. You can think of this as an alternative to Flask.

assets Serve static assets (CSS, JS, images, etc.) directly from your app.

cli The `plain` CLI loads commands from Plain itself, and any `INSTALLED_PACKAGES`.

csrf Cross-Site Request Forgery (CSRF) protection.

forms Handle user input.

http

internal

logs Default logging settings and key-value logger.

middleware Hook into the request/response cycle.

packages Create app-packages and install third-party packages from PyPI.

preflight Static system checks to catch misconfigurations.

runtime Leverage user-settings at runtime.

signals Run code when certain events happen.

templates Render HTML templates using Jinja.

test Testing utilities for Plain.

urls Route requests to views.

utils Various utilities for common things like text manipulation, parsing, dates, and more.

views Take a request, return a response.

Packages

These packages are separate and can be installed individually. They're often included in the starters.