HelloSign Python SDK

4.0.0 · active · verified Fri Apr 17

A Python wrapper for the HelloSign API, enabling programmatic interaction with e-signature workflows. It supports document creation, signature requests, template management, and more. The current stable version is 4.0.0, and it follows an active release cadence for new features and maintenance.

Common errors

```
ModuleNotFoundError: No module named 'hellosign_sdk'
```
cause The `hellosign-python-sdk` package is not installed in your current Python environment.

fix Run `pip install hellosign-python-sdk` in your terminal.
```
AttributeError: module 'hellosign_sdk' has no attribute 'Client'
```
cause You are trying to import the old client class name (`Client`) from a version 4.0.0 or newer installation.

fix Change your import from `from hellosign_sdk import Client` to `from hellosign_sdk import HSClient`.
```
hellosign_sdk.exceptions.HSException: The API Key is not valid. Please double check that you are using a valid API Key.
```
cause The API key provided during client initialization is incorrect, expired, or has leading/trailing whitespace.

fix Verify your HelloSign API key from your HelloSign dashboard. Ensure no extra characters are included and that it's active.

Warnings

breaking The main client class was renamed from `Client` to `HSClient` in version 4.0.0. Code using `from hellosign_sdk import Client` will fail.
Fix: Update your import statement to `from hellosign_sdk import HSClient` and instantiate with `HSClient(...)`.
gotcha Authentication methods typically require an API Key or OAuth token. Ensure your key/token is correctly configured and has the necessary permissions for the API calls you are making.
Fix: Always pass a valid `api_key` or `oauth_token` to the `HSClient` constructor. For OAuth, ensure your `oauth_token` is refreshed as needed.
gotcha API errors are raised as exceptions. It's crucial to implement `try-except` blocks to catch `hellosign_sdk.exceptions.HSException` to handle API-specific errors gracefully.
Fix: Wrap API calls in `try-except HSException as e: ...` blocks to handle issues like invalid parameters, missing permissions, or rate limits.

Install

pip install hellosign-python-sdk Install stable version

Imports

HSClient
wrong:
```
from hellosign_sdk import Client
```
correct:
```
from hellosign_sdk import HSClient
```
As of v4.0.0, the main client class was renamed from `Client` to `HSClient`.

HSException

from hellosign_sdk.exceptions import HSException

Base exception class for API errors.

Quickstart

Initializes the HelloSign client using an API key (preferably from an environment variable) and then demonstrates how to fetch basic account information and list templates, including error handling.

import os
from hellosign_sdk import HSClient
from hellosign_sdk.exceptions import HSException

# Initialize the client with your API key
# It's recommended to use environment variables for sensitive data.
api_key = os.environ.get('HELLOSIGN_API_KEY', 'YOUR_API_KEY')

if not api_key or api_key == 'YOUR_API_KEY':
    print("Please set the HELLOSIGN_API_KEY environment variable or replace 'YOUR_API_KEY' with your actual key.")
else:
    client = HSClient(api_key=api_key)

    try:
        # Example: Get account information
        account = client.get_account()
        print(f"Successfully connected to HelloSign API. Account email: {account.email_address}")

        # Example: List available templates (first page)
        templates = client.get_templates(page=1, page_size=10)
        if templates:
            print(f"Found {len(templates)} templates. First template name: {templates[0].name}")
        else:
            print("No templates found for this account.")

    except HSException as e:
        print(f"HelloSign API Error: {e}")
    except Exception as e:
        print(f"An unexpected error occurred: {e}")

view raw JSON →