Skip to content

Installation

Prerequisites

  • Python 3.11 or higher
  • pip or poetry package manager

From PyPI

The easiest way to install the IVCAP Service SDK:

pip install ivcap_service

Or with poetry:

poetry add ivcap_service

From Source

For development or to use the latest unreleased features:

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

Verify Installation

Test your installation:

python -c "import ivcap_service; print(ivcap_service.__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
pip install -r docs/requirements-docs.txt

Next Steps

Troubleshooting

ImportError: No module named 'ivcap_service'

Make sure you've installed the package: 

pip install ivcap_service

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

Python Version Error

Check your Python version: 

python --version

The SDK requires Python 3.11+. If you have multiple Python versions installed, use: 

python3.11 -m pip install ivcap_service

Permission Denied

If you get permission errors during installation, use: 

pip install --user ivcap_service

Getting Help