semvec/pypi-packages huggingface dataset:
samourai-circuitpython-scratch 0.0.1b2
Example library for testing updates to cookiecutter
License: MIT
Keywords: adafruit blinka circuitpython micropython scratch

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


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


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


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

Example library for testing updates to cookiecutter


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>`_
or individual libraries can be installed using
`circup <https://github.com/adafruit/circup>`_.

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!

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

.. code-block:: shell

    pip3 install samourai-circuitpython-scratch

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

.. code-block:: shell

    sudo pip3 install samourai-circuitpython-scratch

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 samourai-circuitpython-scratch

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

See examples directory.

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

Contributions are welcome! Please read our `Code of Conduct
<https://github.com/lesamouraipourpre/Samourai_CircuitPython_Scratch/blob/HEAD/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>`_.