01 Getting Started

Getting Started

To get started simply clone this repository on your machine and install the required modules (below).

Requirements

• Python 3 (currently tested on 3.10)
• PyUSB 1.2.1
  • libusb 1.0
• toml 0.10.2

Install libusb

libusb is a requirement of PyUSB, their repository has some good information on installation steps if you're unable to follow a method here, or on the libusb site, linked below.

Visit libusb.info for installation information.

macOS

Using homebrew:

brew install libusb

Windows

Download from the libusb site

Linux

Your distribution may already have libusb installed.

Install Required Modules

Using pipenv:

pipenv install

pipenv will use the Pipfile to install all required modules into a virtual environment spefically for this application. This is ideal as it won't cause any version conflicts with any other installed modules.

If you use this method, in the next sections when you're trying to run the application you'll need to preface any command with pipenv run [COMMAND] so if the [COMMAND] is python3 g-manager.py DEVICE you would run pipenv run python3 g-manager.py DEVICE

Other Methods

If you would rather not use pipenv you can use pip to install the modules globally:

python3 -m pip install pyusb==1.2.1 
python3 -m pip install toml==0.10.2

---

Now you're ready to start using G Manager!

Basic Usage