mirror of
https://github.com/Donkie/Spoolman.git
synced 2026-10-22 01:52:17 -05:00
Donkie
6ca753bca0
It has been sitting untracked in client_v2/ -- the wrong place twice over: it is a backend tool that talks to the API over HTTP and knows nothing about the client, and client_v2 is excluded from ruff, so nothing was checking it. scripts/ already holds the repo's operational scripts, and a poe task puts it next to the other things you run against a dev instance. The docstring gains the warning the flags deserve: --purge deletes every vendor, filament and spool on the target, not only the generated ones. Ruff now sees it, so scripts/ gets per-file ignores for the rules a generator legitimately breaks -- stdout is its user interface, its data is deliberately random and full of literal weights and diameters, and the generators are long by nature. Type annotations and everything else stay enforced. Also fix --skip-fields: it skipped creating the extra-field definitions but still generated values for them, so every POST failed with "Unknown extra field" and the run produced nothing. Claude-Session: https://claude.ai/code/session_01UB5KocsTBm9GL5x3Uuup5F
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.