Introduction
April 21, 2023 ยท View on GitHub
.. image:: https://readthedocs.org/projects/circuitpython-uboxplot/badge/?version=latest :target: https://circuitpython-uboxplot.readthedocs.io/ :alt: Documentation Status
.. image:: https://github.com/jposada202020/CircuitPython_uboxplot/workflows/Build%20CI/badge.svg :target: https://github.com/jposada202020/CircuitPython_uboxplot/actions :alt: Build Status
.. image:: https://img.shields.io/pypi/v/circuitpython-uboxplot.svg :alt: latest version on PyPI :target: https://pypi.python.org/pypi/circuitpython-uboxplot
.. image:: https://static.pepy.tech/personalized-badge/circuitpython-uboxplot?period=total&units=international_system&left_color=grey&right_color=blue&left_text=Pypi%20Downloads :alt: Total PyPI downloads :target: https://pepy.tech/project/circuitpython-uboxplot
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg :target: https://github.com/psf/black :alt: Code Style: Black
Calculates boxplot and creates its graphical representation
.. image:: https://github.com/jposada202020/CircuitPython_UBoxplot/blob/main/docs/boxplot.jpg
Dependencies
This driver depends on CircuitPython > 8.X.X RC1
Please ensure all dependencies are available on the CircuitPython filesystem.
This is easily achieved by downloading
the Adafruit library and driver bundle <https://circuitpython.org/libraries>_
or individual libraries can be installed using
circup <https://github.com/adafruit/circup>_.Installing from PyPI
=====================
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally from PyPI <https://pypi.org/project/circuitpython-uboxplot/>_.
To install for current user:
.. code-block:: shell
pip3 install circuitpython-uboxplot
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install circuitpython-uboxplot
To install in a virtual environment in your current project:
.. code-block:: shell
mkdir project-name && cd project-name
python3 -m venv .venv
source .env/bin/activate
pip3 install circuitpython-uboxplot
Installing to a Connected CircuitPython Device with Circup
Make sure that you have circup installed in your Python environment.
Install it with the following command if necessary:
.. code-block:: shell
pip3 install circup
With circup installed and your CircuitPython device connected use the
following command to install:
.. code-block:: shell
circup install uboxplot
Or the following command to update an existing version:
.. code-block:: shell
circup update
Usage Example
For library usage please refer to the examples folder.
Documentation
API documentation for this library can be found on Read the Docs <https://circuitpython-uboxplot.readthedocs.io/>_.
For information on building library documentation, please check out
this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>_.
Contributing
Contributions are welcome! Please read our Code of Conduct <https://github.com/jposada202020/CircuitPython_uboxplot/blob/HEAD/CODE_OF_CONDUCT.md>_
before contributing to help this project stay welcoming.