Meta Package (structum)¶

Role: The “Batteries-Included” entry point for the Structum Framework.

Overview¶

The structum package (often called the “Meta-Package”) serves two primary purposes:

1. Framework Installer: Installing structum automatically installs the Core and all Standard Plugins (auth, database, dynaconf, etc.), providing a complete development environment out of the box.

2. CLI Tool: It provides the structum command-line interface, a unified tool for project management, documentation building warning checks, and development workflows.

Features¶

• Unified Installation: One command (pip install structum) gets you everything.

• Centralized CLI: Manage your project with structum check, structum build-docs, and more.

• Development Tooling: Integrates ruff, black, and sphinx into a cohesive workflow.

Installation¶

pip install structum

Usage¶

See the CLI Documentation for detailed command usage.