chore: 🤖 bootstrap scripts

Author: soul-codes

README.md

@@ -6,10 +6,22 @@ Python 3.12
 
 ## Setting up
 
+- Make sure you have Python 3.12 installed on your system.
+- Create the virtual environment at `venv` using the following command:
+
 ```shell
-pip install -r requirements.txt
+python -m venv venv
 ```
 
+- Activate the bootstrap script for your shell environmennt:
+  - PS1: `./bootstrap.ps1`
+  - Bash: `./bootstrap.sh`
+
+  This will install the required dependencies for project development,
+  activate a pre-commit hook that will format the code using `isort` and
+  `black`.
+
+
 ## Starting the application
 
 ```shell
@@ -30,4 +42,4 @@ Required Notice: © CIB Mango Tree ([https://github.com/CIB-Mango-Tree])
 
 ---
 
-By using this software, you agree to the terms and conditions of the PolyForm Noncommercial License 1.0.0.
+By using this software, you agree to the terms and conditions of the PolyForm Noncommercial License 1.0.0.

bootstrap.ps1

@@ -0,0 +1,35 @@
+# Check if running in PowerShell
+if ($PSVersionTable -eq $null) {
+    Write-Host "Please run this script in PowerShell."
+    exit 1
+}
+
+# Define the virtual environment and requirements file paths
+$repo_root = (Get-Location).Path
+$venv_path = Join-Path $repo_root "venv"
+$requirements_file = Join-Path $repo_root "requirements-dev.txt"
+
+# Activate the virtual environment
+$activate_script = Join-Path $venv_path "Scripts\Activate.ps1"
+if (-Not (Test-Path $activate_script)) {
+    Write-Host "Virtual environment not found. Please ensure it exists at: $venv_path"
+    exit 1
+}
+
+Write-Host "Activating virtual environment..."
+. $activate_script
+
+# Install dependencies
+if (-Not (Test-Path $requirements_file)) {
+    Write-Host "requirements-dev.txt not found at: $requirements_file"
+    exit 1
+}
+
+Write-Host "Installing dependencies from requirements-dev.txt..."
+pip install -r $requirements_file
+
+# Activate pre-commit hooks
+Write-Host "Installing pre-commit hooks..."
+pre-commit install
+
+Write-Host "Bootstrap process complete."

bootstrap.sh

@@ -0,0 +1,32 @@
+#!/bin/bash
+
+# Define the virtual environment and requirements file paths
+REPO_ROOT=$(pwd)
+VENV_PATH="$REPO_ROOT/venv"
+REQUIREMENTS_FILE="$REPO_ROOT/requirements-dev.txt"
+
+# Check if virtual environment exists
+if [ ! -d "$VENV_PATH" ]; then
+    echo "Virtual environment not found. Please ensure it exists at: $VENV_PATH"
+    exit 1
+fi
+
+# Activate the virtual environment
+echo "Activating virtual environment..."
+source "$VENV_PATH/bin/activate"
+
+# Check if requirements-dev.txt exists
+if [ ! -f "$REQUIREMENTS_FILE" ]; then
+    echo "requirements-dev.txt not found at: $REQUIREMENTS_FILE"
+    exit 1
+fi
+
+# Install dependencies
+echo "Installing dependencies from requirements-dev.txt..."
+pip install -r "$REQUIREMENTS_FILE"
+
+# Activate pre-commit hooks
+echo "Installing pre-commit hooks..."
+pre-commit install
+
+echo "Bootstrap process complete."

requirements-dev.txt

@@ -1,3 +1,4 @@
 -r requirements.txt
 
 pre_commit==4.0.1
+pyarrow-stubs==17.13