The remaining commands all pertain managing the bundles on your local system that circup will look for libraries inside of. By default circup uses these 3 bundles:
- Adafruit Library Bundle
- Community Library Bundle
- CircuitPython Org Bundle
These commands allow you to add and remove other 3rd party bundles if you'd like. Once added then circup will be able to install libraries from those 3rd party bundles.
If you don't want to use any 3rd party bundles then you won't need to use these commands.
Bundle Show Command
The circup bundle-show
command will print a list of the currently tracked bundles, and information about the current versions.
$ circup bundle-show --help Usage: circup bundle-show [OPTIONS] Show the list of bundles, default and local, with URL, current version and latest version retrieved from the web. Options: --modules List all the modules per bundle. --help Show this message and exit.
Options Details
The --help
argument will print the built-in documentation information.
The --modules
argument will print the list of libraries within each bundle in additional to the bundle information. This is similar to the output from the circup show command, but the libraries are grouped by which bundle their in and split up.
Example Usage
$ circup bundle-show $ circup bundle-show --modules
Example Output
$ circup bundle-show adafruit/Adafruit_CircuitPython_Bundle https://github.com/adafruit/Adafruit_CircuitPython_Bundle version = 20240525 adafruit/CircuitPython_Community_Bundle https://github.com/adafruit/CircuitPython_Community_Bundle version = 20240524 circuitpython/CircuitPython_Org_Bundle https://github.com/circuitpython/CircuitPython_Org_Bundle version = 20231031.2
Bundle Add Command
The circup bundle-add
command will add a new bundle to be tracked by circup.
One such possible bundle is the CircuitPython Fonts Bundle. It contains several sizes of different open source fonts formatted to work with Circuitpython displayio.
You only need to run this command once to add a bundle. After it comples circup will track the added bundle and download new versions to your computer when they're available. You will also be able to install libraries from the added bundle.
$ circup bundle-add --help Usage: circup bundle-add [OPTIONS] [BUNDLE]... Add bundles to the local bundles list, by "user/repo" github string. A series of tests to validate that the bundle exists and at least looks like a bundle are done before validating it. There might still be errors when the bundle is downloaded for the first time. Options: --help Show this message and exit.
Options Details
The only optional argument is the --help flag which prints the built-in documentation information.
The final part of the command is the Bundle argument, it is required and must be in the format of a user/repository
string pointing to a valid library bundle hosted on Github.
Example Usage
$ circup bundle-add adafruit/circuitpython-fonts
Example Output
$ circup bundle-add adafruit/circuitpython-fonts Added adafruit/circuitpython-fonts https://github.com/adafruit/circuitpython-fonts
Bundle Remove Command
The circup bundle-remove
command is the opposite of the bundle-add
command. circup bundle-remove
will remove the specified bundle from your computer and circup will stop tracking it. After removal you will not be able to install the libraries from that bundle any longer.
$ circup bundle-remove --help Usage: circup bundle-remove [OPTIONS] [BUNDLE]... Remove one or more bundles from the local bundles list. Options: --reset Remove all local bundles. --help Show this message and exit.
Options Details
The --help
argument will print out the built-in documentation information.
The --reset
argument will remove all non-default bundles that have been previously added.
Bundle Argument
If you do not use the --reset argument, then the final part of this command is the Bundle argument. Just as with bundle-add the value must be in the format of a user/repository
string. If you're unsure about the correct names to use then run the circup bundle-show
command to see the bundles that are installed and then choose the one that you want to install and copy the name printed out.
Example Usage
$ circup bundle-remove adafruit/circuitpython-fonts $ circup bundle-remove --reset
Example Output
$ circup bundle-remove adafruit/circuitpython-fonts Bundle adafruit/circuitpython-fonts Do you want to remove that bundle ? [y/N]: y Removing the bundle from the local list adafruit/circuitpython-fonts
Text editor powered by tinymce.