🔖 Release 1.5.0

.editorconfig

@@ -10,7 +10,8 @@ insert_final_newline = true
 trim_trailing_whitespace = true
 
 [**.py]
-indent_style = tab
+indent_style = space
+indent_size = 4
 
 [**.js]
 indent_style = space

.gitattributes

@@ -1,2 +1,3 @@
 # Auto detect text files and perform LF normalization
 * text=auto
+octoprint_virtual_printerconfig/_version.py export-subst

.github/workflows/build.yml

@@ -0,0 +1,52 @@
+name: Build
+on:
+  push:
+
+jobs:
+  build:
+    name: 🔨 Build distribution
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - name: 🏗 Set up Python 3.8
+        uses: actions/setup-python@v1
+        with:
+          python-version: 3.8
+      - name: 🏗 Install build dependencies
+        run: |
+          python -m pip install wheel octoprint --user
+      - name: 🔨 Build a source zip
+        run: |
+          python setup.py sdist --formats=zip
+      - name: ⬆ Upload build result
+        uses: actions/upload-artifact@v1
+        with:
+          name: dist
+          path: dist
+
+  test-install:
+    name: 🧪 Installation tests
+    needs: build
+    strategy:
+      matrix:
+        python: ["2.7", "3.7", "3.8"]
+    runs-on: ubuntu-latest
+    steps:
+      - name: 🏗 Set up Python ${{ matrix.python }}
+        uses: actions/setup-python@v1
+        with:
+          python-version: ${{ matrix.python }}
+      - name: ⬇ Download build result
+        uses: actions/download-artifact@v1
+        with:
+          name: dist
+          path: dist
+      - name: 🏗 Install dependencies
+        run: |
+          python -m pip install --upgrade wheel setuptools pip
+          python -m pip install octoprint
+      - name: 🧪 Test install of package
+        run: |
+          python -m pip install dist/Virtual\ Printer\ Settings-*.zip

.github/workflows/release.yml

@@ -0,0 +1,83 @@
+name: Release
+on:
+  release:
+    types: [published, prereleased]
+
+jobs:
+  build:
+    name: 🔨 Build distribution
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - name: 🏗 Set up Python 3.8
+        uses: actions/setup-python@v1
+        with:
+          python-version: 3.8
+      - name: 🏗 Install build dependencies
+        run: |
+          python -m pip install wheel octoprint --user
+      - name: 🔨 Build a source zip
+        run: |
+          python setup.py sdist --formats=zip
+      - name: ⬆ Upload build result
+        uses: actions/upload-artifact@v1
+        with:
+          name: dist
+          path: dist
+
+  test-install:
+    name: 🧪 Installation tests
+    needs: build
+    strategy:
+      matrix:
+        python: ["2.7", "3.7", "3.8"]
+    runs-on: ubuntu-latest
+    steps:
+      - name: 🏗 Set up Python ${{ matrix.python }}
+        uses: actions/setup-python@v1
+        with:
+          python-version: ${{ matrix.python }}
+      - name: ⬇ Download build result
+        uses: actions/download-artifact@v1
+        with:
+          name: dist
+          path: dist
+      - name: 🏗 Install dependencies
+        run: |
+          python -m pip install --upgrade wheel setuptools pip
+          python -m pip install octoprint
+      - name: 🧪 Test install of package
+        run: |
+          python -m pip install dist/Virtual\ Printer\ Settings-*.zip
+
+  upload-asset:
+    name: 📦 Upload asset to release
+    runs-on: ubuntu-latest
+    needs:
+      - build
+      - test-install
+    steps:
+      - name: ⬇ Download build result
+        uses: actions/download-artifact@v1
+        with:
+          name: dist
+          path: dist
+      - name: 🚚 Rename to release.zip
+        run: |
+          cp dist/Virtual\ Printer\ Settings-*.zip release.zip
+      - name: 🥅 Catch release ID
+        id: get_release
+        uses: bruceadams/[email protected]
+        env:
+          GITHUB_TOKEN: ${{ github.token }}
+      - name: 📦 Attach release artifact
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ steps.get_release.outputs.upload_url }}
+          asset_path: release.zip
+          asset_name: release.zip
+          asset_content_type: application/zip

.gitignore

@@ -8,4 +8,4 @@ dist
 .DS_Store
 *.zip
 resources
-.vscode
+.vscode

.pre-commit-config.yaml

@@ -0,0 +1,40 @@
+exclude: ^(translations/|.*\.css|.*\.svg|octoprint_virtual_printerconfig/_version.py|versioneer.py)
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v2.3.0
+    hooks:
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+      - id: check-case-conflict
+      - id: check-json
+      - id: check-yaml
+      - id: check-toml
+      - id: check-merge-conflict
+      - id: fix-encoding-pragma
+  - repo: https://github.com/OctoPrint/codemods
+    rev: main
+    hooks:
+      - id: codemod_dict_to_literal
+        stages: ["manual"]
+      - id: codemod_set_to_literal
+        stages: ["manual"]
+      - id: codemod_not_in
+        stages: ["manual"]
+  - repo: https://github.com/pre-commit/mirrors-isort
+    rev: v5.5.4
+    hooks:
+      - id: isort
+  - repo: https://github.com/psf/black
+    rev: stable
+    hooks:
+      - id: black
+  - repo: https://gitlab.com/pycqa/flake8
+    rev: 3.8.1
+    hooks:
+      - id: flake8
+        additional_dependencies:
+          - flake8-bugbear
+  - repo: https://github.com/prettier/prettier
+    rev: master
+    hooks:
+      - id: prettier

