Merge tag '1.3.6' into upstream_merge_136_release

.github/ISSUE_TEMPLATE.md

@@ -62,7 +62,7 @@ to also include a link to a file with which to reproduce the problem.]
 [Try to reproduce your problem in safe mode. You can find information
 on how to enable safe mode in the Contribution Guidelines.]
 
-#### Branch & Commit or Version of OctoPrint
+#### Version of OctoPrint
 
 [Can be found in the lower left corner of the web interface. ALWAYS INCLUDE.]
 

.versioneer-lookup

@@ -18,16 +18,16 @@ prerelease
 HEAD
 \(detached.*
 
-# maintenance is currently the branch for preparation of maintenance release 1.3.5
+# maintenance is currently the branch for preparation of maintenance release 1.3.6
 # so are any fix/... and improve/... branches
 maintenance 1.3.6 1a6dbb3f4a5bef857cdeb13c031b9deca2cf30a2 pep440-dev
 fix/.* 1.3.6 1a6dbb3f4a5bef857cdeb13c031b9deca2cf30a2 pep440-dev
 improve/.* 1.3.6 1a6dbb3f4a5bef857cdeb13c031b9deca2cf30a2 pep440-dev
 
-# staging/maintenance is currently the branch for preparation of 1.3.5rc4
+# staging/maintenance is currently the branch for preparation of 1.3.6rc4
 # so is regressionfix/...
-staging/maintenance 1.3.5rc4 679674df2282af0c4500367fa93864c6defa3802 pep440-dev
-regressionfix/.* 1.3.5rc4 679674df2282af0c4500367fa93864c6defa3802 pep440-dev
+staging/maintenance 1.3.6rc4 a8747f7e36a03ff2449b62cdf68b8a26a6fa61b3 pep440-dev
+regressionfix/.* 1.3.6rc4 a8747f7e36a03ff2449b62cdf68b8a26a6fa61b3 pep440-dev
 
 # every other branch is a development branch and thus gets resolved to 1.4.0-dev for now
 .* 1.4.0 7f5d03d0549bcbd26f40e7e4a3297ea5204fb1cc pep440-dev

AUTHORS.md

@@ -1,6 +1,6 @@
 # Authors
 
-The following people have contributed to OctoPrint's code base (ordered by
+The following people have contributed to OctoPrint's code base (ordered roughly by
 date of first contribution):
 
   * [Gina Häußge](https://github.com/foosel)
@@ -61,10 +61,11 @@ date of first contribution):
   * [Siim Raud](https://github.com/2ndalpha)
   * ["geoporalis"](https://github.com/geoporalis)
   * [Andrew Malota](https://github.com/2bitoperations)
-  * [Alexander Leisentritt](https://github.com/Alex9779)
-  * [therealbstern](https://github.com/therealbstern)
   * [Ishwar Agarwal](https://github.com/agarwali)
   * [Kye Hoover](https://github.com/eykrevooh)
+  * [Joseph Carrick](https://github.com/carricktel)
+  * [Alexander Leisentritt](https://github.com/Alex9779)
+  * [therealbstern](https://github.com/therealbstern)
   * [Philipp Baum](https://github.com/philphilphil)
   * [Kyle Evans](https://github.com/kevans91)
   * [Javier Martínez Arrieta](https://github.com/Javierma)
@@ -79,8 +80,12 @@ date of first contribution):
   * [Greg Hulands](https://github.com/ghulands)
   * [Andreas Werner](https://github.com/gallore)
   * [Shawn Bruce](https://github.com/kantlivelong)
-  * [Claudiu Ceia] (https://github.com/ClaudiuCeia)
+  * [Claudiu Ceia](https://github.com/ClaudiuCeia)
   * [Goswin von Brederlow](https://github.com/mrvn)
+  * [Luke McKechnie](https://github.com/galamdring)
+  * [Peter Backx](https://github.com/pbackx)
+  * [Josh Major](https://github.com/astateofblank)
+  * ["alex-gh"](https://github.com/alex-gh)
 
 OctoPrint started off as a fork of [Cura](https://github.com/daid/Cura) by
 [Daid Braam](https://github.com/daid). Parts of its communication layer and

CONTRIBUTING.md

@@ -160,7 +160,7 @@ only provided here as some additional information for you), **even if only addin
     [Try to reproduce your problem in safe mode. You can find information
     on how to enable safe mode in the Contribution Guidelines.]
 
-    #### Branch & Commit or Version of OctoPrint
+    #### Version of OctoPrint
 
     [Can be found in the lower left corner of the web interface. ALWAYS INCLUDE.]
 
@@ -263,6 +263,8 @@ See [How to open the Javascript Console in different browsers](https://webmaster
 ## Setting up a development environment
 
 See [the corresponding chapter in the documentation](http://docs.octoprint.org/en/master/development/index.html#setting-up-a-development-environment).
+This also includes information on how to run the test suite and how to build 
+the documentation.
 
 ## Pull requests
 
@@ -303,7 +305,17 @@ See [the corresponding chapter in the documentation](http://docs.octoprint.org/e
      * Make sure you do not add dead code (e.g. commented out left-overs
        from experiments).
 8. Ensure your changes **pass the existing unit tests**. PRs that break
-   those cannot be accepted.
+   those cannot be accepted. You can run the unit tests locally (after
+   [initial development environment setup with "develop" dependencies](http://docs.octoprint.org/en/master/development/index.html#setting-up-a-development-environment)) 
+   by running
+
+   ```
+   nosetests --with-doctest
+   ```
+
+   in the OctoPrint checkout folder. A [travis build](https://travis-ci.org/foosel/OctoPrint) 
+   is also setup so that if the tests should fail, your PR will be marked 
+   accordingly.
 9. **Test your changes thoroughly**. That also means testing with usage
    scenarios you don't normally use, e.g. if you only use access control, test
    without and vice versa. If you only test with your printer, test with the
@@ -432,6 +444,7 @@ the local version identifier to allow for an exact determination of the active c
   * 2017-03-10: Reproduce bugs in safe mode to make sure they are really caused
     by OctoPrint itself and not a misbehaving plugin.
   * 2017-03-27: Added safe mode section to ticket template.
+  * 2017-11-22: Added note on how to run the unit tests
 
 ## Footnotes
   * [1] - If you are wondering why, the problem is that anything that you add

README.md

@@ -5,14 +5,14 @@
 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](http://www.gnu.org/licenses/agpl.html).
 
-Its website can be found at [octoprint.org](http://octoprint.org).
+Its website can be found at [octoprint.org](https://octoprint.org/?utm_source=github&utm_medium=readme).
 
 The documentation is located at [docs.octoprint.org](http://docs.octoprint.org).
 
-The official plugin repository can be reached at [plugins.octoprint.org](http://plugins.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](http://octoprint.org/support-octoprint/).
-If you enjoy OctoPrint, please consider becoming a regular supporter!
+**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](http://i.imgur.com/dF3noFp.png)
 
@@ -29,7 +29,7 @@ Contributions of all kinds are welcome, not only in the form of code but also wi
 [official documentation](http://docs.octoprint.org/) or [the public wiki](https://github.com/foosel/OctoPrint/wiki), support
 of other users in the [bug tracker](https://github.com/foosel/OctoPrint/issues),
 [the Mailinglist](https://groups.google.com/group/octoprint) or
-[the G+ Community](https://plus.google.com/communities/102771308349328485741) and also [financially](http://octoprint.org/support-octoprint/).
+[the G+ Community](https://plus.google.com/communities/102771308349328485741) 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

SUPPORTERS.md

@@ -21,16 +21,13 @@ thanks to everyone who contributed!
   * DeltaMaker 3D Printers
   * E3D BigBox
   * Ernesto Martinez
-  * Exovite
   * F. Kunsmann
-  * Farren Young II
   * Frank Sander
   * Gary Deen
   * Gary N McKinney
   * George Robles
   * günter weber
   * James Seigel
-  * Jamie R McGuigan
   * Jason Lawrence
   * Jeff Moe
   * Josh Daniels
@@ -39,19 +36,16 @@ thanks to everyone who contributed!
   * Kazuhiro Ogura
   * Makespace Madrid
   * Marcus Ackermann
-  * Mark Qvist
   * Mark Walker
-  * Masayoshi Mitsui
   * Michael Aumock
   * Miles Flavel
   * mitchell hirsch
   * Mohammed khorakiwala
   * Noe Ruiz
   * Patrick McGinnis
-  * Peter Grace
   * Peter Schmehl
   * PRINT3Dforum.com
-  * Robert Gusek
+  * Randy C. Will
   * Roger Strolz
   * Roy Cortes
   * Samer Najia
@@ -64,4 +58,4 @@ thanks to everyone who contributed!
   * Timeshell.ca
   * Trent Shumay
 
-and 1133 more wonderful people pledging on the [Patreon campaign](https://patreon.com/foosel)!
+and 1062 more wonderful people pledging on the [Patreon campaign](https://patreon.com/foosel)!

THIRDPARTYLICENSES.md

@@ -6,7 +6,7 @@
   * [Babel JavaScript Support](https://github.com/mitsuhiko/babel/blob/master/contrib/babel.js): BSD
   * [Bootstrap](http://getbootstrap.com/): Apache License 2.0
   * [Bootstrap Modal](http://jschr.github.io/bootstrap-modal/): Apache License 2.0
-  * [Bootstrap Slider Knockout Bindings](https://github.com/cosminstefanxp/bootstrap-slider-knockout-binding): MIT
+  * [Bootstrap Slider Knockout Binding](https://github.com/cosminstefanxp/bootstrap-slider-knockout-binding): MIT
   * [Bootstrap Slider](http://seiyria.com/bootstrap-slider/): Apache License 2.0
   * [Bootstrap Tabdrop](http://www.eyecon.ro/bootstrap-tabdrop): Apache License 2.0
   * [Detect Mobile Browser](http://detectmobilebrowsers.com/): Public Domain
@@ -36,6 +36,8 @@
   * [Awesome-Slugify](https://pypi.python.org/pypi/awesome-slugify): GPLv3
   * [chainmap](https://bitbucket.org/jeunice/chainmap): Python
   * [Click](http://click.pocoo.org/): BSD
+  * [dateutil](https://dateutil.readthedocs.io/): BSD
+  * [emoji](https://github.com/carpedm20/emoji/): BSD
   * [feedparser](https://github.com/kurtmckee/feedparser): BSD
   * [Flask](http://flask.pocoo.org/): BSD
   * [Flask-Assets](http://github.com/miracle2k/flask-assets): BSD
@@ -44,6 +46,8 @@
   * [Flask-Markdown](http://github.com/dcolish/flask-markdown): BSD
   * [Flask-Principal](http://packages.python.org/Flask-Principal/): MIT
   * [future](https://python-future.org/): MIT
+  * [futures](https://github.com/agronholm/pythonfutures): Python
+  * [monotonic](https://github.com/atdt/monotonic): Apache License 2.0
   * [netaddr](https://github.com/drkjam/netaddr/): BSD
   * [netifaces](https://bitbucket.org/al45tair/netifaces): MIT
   * [pkginfo](http://pypi.python.org/pypi/pkginfo/): Python
@@ -60,6 +64,7 @@
   * [Tornado](http://www.tornadoweb.org/): Apache License 2.0
   * [watchdog](http://github.com/gorakhargosh/watchdog): Apache License 2.0
   * [websocket-client](https://github.com/liris/websocket-client): LGPLv3
+  * [wrapt](http://wrapt.readthedocs.org/): BSD
 
 ## Development (testing, documentation generation, etc)
 
@@ -69,4 +74,5 @@
   * [pypandoc](https://github.com/bebraw/pypandoc): MIT
   * [Sphinx](http://sphinx-doc.org/): BSD
   * [sphinxcontrib-httpdomain](https://bitbucket.org/birkenfeld/sphinx-contrib/src/default/httpdomain/): BSD
+  * [sphinxcontrib-mermad](https://github.com/mgaitan/sphinxcontrib-mermaid): BSD
   * [sphinx_rtd_theme](https://github.com/snide/sphinx_rtd_theme/): BSD

docs/_static/theme_overrides.css

@@ -37,6 +37,11 @@
     vertical-align: 10%;
 }
 
+.rst-content .highlight>pre,
+.rst-content .linenodiv>pre {
+    line-height: 1.5;
+}
+
 /* make code tags non-red again */
 code,
 .rst-content tt {
@@ -52,3 +57,4 @@ a:visited code,
 .rst-content a:visited tt {
     color: #9B59B6 !important;
 }
+

docs/api/connection.rst

@@ -39,7 +39,7 @@ Get connection settings
         "options": {
           "ports": ["/dev/ttyACM0", "VIRTUAL"],
           "baudrates": [250000, 230400, 115200, 57600, 38400, 19200, 9600],
-          "printerProfiles": [{"name": "Default", id: "_default"}],
+          "printerProfiles": [{"name": "Default", "id": "_default"}],
           "portPreference": "/dev/ttyACM0",
           "baudratePreference": 250000,
           "printerProfilePreference": "_default",

docs/api/datamodel.rst

@@ -232,12 +232,18 @@ File information
    * - ``name``
      - 1
      - String
-     - The name of the file without path. E.g. "file.gco" for a file "file.gco" located anywhere in the file system.
+     - The name of the file without path. E.g. "file.gco" for a file "file.gco" located anywhere in the file system. Currently
+       this will always fit into ASCII.
+   * - ``display``
+     - 1
+     - String
+     - The name of the file without the path, this time potentially with non-ASCII unicode characters.
+       E.g. "a turtle 🐢.gco" for a file "a_turtle_turtle.gco" located anywhere in the file system.
    * - ``path``
      - 1
      - String
      - The path to the file within the location. E.g. "folder/subfolder/file.gco" for a file "file.gco" located within
-       "folder" and "subfolder" relative to the root of the location.
+       "folder" and "subfolder" relative to the root of the location. Currently this will always fit into ASCII.
    * - ``type``
      - 1
      - String
@@ -329,11 +335,17 @@ Abridged file or folder information
      - 1
      - String
      - The name of the file or folder without path. E.g. "file.gco" for a file "file.gco" located anywhere in the file system.
+       Currently this will always fit into ASCII.
+   * - ``display``
+     - 1
+     - String
+     - The name of the file without the path, this potentially with non-ASCII unicode characters.
+       E.g. "a turtle 🐢.gco" for a file "a_turtle_turtle.gco" located anywhere in the file system.
    * - ``path``
      - 1
      - String
      - The path to the file or folder within the location. E.g. "folder/subfolder/file.gco" for a file "file.gco" located within
-       "folder" and "subfolder" relative to the root of the location.
+       "folder" and "subfolder" relative to the root of the location. Currently this will always fit into ASCII.
    * - ``origin``
      - 1
      - String, either ``local`` or ``sdcard``

docs/api/files.rst

@@ -192,6 +192,7 @@ Retrieve all files
                 "refs": {
                   "resource": "http://example.com/api/files/local/folderA/subfolder",
                 }
+              }
             ],
             "size": 1334,
             "refs": {

docs/api/job.rst

@@ -4,6 +4,9 @@
 Job operations
 **************
 
+Use these operations to query the currently selected file and start/cancel/restart/pause the
+actual print job.
+
 .. contents::
 
 .. _sec-api-jobs-command:

docs/api/languages.rst

@@ -39,9 +39,7 @@ Retrieve installed language packs
           "_core": {
             "identifier": "_core",
             "name": "Core",
-            "languages": [
-              ...
-            ]
+            "languages": []
           },
           "some_plugin": {
             "identifier": "some_plugin",
@@ -61,7 +59,6 @@ Retrieve installed language packs
                 "last_update": 1470859680,
                 "author": "The italian Transifex Team"
               }
-              ...
             ]
         }
       }
@@ -124,9 +121,7 @@ Delete a language pack
           "_core": {
             "identifier": "_core",
             "name": "Core",
-            "languages": [
-              ...
-            ]
+            "languages": []
           },
           "some_plugin": {
             "identifier": "some_plugin",
@@ -138,8 +133,7 @@ Delete a language pack
                 "locale_english": "German",
                 "last_update": 1474574597,
                 "author": "Gina Häußge"
-              },
-              ...
+              }
             ]
         }
       }

docs/api/settings.rst

@@ -62,10 +62,11 @@ Save settings
 
       {
         "api": {
-          "enabled": true,
-          // ...
+          "enabled": true
         },
-        // ...
+        "appearance": {
+          "color": "black"
+        }
       }
 
 .. _sec-api-settings-generateapikey:

docs/api/slicing.rst

@@ -58,11 +58,9 @@ List All Slicers and Slicing Profiles
               "displayName": "Medium Quality",
               "default": true,
               "resource": "http://example.com/api/slicing/cura/profiles/medium_quality"
-            },
-            ...
+            }
           }
-        },
-        ...
+        }
       }
 
    :statuscode 200: No error
@@ -104,8 +102,7 @@ List Slicing Profiles of a Specific Slicer
           "displayName": "Medium Quality",
           "default": true,
           "resource": "http://example.com/api/slicing/cura/profiles/medium_quality"
-        },
-        ...
+        }
       }
 
    :param slicer:   The identifying key of the slicer for which to list the available profiles.
@@ -147,8 +144,7 @@ Retrieve Specific Profile
           "brim_line_count": 20,
           "cool_head_lift": false,
           "cool_min_feedrate": 10.0,
-          "cool_min_layer_time": 5.0,
-          ...
+          "cool_min_layer_time": 5.0
         }
       }