Skip to content

README.md

Latest commit

 

History

History
90 lines (67 loc) · 1.6 KB

README.md

File metadata and controls

90 lines (67 loc) · 1.6 KB

Development Setup (uv)

We use uv + lock-based dependency management for reproducible environments. Please do not use pip install -r ... or manual dependency installs.

1) Install uv

macOS / Linux

curl -LsSf https://astral.sh/uv/install.sh | sh

Windows (PowerShell)

irm https://astral.sh/uv/install.ps1 | iex

2) Create the environment

If you previously used the old setup, delete .venv first.

rm -rf .venv

From the repository root, do the following:

uv venv --python 3.12
uv sync --group dev

3) Install pre-commit (recommended)

uv run pre-commit install

4) Run tests

uv run pytest

5) Lint and format

uv run ruff format .
uv run ruff check .

Troubleshooting

If uv is not found after installation on macOS/Linux, add it to your PATH:

export PATH="$HOME/.local/bin:$PATH"

Then restart your terminal and retry.

If setup still fails, share:

  • the full error output
  • uv --version

Development Setup (uv)

1) Create your own OpenRouter API key from here: https://openrouter.ai/

2) In the repository root do the following:

cp .env.example .env

Then Open .env and paste:

OPENROUTER_API_KEY=sk-xxxx

3) Make sure your environment is set up

uv sync --group dev

4) Test

uv run python llm_social_simulation/models/tests/try_openrouter.py

Notes

  • Python requirement is defined in pyproject.toml.
  • Prefer running all tooling through uv run ... to keep execution inside the managed environment.