Install & Compatibility
Where this runs
tested against v4.0.0 · pip install
no network on importno background threads
Install × environment matrix
Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux
muslpy 3.10–3.910 runs
installs and imports cleanly · install 0.0s · import 0.691s · 21.6MB
glibcpy 3.10–3.910 runs
installs and imports cleanly · install 2.2s · import 0.618s · 22MB
20MB installed
● package 20MB
Code
Verified usage
Verified import paths — ran on the pinned version, not inferred.
HSClient
✓ from hellosign_sdk import HSClient
✗ from hellosign_sdk import Client
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.
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}")
Errors
Common errors & fixes
ModuleNotFoundError: No module named 'hellosign_sdk'
The `hellosign-python-sdk` package is not installed in your current Python environment.
fixRun `pip install hellosign-python-sdk` in your terminal.
AttributeError: module 'hellosign_sdk' has no attribute 'Client'
You are trying to import the old client class name (`Client`) from a version 4.0.0 or newer installation.
fixChange 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.
The API key provided during client initialization is incorrect, expired, or has leading/trailing whitespace.
fixVerify your HelloSign API key from your HelloSign dashboard. Ensure no extra characters are included and that it's active.
Upgrade
Version history
4.0.0latest on PyPI · released Apr 1, 2020
Audit
Dependencies
requestsrequiredHTTP client for API communication, automatically installed.