README.rst

Introduction

Base Library for the Portal-style libraries. This library only contains base classes and is not intended to be run on its own.

Dependencies

This driver depends on:

• Adafruit CircuitPython
• Adafruit CircuitPython Bitmap Font
• Adafruit CircuitPython Connection Manager
• Adafruit CircuitPython Display Text
• Adafruit CircuitPython NeoPixel
• Adafruit CircuitPython Adafruit IO
• Adafruit CircuitPython MiniQR
• Adafruit CircuitPython Requests
• Adafruit CircuitPython Fake Requests
• Adafruit CircuitPython SimpleIO

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:

pip3 install adafruit-circuitpython-portalbase

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

sudo pip3 install adafruit-circuitpython-portalbase

To install in a virtual environment in your current project:

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

Documentation

API documentation for this library can be found on Read the Docs.

For information on building library documentation, please check out this guide.

Contributing

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