adafruit-circuitpython-simpleio


Nameadafruit-circuitpython-simpleio JSON
Version 3.0.13 PyPI version JSON
download
home_page
SummaryCircuitPython helper library to simplify hardware interactions.
upload_time2023-12-09 17:54:02
maintainer
docs_urlNone
author
requires_python
licenseMIT
keywords adafruit simpleio servo map range bitwrite hardware micropython circuitpython
VCS
bugtrack_url
requirements Adafruit-Blinka
Travis-CI No Travis.
coveralls test coverage No coveralls.
            
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 <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
====================

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI <https://pypi.org/project/adafruit-circuitpython-simpleio/>`_. 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 <https://docs.circuitpython.org/projects/simpleio/en/latest/>`_.

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/adafruit/Adafruit_CircuitPython_SimpleIO/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "adafruit-circuitpython-simpleio",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "adafruit,simpleio,servo,map,range,bitwrite,hardware,micropython,circuitpython",
    "author": "",
    "author_email": "Adafruit Industries <circuitpython@adafruit.com>",
    "download_url": "https://files.pythonhosted.org/packages/dc/17/d624f01195965c8fbae0a24725e2304698805136ff41c137b13ce47b6d0d/adafruit-circuitpython-simpleio-3.0.13.tar.gz",
    "platform": null,
    "description": "\nIntroduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-simpleio/badge/?version=latest\n    :target: https://docs.circuitpython.org/projects/simpleio/en/latest/\n    :alt: Documentation Status\n\n.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg\n    :target: https://adafru.it/discord\n    :alt: Discord\n\n.. image:: https://github.com/adafruit/Adafruit_CircuitPython_SimpleIO/workflows/Build%20CI/badge.svg\n    :target: https://github.com/adafruit/Adafruit_CircuitPython_SimpleIO/actions/\n    :alt: Build Status\n\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\n    :target: https://github.com/psf/black\n    :alt: Code Style: Black\n\nSimpleIO features a number of helpers to simplify hardware interactions. Many\nof the functions and classes are inspired by Arduino APIs to make it easier to\nmove to CircuitPython from Arduino.\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\n\nPlease ensure all dependencies are available on the CircuitPython filesystem.\nThis is easily achieved by downloading\n`the Adafruit library and driver bundle <https://circuitpython.org/libraries>`_.\n\nInstalling from PyPI\n====================\n\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/adafruit-circuitpython-simpleio/>`_. To install for current user:\n\n.. code-block:: shell\n\n    pip3 install adafruit-circuitpython-simpleio\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n    sudo pip3 install adafruit-circuitpython-simpleio\n\nTo install in a virtual environment in your current project:\n\n.. code-block:: shell\n\n    mkdir project-name && cd project-name\n    python3 -m venv .venv\n    source .venv/bin/activate\n    pip3 install adafruit-circuitpython-simpleio\n\nUsage Example\n=============\n\nSee the examples in the `examples/` folder for usage.\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/simpleio/en/latest/>`_.\n\nFor 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>`_.\n\nContributing\n============\n\nContributions are welcome! Please read our `Code of Conduct\n<https://github.com/adafruit/Adafruit_CircuitPython_SimpleIO/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "CircuitPython helper library to simplify hardware interactions.",
    "version": "3.0.13",
    "project_urls": {
        "Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_SimpleIO"
    },
    "split_keywords": [
        "adafruit",
        "simpleio",
        "servo",
        "map",
        "range",
        "bitwrite",
        "hardware",
        "micropython",
        "circuitpython"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "3808184f4435b13fb8f8ccd2cf63e50ff617c68f3ecccefb55c13882b40dfa76",
                "md5": "40acf76cb530121e946fe7d2bf6ee9e1",
                "sha256": "6337f009111f1c2b3796e3dfa7f81a21c069cf3c53b41fb99ee720a7695e0b6a"
            },
            "downloads": -1,
            "filename": "adafruit_circuitpython_simpleio-3.0.13-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "40acf76cb530121e946fe7d2bf6ee9e1",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 6201,
            "upload_time": "2023-12-09T17:53:59",
            "upload_time_iso_8601": "2023-12-09T17:53:59.430324Z",
            "url": "https://files.pythonhosted.org/packages/38/08/184f4435b13fb8f8ccd2cf63e50ff617c68f3ecccefb55c13882b40dfa76/adafruit_circuitpython_simpleio-3.0.13-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "dc17d624f01195965c8fbae0a24725e2304698805136ff41c137b13ce47b6d0d",
                "md5": "86e72f46cf12f4fe443a33203603d947",
                "sha256": "2fc2f53e4dbe8b30cc15f064aed539a9ae07f9c8846844f3b7dd2577e42a14a6"
            },
            "downloads": -1,
            "filename": "adafruit-circuitpython-simpleio-3.0.13.tar.gz",
            "has_sig": false,
            "md5_digest": "86e72f46cf12f4fe443a33203603d947",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 27364,
            "upload_time": "2023-12-09T17:54:02",
            "upload_time_iso_8601": "2023-12-09T17:54:02.330141Z",
            "url": "https://files.pythonhosted.org/packages/dc/17/d624f01195965c8fbae0a24725e2304698805136ff41c137b13ce47b6d0d/adafruit-circuitpython-simpleio-3.0.13.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-12-09 17:54:02",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "adafruit",
    "github_project": "Adafruit_CircuitPython_SimpleIO",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "Adafruit-Blinka",
            "specs": []
        }
    ],
    "lcname": "adafruit-circuitpython-simpleio"
}
        
Elapsed time: 0.14879s