Merge branch 'adafruit:master' into master

Author: syedmalimustafa

.github/PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md

@@ -0,0 +1,13 @@
+# SPDX-FileCopyrightText: 2021 Adafruit Industries
+#
+# SPDX-License-Identifier: MIT
+
+Thank you for contributing! Before you submit a pull request, please read the following.
+
+Make sure any changes you're submitting are in line with the CircuitPython Design Guide, available here: https://circuitpython.readthedocs.io/en/latest/docs/design_guide.html
+
+If your changes are to documentation, please verify that the documentation builds locally by following the steps found here: https://adafru.it/build-docs
+
+Before submitting the pull request, make sure you've run Pylint and Black locally on your code. You can do this manually or using pre-commit. Instructions are available here: https://adafru.it/check-your-code
+
+Please remove all of this text before submitting. Include an explanation or list of changes included in your PR, as well as, if applicable, a link to any related issues.

.github/workflows/build.yml

@@ -76,3 +76,5 @@ jobs:
         python setup.py sdist
         python setup.py bdist_wheel --universal
         twine check dist/*
+    - name: Setup problem matchers
+      uses: adafruit/circuitpython-action-library-ci-problem-matchers@v1

.github/workflows/failure-help-text.yml

@@ -0,0 +1,19 @@
+# SPDX-FileCopyrightText: 2021 Scott Shawcroft for Adafruit Industries
+#
+# SPDX-License-Identifier: MIT
+
+name: Failure help text
+
+on:
+  workflow_run:
+    workflows: ["Build CI"]
+    types:
+      - completed
+
+jobs:
+  post-help:
+    runs-on: ubuntu-latest
+    if: ${{ github.event.workflow_run.conclusion == 'failure' && github.event.workflow_run.event == 'pull_request' }}
+    steps:
+    - name: Post comment to help
+      uses: adafruit/circuitpython-action-library-ci-failed@v1

adafruit_progressbar/__init__.py

@@ -3,7 +3,7 @@
 # SPDX-License-Identifier: MIT
 
 """
-`progressbar_base`
+`adafruit_progressbar`
 ================================================================================
 
 Dynamic progress bar widget for CircuitPython displays

adafruit_progressbar/horizontalprogressbar.py

@@ -57,7 +57,7 @@ class HorizontalProgressBar(ProgressBarBase):
     Using the diagrams below, the bar will fill in the following directions::
 
         --------------------------------
-        | Left-to-right   |  1-3 to 2-4 |
+        | Left-to-right  |  1-3 to 2-4 |
         --------------------------------
         | Right-to-left  |  2-4 to 1-3 |
         --------------------------------

docs/api.rst

@@ -6,6 +6,9 @@ API Definition
 .. If your library file(s) are nested in a directory (e.g. /adafruit_foo/foo.py)
 .. use this format as the module name: "adafruit_foo.foo"
 
+.. automodule:: adafruit_progressbar
+   :members:
+
 .. automodule:: adafruit_progressbar.horizontalprogressbar
    :members:
    :show-inheritance:

docs/examples.rst

@@ -16,3 +16,53 @@ Example showing how to change the progressbar color while updating the values
 .. literalinclude:: ../examples/progressbar_displayio_blinka_color_scale.py
     :caption: examples/progressbar_displayio_blinka_color_scale.py
     :linenos:
+
+
+Vertical Simple test
+--------------------
+
+Simple test to show a vertical Progress bar
+
+.. literalinclude:: ../examples/progressbar_vertical_simpletest.py
+    :caption: examples/progressbar_vertical_simpletest.py
+    :linenos:
+
+
+MatrixPortal Example
+--------------------
+
+Progressbar using the MatrixPortal
+
+.. literalinclude:: ../examples/progressbar_matrixportal.py
+    :caption: examples/examples/progressbar_matrixportal.py
+    :linenos:
+
+
+
+MagTag Example
+---------------
+
+Progressbar using the MagTag
+
+.. literalinclude:: ../examples/progressbar_magtag_simpletest.py
+    :caption: examples/progressbar_magtag_simpletest.py
+    :linenos:
+
+
+DisplayIO Blinka
+----------------
+
+Progressbar using DisplayIO in Blinka
+
+.. literalinclude:: ../examples/progressbar_displayio_blinka.py
+    :caption: examples/progressbar_displayio_blinka.py
+    :linenos:
+
+Combined ProgressBar
+--------------------
+
+Example showing both a Vertical and an Horizontal ProgressBar
+
+.. literalinclude:: ../examples/progressbar_combined.py
+    :caption: examples/progressbar_combined.py
+    :linenos:

docs/index.rst

@@ -23,6 +23,10 @@ Table of Contents
 .. toctree::
     :caption: Tutorials
 
+    ProgressBar Basics <https://learn.adafruit.com/magtag-progress-displays/progressbar-basics>
+
+    Adafruit MagTag COVID Vaccination Percent Tracker  <https://learn.adafruit.com/adafruit-magtag-covid-vaccination-percent-tracker>
+
 
 .. toctree::
     :caption: Related Products