{ "info": { "author": "Gina H\u00e4u\u00dfge", "author_email": "gina@octoprint.org", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Environment :: Web Environment", "Framework :: Flask", "Intended Audience :: Developers", "Intended Audience :: Education", "Intended Audience :: End Users/Desktop", "Intended Audience :: Manufacturing", "Intended Audience :: Other Audience", "Intended Audience :: Science/Research", "License :: OSI Approved :: GNU Affero General Public License v3", "Natural Language :: English", "Natural Language :: German", "Operating System :: OS Independent", "Programming Language :: JavaScript", "Programming Language :: Python", "Programming Language :: Python :: 2", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: Implementation :: CPython", "Topic :: Printing", "Topic :: System :: Monitoring" ], "description": "# OctoPrint\r\n\r\n\r\n![GitHub release](https://img.shields.io/github/release/foosel/OctoPrint.svg?colorB=brightgreen)\r\n[![Travis build status](https://img.shields.io/travis/foosel/OctoPrint.svg)](https://travis-ci.org/foosel/OctoPrint)\r\n[![Discourse topics](https://img.shields.io/discourse/https/community.octoprint.org/users.svg)](https://community.octoprint.org)\r\n[![IRC](https://img.shields.io/badge/chat-on%20irc-brightgreen.svg)](https://chat.octoprint.org)\r\n[![Twitter Follow](https://img.shields.io/twitter/follow/OctoPrint3d.svg?style=social&label=Follow)](https://twitter.com/OctoPrint3d)\r\n\r\n\r\nOctoPrint provides a snappy web interface for controlling consumer 3D printers. It is Free Software\r\nand released under the [GNU Affero General Public License V3](http://www.gnu.org/licenses/agpl.html).\r\n\r\nIts website can be found at [octoprint.org](https://octoprint.org/?utm_source=github&utm_medium=readme).\r\n\r\nThe community forum is available at [community.octoprint.org](https://community.octoprint.org/?utm_source=github&utm_medium=readme).\r\n\r\nThe official IRC channel is [#octoprint on freenode](https://chat.octoprint.org). Its logs can be found [here](https://freenode.logbot.info/octoprint).\r\n\r\nThe FAQ can be accessed by following [faq.octoprint.org](https://faq.octoprint.org/?utm_source=github&utm_medium=readme).\r\n\r\nThe documentation is located at [docs.octoprint.org](http://docs.octoprint.org).\r\n\r\nThe official plugin repository can be reached at [plugins.octoprint.org](https://plugins.octoprint.org/?utm_source=github&utm_medium=readme).\r\n\r\n**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).\r\nIf you enjoy OctoPrint, please consider becoming a regular supporter!**\r\n\r\n![Screenshot](http://i.imgur.com/dF3noFp.png)\r\n\r\nYou are currently looking at the source code repository of OctoPrint. If you already installed it\r\n(e.g. by using the Raspberry Pi targeted distribution [OctoPi](https://github.com/guysoft/OctoPi)) and only\r\nwant to find out how to use it, [the documentation](http://docs.octoprint.org/) and [the public wiki](https://github.com/foosel/OctoPrint/wiki)\r\nmight be of more interest for you. You might also want to subscribe to join\r\n[the community forum at community.octoprint.org](https://community.octoprint.org) where there are other active users who might be\r\nable to help you with any questions you might have.\r\n\r\n## Contributing\r\n\r\nContributions of all kinds are welcome, not only in the form of code but also with regards to the\r\n[official documentation](http://docs.octoprint.org/) or [the public wiki](https://github.com/foosel/OctoPrint/wiki), debugging help\r\nin the [bug tracker](https://github.com/foosel/OctoPrint/issues), support of other users on\r\n[the community forum at community.octoprint.org](https://community.octoprint.org)\r\nand also [financially](https://octoprint.org/support-octoprint/?utm_source=github&utm_medium=readme).\r\n\r\nIf you think something is bad about OctoPrint or its documentation the way it is, please help\r\nin any way to make it better instead of just complaining about it -- this is an Open Source Project\r\nafter all :)\r\n\r\nFor information about how to go about submitting bug reports or pull requests, please see the project's\r\n[Contribution Guidelines](https://github.com/foosel/OctoPrint/blob/master/CONTRIBUTING.md).\r\n\r\n## Installation\r\n\r\nInstallation instructions for installing from source for different operating\r\nsystems can be found [on the wiki](https://github.com/foosel/OctoPrint/wiki#assorted-guides).\r\n\r\nIf you want to run OctoPrint on a Raspberry Pi, you might want to take a look at [OctoPi](https://github.com/guysoft/OctoPi)\r\nwhich is a custom SD card image that includes OctoPrint plus dependencies.\r\n\r\nThe generic steps that should basically be done regardless of operating system\r\nand runtime environment are the following (as *regular\r\nuser*, please keep your hands *off* of the `sudo` command here!) - this assumes\r\nyou already have Python 2.7, pip and virtualenv set up on your system:\r\n\r\n1. Checkout OctoPrint: `git clone https://github.com/foosel/OctoPrint.git`\r\n2. Change into the OctoPrint folder: `cd OctoPrint`\r\n3. Create a user-owned virtual environment therein: `virtualenv venv` if your system default python version is\r\n python 2.7, otherwise you need to specify the version explicitly, e.g. `virtualenv --python=python2.7 venv`.\r\n4. Install OctoPrint *into that virtual environment*: `./venv/bin/pip install .`\r\n\r\nYou may then start the OctoPrint server via `/path/to/OctoPrint/venv/bin/octoprint`, see [Usage](#usage)\r\nfor details.\r\n\r\nAfter installation, please make sure you follow the first-run wizard and set up\r\naccess control as necessary.\r\n\r\n## Dependencies\r\n\r\nOctoPrint depends on a few python modules to do its job. Those are automatically installed when installing\r\nOctoPrint via `pip`:\r\n\r\n pip install .\r\n\r\nYou should do this every time after pulling from the repository, since the dependencies may have changed.\r\n\r\nOctoPrint currently only supports Python 2.7.\r\n\r\n## Usage\r\n\r\nRunning the pip install via\r\n\r\n pip install .\r\n\r\ninstalls the `octoprint` script in your Python installation's scripts folder\r\n(which, depending on whether you installed OctoPrint globally or into a virtual env, will be in your `PATH` or not). The\r\nfollowing usage examples assume that the `octoprint` script is on your `PATH`.\r\n\r\nYou can start the server via\r\n\r\n octoprint serve\r\n\r\nBy default it binds to all interfaces on port 5000 (so pointing your browser to `http://127.0.0.1:5000`\r\nwill do the trick). If you want to change that, use the additional command line parameters `host` and `port`,\r\nwhich accept the host ip to bind to and the numeric port number respectively. If for example you want the server\r\nto only listen on the local interface on port 8080, the command line would be\r\n\r\n octoprint serve --host=127.0.0.1 --port=8080\r\n\r\nAlternatively, the host and port on which to bind can be defined via the config file.\r\n\r\nIf you want to run OctoPrint as a daemon (only supported on Linux), use\r\n\r\n octoprint daemon {start|stop|restart} [--pid PIDFILE]\r\n\r\nIf you do not supply a custom pidfile location via `--pid PIDFILE`, it will be created at `/tmp/octoprint.pid`.\r\n\r\nYou can also specify the config file or the base directory (for basing off the `uploads`, `timelapse` and `logs` folders),\r\ne.g.:\r\n\r\n octoprint serve --config /path/to/another/config.yaml --basedir /path/to/my/basedir\r\n\r\nTo start OctoPrint in safe mode - which disables all third party plugins that do not come bundled with OctoPrint - use\r\nthe ``--safe`` flag:\r\n\r\n octoprint serve --safe\r\n\r\nSee `octoprint --help` for more information on the available command line parameters.\r\n\r\nOctoPrint also ships with a `run` script in its source directory. You can invoke it to start the server. It\r\ntakes the same command line arguments as the `octoprint` script.\r\n\r\n## Configuration\r\n\r\nIf not specified via the command line, the config file `config.yaml` for OctoPrint is expected in the settings folder,\r\nwhich is located at `~/.octoprint` on Linux, at `%APPDATA%/OctoPrint` on Windows and\r\nat `~/Library/Application Support/OctoPrint` on MacOS.\r\n\r\nA comprehensive overview of all available configuration settings can be found\r\n[in the docs](http://docs.octoprint.org/en/master/configuration/config_yaml.html).\r\nPlease note that the most commonly used configuration settings can also easily\r\nbe edited from OctoPrint's settings dialog.\r\n\r\n## Special Thanks\r\n\r\nCross-browser testing services are kindly provided by [BrowserStack](https://www.browserstack.com/).\r\n\r\nProfiling is done with the help of [PyVmMonitor](https://www.pyvmmonitor.com).\r\n\r\nError tracking is powered and sponsored by [Sentry](https://sentry.io).\r\n\r\n\r\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://octoprint.org", "keywords": "3dprinting 3dprinter 3d-printing 3d-printer octoprint", "license": "GNU Affero General Public License v3", "maintainer": "", "maintainer_email": "", "name": "OctoPrint", "package_url": "https://pypi.org/project/OctoPrint/", "platform": "", "project_url": "https://pypi.org/project/OctoPrint/", "project_urls": { "Bug Reports": "https://github.com/foosel/OctoPrint/issues", "Community Forum": "https://community.octoprint.org", "Funding": "https://donate.octoprint.org", "Homepage": "https://octoprint.org", "Source": "https://github.com/foosel/OctoPrint" }, "release_url": "https://pypi.org/project/OctoPrint/1.3.11/", "requires_dist": [ "flask (<0.11,>=0.10.1)", "Jinja2 (<2.9,>=2.8.1)", "tornado (==4.5.3)", "Flask-Login (<0.3,>=0.2.11)", "regex (!=2018.11.6)", "Flask-Principal (<0.5,>=0.4)", "Flask-Babel (<0.13,>=0.12)", "Flask-Assets (<0.13,>=0.12)", "werkzeug (<0.16,>=0.15.1)", "cachelib (<0.2,>=0.1)", "PyYAML (<6,>=5.1)", "markdown (<3.1,>=3.0)", "pyserial (<3.5,>=3.4)", "netaddr (<0.8,>=0.7.19)", "watchdog (<0.10,>=0.9.0)", "sarge (==0.1.5post0)", "netifaces (<0.11,>=0.10.9)", "pylru (<1.3,>=1.2)", "rsa (<5,>=4.0)", "pkginfo (<1.6,>=1.5.0.1)", "requests (<3,>=2.21.0)", "semantic-version (<2.7,>=2.6)", "psutil (<5.7,>=5.6.1)", "Click (<8,>=7)", "awesome-slugify (<1.7,>=1.6.5)", "feedparser (<5.3,>=5.2.1)", "chainmap (<1.1,>=1.0.3)", "future (<0.18,>=0.17.1)", "scandir (<1.11,>=1.10)", "websocket-client (<0.57,>=0.56)", "wrapt (<1.12,>=1.11.1)", "futures (<3.3,>=3.2)", "emoji (<0.6,>=0.5.1)", "monotonic (<1.6,>=1.5)", "frozendict (<1.3,>=1.2)", "sentry-sdk (==0.7.7)", "typing (<4,>=3.6.6)", "mock (<3,>=2.0.0); extra == 'develop'", "nose (<1.4,>=1.3.7); extra == 'develop'", "ddt; extra == 'develop'", "sphinx (<1.7,>=1.6); extra == 'develop'", "sphinxcontrib-httpdomain; extra == 'develop'", "sphinxcontrib-mermaid (>=0.3); extra == 'develop'", "sphinx-rtd-theme; extra == 'develop'", "cookiecutter (<1.7,>=1.6); extra == 'plugins'" ], "requires_python": ">=2.7.9,<3", "summary": "The snappy web interface for your 3D printer", "version": "1.3.11" }, "last_serial": 5873585, "releases": { "1.3.11": [ { "comment_text": "", "digests": { "md5": "d9f1c136ed1abbb3a1764db81858df13", "sha256": "7ffc741c9d4202d78aeeb0b5385c65713cc5e9da59b1dde508681ab6a1c21144" }, "downloads": -1, "filename": "OctoPrint-1.3.11-py2-none-any.whl", "has_sig": false, "md5_digest": "d9f1c136ed1abbb3a1764db81858df13", "packagetype": "bdist_wheel", "python_version": "py2", "requires_python": ">=2.7.9,<3", "size": 3071546, "upload_time": "2019-09-04T15:22:09", "url": "https://files.pythonhosted.org/packages/37/57/24bbb701b5a4b802b88ef22f921fbe5b8debe922ecf4d3c81945a1881905/OctoPrint-1.3.11-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "bb6796609efa51b7c5922bcb5f90d6e2", "sha256": "5777c1a3b01acc81b5f94633064726e20a235f368382861ac3670868a7a7161a" }, "downloads": -1, "filename": "OctoPrint-1.3.11.tar.gz", "has_sig": false, "md5_digest": "bb6796609efa51b7c5922bcb5f90d6e2", "packagetype": "sdist", "python_version": "source", "requires_python": ">=2.7.9,<3", "size": 2880004, "upload_time": "2019-09-04T15:22:13", "url": "https://files.pythonhosted.org/packages/eb/8f/650801fe6b4eee9111ee5fc1600d52b40cf171702edc8f9c02c17460c458/OctoPrint-1.3.11.tar.gz" } ], "1.3.12rc1": [ { "comment_text": "", "digests": { "md5": "8d2ed7e58e51492c49bf9c64dbe88106", "sha256": "1f380fdba3375978bba1078a8e58f3f56decc9d177a1e6f8007682933095a24c" }, "downloads": -1, "filename": "OctoPrint-1.3.12rc1-py2-none-any.whl", "has_sig": false, "md5_digest": "8d2ed7e58e51492c49bf9c64dbe88106", "packagetype": "bdist_wheel", "python_version": "py2", "requires_python": ">=2.7.9,<3", "size": 3088829, "upload_time": "2019-09-10T17:30:17", "url": "https://files.pythonhosted.org/packages/90/9a/50555eacde1becd6ba3fd4faa5e4bfe74b0cb6ab6f219e46f0cf1ab980f8/OctoPrint-1.3.12rc1-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "12a682a00aba201305f1a0fe7d0eb8b8", "sha256": "a814493e2c2a03bf6f06431e9901322430e1e122bb99ee37f4708cef5189a453" }, "downloads": -1, "filename": "OctoPrint-1.3.12rc1.tar.gz", "has_sig": false, "md5_digest": "12a682a00aba201305f1a0fe7d0eb8b8", "packagetype": "sdist", "python_version": "source", "requires_python": ">=2.7.9,<3", "size": 2899383, "upload_time": "2019-09-10T17:30:22", "url": "https://files.pythonhosted.org/packages/73/40/da5258ee7140da087b032c42a8b434a7f72a75c571eaf3fc2271708e4b72/OctoPrint-1.3.12rc1.tar.gz" } ], "1.3.12rc3": [ { "comment_text": "", "digests": { "md5": "8579c9e03b156bae7fc87a66219eb38f", "sha256": "f7d24a67474f0f87c3d84a3ff791b95e52a141d6465fc8778e17a819a3a10081" }, "downloads": -1, "filename": "OctoPrint-1.3.12rc3.tar.gz", "has_sig": false, "md5_digest": "8579c9e03b156bae7fc87a66219eb38f", "packagetype": "sdist", "python_version": "source", "requires_python": ">=2.7.9,<3", "size": 2900249, "upload_time": "2019-09-23T13:16:11", "url": "https://files.pythonhosted.org/packages/99/f7/ef4d7a4edac1c09adb0568e203f0104453c58c8913f6112cece6f7e41135/OctoPrint-1.3.12rc3.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "d9f1c136ed1abbb3a1764db81858df13", "sha256": "7ffc741c9d4202d78aeeb0b5385c65713cc5e9da59b1dde508681ab6a1c21144" }, "downloads": -1, "filename": "OctoPrint-1.3.11-py2-none-any.whl", "has_sig": false, "md5_digest": "d9f1c136ed1abbb3a1764db81858df13", "packagetype": "bdist_wheel", "python_version": "py2", "requires_python": ">=2.7.9,<3", "size": 3071546, "upload_time": "2019-09-04T15:22:09", "url": "https://files.pythonhosted.org/packages/37/57/24bbb701b5a4b802b88ef22f921fbe5b8debe922ecf4d3c81945a1881905/OctoPrint-1.3.11-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "bb6796609efa51b7c5922bcb5f90d6e2", "sha256": "5777c1a3b01acc81b5f94633064726e20a235f368382861ac3670868a7a7161a" }, "downloads": -1, "filename": "OctoPrint-1.3.11.tar.gz", "has_sig": false, "md5_digest": "bb6796609efa51b7c5922bcb5f90d6e2", "packagetype": "sdist", "python_version": "source", "requires_python": ">=2.7.9,<3", "size": 2880004, "upload_time": "2019-09-04T15:22:13", "url": "https://files.pythonhosted.org/packages/eb/8f/650801fe6b4eee9111ee5fc1600d52b40cf171702edc8f9c02c17460c458/OctoPrint-1.3.11.tar.gz" } ] }