mirror of
https://github.com/Donkie/Spoolman.git
synced 2026-10-21 17:42:16 -05:00
Donkie
a46cad036f
Adds the five auth_ tables and one DDL-only Alembic revision. Nothing reads or writes them yet; the data layer and endpoints follow in later commits. All five tables are created now, not just the two phase 1 needs. The reason is migrations/env.py's `target_metadata = Base.metadata`: if the database carried auth_api_key while models.py did not, the next autogenerated revision anyone produced would emit op.drop_table for it. Models and schema have to move together, so the phase 2/5 tables land as models now and gain their business logic later. Design notes, all following existing conventions in this schema: - Tables are prefixed auth_ because `user` and `session` are reserved words in PostgreSQL and MySQL, and quoting them at every call site is a footgun. - No relationship() on any auth table. Auth lookups are single-row queries on an indexed column, so there is nothing to eager-load; a `sessions` collection on AuthUser would fetch every session row on every login, and lazy-loading one under asyncio raises MissingGreenlet. - Enum-valued columns (level, actor_kind) are String, matching multi_color_direction. There is not one sa.Enum in this schema, and adding one would create a native PostgreSQL type and a MySQL ENUM(...) with three different ALTER dialects. - Uniqueness is enforced with unique indexes rather than named UNIQUE constraints. That is the portable form across all four dialects, and it keeps the multi-tenancy seam cheap: auth_user.username can later become a composite (tenant_id, username) index without dropping a constraint whose generated name differs per dialect. - The revision is pure DDL with no DML, which is what makes it safe as a single revision on CockroachDB -- the aafcd7fb0e84 -> 304a32906234 split was needed only because the second half wrote data. The revision body is alembic's own autogenerate output against a database at 415a8f855e14, so it matches the conventions of the existing revisions rather than being hand-approximated. Verified on SQLite: upgrade from scratch creates all five tables with the four unique indexes; downgrade -1 drops them all; upgrade replays cleanly. Critically, running autogenerate again after upgrade emits an empty migration, proving the models and the schema agree and that no future autogenerate will try to drop the phase 2/5 tables.
Keep track of your inventory of 3D-printer filament spools.
Spoolman is a self-hosted web service designed to help you efficiently manage your 3D printer filament spools and monitor their usage. It acts as a centralized database that seamlessly integrates with popular 3D printing software like OctoPrint and Klipper/Moonraker. When connected, it automatically updates spool weights as printing progresses, giving you real-time insights into filament usage.
Features
- Filament Management: Keep comprehensive records of filament types, manufacturers, and individual spools.
- API Integration: The REST API allows easy integration with other software, facilitating automated workflows and data exchange.
- Real-Time Updates: Stay informed with live spool updates through Websockets, providing immediate feedback during printing operations.
- Central Filament Database: A community-supported database of manufacturers and filaments simplify adding new spools to your inventory. Contribute by heading to SpoolmanDB.
- Web-Based Client: Spoolman includes a built-in web client that lets you manage data effortlessly:
- View, create, edit, and delete filament data.
- Add custom fields to tailor information to your specific needs.
- Print labels with QR codes for easy spool identification and tracking.
- Contribute to its translation into 18 languages via Weblate.
- Database Support: SQLite, PostgreSQL, MySQL, and CockroachDB.
- Multi-Printer Management: Handles spool updates from several printers simultaneously.
- Advanced Monitoring: Integrate with Prometheus for detailed historical analysis of filament usage, helping you track and optimize your printing processes. See the Wiki for instructions on how to set it up.
Spoolman integrates with:
- Moonraker and most front-ends (Fluidd, KlipperScreen, Mainsail, ...)
- OctoPrint
- OctoEverywhere
- Home Assistant
- MCP Server - Manage your filament inventory through AI assistants like Claude using the Model Context Protocol
Web client preview:
Installation
Please see the Installation page on the Wiki for details how to install Spoolman.