.versioneer-lookup

@@ -0,0 +1,28 @@
+# Configuration file for the versioneer lookup, manually mapping tags based on branches
+#
+# Format is
+#
+#   <branch-regex> <tag> <reference commit>
+#
+# The file is processed from top to bottom, the first matching line wins. If <tag> or <reference commit> are left out,
+# the lookup table does not apply to the matched branches
+
+# These branches should only use tags, use for your release branches
+master
+main
+pre-release
+rc/.*
+rc
+
+# neither should disconnected checkouts, e.g. 'git checkout <tag>'
+HEAD
+\(detached.*
+
+# here, maintenance is currently the branch for 0.1.4 - hash is of previous tag on this branch
+maintenance 0.1.4 60391c634bd7077dae6abd40f4d6afd2b35519e4 pep440-dev
+
+# devel is currently the branch for work towards 0.2.0
+devel 0.2.0 60391c634bd7077dae6abd40f4d6afd2b35519e4 pep440-dev
+
+# Every other branch is also development, so is resolved to 0.2.0 as well for now
+.* 0.2.0 60391c634bd7077dae6abd40f4d6afd2b35519e4 pep440-dev

MANIFEST

@@ -0,0 +1,13 @@
+# file GENERATED by distutils, do NOT edit
+README.md
+setup.cfg
+setup.py
+versioneer.py
+octoprint_virtual_printerconfig\__init__.py
+octoprint_virtual_printerconfig\_version.py
+octoprint_virtual_printerconfig\static\js\virtual_printerconfig.js
+octoprint_virtual_printerconfig\static\sass\virtual_printerconfig.sass
+octoprint_virtual_printerconfig\templates\settings_replacement.jinja2
+octoprint_virtual_printerconfig\templates\settings_tab_firmware.jinja2
+octoprint_virtual_printerconfig\templates\settings_tab_physical.jinja2
+octoprint_virtual_printerconfig\templates\settings_tab_responses.jinja2

MANIFEST.in

@@ -2,3 +2,5 @@ include README.md
 recursive-include octoprint_virtual_printer_settings/templates *
 recursive-include octoprint_virtual_printer_settings/translations *
 recursive-include octoprint_virtual_printer_settings/static *
+include versioneer.py
+include octoprint_virtual_printerconfig/_version.py

README.md

@@ -5,9 +5,20 @@ Overrides the default template which only has an enabling checkbox.
 
 Very useful if you are developing plugins, or even core OctoPrint. No more digging deep into config.yaml and hoping you typed the settings correctly!
 
-### This plugin is not under *active* development, but if you have any problems, or feature requests I would be happy to take a look & see what I can do.
+### This plugin is not under _active_ development, but if you have any problems, or feature requests I would be happy to take a look & see what I can do.
 
-#### Warning: Only compatible with OctoPrint 1.4.1 and higher, please update!
+## Compatibility
+
+The lastest version of the plugin is only compatible with OctoPrint 1.5.x.
+To find a version compatible with your instance, take a look in the table below
+
+| OctoPrint version | Plugin version | Install URL                                                                    |
+| ----------------- | -------------- | ------------------------------------------------------------------------------ |
+| 1.5.x             | 1.5.x          | `https://github.com/cp2004/OctoPrint-VirtualPrinterSettings/archive/1.5.0.zip` |
+| 1.4.1/2           | 0.1.3          | `https://github.com/cp2004/OctoPrint-VirtualPrinterSettings/archive/0.1.3.zip` |
+
+Use the above URLs in OctoPrint's [Plugin Manager](https://docs.octoprint.org/en/master/bundledplugins/pluginmanager.html) >
+Get More > ...from URL field.
 
 ## Setup
 
@@ -16,7 +27,6 @@ or manually using this URL:
 
     https://github.com/cp2004/OctoPrint-VirtualPrinterSettings/archive/master.zip
 
-
 ## Configuration
 
 Plugin adds settings to OctoPrint's UI that are [documented here](https://docs.octoprint.org/en/master/development/virtual_printer.html#virtual-printer-configuration-options)

extras/virtual_printer_settings.md

@@ -15,32 +15,29 @@ source: https://github.com/cp2004/OctoPrint-VirtualPrinterSettings
 archive: https://github.com/cp2004/OctoPrint-VirtualPrinterSettings/archive/master.zip
 
 tags:
-- development
-- settings
-- virtual printer
+  - development
+  - settings
+  - virtual printer
 
 # TODO
 screenshots:
-- url: /assets/img/plugins/virtual_printer_2/settings.png
-  alt: alt-text of a screenshot
-  caption: caption of a screenshot
+  - url: /assets/img/plugins/virtual_printer_2/settings.png
+    alt: alt-text of a screenshot
+    caption: caption of a screenshot
 
 featuredimage: /assets/img/plugins/virtual_printer_2/settings.png
 
-
 compatibility:
-
   octoprint:
-  - 1.4.1
+    - 1.4.1
 
   os:
-  - linux
-  - windows
-  - macos
-  - freebsd
+    - linux
+    - windows
+    - macos
+    - freebsd
 
   python: ">=2.7,<4"
-
 ---
 
 Add easily configurable and well organised settings for OctoPrint's virtual printer.