# Getting Started

## Introduction <a href="#introduction" id="introduction"></a>

The Paradime SDK provides a convenient way to interact with the Paradime API, allowing you to manage various aspects of your Paradime workspace programmatically.&#x20;

This documentation will guide you through the installation process, basic usage, and specific features of the SDK.

## Installation

To install the Paradime SDK, use pip:

```bash
pip install paradime-io
```

## Obtaining API Credentials

Before you can use the Paradime SDK, you need to obtain the following API credentials for your workspace:

* `API Key`
* `API Secret`
* `API Endpoint`

{% content-ref url="../generate-api-keys" %}
[generate-api-keys](https://docs.paradime.io/app-help/developers/generate-api-keys)
{% endcontent-ref %}

## Initialize the Python SDK

Once you have your API credentials, you can initialize the Paradime SDK client:

```python
from paradime import Paradime

paradime = Paradime(
    api_endpoint="API_ENDPOINT", 
    api_key="API_KEY", 
    api_secret="API_SECRET",
)

# Now you can use the paradime client to interact with the API
```

Replace `"API_ENDPOINT"`, `"API_KEY"`, and `"API_SECRET"` with your actual credentials.

## SDK Modules

The following docs provide detailed information and usage examples for each of the Paradime SDK modules:

{% content-ref url="modules/audit-log" %}
[audit-log](https://docs.paradime.io/app-help/developers/python-sdk/modules/audit-log)
{% endcontent-ref %}

{% content-ref url="modules/bolt" %}
[bolt](https://docs.paradime.io/app-help/developers/python-sdk/modules/bolt)
{% endcontent-ref %}

{% content-ref url="modules/custom-integration" %}
[custom-integration](https://docs.paradime.io/app-help/developers/python-sdk/modules/custom-integration)
{% endcontent-ref %}

{% content-ref url="../../documentation/data-catalog/lineage/compare-lineage-version" %}
[compare-lineage-version](https://docs.paradime.io/app-help/documentation/data-catalog/lineage/compare-lineage-version)
{% endcontent-ref %}

{% content-ref url="modules/user-management" %}
[user-management](https://docs.paradime.io/app-help/developers/python-sdk/modules/user-management)
{% endcontent-ref %}

{% content-ref url="modules/workspace-management" %}
[workspace-management](https://docs.paradime.io/app-help/developers/python-sdk/modules/workspace-management)
{% endcontent-ref %}