diff --git a/README.rst b/README.rst index a85e0ab..6e0b11f 100644 --- a/README.rst +++ b/README.rst @@ -39,6 +39,31 @@ libraries. Please ensure they are also available on the CircuitPython filesystem This is easily achieved by downloading `a 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-pcf8523 + +To install system-wide (this may be required in some cases): + +.. code-block:: shell + + sudo pip3 install adafruit-circuitpython-pcf8523 + +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-pcf8523 + + Usage Notes =========== @@ -115,3 +140,61 @@ After the RTC is set, you retrieve the alarm status by reading the if rtc.alarm_status: print("wake up!") rtc.alarm_status = False + +Contributing +============ + +Contributions are welcome! Please read our `Code of Conduct +`_ +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 `_ 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-pcf8523 --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. + diff --git a/docs/examples.rst b/docs/examples.rst index 1958898..0c1e7dd 100644 --- a/docs/examples.rst +++ b/docs/examples.rst @@ -1,6 +1,6 @@ Demo ---- -.. literalinclude:: ../examples/demo.py - :caption: examples/demo.py +.. literalinclude:: ../examples/pcf8523_simpletest.py + :caption: examples/pcf8523_simpletest.py :linenos: diff --git a/examples/demo.py b/examples/pcf8523_simpletest.py similarity index 100% rename from examples/demo.py rename to examples/pcf8523_simpletest.py diff --git a/setup.py b/setup.py index 139b554..290828a 100644 --- a/setup.py +++ b/setup.py @@ -34,7 +34,7 @@ author='Adafruit Industries', author_email='circuitpython@adafruit.com', - install_requires=['adafruit-circuitpython-register', 'adafruit-circuitpython-busdevice'], + install_requires=['Adafruit-Blinka', 'adafruit-circuitpython-register', 'adafruit-circuitpython-busdevice'], # Choose your license license='MIT',