README.rst

   1 Introduction
   2 ============
   3
   4 .. image:: https://readthedocs.org/projects/adafruit-micropython-blinka/badge/?version=latest
   5     :target: https://circuitpython.readthedocs.io/projects/blinka/en/latest/
   6     :alt: Documentation Status
   7
   8 .. image:: https://img.shields.io/discord/327254708534116352.svg
   9     :target: https://adafru.it/discord
  10     :alt: Discord
  11
  12 .. image:: https://travis-ci.com/adafruit/Adafruit_Blinka.svg?branch=master
  13     :target: https://travis-ci.com/adafruit/Adafruit_Blinka
  14     :alt: Build Status
  15
  16 .. image:: https://img.shields.io/badge/code%20style-black-000000.svg
  17     :target: https://github.com/psf/black
  18     :alt: Code Style: Black
  19
  20 This repository contains a selection of packages emulating the CircuitPython API
  21 for devices or hosts running CPython or MicroPython. Working code exists to emulate these CircuitPython packages:
  22
  23 * **analogio** - analog input/output pins, using pin identities from board+microcontroller packages
  24 * **bitbangio** - software-driven interfaces for I2C, SPI
  25 * **board** - breakout-specific pin identities
  26 * **busio** - hardware-driven interfaces for I2C, SPI, UART
  27 * **digitalio** - digital input/output pins, using pin identities from board+microcontroller packages
  28 * **microcontroller** - chip-specific pin identities
  29 * **micropython** - MicroPython-specific module
  30 * **neopixel_write** - low-level interface to NeoPixels
  31 * **pulseio** - contains classes that provide access to basic pulse IO (PWM)
  32 * **pwmio** - contains classes that provide access to basic pulse IO (PWM)
  33
  34 For details, see the `Blinka API reference
  35 <https://circuitpython.readthedocs.io/projects/blinka/en/latest/index.html>`_.
  36
  37 Dependencies
  38 =============
  39
  40 The emulation described above is intended to provide a
  41 CircuitPython-like API for devices which are running CPython or
  42 Micropython. Since corresponding packages should be built-in to any
  43 standard CircuitPython image, they have no value on a device already
  44 running CircuitPython and would likely conflict in unhappy ways.
  45
  46 The test suites in the test/src folder under **testing.universal** are by design
  47 intended to run on *either* CircuitPython *or* CPython/Micropython+compatibility layer to prove conformance.
  48
  49 Installing from PyPI
  50 =====================
  51
  52 On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
  53 PyPI <https://pypi.org/project/Adafruit-Blinka/>`_. To install for current user:
  54
  55 .. code-block:: shell
  56
  57     pip3 install Adafruit-Blinka
  58
  59 To install system-wide (this may be required in some cases):
  60
  61 .. code-block:: shell
  62
  63     sudo pip3 install Adafruit-Blinka
  64
  65 To install in a virtual environment in your current project:
  66
  67 .. code-block:: shell
  68
  69     mkdir project-name && cd project-name
  70     python3 -m venv .env
  71     source .env/bin/activate
  72     pip3 install Adafruit-Blinka
  73
  74 Usage Example
  75 =============
  76
  77 At the time of writing (`git:7fc1f8ab <https://github.com/cefn/Adafruit_Micropython_Blinka/tree/7fc1f8ab477124628a5afebbf6826005955805f9>`_),
  78 the following sequence runs through some basic testing of the digitalio compatibility layer...
  79
  80 .. code-block:: python
  81
  82     from testing import test_module_name
  83     test_module_name("testing.universal.digitalio")
  84
  85 An example log from running the suites is `here <https://github.com/cefn/Adafruit_Micropython_Blinka/issues/2#issuecomment-366713394>`_ .
  86
  87 Contributing
  88 ============
  89
  90 Contributions are welcome! Please read our `Code of Conduct
  91 <https://github.com/adafruit/Adafruit_Blinka/blob/master/CODE_OF_CONDUCT.md>`_
  92 before contributing to help this project stay welcoming.
  93
  94 Building locally
  95 ================
  96
  97 Sphinx documentation
  98 -----------------------
  99
 100 Sphinx is used to build the documentation based on rST files and comments in the code. First,
 101 install dependencies (feel free to reuse the virtual environment from above):
 102
 103 .. code-block:: shell
 104
 105     python3 -m venv .env
 106     source .env/bin/activate
 107     pip install Sphinx sphinx-rtd-theme Adafruit-PlatformDetect
 108
 109 Now, once you have the virtual environment activated:
 110
 111 .. code-block:: shell
 112
 113     cd docs
 114     sphinx-build -E -W -b html . _build/html
 115
 116 This will output the documentation to ``docs/_build/html``. Open the index.html in your browser to
 117 view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to
 118 locally verify it will pass.