Requirements

You will need to have Python 3.9 or higher, pip, and git installed in order to install circup.

Windows Installation

You can verify that you have Python correctly installed by typing python3 --version at the command prompt and checking that you are running Python 3.9 or higher. If you have Windows 10 and don't currently have it installed, Python is available in the Windows store.

Next, we check that Pip is installed by typing pip3 --version. This should have been installed with Python, but if not, you will need to download and install it. Make sure you are running the latest version of pip by typing pip3 install --upgrade pip.

Finally, make sure git is installed by typing git --version. If this isn't installed, you will need to install a version that you can run from the command line such as git-scm.

After we have verified that we have all the requirements, let's update the Path variable. Getting to this can vary by windows versions, but it's often in the Environment Variable setting dialog, which can be accessed through the System Properties.

To figure out the correct path to add, type the following at the command line:

python3 -m site --user-base

Then copy the path that is returned and add \Python312\Scripts or whatever the latest version is onto the end of your PATH. If your PATH varies due to having a different version of Python, change it accordingly.

Now continue on to the circup installation.

MacOS Installation

You can verify that you have Python correctly installed by typing python3 --version at the command prompt and checking that you are running Python 3.9 or higher. If you don't currently have it installed, Python can easily be installed through a utility called Homebrew.

Next, we check that Pip is installed by typing pip3 --version. This should have been installed with Python, but if not, you will need to download and install it. Make sure you are running the latest version of pip by typing pip3 install --upgrade pip.

Finally, make sure git is installed by typing git --version. If this isn't installed, this can also easily be installed with Homebrew.

Now continue on to the CircUp installation.

Linux Installation

You can easily make sure all three requirements are installed with the following command on a Debian or Ubuntu system:

sudo apt-get install -y python3 git python3-pip

Make sure you are running the latest version of pip by typing pip3 install --upgrade pip.

Now continue on to the CircUp installation.

Python VENV

You will need to setup a venv with modern python3 releases. The activate file will need to be sourced on each subsequent login for circup to work. 

sudo apt install python3-venv
python3 -m venv env
source env/bin/activate

sudo apt install python3-venv
python3 -m venv env
source env/bin/activate