Installation

Requirements

• Python 3.10 or higher

• Internet connection for OAuth authentication

• Compatible with Windows, macOS, and Linux

Install from PyPI

The easiest way to install the IDTAP API is using pip:

pip install idtap

This will install the package and all required dependencies:

• requests - HTTP client library

• requests-toolbelt - Additional HTTP utilities

• pyhumps - Case conversion utilities

• keyring - Secure token storage

• cryptography - Encryption for token security

• PyJWT - JWT token handling

• google-auth-oauthlib - Google OAuth integration

• pymongo - MongoDB database access (for advanced features)

Install from Source

To install the latest development version from GitHub:

pip install git+https://github.com/UCSC-IDTAP/Python-API.git

Or clone the repository and install locally:

git clone https://github.com/UCSC-IDTAP/Python-API.git
cd Python-API
pip install -e .

Development Installation

For development, install with optional development dependencies:

pip install idtap[dev]

This includes additional packages for testing and development:

• pytest - Testing framework

• responses - HTTP request mocking

• black - Code formatting

• isort - Import sorting

• mypy - Type checking

• flake8 - Code linting

Platform-Specific Notes

Linux

On Linux systems, you may need to install additional packages for secure keyring support:

pip install idtap[linux]

This installs secretstorage for integration with the system keyring.

macOS/Windows

The standard installation works out of the box on macOS and Windows with built-in keyring support.

Verification

To verify your installation, run:

import idtap
print(idtap.__version__)

This should print the installed version number (e.g., 0.1.7).