Metadata-Version: 2.0
Name: adafruit-circuitpython-motorkit
Version: 1.1.2
Summary: CircuitPython helper library for DC & Stepper Motor FeatherWing, Shield, and Pi Hat kits.
Home-page: https://github.com/adafruit/Adafruit_CircuitPython_MotorKit
Author: Adafruit Industries
Author-email: circuitpython@adafruit.com
License: MIT
Keywords: adafruit motor pca9685 featherwing pi shield motorkit kit i2c hardware micropython circuitpython
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: System :: Hardware
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Description-Content-Type: text/x-rst
Requires-Dist: Adafruit-Blinka
Requires-Dist: adafruit-circuitpython-busdevice
Requires-Dist: adafruit-circuitpython-motor
Requires-Dist: adafruit-circuitpython-pca9685
Requires-Dist: adafruit-circuitpython-register

Introduction
============

.. image:: https://readthedocs.org/projects/adafruit-circuitpython-motorkit/badge/?version=latest
    :target: https://circuitpython.readthedocs.io/projects/motorkit/en/latest/
    :alt: Documentation Status

.. image:: https://img.shields.io/discord/327254708534116352.svg
    :target: https://discord.gg/nBQh6qu
    :alt: Discord

.. image:: https://travis-ci.com/adafruit/Adafruit_CircuitPython_MotorKit.svg?branch=master
    :target: https://travis-ci.com/adafruit/Adafruit_CircuitPython_MotorKit
    :alt: Build Status

CircuitPython helper library for the DC & Stepper Motor FeatherWing, Shield and Pi Hat kits.

Dependencies
=============
This driver depends on:

* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
* `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_
* `Register <https://github.com/adafruit/Adafruit_CircuitPython_Register>`_
* `PCA9685 <https://github.com/adafruit/Adafruit_CircuitPython_PCA9685>`_
* `Motor <https://github.com/adafruit/Adafruit_CircuitPython_Motor>`_

Please ensure all dependencies are available on the CircuitPython filesystem.
This is easily achieved by downloading
`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.

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-motorkit/>`_. To install for current user:

.. code-block:: shell

    pip3 install adafruit-circuitpython-motorkit

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

.. code-block:: shell

    sudo pip3 install adafruit-circuitpython-motorkit

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 adafruit-circuitpython-motorkit

Usage Example
=============

DC motor example:

.. code-block:: python

    import time
    from adafruit_motorkit import MotorKit

    kit = MotorKit()

    kit.motor1.throttle = 1.0
    time.sleep(0.5)
    kit.motor1.throttle = 0

Stepper motor example:

.. code-block:: python

    import time
    from adafruit_motorkit import MotorKit

    kit = MotorKit()

    for i in range(100):
        kit.stepper1.onestep()

Contributing
============

Contributions are welcome! Please read our `Code of Conduct
<https://github.com/adafruit/Adafruit_CircuitPython_MotorKit/blob/master/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.

Building locally
================

Zip release files
-----------------

To build this library locally you'll need to install the
`circuitpython-build-tools <https://github.com/adafruit/circuitpython-build-tools>`_ package.

.. code-block:: shell

    python3 -m venv .env
    source .env/bin/activate
    pip install circuitpython-build-tools

Once installed, make sure you are in the virtual environment:

.. code-block:: shell

    source .env/bin/activate

Then run the build:

.. code-block:: shell

    circuitpython-build-bundles --filename_prefix adafruit-circuitpython-motorkit --library_location .

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

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.


