..
SPDX-FileCopyrightText: 2022 Alec Delaney, for Adafruit Industries
SPDX-License-Identifier: MIT
circfirm
--------
.. image:: https://img.shields.io/pypi/pyversions/circfirm
:target: https://pypi.org/project/circfirm/
:alt: PyPI - Python Version
.. image:: https://readthedocs.org/projects/circfirm/badge/?version=latest
:target: https://circfirm.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
.. image:: https://img.shields.io/github/actions/workflow/status/tekktrik/circfirm/push.yml
:target: https://github.com/tekktrik/circfirm/actions
:alt: GitHub Actions Workflow Status
.. image:: https://codecov.io/gh/tekktrik/circfirm/graph/badge.svg?token=UM67L1VZZ1
:target: https://codecov.io/gh/tekktrik/circfirm
:alt: Codecov Report
.. image:: https://img.shields.io/pypi/wheel/circfirm
:target: https://pypi.org/project/circfirm/
:alt: PyPI - Wheel
.. image:: https://img.shields.io/pypi/dm/circfirm
:target: https://pypi.org/project/circfirm/
:alt: PyPI - Downloads
A CLI tool for updating the firmware for CircuitPython boards
Installation
============
The best way to install ``circfirm`` is by using `pipx <https://github.com/pypa/pipx>`_,
which creates an isolated virtual environment for the dependencies:
.. code-block:: shell
pipx install circfirm
You can also just use ``pip`` to install it, if the dependencies won't cause issues:
.. code-block:: shell
pip install circfirm
Example Usage
=============
The follow commands show some of the functionality of ``circfirm``:
.. code-block:: shell
# 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 --help
License
=======
This software is provided under an MIT license.
Raw data
{
"_id": null,
"home_page": null,
"name": "circfirm",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9.0",
"maintainer_email": null,
"keywords": "adafruit, circuitpython, tool, cli, firmware, install, upload",
"author": null,
"author_email": "Alec Delaney <tekktrik@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/e7/a5/e5bd795fba766f009ebdbcce0d4c5e00b390cc1a5eb8f5d23d3cf11159a0/circfirm-4.0.0.tar.gz",
"platform": null,
"description": "..\n SPDX-FileCopyrightText: 2022 Alec Delaney, for Adafruit Industries\n SPDX-License-Identifier: MIT\n\ncircfirm\n--------\n\n.. image:: https://img.shields.io/pypi/pyversions/circfirm\n :target: https://pypi.org/project/circfirm/\n :alt: PyPI - Python Version\n\n.. image:: https://readthedocs.org/projects/circfirm/badge/?version=latest\n :target: https://circfirm.readthedocs.io/en/latest/?badge=latest\n :alt: Documentation Status\n\n.. image:: https://img.shields.io/github/actions/workflow/status/tekktrik/circfirm/push.yml\n :target: https://github.com/tekktrik/circfirm/actions\n :alt: GitHub Actions Workflow Status\n\n.. image:: https://codecov.io/gh/tekktrik/circfirm/graph/badge.svg?token=UM67L1VZZ1\n :target: https://codecov.io/gh/tekktrik/circfirm\n :alt: Codecov Report\n\n.. image:: https://img.shields.io/pypi/wheel/circfirm\n :target: https://pypi.org/project/circfirm/\n :alt: PyPI - Wheel\n\n.. image:: https://img.shields.io/pypi/dm/circfirm\n :target: https://pypi.org/project/circfirm/\n :alt: PyPI - Downloads\n\nA CLI tool for updating the firmware for CircuitPython boards\n\nInstallation\n============\n\nThe best way to install ``circfirm`` is by using `pipx <https://github.com/pypa/pipx>`_,\nwhich creates an isolated virtual environment for the dependencies:\n\n.. code-block:: shell\n\n pipx install circfirm\n\nYou can also just use ``pip`` to install it, if the dependencies won't cause issues:\n\n.. code-block:: shell\n\n pip install circfirm\n\nExample Usage\n=============\n\nThe follow commands show some of the functionality of ``circfirm``:\n\n.. code-block:: shell\n\n # Install a version of CircuitPython to a connected board\n circfirm install 8.0.0\n\n # Install a version of CircuitPython in French to a connected board\n circfirm install 8.0.0 --language fr\n\n # List all the cached (previously downloaded) CircuitPython versions\n circfirm cache list\n\n # List all the cached CircuitPython versions for a speciic board\n circfirm cache list --board-id feather_m4_express\n\n # Save a version of CircuitPython to the cache\n # (You can also use the --language option here)\n circfirm cache save feather_m4_express 8.0.0\n\n # Clear the cached CircuitPython versions\n circfirm cache clear\n\n # You can use --board-id, --version, and --language options to further specify\n # what firmwares should be cleared - this clears version 7.0.0 firmwares for\n # all boards and in all languages\n circfirm cache clear --version 7.0.0\n\n # See help/information about circfirm or any specific command using --help\n circfirm --help\n circfirm install --help\n circfirm cache save --help\n\nLicense\n=======\n\nThis software is provided under an MIT license.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CLI tool for install firmware for CircuitPython boards",
"version": "4.0.0",
"project_urls": {
"Homepage": "https://github.com/tekktrik/circfirm",
"Issues": "https://github.com/tekktrik/circfirm/issues",
"Repository": "https://github.com/tekktrik/circfirm.git"
},
"split_keywords": [
"adafruit",
" circuitpython",
" tool",
" cli",
" firmware",
" install",
" upload"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0d4f20bc2c55e0d2b95ae38aab937ead7a19f398dc6c5af0d5a991329e0b339c",
"md5": "70c3701a6ab26f3ce4a4730bfee90a17",
"sha256": "cdd7736b8affc99506bef15459cb35dcae11de6e1e54ada7195decea4209312e"
},
"downloads": -1,
"filename": "circfirm-4.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "70c3701a6ab26f3ce4a4730bfee90a17",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9.0",
"size": 22898,
"upload_time": "2025-01-15T14:59:19",
"upload_time_iso_8601": "2025-01-15T14:59:19.411401Z",
"url": "https://files.pythonhosted.org/packages/0d/4f/20bc2c55e0d2b95ae38aab937ead7a19f398dc6c5af0d5a991329e0b339c/circfirm-4.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e7a5e5bd795fba766f009ebdbcce0d4c5e00b390cc1a5eb8f5d23d3cf11159a0",
"md5": "71c32749e10e77cb78df22bac5278c71",
"sha256": "48dc0d3bd7d7f68fe4e9a82d77869927e4ef6d4ef56d80be6120fc3a575e8ae9"
},
"downloads": -1,
"filename": "circfirm-4.0.0.tar.gz",
"has_sig": false,
"md5_digest": "71c32749e10e77cb78df22bac5278c71",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9.0",
"size": 8070281,
"upload_time": "2025-01-15T14:59:22",
"upload_time_iso_8601": "2025-01-15T14:59:22.571384Z",
"url": "https://files.pythonhosted.org/packages/e7/a5/e5bd795fba766f009ebdbcce0d4c5e00b390cc1a5eb8f5d23d3cf11159a0/circfirm-4.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-15 14:59:22",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "tekktrik",
"github_project": "circfirm",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "boto3",
"specs": [
[
"~=",
"1.35"
]
]
},
{
"name": "click",
"specs": [
[
"~=",
"8.1"
]
]
},
{
"name": "click-spinner",
"specs": [
[
"~=",
"0.1"
]
]
},
{
"name": "packaging",
"specs": [
[
"~=",
"24.2"
]
]
},
{
"name": "psutil",
"specs": [
[
"~=",
"6.1"
]
]
},
{
"name": "pyyaml",
"specs": [
[
"~=",
"6.0"
]
]
},
{
"name": "requests",
"specs": [
[
"~=",
"2.32"
]
]
},
{
"name": "boto3-stubs",
"specs": [
[
"~=",
"1.35"
]
]
}
],
"lcname": "circfirm"
}
JSON
