Skip to content

Installation

Jump to bottom
Ckyiu edited this page Nov 28, 2021 · 12 revisions

Here is a guide on how to install the CircuitPython Bundle Manager v2! Ensure that you have at least Python 3.9, it isn't tested against older versions!

Install from binary

I am only able to provide binaries for Windows and Debian - sorry!

Windows

  1. Download a release for Windows.
  2. Verify the SHA256 of the downloaded zip file! Optional but highly recommended.
  3. Extract to somewhere convenient. (Like a drive where all your projects go)
  4. Run the binary inside the folder!
  5. Create a shortcut to the desktop if you want!

Debian

  1. Download a release for Debian.
  2. Verify the SHA256 of the downloaded .tar.gz file! Optional but highly recommended.
  3. Extract to somewhere convenient. (Like the home directory)
  4. Run the binary inside the folder!
  5. Create a symlink to the desktop if you want!

Install from source

Windows

  1. cd to somewhere convenient. (Like a drive where all your projects go)
  2. Download the repo (git clone https://github.com/UnsignedArduino/CircuitPython-Bundle-Manager-v2) or if you don't have git installed you can download the ZIP version of the repo and extract it to a convenient directory, then open a Command Prompt/PowerShell there.
  3. cd into the downloaded repo.
  4. Create a virtual environment. (python -m venv .venv)
  5. Activate the virtual environment. (".venv/Scripts/activate.bat" for Windows Command Processor, .\.venv\Scripts\Activate.ps1 for PowerShell)
  6. Install the requirements. (pip install -r requirements.txt)
  7. Run! (python main.py)

Steps 4 and 5 are not required, but highly recommended. (Skip them if you don't know what a virtual environment is)

Linux / macOS

These instructions have been only tested on Debian + Bash shell. (PRs to fix/add steps for different distros/macOS would be highly appreciated)

  1. cd to somewhere convenient. (Like your home directory)
  2. Download the repo (git clone https://github.com/UnsignedArduino/CircuitPython-Bundle-Manager-v2) or if you don't have git installed you can download the ZIP version of the repo and extract it to a convenient directory, then open a terminal there.
  3. cd into the downloaded repo.
  4. Create a virtual environment. (python3 -m venv .venv)
  5. Activate the virtual environment. (source .venv/bin/activate)
  6. Install the requirements. (pip3 install -r requirements.txt)
  7. Run! (python3 main.py)

Steps 4 and 5 are not required, but highly recommended. (Skip them if you don't know what a virtual environment is)

Common installation problems

cryptography is preventing me from installing dependencies!

Follow the instructions to install cryptography on your machine. Then try step 6 again. Common installation problems are that you have an outdated pip/pip3 installed. cryptography will also take a long time to install either way!

I'm having other problems installing!

GitHub Discussions have been enabled for this repo, please open a new discussion if needed!

Build a binary

First, install the dependencies needed for building from build-requirements.txt.

On Windows, run build.bat. On macOS / Linux, run build.sh.

The results are in dist.

Clone this wiki locally