WuttJamaican

This package provides a “base layer” for custom apps, regardless of environment/platform:

• console

• web

• GUI

It mostly is a distillation of certain patterns developed within the Rattail Project, which are deemed generally useful. (At least, according to the author.) It roughly corresponds to the “base layer” as described in the Rattail Manual (see Base Layer).

Good documentation and 100% test coverage are priorities for this project.

Rattail is still the main use case so far, and will be refactored along the way to incorporate what this package has to offer.

Features

• flexible configuration, using config files and/or DB settings table

• flexible command line interface, with arbitrary top-level and subcommands

• flexible architecture, abstracting various portions of the overall app

• flexible database support, using SQLAlchemy

Contents

• Glossary
• Documentation
  • Installation
    • Quick Start
    • Prerequisites
    • Virtual Environment
    • Package Installation
  • Configuration
    • Overview
    • Config Settings
    • Config Object
    • Config Files
    • Settings Table
  • Command Line Interface
    • Overview
    • Commands
    • Subcommands
    • Ad Hoc Scripts
  • Handlers
    • Overview
    • Architecture
    • App Handler
  • Providers
    • Overview
    • Architecture
    • App Providers
  • Databases
    • Overview
    • App Database
    • Other Databases
• Package API
  • wuttjamaican
    • wuttjamaican.app
    • wuttjamaican.cmd
    • wuttjamaican.conf
    • wuttjamaican.db
    • wuttjamaican.db.conf
    • wuttjamaican.db.sess
    • wuttjamaican.exc
    • wuttjamaican.testing
    • wuttjamaican.util

Indices and tables

• Index

• Module Index

• Search Page