poaster 1.0.0

Minimal, libre bulletin board for posts.

poaster

---

Minimal, libre bulletin board for posts.

Quickstart

Install package:

pip install poaster

Initialize application:

poaster init

Add a user:

poaster users add

Launch application server:

poaster run

Navigate to /api/docs to see API documentation.

Development

The easiest way to develop locally with poaster is to use hatch. With hatch, you will have access to important helper scripts for running locally, linting, type-checks, testing, etc.

Testing

Lint and check types with:

hatch run types:check

Run test suite and report coverage with:

hatch run cov

Database Management

To upgrade the local database to latest schema, run:

hatch run db:upgrade

Now that the tables are created, you can add fixtures:

hatch run db:fixtures

If you add or update a table, you can generate a migration script by running:

hatch run db:migration

If the migration script wasn't generated, check to see if you imported the model to migrations/env.py.

Local Server

Run the application server locally with:

hatch run dev

The server should reload on changes to the source code.

License

poaster is distributed under the terms of the AGPLv3 license.