LOCAL_INSTALL.md

Local Installation Guide

This project requires Python 3.12.x and manages dependencies using pyproject.toml. Below are several methods to set up your environment.

Using System Python with venv

Unix/macOS Instructions

1. Ensure Python 3.12.x is installed:

python --version

2. Create a virtual environment:

python -m venv .venv

3. Activate the virtual environment:

source .venv/bin/activate

4. Install dependencies:

pip install .

Windows Instructions

1. Ensure Python 3.12.x is installed:

python --version

2. Create a virtual environment:

python -m venv .venv

3. Activate the virtual environment:

.venv\Scripts\activate

4. Install dependencies:

pip install .

Using uv (Fast Python Package Installer)

1. Install uv:

pip install uv

2. Create a virtual environment and install dependencies:

uv sync

Using DevContainer

This project includes DevContainer configuration for VS Code:

1. Install the Dev Containers extension in VS Code
2. Open the project in VS Code
3. Click "Reopen in Container" when prompted or use the command palette (F1) and select "Dev Containers: Reopen in Container"

The container will automatically set up Python 3.12 and install all dependencies.

Using Docker

Build and run the project using Docker:

# Build the image
docker build -t moderne-cluster-build-logs:latest .