circuitpython-build-tools 1.20.1

CircuitPython library build tools

Adafruit CircuitPython Build Tools

This repo contains build scripts used to build the Adafruit CircuitPython bundle, CircuitPython Community bundle and individual library release zips. Its focused on Github Actions support but will also work locally when a gcc compiler is present.

The scripts will either fetch a pre-built mpy-cross from s3 or automatically clone the CircuitPython repo and attempt to build mpy-cross. You'll need some version of gcc for this to work.

Setting up libraries

These build tools automatically build .mpy files and zip them up for CircuitPython when a new tagged release is created. To add support to a repo you need to use the CircuitPython cookiecutter to generate .github/workflows/*.yml.

The bundle build will produce one zip file for every major CircuitPython release supported containing compatible mpy files and a zip with human readable py files. It'll also "release" a z-build_tools_version-x.x.x.ignore file that will be used to determine when a library needs new release files because the build tools themselves changed, such as when a new major CircuitPython release happens.

Building libraries locally

To build libraries built with the build tools you'll need to install the circuitpython-build-tools package.

python3 -m venv .env
source .env/bin/activate
pip install circuitpython-build-tools
circuitpython-build-bundles --filename_prefix <output file prefix> --library_location .

When making changes to circuitpython-build-tools itself, you can test your changes locally like so:

cd circuitpython-build-tools # this will be specific to your storage location
python3 -m venv .env
source .env/bin/activate
pip install -e .  # '-e' is pip's "development" install feature
circuitpython-build-bundles --filename_prefix <output file prefix> --library_location <library location> --library_depth 2

Contributing

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