Octoprint

<p align="center"><img src="https://octoprint.org/assets/img/logo.png" alt="OctoPrint's logo" /></p>

<h1 align="center">OctoPrint</h1>

<p align="center">
  <img src="https://img.shields.io/github/v/release/OctoPrint/OctoPrint?logo=github&logoColor=white" alt="GitHub release"/>
  <img src="https://img.shields.io/pypi/v/OctoPrint?logo=python&logoColor=white" alt="PyPI"/>
  <img src="https://img.shields.io/badge/dynamic/toml?url=https%3A%2F%2Fraw.githubusercontent.com%2FOctoPrint%2FOctoPrint%2Frefs%2Fheads%2Fdev%2Fpyproject.toml&query=%24.project.requires-python&prefix=Python%20&label=supports" alt="Supported Python versions">

  <img src="https://img.shields.io/github/actions/workflow/status/OctoPrint/OctoPrint/build.yml?branch=master" alt="Build status"/>
  <a href="https://community.octoprint.org"><img src="https://img.shields.io/discourse/users?label=forum&logo=discourse&logoColor=white&server=https%3A%2F%2Fcommunity.octoprint.org" alt="Community Forum"/></a>
  <a href="https://discord.octoprint.org"><img src="https://img.shields.io/discord/704958479194128507?label=discord&logo=discord&logoColor=white" alt="Discord"/></a>
  <a href="https://octoprint.org/conduct/"><img src="https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg" alt="Contributor Covenant"/></a>
  <a href="https://github.com/astral-sh/ruff"><img src="https://img.shields.io/badge/code%20style-ruff-261230" alt="Linting & formatting python: ruff"/></a>
  <a href="https://github.com/djlint/djlint"><img src="https://img.shields.io/badge/html%20style-djLint-blue.svg" alt="Linting & formatting html/jinja: djLint"/></a>
  <a href="https://github.com/prettier/prettier"><img src="https://img.shields.io/badge/code_style-prettier-ff69b4.svg" alt="Formatting js/css/less/yaml: prettier"/></a>
  <a href="https://github.com/pre-commit/pre-commit"><img src="https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white" alt="pre-commit"/></a>
  <img src="https://img.shields.io/badge/made_by-humans-blue?logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGhlaWdodD0iMjRweCIgdmlld0JveD0iMCAtOTYwIDk2MCA5NjAiIHdpZHRoPSIyNHB4IiBmaWxsPSIjZTNlM2UzIj48cGF0aCBkPSJNNDExLTQ4MHEtMjggMC00Ni0yMXQtMTMtNDlsMTItNzJxOC00MyA0MC41LTcwLjVUNDgwLTcyMHE0NCAwIDc2LjUgMjcuNVQ1OTctNjIybDEyIDcycTUgMjgtMTMgNDl0LTQ2IDIxSDQxMVptMjQtODBoOTFsLTgtNDlxLTItMTQtMTMtMjIuNXQtMjUtOC41cS0xNCAwLTI0LjUgOC41VDQ0My02MDlsLTggNDlaTTEyNC00NDFxLTIzIDEtMzkuNS05VDYzLTQ4MXEtMi05LTEtMTh0NS0xN3EwIDEtMS00LTItMi0xMC0yNC0yLTEyIDMtMjN0MTMtMTlsMi0ycTItMTkgMTUuNS0zMnQzMy41LTEzcTMgMCAxOSA0bDMtMXE1LTUgMTMtNy41dDE3LTIuNXExMSAwIDE5LjUgMy41VDIwOC02MjZxMSAwIDEuNS41dDEuNS41cTE0IDEgMjQuNSA4LjVUMjUxLTU5NnEyIDcgMS41IDEzLjVUMjUwLTU3MHEwIDEgMSA0IDcgNyAxMSAxNS41dDQgMTcuNXEwIDQtNiAyMS0xIDIgMCA0bDIgMTZxMCAyMS0xNy41IDM2VDIwMi00NDFoLTc4Wm02NzYgMXEtMzMgMC01Ni41LTIzLjVUNzIwLTUyMHEwLTEyIDMuNS0yMi41VDczMy01NjNsLTI4LTI1cS0xMC04LTMuNS0yMHQxOC41LTEyaDgwcTMzIDAgNTYuNSAyMy41VDg4MC01NDB2MjBxMCAzMy0yMy41IDU2LjVUODAwLTQ0MFpNMC0yNDB2LTYzcTAtNDQgNDQuNS03MC41VDE2MC00MDBxMTMgMCAyNSAuNXQyMyAyLjVxLTE0IDIwLTIxIDQzdC03IDQ5djY1SDBabTI0MCAwdi02NXEwLTY1IDY2LjUtMTA1VDQ4MC00NTBxMTA4IDAgMTc0IDQwdDY2IDEwNXY2NUgyNDBabTU2MC0xNjBxNzIgMCAxMTYgMjYuNXQ0NCA3MC41djYzSDc4MHYtNjVxMC0yNi02LjUtNDlUNzU0LTM5N3ExMS0yIDIyLjUtMi41dDIzLjUtLjVabS0zMjAgMzBxLTU3IDAtMTAyIDE1dC01MyAzNWgzMTFxLTktMjAtNTMuNS0zNVQ0ODAtMzcwWm0wIDUwWm0xLTI4MFoiLz48L3N2Zz4=" alt="Made by humans"/>
