tannewt / adafruit_circuitpython_ssd1325

DisplayIO driver for grayscale OLEDs driven by SSD1325

Introduction

DisplayIO driver for grayscale OLEDs drive by SSD1325

Dependencies

This driver depends on:

• Adafruit CircuitPython

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

Note

This library is not available on PyPI yet. Install documentation is included as a standard element. Stay tuned for PyPI availability!

Remove the above note if PyPI version is/will be available at time of release. If the library is not planned for PyPI, remove the entire 'Installing from PyPI' section.

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally from PyPI. To install for current user:

pip3 install adafruit-circuitpython-ssd1325

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

sudo pip3 install adafruit-circuitpython-ssd1325

To install in a virtual environment in your current project:

mkdir project-name && cd project-name
python3 -m venv .env
source .env/bin/activate
pip3 install adafruit-circuitpython-ssd1325

Usage Example

Add a quick, simple example. It and other examples should live in the examples folder and be included in docs/examples.rst.

Contributing

Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.

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):

python3 -m venv .env
source .env/bin/activate
pip install Sphinx sphinx-rtd-theme

Now, once you have the virtual environment activated:

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.