Metadata-Version: 2.1
Name: circuitpython-boxplot
Version: 0.1.1
Summary: calculates boxplot and creates its graphical representation
Author-email: "Jose D. Montoya" <boxplot@mailmeto.mozmail.com>
License: MIT
Project-URL: Homepage, https://github.com/jposada202020/CircuitPython_boxplot
Keywords: adafruit,blinka,circuitpython,micropython,boxplot,circuitpython,ulab,boxplot,graphics,community,statistical
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Embedded Systems
Classifier: Topic :: System :: Hardware
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: Adafruit-Blinka
Provides-Extra: optional

Introduction
============


.. image:: https://readthedocs.org/projects/circuitpython-boxplot/badge/?version=latest
    :target: https://circuitpython-boxplot.readthedocs.io/
    :alt: Documentation Status


.. image:: https://github.com/jposada202020/CircuitPython_boxplot/workflows/Build%20CI/badge.svg
    :target: https://github.com/jposada202020/CircuitPython_boxplot/actions
    :alt: Build Status


.. 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


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-boxplot/>`_.
To install for current user:

.. code-block:: shell

    pip3 install circuitpython-boxplot

To install system-wide (this may be required in some cases):

.. code-block:: shell

    sudo pip3 install circuitpython-boxplot

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-boxplot

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 boxplot

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-boxplot.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_boxplot/blob/HEAD/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