</p>

OctoPrint provides a snappy web interface for controlling consumer 3D printers. It is Free Software
and released under the [GNU Affero General Public License V3](https://www.gnu.org/licenses/agpl-3.0.html)[^1].

Its website can be found at [octoprint.org](https://octoprint.org/?utm_source=github&utm_medium=readme).

The community forum is available at [community.octoprint.org](https://community.octoprint.org/?utm_source=github&utm_medium=readme). It also serves as a central knowledge base.

An invite to the Discord server can be found at [discord.octoprint.org](https://discord.octoprint.org).

The FAQ can be accessed by following [faq.octoprint.org](https://faq.octoprint.org/?utm_source=github&utm_medium=readme).

The documentation is located at [docs.octoprint.org](https://docs.octoprint.org).

The official plugin repository can be reached at [plugins.octoprint.org](https://plugins.octoprint.org/?utm_source=github&utm_medium=readme).

**OctoPrint's development wouldn't be possible without the [financial support by its community](https://octoprint.org/support-octoprint/?utm_source=github&utm_medium=readme).
If you enjoy OctoPrint, please consider becoming a regular supporter!**

![Screenshot](https://octoprint.org/assets/img/screenshot-readme.png)

You are currently looking at the source code repository of OctoPrint. If you already installed it
(e.g. by using the Raspberry Pi targeted distribution [OctoPi](https://github.com/guysoft/OctoPi)) and only
want to find out how to use it, [the documentation](https://docs.octoprint.org/) might be of more interest for you. You might also want to subscribe to join
[the community forum at community.octoprint.org](https://community.octoprint.org) where there are other active users who might be
able to help you with any questions you might have.

[^1]: Where another license applies to a specific file or folder, that is noted inside the file itself or a folder README. For licenses of both linked and
      vendored third party dependencies, see also THIRDPARTYLICENSES.md.

## Contributing

Contributions of all kinds are welcome, not only in the form of code but also with regards to the
[official documentation](https://docs.octoprint.org/), debugging help
in the [bug tracker](https://github.com/OctoPrint/OctoPrint/issues), support of other users on
[the community forum at community.octoprint.org](https://community.octoprint.org) or
[the official discord at discord.octoprint.org](https://discord.octoprint.org)
and also [financially](https://octoprint.org/support-octoprint/?utm_source=github&utm_medium=readme).

If you think something is bad about OctoPrint or its documentation the way it is, please help
in any way to make it better instead of just complaining about it -- this is an Open Source Project
after all :)

For information about how to go about submitting bug reports or pull requests, please see the project's
[Contribution Guidelines](https://github.com/OctoPrint/OctoPrint/blob/dev/CONTRIBUTING.md).

## Special Thanks

Cross-browser testing services are kindly provided by [BrowserStack](https://www.browserstack.com/).

Profiling is done with the help of [PyVmMonitor](https://www.pyvmmonitor.com).

Error tracking is powered and sponsored by [Sentry](https://sentry.io).