A tool to manage/update libraries on CircuitPython devices.
Project description
A tool to manage and update libraries (modules) on a CircuitPython device.
Installation
Circup requires Python 3.5 or higher.
In a virtualenv, pip install circup should do the trick. This is the simplest way to make it work.
If you have no idea what a virtualenv is, try the following command, pip3 install --user circup.
What does Circup Do?
Each CircuitPython library on the device usually has a version number as metadata within the module.
This utility looks at all the libraries on the device and checks if they are the most recent (compared to the versions found in the most recent version of the Adafruit CircuitPython Bundle and Circuitpython Community Bundle). If the libraries are out of date, the utility helps you update them.
The Adafruit CircuitPython Bundle can be found here:
https://github.com/adafruit/Adafruit_CircuitPython_Bundle/releases/latest
Full details of these libraries, what they’re for and how to get them, can be found here:
https://circuitpython.org/libraries
The Circuitpython Community Bundle can be found here:
https://github.com/adafruit/CircuitPython_Community_Bundle/releases/latest
Usage
If you need more detailed help using Circup see the Learn Guide article “Use CircUp to easily keep your CircuitPython libraries up to date”.
First, plug in a device running CircuiPython. This should appear as a mounted storage device called CIRCUITPY.
To get help, just type the command:
$ circup
Usage: circup [OPTIONS] COMMAND [ARGS]...
A tool to manage and update libraries on a CircuitPython device.
Options:
--verbose Comprehensive logging is sent to stdout.
--version Show the version and exit.
--path DIRECTORY Path to CircuitPython directory. Overrides automatic
path detection.
--help Show this message and exit.
-r --requirement Supports requirements.txt tracking of library
requirements with freeze and install commands.
Commands:
freeze Output details of all the modules found on the connected...
install Installs .mpy version of named module(s) onto the device.
install --py Installs .py version of named module(s).
list Lists all out of date modules found on the connected...
show Show the long list of all available modules in the bundle.
show <query> Search the names in the modules in the bundle for a match.
uninstall Uninstall a named module(s) from the connected device.
update Update modules on the device. Use --all to automatically update
all modules.
To search for a specific module containing the name bme:
$ circup show bme:
$ circup show bme Found device at /Volumes/CIRCUITPY, running CircuitPython 6.1.0-beta.2. adafruit_bme280 adafruit_bme680 2 shown of 257 packages.
To show version information for all the modules currently on a connected CIRCUITPYTHON device:
$ circup freeze adafruit_binascii==v1.0 adafruit_bme280==2.3.1 adafruit_ble==1.0.2
With $ circup freeze -r, Circup will save, in the current working directory,
a requirements.txt file with a list of all modules currently installed on the
connected device.
To list all the modules that require an update:
$ circup list The following modules are out of date or probably need an update. Module Version Latest ------------------ -------- -------- adafruit_binascii v1.0 1.0.1 adafruit_ble 1.0.2 4.0
To interactively update the out-of-date modules:
$ circup update Found 3 module[s] needing update. Please indicate which modules you wish to update: Update 'adafruit_binascii'? [y/N]: Y OK Update 'adafruit_ble'? [y/N]: Y OK
Install a module or modules onto the connected device with:
$ circup install adafruit_thermal_printer Installed 'adafruit_thermal_printer'. $ circup install adafruit_thermal_printer adafruit_bus_io Installed 'adafruit_thermal_printer'. Installed 'adafruit_bus_io'.
If you need to work with the original .py version of a module, use the –py flag.
$ circup install –py adafruit_thermal_printer Installed ‘adafruit_thermal_printer’.
You can also install a list of modules from a requirements.txt file in the current working directory with:
$ circup install -r requirements.txt Installed 'adafruit_bmp280'. Installed 'adafruit_lis3mdl'. Installed 'adafruit_lsm6ds'. Installed 'adafruit_sht31d'. Installed 'neopixel'.
Uninstall a module or modules like this:
$ circup uninstall adafruit_thermal_printer Uninstalled 'adafruit_thermal_printer'. $ circup uninstall adafruit_thermal_printer adafruit_bus_io Uninstalled 'adafruit_thermal_printer'. Uninstalled 'adafruit_bus_io'.
Use the --verbose flag to see the logs as the command is working:
$ circup --verbose freeze Logging to /home/ntoll/.cache/circup/log/circup.log 10/18/2020 00:54:43 INFO: ### Started Circup ### 10/18/2020 00:54:43 INFO: Found device: /Volumes/CIRCUITPY Found device at /Volumes/CIRCUITPY, running CircuitPython 6.0.0-alpha.1-1352-gf0b37313c. 10/18/2020 00:54:44 INFO: Freeze 10/18/2020 00:54:44 INFO: Found device: /Volumes/CIRCUITPY ... etc ...
The --path flag let’s you pass in a different path to the CircuitPython mounted volume. This is helpful when you have renamed or have more than one CircuitPython devices attached:
$ circup --path /run/media/user/CIRCUITPY1 list
The --version flag will tell you the current version of the circup command itself:
$ circup --version CircUp, A CircuitPython module updater. Version 0.0.1
That’s it!
Discussion of this tool happens on the Adafruit CircuitPython Discord channel.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file circup-0.9.7.tar.gz.
File metadata
- Download URL: circup-0.9.7.tar.gz
- Upload date:
- Size: 91.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.9.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 76899bf77a1ca22d2f034078c0fd398d752c7156588a6af86cea8ca0f156dcc8 |
|
| MD5 | 084f5b60803d342a8dcf65ee269ca45e |
|
| BLAKE2b-256 | 407b61e03eaea37423cd27ed311205c69f488f7b1cf931558ed005cefde18c81 |
