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.
3 maintainers
Release files for circuitpython-build-tools 1.20.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| circuitpython_build_tools-1.20.1.tar.gz | 18.2 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| circuitpython_build_tools-1.20.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 32.8 kB
Release files / circuitpython_build_tools-1.20.1.tar.gz
| Download URL | circuitpython_build_tools-1.20.1.tar.gz |
|---|---|
| Size | 18.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a0f1d2a9adc965f3141b35017e5c4ad0ec530b7c406af08079642771f920b3a1
|
|
BLAKE2b-256 checksum How to use checksums |
3214700bbc52fc5d54d50d640882e2193b2f2f3a4bef371a86ef27336846c9d9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Mar 2, 2026.
Transparency logRelease files / circuitpython_build_tools-1.20.1-py3-none-any.whl
| Download URL | circuitpython_build_tools-1.20.1-py3-none-any.whl |
|---|---|
| Size | 14.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
9840189795aa172e98791fbcaf63c627cb324071e8b326fe2552cb1638c50577
|
|
BLAKE2b-256 checksum How to use checksums |
b969527519684128d516d0cdd05c52d88580b025846eab0324653931eb215b14
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Mar 2, 2026.
Transparency log
