Install & Compatibility
Where this runs
tested against v1.12.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.95 runs
installs and imports cleanly · install 0.0s · import 3.432s · 34.3MB
glibcpy 3.10–3.95 runs
installs and imports cleanly · install 3.7s · import 3.270s · 34MB
33MB installed
● package 33MB
Code
Verified usage
Verified import paths — ran on the pinned version, not inferred.
Configuration
✓ from dropbox_sign import Configuration
✗ from hellosign_sdk import Configuration
The package name and module paths changed significantly from 'hellosign-sdk' to 'dropbox-sign'.
ApiClient
✓ from dropbox_sign import ApiClient
✗ from hellosign_sdk import ApiClient
The core API client class now resides under the 'dropbox_sign' namespace.
account_api
✓ from dropbox_sign.apis import account_api
✗ from hellosign_sdk.apis import account_api
Specific API modules are now located within the 'dropbox_sign.apis' subpackage.
ApiException
✓ from dropbox_sign.exceptions import ApiException
Specific exceptions like ApiException for API errors are found here.
This quickstart demonstrates how to initialize the Dropbox Sign client using an API key from an environment variable, fetch basic account information, and handle potential API errors. Replace `DROPBOX_SIGN_API_KEY` with your actual API key.
import os
from dropbox_sign import Configuration, ApiClient
from dropbox_sign.apis import account_api
from dropbox_sign.exceptions import ApiException
# It's recommended to load your API key from environment variables
api_key = os.environ.get('DROPBOX_SIGN_API_KEY', '')
if not api_key:
print("Warning: DROPBOX_SIGN_API_KEY environment variable not set. "
"This example will likely fail. Please set it for a successful run.")
# Configure API key authorization
configuration = Configuration(api_key=api_key)
try:
# Create an API client instance
with ApiClient(configuration) as api_client:
# Instantiate a specific API (e.g., AccountApi) with the client
account_api_instance = account_api.AccountApi(api_client)
# Call an API method, e.g., get the current account information
response = account_api_instance.account_get()
print("Successfully retrieved account information:")
print(response.to_dict()) # Convert response model to dictionary for easy printing
except ApiException as e:
print(f"Error calling Dropbox Sign API: Status {e.status}, Reason {e.reason}, Body {e.body}")
except Exception as e:
print(f"An unexpected error occurred: {e}")
Debug
Known issues
breakingThe package name and entire module structure changed from `hellosign-sdk` to `dropbox-sign`. This is not a simple upgrade.fixYou must uninstall `hellosign-sdk` and install `dropbox-sign`. All import paths and class names will need to be updated. Refer to the official migration guide on GitHub: `github.com/hellosign/dropbox-sign-python#migration-from-hellosign-sdk-to-dropbox-sign-python-sdk`
affects: All versions migrating from `hellosign-sdk` to `dropbox-sign`
gotchaAPI Key vs. OAuth2 for authentication: Ensure you use the correct configuration method for your chosen authentication flow.fixFor API Key authentication, set `Configuration.api_key = 'YOUR_API_KEY'`. For OAuth2, set `Configuration.username` (client ID) and `Configuration.password` (client secret). Using environment variables for sensitive credentials like `os.environ.get('DROPBOX_SIGN_API_KEY')` is highly recommended. affects: All versions
gotchaAPI errors are raised as `ApiException`. Catching generic `Exception` might mask specific API response issues.fixAlways catch `dropbox_sign.exceptions.ApiException` for API-specific errors. This allows you to inspect `e.status`, `e.reason`, and `e.body` for detailed error information returned by the Dropbox Sign API.
affects: All versions
Errors
Common errors & fixes
ModuleNotFoundError: No module named 'hellosign'
The official Python SDK for Dropbox Sign was renamed from `hellosign-python-sdk` to `dropbox-sign`. Code attempting to import the old package name will fail.
fixFirst, uninstall the old SDK if it's present (`pip uninstall hellosign-python-sdk`). Then, install the new SDK (`pip install dropbox-sign`) and update your import statements from `import hellosign` to `import dropbox_sign` or specific modules like `from dropbox_sign import ApiClient, ApiException, Configuration, apis, models`.
ApiException: (401)
Reason: Unauthorized
HTTP response body: {"error": {"error_msg": "The credentials you have supplied are invalid."}}
The API key provided in the SDK's configuration is incorrect, expired, or does not have the necessary permissions to perform the requested action.
fixVerify that your API key is correct and active in your Dropbox Sign dashboard. Ensure it is correctly passed to the `Configuration` object, typically as the `username` parameter: `configuration = Configuration(username="YOUR_API_KEY")`.
ApiException: (400)
Reason: Bad Request
HTTP response body: {"error": {"error_msg": "Missing parameter: client_id"}}
A required parameter for the specific API endpoint call is missing or has an invalid format in the request payload.
fixConsult the Dropbox Sign API documentation for the specific endpoint you are calling (e.g., `signature_request_create_embedded`). Ensure all mandatory parameters, such as `client_id`, `signers`, or `files`, are included in your request model and are correctly formatted.
AttributeError: 'Client' object has no attribute 'send_signature_request'
This error often occurs when migrating from an older version of the Dropbox Sign (formerly HelloSign) Python SDK to the new `dropbox-sign` SDK. The new SDK introduces breaking changes, including a new API client architecture where endpoints are accessed through specific API classes (e.g., `SignatureRequestApi`) rather than a flat client object, and request bodies are passed as model objects.
fixUpdate your code to use the new SDK's structure. Instead of calling methods directly on a generic client, instantiate the relevant API class (e.g., `signature_request_api = apis.SignatureRequestApi(api_client)`) and use its methods with corresponding model objects (e.g., `response = signature_request_api.signature_request_send(data)`). Refer to the migration guide for detailed changes.
Upgrade
Version history
1.12.0latest on PyPI · released Aug 18, 2026
Audit
Dependencies
No dependency data recorded yet.