Installation Guide

Quick Start

Get started with ITOM Library in seconds using pip:

pip install itom-library

Installation Methods

From PyPI (Recommended)

Install the latest stable release from the Python Package Index:

pip install itom-library

To install a specific version:

pip install itom-library==0.1.0

From Source

Install from the GitLab repository for the latest development version:

git clone <repository-url>
cd ITOM-Library
pip install -e .

Development Installation

For contributors and developers, install with development dependencies:

pip install -e ".[dev]"

This includes testing frameworks and development tools:

  • pytest for running tests
  • responses for mocking HTTP requests

System Requirements

Prerequisites
  • Python: 3.10 or higher
  • pip: Latest version recommended
  • requests library: >= 2.28.0 (automatically installed)

Virtual Environment Setup

We recommend using a virtual environment to avoid dependency conflicts:

Using venv (Python built-in)

# Create virtual environment
python -m venv venv

# Activate (Windows)
venv\Scripts\activate

# Activate (Linux/Mac)
source venv/bin/activate

# Install ITOM Library
pip install itom-library

Using conda

# Create conda environment
conda create -n itom python=3.10

# Activate environment
conda activate itom

# Install ITOM Library
pip install itom-library

Verification

Verify your installation by importing the library:

python -c "import itom_library; print('ITOM Library installed successfully!')"

Troubleshooting

Try using pip install --user itom-library or use a virtual environment.

Ensure you're using Python 3.10 or higher. Check with python --version.

Update pip first: pip install --upgrade pip, then retry installation.