Setup

Requirements

Python - A popular programming language that is reliable, flexible, easy to learn.
uv - is a fast package manager for Python, an alternative to pip and pipenv, designed for speed and efficiency.

Note

The project is mainly intended for Unix based systems. The project might not work as expected in Windows.

Clone the repository
```
git clone <repo-url>
```
Or download the zip file and extract it.
Change the directory to the project folder
```
cd <project-folder>
```
Install the dependencies
```
uv pip install -e .
```
Setup DB
```
uv run src/core/db/schema.py
```
Run the project
```
uv run python3 src/main.py
```
The above might only work for Unix based systems. For Windows, you can use python src/main.py or py src/main.py.
For usage like a cli tool use
```
uv pip install -e .
```
This will install the package in editable mode, so you can run the tool from anywhere in the terminal.

This currently only works for Unix based systems.