Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-asyncio/badge/?version=latest
:target: https://docs.circuitpython.org/projects/asyncio/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_asyncio/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_asyncio/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
Cooperative multitasking and asynchronous I/O
The code in this library is largely based on the
`MicroPython uasyncio implementation <https://github.com/micropython/micropython/tree/master/extmod/uasyncio>`_.
Dependencies
=============
This driver depends on:
* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
* `Ticks <https://github.com/adafruit/Adafruit_CircuitPython_Ticks>`_
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
=====================
This library is meant to be a subset of the ` ``asyncio`` module in CPython
<https://docs.python.org/3/library/asyncio.html>`_, and will not be made available on PyPI.
Use the CPython version instead.
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 asyncio
Or the following command to update an existing version:
.. code-block:: shell
circup update
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/asyncio/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_asyncio/blob/HEAD/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": "",
"name": "adafruit-circuitpython-asyncio",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "adafruit,blinka,circuitpython,micropython,asyncio,async",
"author": "",
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/b2/d4/9a79d421872e86310728eb13646816625bdc749a050f6c6d87042f536eef/adafruit-circuitpython-asyncio-1.3.1.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-asyncio/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/asyncio/en/latest/\n :alt: Documentation Status\n\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\n.. image:: https://github.com/adafruit/Adafruit_CircuitPython_asyncio/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_asyncio/actions\n :alt: Build Status\n\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\nCooperative multitasking and asynchronous I/O\n\nThe code in this library is largely based on the\n`MicroPython uasyncio implementation <https://github.com/micropython/micropython/tree/master/extmod/uasyncio>`_.\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\n* `Ticks <https://github.com/adafruit/Adafruit_CircuitPython_Ticks>`_\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>`_\nor individual libraries can be installed using\n`circup <https://github.com/adafruit/circup>`_.\n\n\nInstalling from PyPI\n=====================\nThis library is meant to be a subset of the ` ``asyncio`` module in CPython\n<https://docs.python.org/3/library/asyncio.html>`_, and will not be made available on PyPI.\nUse the CPython version instead.\n\n\nInstalling to a Connected CircuitPython Device with Circup\n==========================================================\n\nMake sure that you have ``circup`` installed in your Python environment.\nInstall it with the following command if necessary:\n\n.. code-block:: shell\n\n pip3 install circup\n\nWith ``circup`` installed and your CircuitPython device connected use the\nfollowing command to install:\n\n.. code-block:: shell\n\n circup install asyncio\n\nOr the following command to update an existing version:\n\n.. code-block:: shell\n\n circup update\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/asyncio/en/latest/>`_.\n\nFor information on building library documentation, please check out\n`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_asyncio/blob/HEAD/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Cooperative multitasking and asynchronous I/O",
"version": "1.3.1",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_asyncio.git"
},
"split_keywords": [
"adafruit",
"blinka",
"circuitpython",
"micropython",
"asyncio",
"async"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4bd2900a65380db76f016190d91dd30c0dbd18c20f1acc8936c19be6dbb95942",
"md5": "d8ee8d8a8c9dad027f299704a03a6833",
"sha256": "e0ff0930b4c604c986f268feb068449a613d8df0e964d624ec2a3b79047db853"
},
"downloads": -1,
"filename": "adafruit_circuitpython_asyncio-1.3.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d8ee8d8a8c9dad027f299704a03a6833",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 19143,
"upload_time": "2024-02-20T21:42:06",
"upload_time_iso_8601": "2024-02-20T21:42:06.375165Z",
"url": "https://files.pythonhosted.org/packages/4b/d2/900a65380db76f016190d91dd30c0dbd18c20f1acc8936c19be6dbb95942/adafruit_circuitpython_asyncio-1.3.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b2d49a79d421872e86310728eb13646816625bdc749a050f6c6d87042f536eef",
"md5": "438418f833e05a1b85f1e86b926e0007",
"sha256": "ec24197f939482e8149e460effac9f6840af25ff4352506e3b7120c214756cf2"
},
"downloads": -1,
"filename": "adafruit-circuitpython-asyncio-1.3.1.tar.gz",
"has_sig": false,
"md5_digest": "438418f833e05a1b85f1e86b926e0007",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 39490,
"upload_time": "2024-02-20T21:42:08",
"upload_time_iso_8601": "2024-02-20T21:42:08.269692Z",
"url": "https://files.pythonhosted.org/packages/b2/d4/9a79d421872e86310728eb13646816625bdc749a050f6c6d87042f536eef/adafruit-circuitpython-asyncio-1.3.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-20 21:42:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_asyncio",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "adafruit-circuitpython-asyncio"
}
JSON
