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.
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.
After you clone this repository you must run git submodule init
and then git submodule update.
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"
Determine the best location within libraries for the new library and then run:
git submodule add <git url> libraries/<target directory>
The target directory should omit any MicroPython or CircuitPython specific
prefixes such as adafruit-micropython 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 the bundle run build-bundles.py it requires Python 3.5+ and will
produce a zip file in build. The file structure of the zip will not be
identical to the source libraries directory in order to save space. Libraries
with a single source will not be placed in their own directory.
Note that adafruit/circuitpython is one of the submodules that is included.
It is used to build mpy-cross to compile the .py files to .mpy.
It is updated to the latest available tag when you run update-submodules.sh.
If you don't want to use the latest tagged version, make sure you checkout
an appropriate branch or tag of circuitpython to match the bundle version
you want to build.