SDKs
Python SDK (Beta) v1.X
Getting Started
Installation

Installation

The documentation targets dealcloud-sdk 1.x. The package is available on PyPI (opens in a new tab).

Requirements

  • Python 3.13 or higher
  • pip, uv, poetry, or conda for package management

Install with pip

pip install dealcloud-sdk

The base install includes pandas, pydantic, numpy, fsspec, and intapp-rest-client (HTTP). Extras add Polars, YAML config helpers, optional cloud filesystem backends (s3, azure, gcs), OpenTelemetry packages for tracing (telemetry), or all (every optional extra).

Install with uv (Recommended)

uv (opens in a new tab) is a fast Python package manager that's recommended for new projects.

uv add dealcloud-sdk

Install with Poetry

poetry add dealcloud-sdk

With extras:

poetry add dealcloud-sdk -E polars   # Polars DataFrames (faster)
poetry add dealcloud-sdk -E yaml     # YAML config files
poetry add dealcloud-sdk -E s3       # AWS S3 (s3fs)
poetry add dealcloud-sdk -E azure    # Azure Data Lake (adlfs)
poetry add dealcloud-sdk -E gcs      # Google Cloud Storage (gcsfs)
poetry add dealcloud-sdk -E telemetry  # OpenTelemetry (HTTPX tracing)
poetry add dealcloud-sdk -E all      # All optional features (includes telemetry)

Install with Conda

If you're using Conda or Mamba for environment management, you can install the SDK via pip within your conda environment:

conda activate your-environment
pip install dealcloud-sdk

With extras:

pip install dealcloud-sdk[polars]
pip install dealcloud-sdk[yaml]
pip install dealcloud-sdk[s3]       # or [azure] / [gcs]
pip install dealcloud-sdk[telemetry]
pip install dealcloud-sdk[all]
📦

The SDK is not yet available on conda-forge. Use pip within your conda environment as shown above.

Optional Dependencies

ExtraPackagesPurpose
polarspolars, pyarrowHigh-performance DataFrames (10–100x faster than pandas for large sets)
yamlpyyaml, python-benedict[yaml]YAML configuration files
s3s3fsAWS S3 URLs via fsspec
azureadlfsAzure Data Lake Storage Gen2
gcsgcsfsGoogle Cloud Storage
telemetryopentelemetry-sdk, opentelemetry-instrumentation-httpxDependencies for distributed tracing (HTTPX instrumentation); configure tracing in your app
alldealcloud-sdk[polars,yaml,s3,azure,gcs,telemetry]All optional extras

The base package includes pandas, pydantic, numpy, fsspec, and intapp-rest-client; no extra is needed for pandas DataFrames or core REST calls.

🚀

Polars is recommended for large datasets (100k+ rows). It's significantly faster and uses less memory than pandas. See Polars Integration.

Verify Installation

🧩

Set up an isolated environment first. The SDK depends on a specific intapp-rest-client release. A global Python install or an old intapp-rest-client in site-packages can produce ImportError when importing dealcloud_sdk. Create a venv with uv (or use Conda as above), or run uv pip install -U dealcloud-sdk so the HTTP client version matches the SDK.

Create a virtual environment with uv (opens in a new tab), install the package, then run Python:

# uv venv [.venv] [--python <version_or_path>]
uv venv .venv --python 3.13
source .venv/bin/activate   # Windows: .venv\Scripts\activate
uv pip install dealcloud-sdk
from dealcloud_sdk import DealCloud
 
# Check version
import dealcloud_sdk
print(dealcloud_sdk.__version__)

Development Installation

Clone your team’s repository (or unpack a source distribution), then from the repo root sync a local environment (creates .venv if needed) and install the dev extra (pytest, linters, and so on):

cd dealcloud-python-sdk
uv sync --extra dev

Use uv run python or activate .venv to run commands against that environment. For an editable install into an existing venv instead, use uv pip install -e ".[dev]".

💡

The SDK builds on intapp-rest-client (HTTPX-based). For low-level client behavior (retries, auth, tracing), see the Intapp REST Client docs. If you have legacy code using requests, see the Migration Guide.

Next Steps

Python SDK (Beta) v1.XQuick Start