Installation

This guide explains how to install and set up the EDC API Python package.

Requirements 

Before installing, make sure you have:

To install the latest released version from PyPI (if available):

pip install edcapi

If the package is hosted on GitLab and not yet published on PyPI, clone the repository manually:

git clone https://gitlab.lrz.de/edc/python3-edcapi.git
cd python3-edcapi
pip install .

It’s a good practice to use a virtual environment to avoid dependency conflicts:

python -m venv .venv
source .venv/bin/activate  # On Windows use `.venv\Scripts\activate`
pip install -e .

After installation, check that the package is available using Python shell:

import edcapi
print(edcapi.__version__)

If you encounter issues during installation:

Ensure you are using a recent version of pip:
```
pip install --upgrade pip
```
If dependencies fail to build, check that development tools are installed:
- On Ubuntu/Debian: sudo apt install build-essential
- On macOS: xcode-select --install
Verify your internet connection if cloning from GitLab.