Keg Elements is a collection of helpers and base classes for building apps with Keg or Keg extensions.
For a simple example and an application setup checklist, see the Getting Started guide.
Project structure and tooling mostly derives from Coppy. See its documentation for context and additional instructions.
This project can be updated from the upstream repo, see Updating a Project.
From zero to hero (passing tests that is):
-
Ensure host dependencies are installed
-
Start docker service dependencies (if applicable):
docker compose up -d -
Sync project virtualenv w/ lock file:
uv sync -
Configure prek:
prek install -
Run tests:
nox
Versions are date based. A version task shows and bumps versions:
# Show current version
mise run version show
# Bump version based on date, tag, and push:
mise run version bump
# See other options
mise run version -- --help