Developer Setup

Developer Setup

Windows

1. Install Python 3.10 (newer versions are not compatible)
2. Clone/download this repository
3. Open the project folder in your IDE (VS Code preferred)
4. Open the repository folder in a terminal window
   1. Create a virtual environment python -m venv env or py -m venv env if you have multiple versions of Python installed
   2. Activate the newly created virtual environment .\env\Scripts\activate
   3. Install the dependencies pip install -r requirements.txt
5. Run ./src/OSBC.py (may need to restart IDE for it to recognize installed dependencies)

Linux

Please only use Linux if you know what you're doing. OSBC has only been tested in Ubuntu v22.04.

1. Make sure your GNOME display server is running Xorg. See here for instructions.
   1. You may need to run sudo apt-get install xorg-dev
2. Run the following commands:
   1. sudo apt update
   2. sudo apt install build-essential
   3. sudo apt install python3-dev (ensure Python 3.10 is installed)
3. Clone the repository and navigate to the project folder in your terminal. Run the following commands:
   1. Create a virtual environment python3 -m venv env
   2. Activate the virtual environment . env/bin/activate
   3. Install the dependencies pip install -r requirements.txt
4. Run ./src/OSBC.py
   1. If you encounter a Tkinter error, run sudo apt install python3-tk