https://github.com/adafruit/adafruit_circuitpython_simpleio

Simple CircuitPython classes to do a wide variety of basic functionality.
https://github.com/adafruit/adafruit_circuitpython_simpleio

circuitpython hacktoberfest

Last synced: 4 days ago
JSON representation

Simple CircuitPython classes to do a wide variety of basic functionality.

• Host: GitHub
• URL: https://github.com/adafruit/adafruit_circuitpython_simpleio
• Owner: adafruit
• License: mit
• Created: 2016-12-08T00:31:07.000Z (about 8 years ago)
• Default Branch: main
• Last Pushed: 2025-01-16T20:03:15.000Z (17 days ago)
• Last Synced: 2025-01-22T10:09:51.423Z (12 days ago)
• Topics: circuitpython, hacktoberfest
• Language: Python
• Homepage:
• Size: 187 KB
• Stars: 11
• Watchers: 23
• Forks: 21
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        

Introduction

============

.. image:: https://readthedocs.org/projects/adafruit-circuitpython-simpleio/badge/?version=latest

    :target: https://docs.circuitpython.org/projects/simpleio/en/latest/

    :alt: Documentation Status

.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg

    :target: https://adafru.it/discord

    :alt: Discord

.. image:: https://github.com/adafruit/Adafruit_CircuitPython_SimpleIO/workflows/Build%20CI/badge.svg

    :target: https://github.com/adafruit/Adafruit_CircuitPython_SimpleIO/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

SimpleIO features a number of helpers to simplify hardware interactions. Many

of the functions and classes are inspired by Arduino APIs to make it easier to

move to CircuitPython from Arduino.

Dependencies

=============

This driver depends on:

* `Adafruit CircuitPython `_

Please ensure all dependencies are available on the CircuitPython filesystem.

This is easily achieved by downloading

`the Adafruit library and driver bundle `_.

Installing from PyPI

====================

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from

PyPI `_. To install for current user:

.. code-block:: shell

    pip3 install adafruit-circuitpython-simpleio

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

.. code-block:: shell

    sudo pip3 install adafruit-circuitpython-simpleio

To install in a virtual environment in your current project:

.. code-block:: shell

    mkdir project-name && cd project-name

    python3 -m venv .venv

    source .venv/bin/activate

    pip3 install adafruit-circuitpython-simpleio

Usage Example

=============

See the examples in the `examples/` folder for usage.

Documentation

=============

API documentation for this library can be found on `Read the Docs `_.

For information on building library documentation, please check out `this guide `_.

Contributing

============

Contributions are welcome! Please read our `Code of Conduct

`_

before contributing to help this project stay welcoming.