Skip to content

Installation

We recommend using uv to manage virtual environments for installing glnova.

If you don't have uv installed, you can install it with pip. See the project pages for more details:

  • Install via pip: pip install --upgrade pip && pip install uv
  • Project pages: uv on PyPI | uv on GitHub
  • Full documentation and usage guide: uv docs

Requirements

  • Python 3.10 or higher
  • Operating System: Linux, macOS, or Windows

Note

The package is built and tested against Python 3.10-3.12. When creating a virtual environment with uv, specify the Python version to ensure compatibility: uv venv --python 3.10 (replace 3.10 with your preferred version in the 3.10-3.12 range). This avoids potential issues with unsupported Python versions.

Install from PyPI

The recommended way to install glnova is from PyPI:

# Create a virtual environment (recommended with uv)
uv venv --python 3.10
source .venv/bin/activate  # On Windows: .venv\Scripts\activate
uv pip install glnova

Optional Dependencies

For development or specific features:

# Development dependencies (testing, linting, etc.)
uv pip install glnova[dev]

# Documentation dependencies
uv pip install glnova[docs]

# All dependencies
uv pip install glnova[dev,docs]

Install from Source

For the latest development version:

git clone git@github.com:isaac-cf-wong/glnova.git
cd glnova
# Create a virtual environment (recommended with uv)
uv venv --python 3.10
source .venv/bin/activate  # On Windows: .venv\Scripts\activate
uv pip install .

Development Installation

To set up for development:

git clone git@github.com:isaac-cf-wong/glnova.git
cd glnova

# Create a virtual environment (recommended with uv)
uv venv --python 3.10
source .venv/bin/activate  # On Windows: .venv\Scripts\activate
uv pip install ".[dev]"

# Install the commitlint dependencies
npm install

# Install pre-commit hooks
pre-commit install
pre-commit install --hook-type commit-msg

Verify Installation

Check that glnova is installed correctly:

glnova --help

python -c "import glnova; print(glnova.__version__)"

Dependencies

Core Dependencies

  • typer: CLI framework

Getting Help

  1. Check the troubleshooting guide
  2. Search existing issues
  3. Create a new issue with:
    • Your operating system and Python version
    • Full error message
    • Steps to reproduce the problem