Skip to content

Installation

Prerequisites

  • Python 3.11 or higher
  • pip or poetry package manager
  • Access to an IVCAP deployment (URL and JWT token)

From PyPI

The easiest way to install the IVCAP Client SDK:

pip install ivcap-client

Or with poetry:

poetry add ivcap-client

From Source

For development or to use the latest unreleased features:

git clone https://github.com/ivcap-works/ivcap-client-sdk-python.git
cd ivcap-client-sdk-python
poetry install

Verify Installation

Test your installation:

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

You should see the version number printed.

Optional: Development Dependencies

If you plan to contribute or build documentation locally:

# Development tools
poetry install --with dev

# Documentation tools (MkDocs) — run from the project root
pip install -r docs/requirements.txt

Next Steps

Troubleshooting

ImportError: No module named 'ivcap_client'

Make sure you've installed the package: 

pip install ivcap-client

If using a virtual environment, ensure it's activated.

Python Version Error

Check your Python version: 

python --version

The SDK requires Python 3.11+.

Permission Denied

If you get permission errors during installation, use: 

pip install --user ivcap-client

Getting Help