Skip to content

Installation

Follow these steps to set up LuminaPy on your machine.

Option 1: Using pip

# Clone the repository
git clone https://github.com/Harery/LuminaPy.git
cd LuminaPy

# Create virtual environment
python -m venv .venv

# Activate virtual environment
# On Windows:
.venv\Scripts\activate
# On macOS/Linux:
source .venv/bin/activate

# Install in development mode
pip install -e ".[dev]"

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

# Clone and setup
git clone https://github.com/Harery/LuminaPy.git
cd LuminaPy

# Sync dependencies
uv sync --all-extras

Option 3: GitHub Codespaces

Open in GitHub Codespaces

Click the button above for an instant, pre-configured environment.

Verify Installation

# Run tests
pytest verify/tests -v

# Run linter
ruff check .

# Run type checker
pyright build/

# Run learning tracker
python -m pylab.track

Project Structure

LuminaPy/
├── build/           # Learning content (implementations)
├── verify/          # Tests and coverage
├── learn/           # Notebooks and resources
├── ship/            # Scripts and tools
├── record/          # Documentation
└── pyproject.toml   # Project configuration

Troubleshooting

Common Issues

  1. pip not found 

    python -m ensurepip --upgrade

  2. Permission denied 

    pip install -e ".[dev]" --user

  3. Tests failing 

    pip install pytest pytest-cov -U

Next Steps

  • Roadmap - See the complete learning path