A bundle of useful CircuitPython libraries ready to use from the filesystem.
Clone or download
adafruit-adabot Automated update by Adabot (adafruit/adabot@44d3b57)
Updating https://github.com/adafruit/Adafruit_CircuitPython_DotStar to 1.4.0 from 1.3.0:
  > Merge pull request adafruit/Adafruit_CircuitPython_DotStar#31 from kattni/example-update
  > Merge pull request adafruit/Adafruit_CircuitPython_DotStar#30 from adafruit/pi_bitbang_exception
  > Merge pull request adafruit/Adafruit_CircuitPython_DotStar#28 from siddacious/master
  > ignore the board module imports in .pylintrc

Updating https://github.com/adafruit/Adafruit_CircuitPython_LSM303 to 1.2.1 from 1.2.0:
  > Merge pull request adafruit/Adafruit_CircuitPython_LSM303#7 from dastels/master
  > ignore the board module imports in .pylintrc
  > Merge pull request adafruit/Adafruit_CircuitPython_LSM303#6 from kattni/example-update
Latest commit 548859b Oct 16, 2018

README.md

Adafruit CircuitPython Library Bundle

Doc Status Gitter Discord

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

Use

To use the bundle download the zip (not source zip) from the latest release, unzip it and copy over the subfolders, such as lib, into the root of your CircuitPython device. Make sure to indicate that it should be merged with the existing folder when it exists.

Development

After you clone this repository you must run git submodule init and then git submodule update.

Updating libraries

To update the libraries run update-submodules.sh. The script will fetch the latest code and update to the newest tag (not master).

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

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

Adding a library

Determine the best location within libraries (libraries/drivers/ or libraries/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 as adafruit-circuitpython to simplify the listing.

Removing a library

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

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

Building the bundle

To build this bundle locally you'll need to install the circuitpython-build-tools <https://github.com/adafruit/circuitpython-build-tools>_ package.

python3 -m venv .env
source .env/bin/activate
pip install circuitpython-build-tools

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

source .env/bin/activate

Then run the build:

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