Introduction ============ .. image:: https://readthedocs.org/projects/adafruit-circuitpython-max31865/badge/?version=latest :target: https://circuitpython.readthedocs.io/projects/max31865/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_MAX31865.svg?branch=master :target: https://travis-ci.com/adafruit/Adafruit_CircuitPython_MAX31865 :alt: Build Status CircuitPython module for the MAX31865 thermocouple amplifier. Dependencies ============= This driver depends on: * `Adafruit CircuitPython `_ * `Bus Device `_ 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-max31865 To install system-wide (this may be required in some cases): .. code-block:: shell sudo pip3 install adafruit-circuitpython-max31865 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-max31865 Usage Example ============= See examples/max31865_simpletest.py for a demo of the usage. Contributing ============ Contributions are welcome! Please read our `Code of Conduct `_ before contributing to help this project stay welcoming. Building locally ================ 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-max31865 --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.