A CLI tool for updating the firmware for CircuitPython boards
Installation
The best way to install circfirm is by using pipx, which creates an isolated virtual environment for the dependencies:
pipx install circfirmYou can also just use pip to install it, if the dependencies won’t cause issues:
pip install circfirmExample Usage
The follow commands show some of the functionality of circfirm:
# Install a version of CircuitPython to a connected board
circfirm install 8.0.0
# Install a version of CircuitPython in French to a connected board
circfirm install 8.0.0 --language fr
# List all the cached (previously downloaded) CircuitPython versions
circfirm cache list
# List all the cached CircuitPython versions for a speciic board
circfirm cache list --board-id feather_m4_express
# Save a version of CircuitPython to the cache
# (You can also use the --language option here)
circfirm cache save feather_m4_express 8.0.0
# Clear the cached CircuitPython versions
circfirm cache clear
# You can use --board-id, --version, and --language options to further specify
# what firmwares should be cleared - this clears version 7.0.0 firmwares for
# all boards and in all languages
circfirm cache clear --version 7.0.0
# See help/information about circfirm or any specific command using --help
circfirm --help
circfirm install --help
circfirm cache save --helpDocumentation
Documentation for circfirm can be found here
License
This software is provided under an MIT license.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file circfirm-5.2.5.tar.gz.
File metadata
- Download URL: circfirm-5.2.5.tar.gz
- Upload date:
- Size: 8.1 MB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
2d1ccd153b4f05c259f3f3e2d044fa0860d023e6b6d2f535d495f99e2ab2ef3f
|
|
| MD5 |
58cd63a1370ff171a83cbd63146adf00
|
|
| BLAKE2b-256 |
fab6a29fdffe3d1a00376f89cf753e5b585e4d96079d36b0f1a61944db5f7fde
|
Provenance
The following attestation bundles were made for circfirm-5.2.5.tar.gz:
Publisher:
publish.yml on tekktrik/circfirm
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
circfirm-5.2.5.tar.gz -
Subject digest:
2d1ccd153b4f05c259f3f3e2d044fa0860d023e6b6d2f535d495f99e2ab2ef3f - Sigstore transparency entry: 2505479687
- Sigstore integration time:
-
Permalink:
tekktrik/circfirm@f6bace50a9a042511755576f52688377005155fb -
Branch / Tag:
refs/tags/5.2.5 - Owner: https://github.com/tekktrik
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@f6bace50a9a042511755576f52688377005155fb -
Trigger Event:
release
-
Statement type:
File details
Details for the file circfirm-5.2.5-py3-none-any.whl.
File metadata
- Download URL: circfirm-5.2.5-py3-none-any.whl
- Upload date:
- Size: 23.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6e1a56f563d3f97c2ad037b3a9958223c52c20e9a8d91d18a14f3dd58ec2642a
|
|
| MD5 |
148678ea8ca9926a18994ee596ba5fca
|
|
| BLAKE2b-256 |
8934ba8dc46ea71aa075ede953e48d67b5769e521114af9c52b25e4eae00abce
|
Provenance
The following attestation bundles were made for circfirm-5.2.5-py3-none-any.whl:
Publisher:
publish.yml on tekktrik/circfirm
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
circfirm-5.2.5-py3-none-any.whl -
Subject digest:
6e1a56f563d3f97c2ad037b3a9958223c52c20e9a8d91d18a14f3dd58ec2642a - Sigstore transparency entry: 2505480624
- Sigstore integration time:
-
Permalink:
tekktrik/circfirm@f6bace50a9a042511755576f52688377005155fb -
Branch / Tag:
refs/tags/5.2.5 - Owner: https://github.com/tekktrik
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@f6bace50a9a042511755576f52688377005155fb -
Trigger Event:
release
-
Statement type:
