jepler/Jepler_CircuitPython_udecimal
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
No description
1 commit 13 branches 17 tags 563 KiB
Python 99.1%
Shell 0.9%
Find a file
Jeff Epler 483088a9fc Initial commit
2020-09-06 15:39:24 -05:00
.github/workflows Initial commit 2020-09-06 15:39:24 -05:00
docs Initial commit 2020-09-06 15:39:24 -05:00
examples Initial commit 2020-09-06 15:39:24 -05:00
jepler_udecimal Initial commit 2020-09-06 15:39:24 -05:00
LICENSES Initial commit 2020-09-06 15:39:24 -05:00
.gitignore Initial commit 2020-09-06 15:39:24 -05:00
.pre-commit-config.yaml Initial commit 2020-09-06 15:39:24 -05:00
.pylintrc Initial commit 2020-09-06 15:39:24 -05:00
.readthedocs.yml Initial commit 2020-09-06 15:39:24 -05:00
CODE_OF_CONDUCT.md Initial commit 2020-09-06 15:39:24 -05:00
LICENSE Initial commit 2020-09-06 15:39:24 -05:00
pyproject.toml Initial commit 2020-09-06 15:39:24 -05:00
README.rst Initial commit 2020-09-06 15:39:24 -05:00
requirements.txt Initial commit 2020-09-06 15:39:24 -05:00
setup.py Initial commit 2020-09-06 15:39:24 -05:00
test.py Initial commit 2020-09-06 15:39:24 -05:00

README.rst 

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

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

.. image:: https://img.shields.io/discord/327254708534116352.svg
    :target: https://adafru.it/discord
    :alt: Discord

.. image:: https://github.com/jepler/Jepler_CircuitPython_udecimal/workflows/Build%20CI/badge.svg
    :target: https://github.com/jepler/Jepler_CircuitPython_udecimal/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

Reduced version of the decimal library for CircuitPython


Dependencies
=============
This driver depends on:

* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_

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

Installing from PyPI
=====================
.. note:: This library is not available on PyPI yet. Install documentation is included
   as a standard element. Stay tuned for PyPI availability!

.. todo:: Remove the above note if PyPI version is/will be available at time of release.
   If the library is not planned for PyPI, remove the entire 'Installing from PyPI' section.

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI <https://pypi.org/project/adafruit-circuitpython-udecimal/>`_. To install for current user:

.. code-block:: shell

    pip3 install adafruit-circuitpython-udecimal

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

.. code-block:: shell

    sudo pip3 install adafruit-circuitpython-udecimal

To install in a virtual environment in your current project:

.. code-block:: shell

    mkdir project-name && cd project-name
    python3 -m venv .env
    source .env/bin/activate
    pip3 install adafruit-circuitpython-udecimal

Usage Example
=============

.. todo:: Add a quick, simple example. It and other examples should live in the examples folder and be included in docs/examples.rst.

Contributing
============

Contributions are welcome! Please read our `Code of Conduct
<https://github.com/jepler/Jepler_CircuitPython_udecimal/blob/master/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.

Documentation
=============

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