diff --git a/README.rst b/README.rst index c6c8a03..5d58b31 100644 --- a/README.rst +++ b/README.rst @@ -28,6 +28,30 @@ Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading `the Adafruit library and driver bundle `_. +Installing from PyPI +-------------------- +On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from +PyPI `_. To install for current user: + +.. code-block:: shell + + pip3 install adafruit-circuitpython-pca9685 + +To install system-wide (this may be required in some cases): + +.. code-block:: shell + + sudo pip3 install adafruit-circuitpython-pca9685 + +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-pca9685 + Usage Example ============= @@ -85,4 +109,4 @@ Now, once you have the virtual environment activated: 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. \ No newline at end of file +locally verify it will pass. diff --git a/docs/examples.rst b/docs/examples.rst index 2fec63d..7623aae 100644 --- a/docs/examples.rst +++ b/docs/examples.rst @@ -7,10 +7,10 @@ Ensure your device works with this simple test. :caption: examples/pca9685_simpletest.py :linenos: -.. literalinclude:: ../examples/calibration.py - :caption: examples/calibration.py +.. literalinclude:: ../examples/pca9685_calibration.py + :caption: examples/pca9685_calibration.py :linenos: -.. literalinclude:: ../examples/servo.py - :caption: examples/servo.py - :linenos: \ No newline at end of file +.. literalinclude:: ../examples/pca9685_servo.py + :caption: examples/pca9685_servo.py + :linenos: diff --git a/examples/calibration.py b/examples/pca9685_calibration.py similarity index 100% rename from examples/calibration.py rename to examples/pca9685_calibration.py diff --git a/examples/servo.py b/examples/pca9685_servo.py similarity index 100% rename from examples/servo.py rename to examples/pca9685_servo.py diff --git a/setup.py b/setup.py index 050578f..12942f7 100644 --- a/setup.py +++ b/setup.py @@ -34,7 +34,7 @@ author='Radomir Dopieralski & Adafruit Industries', author_email='circuitpython@adafruit.com', - install_requires=['adafruit-circuitpython-busdevice', 'adafruit-circuitpython-register'], + install_requires=['Adafruit-Blinka', 'adafruit-circuitpython-busdevice', 'adafruit-circuitpython-register'], # Choose your license license='MIT',