Usage
Here is a guide on how to use the CircuitPython Bundle Manager v2! If this is the first time running the CircuitPython Bundle Manager v2, refer to the first-time preparation section.
Make sure you followed the instructions to install the CircuitPython Bundle Manager v2.
On the first launch, you should see something like this:
The first thing to do is to obtain a GitHub token so you can download bundles to use!
First, go to the personal access tokens page of your GitHub account and create a new token for the CircuitPython Bundle Manager v2. After you create a token, go to the Other tab and click on the Go to credential settings button.
If you want to save the token to the OS' credential manager, check the check button. This allows you to not have to copy and paste in a new token every time you relaunch the application and need to download a bundle.
Then, click the Open credential manager button. A new dialog will pop up like this:
Paste in your new token and press Save current token. If successful, you can close the credential manager now!
Go to the Bundle tab and click Add bundle.... A new dialog will pop up:
This allows you to download releases from either the main repository or the community repository. Choose Adafruit CircuitPython Bundle. (if you need a community bundle you can always click CircuitPython Community Bundle instead)
Select a release (you will probably choose the latest release at the time of writing) and press Download! On success, you can close the add bundle dialog (unless you want to add more) and you will now see the just-downloaded bundle in the list!
Next, select the bundle in the list box and press the Use bundle button. Now you are all set!
This section covers using the CircuitPython Bundle Manager v2 for the first time.
In order to manage modules on an installed device, we must know which device to use!
Go to the Drive tab (Refresh if necessary as we only update available drives upon launch and when you press the Refresh button) and select a CircuitPython drive if you have one plugged in!
Here you can see various stats about the device, including disk space and the contents of boot_out.txt. Note that if None or a non-CircuitPython drive is selected, you won't be able to manage modules cause they aren't CircuitPython drives!
Switch to the Modules tab and now you can manage modules! After you select the correct bundle version (if a bundle is selected) under the list of modules you can now manage modules! It should be mostly self-explanatory.
If you want to search for a module, type in the entry above the list of modules in the bundle.
This section covers the various buttons (and other things) of the CircuitPython Bundle Manager v2 and how to use them.
The Add bundle button will pop up a dialog that allows you to choose whether to download releases from either the main repository or the community repository. Choose Adafruit CircuitPython Bundle.
Then, you can download a release using the release selector:
The Remove bundle button will delete the currently selected bundle, allowing you to gain space if needed.
The Use bundle button will make the modules tab use the currently selected bundle in the listbox.
The Bundle info button will pull up information about the bundle, like where it was downloaded from and how old it is.
The Refresh button will refresh the currently available releases.
There are two listboxes (well, up to two, depending on whether or not there is a bundle selected and a CircuitPython drive is selected) - the one on the left will show the available modules in the currently selected bundle version (you can change the version under the bundle listbox using the combo box) while the right listbox holds the modules currently installed in the selected CircuitPython device if one is selected. The install, reinstall, and uninstall buttons will enable themselves depending on which module is selected and where.
The combo box at the top will select the current drive to use when managing modules. The list of selected drives will only update when you press the Refresh button so press that if your CircuitPython device isn't showing up!
The other tab contains settings for the CircuitPython Bundle Manager v2 and contains links to important places like this documentation.
If you press the Shift key then some of the buttons will change:
This page allows you to manage your GitHub token used to find available bundles.
Note that if you uncheck the checkbutton that saves your GitHub token in the OS' credential manager while there is a token stored it will not delete it from the OS' credential manager! You should manually delete the key, uncheck the setting, then paste your key back in to use it for the duration of the application's lifetime so that it only stays in memoiry.