Repository files navigation

This repo bundles a bunch of useful CircuitPython libraries into an easy todownload zip file. CircuitPython boards can ship with the contents of the zip tomake it easy to provide a lot of libraries by default.

To use the bundle download the zip (not source zip) from thelatest release,unzip it and copy over the subfolders, such aslib, into the root of yourCircuitPython device. Make sure to indicate that it should be merged with theexisting folder when it exists.

DO NOT use this to install libraries on a Linux computer, such as the Raspberry Pi,with regular Python (aka CPython). Instead, use the python3 version ofpip to installthe libraries you want to use. It will automatically install dependencies for you. For example:

pip3 install adafruit-circuitpython-lis3dh

After you clone this repository you must rungit submodule initand thengit submodule update.

For developing individual libraries, please see LIBRARY_DEVELOPMENT.rst.

To update the libraries runupdate-submodules.sh. The script will fetch thelatest code and update to the newest tag (not main).

To find libraries with commits that haven't been included in a release do:

git submodule foreach "git log --oneline HEAD...origin/main"

Determine the best location withinlibraries (libraries/drivers/ orlibraries/helpers/)for the new library and then run:

git submodule add <git url> libraries/<target directory>

The target directory should omit any CircuitPython specific prefixes such asadafruit-circuitpython to simplify the listing.

Only do this if you are replacing the module with an equivalent:

git submodule deinit libraries/<target directory>git rm libraries/<target directory>

To build this bundle locally you'll need to install thecircuitpython-build-tools package.

python3 -m venv .venvsource .venv/bin/activatepip install circuitpython-build-tools

Once installed, make sure you are in the virtual environment:

source .venv/bin/activate

Then run the build:

circuitpython-build-bundles --filename_prefix adafruit-circuitpython-bundle --library_location libraries --library_depth 2