01-INSTALLATION.md

Installation

Clone the Repository

Start by cloning the repository to your desired location and navigating into the local repository:

git clone https://github.com/Pantonius/TagPag.git
cd TagPag

Virtual Environment

It is best practice to run python applications in their own environments such that dependencies of different projects don't interfere with each other. Below are instructions on how to set up a virtual environment for this project using pyenv or conda.

Using pyenv

1. Install pyenv by following the instructions in the official documentation.

2. Create a virtual environment for this application using pyenv. Open your terminal and execute the following commands:

   pyenv install 3.12.7
   pyenv virtualenv 3.12.7 -env

3. Activate the virtual environment:

   pyenv activate tagpag-env

4. Install the required dependencies:

   pip install -r requirements.txt

Using conda (for Windows)

1. Install conda by following the instructions in the official documentation.

2. Create a virtual environment for this application using conda. Open your terminal and execute the following commands:

   conda create --name -env python=3.12.7

3. Activate the virtual environment:

   conda activate -env

4. Install the required dependencies:

   pip install -r requirements.txt

Start the Project

1. Activate the environment depending on your setup:

   • If you are using pyenv, activate the virtual environment by running:

     pyenv activate -env

   • If you are using conda, activate the environment by running:

     conda activate -env

2. Run the streamlit app:

   streamlit run src/app.py

An example configuration (see .env-example) should be loaded with some example data (see example_workdir).