Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-micropython-blinka/badge/?version=latest
:target: https://circuitpython.readthedocs.io/projects/blinka/en/latest/
:alt: Documentation Status
.. image:: https://img.shields.io/discord/327254708534116352.svg
:target: https://adafru.it/discord
:alt: Discord
.. image:: https://travis-ci.com/adafruit/Adafruit_Blinka.svg?branch=master
:target: https://travis-ci.com/adafruit/Adafruit_Blinka
:alt: Build Status
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
:alt: Code Style: Black
This repository contains a selection of packages emulating the CircuitPython API
for devices or hosts running CPython or MicroPython. Working code exists to emulate these CircuitPython packages:
* **analogio** - analog input/output pins, using pin identities from board+microcontroller packages
* **bitbangio** - software-driven interfaces for I2C, SPI
* **board** - breakout-specific pin identities
* **busio** - hardware-driven interfaces for I2C, SPI, UART
* **digitalio** - digital input/output pins, using pin identities from board+microcontroller packages
* **keypad** - support for scanning keys and key matrices
* **microcontroller** - chip-specific pin identities
* **micropython** - MicroPython-specific module
* **neopixel_write** - low-level interface to NeoPixels
* **pulseio** - contains classes that provide access to basic pulse IO (PWM)
* **pwmio** - contains classes that provide access to basic pulse IO (PWM)
* **rainbowio** - provides the colorwheel() function
* **usb_hid** - act as a hid-device using usb_gadget kernel driver
For details, see the `Blinka API reference
<https://circuitpython.readthedocs.io/projects/blinka/en/latest/index.html>`_.
Dependencies
=============
The emulation described above is intended to provide a
CircuitPython-like API for devices which are running CPython or
Micropython. Since corresponding packages should be built-in to any
standard CircuitPython image, they have no value on a device already
running CircuitPython and would likely conflict in unhappy ways.
The test suites in the test/src folder under **testing.universal** are by design
intended to run on *either* CircuitPython *or* CPython/Micropython+compatibility layer to prove conformance.
Installing from PyPI
=====================
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI <https://pypi.org/project/quax-Blinka/>`_. To install for current user:
.. code-block:: shell
pip3 install quax-Blinka
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install quax-Blinka
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 quax-Blinka
Usage Example
=============
The pin names may vary by board, so you may need to change the pin names in the code. This
example runs on the Raspberry Pi boards to blink an LED connected to GPIO 18 (Pin 12):
.. code-block:: python
import time
import board
import digitalio
PIN = board.D18
print("hello blinky!")
led = digitalio.DigitalInOut(PIN)
led.direction = digitalio.Direction.OUTPUT
while True:
led.value = True
time.sleep(0.5)
led.value = False
time.sleep(0.5)
Contributing
============
Contributions are welcome! Please read our `Code of Conduct
<https://github.com/adafruit/Adafruit_Blinka/blob/master/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Building locally
================
Sphinx documentation
-----------------------
Sphinx is used to build the documentation based on rST files and comments in the code. First,
install dependencies (feel free to reuse the virtual environment from above):
.. code-block:: shell
python3 -m venv .env
source .env/bin/activate
pip install Sphinx sphinx-rtd-theme Adafruit-PlatformDetect
Now, once you have the virtual environment activated:
.. code-block:: shell
cd docs
sphinx-build -E -W -b html . _build/html
This will output the documentation to ``docs/_build/html``. Open the index.html in your browser to
view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to
locally verify it will pass.
Raw data
{
"_id": null,
"home_page": "https://github.com/quaxalber/Adafruit_Blinka",
"name": "quax-Blinka",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7.0",
"maintainer_email": "",
"keywords": "",
"author": "Adafruit Industries",
"author_email": "circuitpython@adafruit.com",
"download_url": "https://files.pythonhosted.org/packages/2e/f7/3b204f18d30f126b7a810002ac1f2c1a5c0dc76d4d1accb7ada2acaa245a/quax-Blinka-8.27.0.post2.tar.gz",
"platform": null,
"description": "\nIntroduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-micropython-blinka/badge/?version=latest\n :target: https://circuitpython.readthedocs.io/projects/blinka/en/latest/\n :alt: Documentation Status\n\n.. image:: https://img.shields.io/discord/327254708534116352.svg\n :target: https://adafru.it/discord\n :alt: Discord\n\n.. image:: https://travis-ci.com/adafruit/Adafruit_Blinka.svg?branch=master\n :target: https://travis-ci.com/adafruit/Adafruit_Blinka\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\nThis repository contains a selection of packages emulating the CircuitPython API\nfor devices or hosts running CPython or MicroPython. Working code exists to emulate these CircuitPython packages:\n\n* **analogio** - analog input/output pins, using pin identities from board+microcontroller packages\n* **bitbangio** - software-driven interfaces for I2C, SPI\n* **board** - breakout-specific pin identities\n* **busio** - hardware-driven interfaces for I2C, SPI, UART\n* **digitalio** - digital input/output pins, using pin identities from board+microcontroller packages\n* **keypad** - support for scanning keys and key matrices\n* **microcontroller** - chip-specific pin identities\n* **micropython** - MicroPython-specific module\n* **neopixel_write** - low-level interface to NeoPixels\n* **pulseio** - contains classes that provide access to basic pulse IO (PWM)\n* **pwmio** - contains classes that provide access to basic pulse IO (PWM)\n* **rainbowio** - provides the colorwheel() function\n* **usb_hid** - act as a hid-device using usb_gadget kernel driver\n\nFor details, see the `Blinka API reference\n<https://circuitpython.readthedocs.io/projects/blinka/en/latest/index.html>`_.\n\nDependencies\n=============\n\nThe emulation described above is intended to provide a\nCircuitPython-like API for devices which are running CPython or\nMicropython. Since corresponding packages should be built-in to any\nstandard CircuitPython image, they have no value on a device already\nrunning CircuitPython and would likely conflict in unhappy ways.\n\nThe test suites in the test/src folder under **testing.universal** are by design\nintended to run on *either* CircuitPython *or* CPython/Micropython+compatibility layer to prove conformance.\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/quax-Blinka/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install quax-Blinka\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install quax-Blinka\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 .env\n source .env/bin/activate\n pip3 install quax-Blinka\n\nUsage Example\n=============\n\nThe pin names may vary by board, so you may need to change the pin names in the code. This\nexample runs on the Raspberry Pi boards to blink an LED connected to GPIO 18 (Pin 12):\n\n.. code-block:: python\n\n import time\n import board\n import digitalio\n\n PIN = board.D18\n\n print(\"hello blinky!\")\n\n led = digitalio.DigitalInOut(PIN)\n led.direction = digitalio.Direction.OUTPUT\n\n while True:\n led.value = True\n time.sleep(0.5)\n led.value = False\n time.sleep(0.5)\n\nContributing\n============\n\nContributions are welcome! Please read our `Code of Conduct\n<https://github.com/adafruit/Adafruit_Blinka/blob/master/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n\nBuilding locally\n================\n\nSphinx documentation\n-----------------------\n\nSphinx is used to build the documentation based on rST files and comments in the code. First,\ninstall dependencies (feel free to reuse the virtual environment from above):\n\n.. code-block:: shell\n\n python3 -m venv .env\n source .env/bin/activate\n pip install Sphinx sphinx-rtd-theme Adafruit-PlatformDetect\n\nNow, once you have the virtual environment activated:\n\n.. code-block:: shell\n\n cd docs\n sphinx-build -E -W -b html . _build/html\n\nThis will output the documentation to ``docs/_build/html``. Open the index.html in your browser to\nview them. It will also (due to -W) error out on any warning like Travis will. This is a good way to\nlocally verify it will pass.\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CircuitPython APIs for non-CircuitPython versions of Python such as CPython on Linux and MicroPython.",
"version": "8.27.0.post2",
"project_urls": {
"Homepage": "https://github.com/quaxalber/Adafruit_Blinka"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a8c28527cc931b737b8afb7f0fba400363c2a6486d78a66ab0ea5dd16347ea16",
"md5": "7f1d6dad4976e808382c7d806942c3c6",
"sha256": "1a7be5f5ed609fbdd7138d8a178324a3328453b16234792dd073f9e6fe11ebbf"
},
"downloads": -1,
"filename": "quax_Blinka-8.27.0.post2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7f1d6dad4976e808382c7d806942c3c6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7.0",
"size": 296453,
"upload_time": "2023-12-15T18:12:25",
"upload_time_iso_8601": "2023-12-15T18:12:25.737034Z",
"url": "https://files.pythonhosted.org/packages/a8/c2/8527cc931b737b8afb7f0fba400363c2a6486d78a66ab0ea5dd16347ea16/quax_Blinka-8.27.0.post2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2ef73b204f18d30f126b7a810002ac1f2c1a5c0dc76d4d1accb7ada2acaa245a",
"md5": "f08b56b2b4e8ebfe892ca7bfeda72d05",
"sha256": "76200c002f63b361bf274eb5ad58c5ba0980d211b697edea4e08ba8920f58f97"
},
"downloads": -1,
"filename": "quax-Blinka-8.27.0.post2.tar.gz",
"has_sig": false,
"md5_digest": "f08b56b2b4e8ebfe892ca7bfeda72d05",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7.0",
"size": 176888,
"upload_time": "2023-12-15T18:12:27",
"upload_time_iso_8601": "2023-12-15T18:12:27.228876Z",
"url": "https://files.pythonhosted.org/packages/2e/f7/3b204f18d30f126b7a810002ac1f2c1a5c0dc76d4d1accb7ada2acaa245a/quax-Blinka-8.27.0.post2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-15 18:12:27",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "quaxalber",
"github_project": "Adafruit_Blinka",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "quax-blinka"
}
JSON
