1  Introduction
  2  ============
  3  
  4  
  5  .. image:: https://readthedocs.org/projects/circuitpython-uboxplot/badge/?version=latest
  6      :target: https://circuitpython-uboxplot.readthedocs.io/
  7      :alt: Documentation Status
  8  
  9  
 10  .. image:: https://github.com/jposada202020/CircuitPython_uboxplot/workflows/Build%20CI/badge.svg
 11      :target: https://github.com/jposada202020/CircuitPython_uboxplot/actions
 12      :alt: Build Status
 13  
 14  .. image:: https://img.shields.io/pypi/v/circuitpython-uboxplot.svg
 15      :alt: latest version on PyPI
 16      :target: https://pypi.python.org/pypi/circuitpython-uboxplot
 17  
 18  .. image:: https://static.pepy.tech/personalized-badge/circuitpython-uboxplot?period=total&units=international_system&left_color=grey&right_color=blue&left_text=Pypi%20Downloads
 19      :alt: Total PyPI downloads
 20      :target: https://pepy.tech/project/circuitpython-uboxplot
 21  
 22  .. image:: https://img.shields.io/badge/code%20style-black-000000.svg
 23      :target: https://github.com/psf/black
 24      :alt: Code Style: Black
 25  
 26  Calculates boxplot and creates its graphical representation
 27  
 28  .. image:: https://github.com/jposada202020/CircuitPython_UBoxplot/blob/main/docs/boxplot.jpg
 29  
 30  
 31  Dependencies
 32  =============
 33  This driver depends on CircuitPython > 8.X.X RC1
 34  
 35  Please ensure all dependencies are available on the CircuitPython filesystem.
 36  This is easily achieved by downloading
 37  `the Adafruit library and driver bundle <https://circuitpython.org/libraries>`_
 38  or individual libraries can be installed using
 39  `circup <https://github.com/adafruit/circup>`_.Installing from PyPI
 40  
 41  =====================
 42  
 43  On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
 44  PyPI <https://pypi.org/project/circuitpython-uboxplot/>`_.
 45  To install for current user:
 46  
 47  .. code-block:: shell
 48  
 49      pip3 install circuitpython-uboxplot
 50  
 51  To install system-wide (this may be required in some cases):
 52  
 53  .. code-block:: shell
 54  
 55      sudo pip3 install circuitpython-uboxplot
 56  
 57  To install in a virtual environment in your current project:
 58  
 59  .. code-block:: shell
 60  
 61      mkdir project-name && cd project-name
 62      python3 -m venv .venv
 63      source .env/bin/activate
 64      pip3 install circuitpython-uboxplot
 65  
 66  Installing to a Connected CircuitPython Device with Circup
 67  ==========================================================
 68  
 69  Make sure that you have ``circup`` installed in your Python environment.
 70  Install it with the following command if necessary:
 71  
 72  .. code-block:: shell
 73  
 74      pip3 install circup
 75  
 76  With ``circup`` installed and your CircuitPython device connected use the
 77  following command to install:
 78  
 79  .. code-block:: shell
 80  
 81      circup install uboxplot
 82  
 83  Or the following command to update an existing version:
 84  
 85  .. code-block:: shell
 86  
 87      circup update
 88  
 89  Usage Example
 90  =============
 91  
 92  For library usage please refer to the examples folder.
 93  
 94  Documentation
 95  =============
 96  API documentation for this library can be found on `Read the Docs <https://circuitpython-uboxplot.readthedocs.io/>`_.
 97  
 98  For information on building library documentation, please check out
 99  `this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.
100  
101  Contributing
102  ============
103  
104  Contributions are welcome! Please read our `Code of Conduct
105  <https://github.com/jposada202020/CircuitPython_uboxplot/blob/HEAD/CODE_OF_CONDUCT.md>`_
106  before contributing to help this project stay welcoming.