..
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": "",
"name": "circfirm",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8.0",
"maintainer_email": "",
"keywords": "adafruit,circuitpython,tool,cli,firmware,install,upload",
"author": "",
"author_email": "Alec Delaney <tekktrik@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/56/4e/e9a3d88089d2b6445b3846e54abbf004ccde1d81b6805da1169547c5ffe1/circfirm-3.1.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": "3.1.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": "7948acb9db8bf1702965bc4896564ce07c3b0ec7b21f21353d5f0d9bf54c1721",
"md5": "c60b91a330b7d238252508a2764e4f80",
"sha256": "0ee07b8a4e36a1a47cebe3cbcbe67de9cf6dba46edba1d06612e9c16fc658c62"
},
"downloads": -1,
"filename": "circfirm-3.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c60b91a330b7d238252508a2764e4f80",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8.0",
"size": 22100,
"upload_time": "2024-03-17T17:49:21",
"upload_time_iso_8601": "2024-03-17T17:49:21.137033Z",
"url": "https://files.pythonhosted.org/packages/79/48/acb9db8bf1702965bc4896564ce07c3b0ec7b21f21353d5f0d9bf54c1721/circfirm-3.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "564ee9a3d88089d2b6445b3846e54abbf004ccde1d81b6805da1169547c5ffe1",
"md5": "5ac50d1a4e417c475b8e7f29b14c745e",
"sha256": "23f3b9ebef19a5b017580d821bb92b110cd4fdabe096f29a30bc9ad095195096"
},
"downloads": -1,
"filename": "circfirm-3.1.0.tar.gz",
"has_sig": false,
"md5_digest": "5ac50d1a4e417c475b8e7f29b14c745e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8.0",
"size": 8069110,
"upload_time": "2024-03-17T17:49:22",
"upload_time_iso_8601": "2024-03-17T17:49:22.521937Z",
"url": "https://files.pythonhosted.org/packages/56/4e/e9a3d88089d2b6445b3846e54abbf004ccde1d81b6805da1169547c5ffe1/circfirm-3.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-17 17:49:22",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "tekktrik",
"github_project": "circfirm",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "circfirm"
}
JSON
