flask-flac 0.20260528.1

Flask based library to help structure an application with an eye towards CLI apps, not just web.

Flac

Flask based library to help structure an application with an eye towards CLI apps, not just web.

Features

• App factory pattern

  • blueprints (web & CLI)

• CLI Integration

  • custom command
  • two-phase init for blueprints

• Configuration

  • .env & .flaskenv
  • from files
  • from environment
  • alternate settings for testing, dev, prod

• Logging

  • logs are probably cheap, don't prematurely optimize
  • centralize your logs to an aggregation service
  • .info logs are show/saved by default
  • cli output is plain text
  • saved logs are JSON
  • saved logs go to syslog, let devops handle the aggregation

• Testing

  • alternate DB URI
  • pytest & fixtures

• Flask-SQLAlchemy

  • ext init
  • fixtures to get db to ensure app context

• Celery

  • refresh process pool

• cli integration with the ability to customize the app's configuration using global cli options

  someapp --debug --with-sentry run-some-task

• pytest fixtures for app initialization

• demo cli test that uses separate process

Copier App Template

Flac provides a copier template to create the scaffold needed for a basic Flac app:

copier copy --trust gh:rsyring/flac .../projects/some-new-app-pkg

Development

Copier Template

Project structure and tooling mostly derives from the Coppy, see its documentation for context and additional instructions.

This project can be updated from the upstream repo, see Updating a Project.

Project Setup

From zero to hero (passing tests that is):

1. Ensure host dependencies are installed

2. Start docker service dependencies (if applicable):

   docker compose up -d

3. Sync project virtualenv w/ lock file:

   uv sync

4. Configure prek:

   prek install

5. Run tests:

   nox

Versions

Versions are date based. A bump action exists to help manage versions:

  # Show current version
  mise bump --show

  # Bump version based on date, tag, and push:
  mise bump

  # See other options
  mise bump -- --help