https://github.com/Donkie/Spoolman

Keep track of your inventory of 3D-printer filament spools.
https://github.com/Donkie/Spoolman

3d-printing database inventory service

Last synced: 6 months ago
JSON representation

Keep track of your inventory of 3D-printer filament spools.

• Host: GitHub
• URL: https://github.com/Donkie/Spoolman
• Owner: Donkie
• License: mit
• Created: 2023-04-01T14:24:19.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2024-11-04T21:53:55.000Z (12 months ago)
• Last Synced: 2024-11-04T22:32:46.339Z (12 months ago)
• Topics: 3d-printing, database, inventory, service
• Language: Python
• Homepage:
• Size: 2.19 MB
• Stars: 977
• Watchers: 28
• Forks: 90
• Open Issues: 143
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

          

  

  

  




_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](https://octoprint.org/) and [Klipper](https://www.klipper3d.org/)/[Moonraker](https://moonraker.readthedocs.io/en/latest/). When connected, it automatically updates spool weights as printing progresses, giving you real-time insights into filament usage.

[![Static Badge](https://img.shields.io/badge/Spoolman%20Wiki-blue?link=https%3A%2F%2Fgithub.com%2FDonkie%2FSpoolman%2Fwiki)](https://github.com/Donkie/Spoolman/wiki)

[![GitHub Release](https://img.shields.io/github/v/release/Donkie/Spoolman)](https://github.com/Donkie/Spoolman/releases)

### Features

* **Filament Management**: Keep comprehensive records of filament types, manufacturers, and individual spools.

* **API Integration**: The [REST API](https://donkie.github.io/Spoolman/) 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](https://github.com/Donkie/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](https://hosted.weblate.org/projects/spoolman/).

* **Database Support**: SQLite, PostgreSQL, MySQL, and CockroachDB.

* **Multi-Printer Management**: Handles spool updates from several printers simultaneously.

* **Advanced Monitoring**: Integrate with [Prometheus](https://prometheus.io/) for detailed historical analysis of filament usage, helping you track and optimize your printing processes. See the [Wiki](https://github.com/Donkie/Spoolman/wiki/Filament-Usage-History) for instructions on how to set it up.

**Spoolman integrates with:**

  * [Moonraker](https://moonraker.readthedocs.io/en/latest/configuration/#spoolman) and most front-ends (Fluidd, KlipperScreen, Mainsail, ...)

  * [OctoPrint](https://github.com/mdziekon/octoprint-spoolman)

  * [OctoEverywhere](https://octoeverywhere.com/spoolman?source=github_spoolman)

  * [Homeassistant](https://github.com/Disane87/spoolman-homeassistant)

**Web client preview:**

![image](https://github.com/Donkie/Spoolman/assets/2332094/33928d5e-440f-4445-aca9-456c4370ad0d)

## Installation

Please see the [Installation page on the Wiki](https://github.com/Donkie/Spoolman/wiki/Installation) for details how to install Spoolman.