Installation

Installation

This page shows recommended ways to install and set up SCMeritsCalc locally.

Prerequisites

• Python 3.10+ (recommended)
• git
• Optional: pipx (for isolated CLI installs), Docker (if you prefer containers)

Clone the repo

git clone https://github.com/PINKgeekPDX/SCMeritsCalc.git
cd SCMeritsCalc

Create a virtual environment (recommended)

python -m venv .venv
# macOS / Linux
source .venv/bin/activate
# Windows (PowerShell)
.venv\Scripts\Activate.ps1

Install dependencies

• If the repository contains requirements.txt:

pip install -r requirements.txt

• If the project uses Poetry or similar, follow its instructions:

# Example for Poetry (if used)
poetry install

Run checks (optional)

# Linting (if configured)
flake8
# Type checking
mypy

Docker (optional)

• If you prefer to run via Docker and a Dockerfile exists:

docker build -t scmeritscalc:latest .
docker run --rm -it scmeritscalc:latest

If you encounter dependency conflicts, create an isolated environment or use tools like pip-tools/poetry to resolve them.

Notes

• Adjust the Python version and commands as appropriate for your environment.
• If you don't see requirements.txt, check the repository root or pyproject.toml for dependency management configuration.