Skip to content

Installation

Requirements

lonkit requires Python 3.10 or higher.

Install from PyPI

The simplest way to install lonkit is via pip:

pip install lonkit

Install from Source

For the latest development version:

git clone https://github.com/helix-agh/lonkit.git
cd lonkit
pip install -e .

Development Installation

To install lonkit with development dependencies for contributing:

git clone https://github.com/helix-agh/lonkit.git
cd lonkit
pip install -e ".[dev]"

This includes:

  • pytest - Testing framework
  • pytest-cov - Coverage reporting
  • ruff - Linting and formatting
  • mypy - Type checking
  • pre-commit - Git hooks

Verifying Installation

After installation, verify everything works:

import lonkit
print(lonkit.__version__)

You should see the version number (e.g., 0.3.0).

Troubleshooting

igraph Installation Issues

On some systems, you may need to install igraph system dependencies first:

sudo apt-get install build-essential python3-dev libxml2-dev zlib1g-dev
pip install lonkit
brew install igraph
pip install lonkit

igraph typically installs without issues on Windows via pip.

Plotly/Kaleido Issues

If you encounter issues with static image export:

pip install --upgrade kaleido

On some systems, you may need:

pip install kaleido==0.2.1