Skip to content

Installation from source

Software prerequisites

  • Docker
  • Python version 3.9 or 3.10 (for version 0.8.1+)
  • Pip
  • Python Virtual Environment
  • PyCharm
  • Git
  • Elasticsearch
  • Redis

Install the above software, and we're ready to start.

Download the source code

Open a terminal and go to the directory where you want to keep the code. Enter:

git clone https://github.com/Tracardi/tracardi  #(1)
git clone https://github.com/Tracardi/tracardi-api #(2)
  1. Clones tracardi repository. Code will be available in tracardi folder.
  2. Clones tracardi-api repository

Create virtual environments

Type:

cd tracardi-api
python3.9 -m venv venv  # (1)
cd ..
cd tracardi
python3.9 -m venv venv
  1. Installs virtual environment with python 3.9 or 3.10 (for version 0.8.1+)

Tip

Before creating the virtual environment make sure you have version 3.10.x installed. Type python --version to see if the version is correct.

Install dependencies

# Activates virtual environment (1)
cd tracardi-api
source venv/bin/activate

# Install wheel
pip3 install wheel

# Installs dependencies
pip install -r app/requirements.txt

# Run code (2)
USER_NAME=admin PASSWORD=admin uvicorn app.main:application --host 0.0.0.0 --port 8686
  1. Only tracardi-api is required to run the API. Tracardi library will be installed as dependency.
  2. Sets default username: password as admin: admin and runs Tracardi API on port 8686.
cd tracardi-api
venv\Scripts\activate

// Installs dependencies
pip install -r app/requirements.txt

// Run code 
USER_NAME=admin PASSWORD=admin uvicorn app.main:application --host 0.0.0.0 --port 8686

// Activates virtual environment
cd tracardi-api
source venv/bin/activate

// Installs dependencies
pip install -r app/requirements.txt

// Run code
USER_NAME=admin PASSWORD=admin uvicorn app.main:application --host 0.0.0.0 --port 8686

Test access to documentation

Visit http://0.0.0.0:8686/docs