# BoldSign
Easily integrate BoldSign's e-signature features into your Python applications. This package simplifies sending documents for signature, embedding signing ceremonies, tracking document status, downloading signed documents, and managing e-signature workflows.
## Prerequisites
- Python 3.7+
- Free [developer account](https://boldsign.com/esignature-api/)
## Documentation
- [Official API documentation](https://developers.boldsign.com/)
## Installation & Usage
You can install this package by using the pip tool:
```sh
pip install boldsign
```
(You may need to run pip with root permission: sudo pip install boldsign)
Then import the package:
```python
import boldsign
```
## Dependencies
This package requires the following dependencies to function properly. They will be installed automatically when you install the package:
- urllib3>=1.25.3
- python-dateutil
- pydantic>=2
- typing-extensions>=4.7.1
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
import boldsign
configuration = boldsign.Configuration(
api_key = "***your_api_key***"
)
# Enter a context with an instance of the API client
with boldsign.ApiClient(configuration) as api_client:
# Create an instance of the DocumentApi class
document_api = boldsign.DocumentApi(api_client)
# Define the signature field to be added to the document
signatureField = boldsign.FormField(
fieldType="Signature", # Field type is Signature
pageNumber=1, # Specify the page number
bounds=boldsign.Rectangle(x=100, y=100, width=100, height=50), # Position and size of the signature field
)
# Define the signer with a name and email address
signer = boldsign.DocumentSigner(
name="David", # Name of the signer
emailAddress="david@example.com", # Signer's email address
signerType="Signer", # Specify the signer type
formFields=[signatureField] # Assign the signature field to the signer
)
# Prepare the request body for sending the document for signature
send_for_sign = boldsign.SendForSign(
title="Agreement", # Title of the document
signers=[signer], # List of signers
files=["/documents/agreement.pdf"] # Path to the document file to be signed
)
# Send the document for signature and capture the response
api_response = document_api.send_document(send_for_sign=send_for_sign)
```
Raw data
{
"_id": null,
"home_page": "https://github.com/boldsign/boldsign-python-sdk",
"name": "kamaleshpython",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "boldsign, api, sdk, BoldSign API",
"author": "BoldSign",
"author_email": "support@boldsign.com",
"download_url": "https://files.pythonhosted.org/packages/60/79/466234b97576e94dc9dbc90d17ffb1a9d0e0d26a5b32f47d11a12f0cc98d/kamaleshpython-1.0.5.tar.gz",
"platform": null,
"description": "# BoldSign\n\nEasily integrate BoldSign's e-signature features into your Python applications. This package simplifies sending documents for signature, embedding signing ceremonies, tracking document status, downloading signed documents, and managing e-signature workflows.\n\n## Prerequisites\n\n- Python 3.7+\n- Free [developer account](https://boldsign.com/esignature-api/)\n\n## Documentation\n\n- [Official API documentation](https://developers.boldsign.com/)\n\n## Installation & Usage\n\nYou can install this package by using the pip tool: \n```sh\npip install boldsign\n```\n(You may need to run pip with root permission: sudo pip install boldsign)\n\nThen import the package:\n```python\nimport boldsign\n```\n\n## Dependencies\n\nThis package requires the following dependencies to function properly. They will be installed automatically when you install the package:\n \n- urllib3>=1.25.3 \n- python-dateutil \n- pydantic>=2 \n- typing-extensions>=4.7.1 \n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```python\n\nimport boldsign\n\nconfiguration = boldsign.Configuration(\n api_key = \"***your_api_key***\"\n)\n\n# Enter a context with an instance of the API client\nwith boldsign.ApiClient(configuration) as api_client:\n # Create an instance of the DocumentApi class\n document_api = boldsign.DocumentApi(api_client)\n\n # Define the signature field to be added to the document\n signatureField = boldsign.FormField(\n fieldType=\"Signature\", # Field type is Signature\n pageNumber=1, # Specify the page number\n bounds=boldsign.Rectangle(x=100, y=100, width=100, height=50), # Position and size of the signature field\n )\n\n # Define the signer with a name and email address\n signer = boldsign.DocumentSigner(\n name=\"David\", # Name of the signer\n emailAddress=\"david@example.com\", # Signer's email address\n signerType=\"Signer\", # Specify the signer type\n formFields=[signatureField] # Assign the signature field to the signer\n )\n\n # Prepare the request body for sending the document for signature\n send_for_sign = boldsign.SendForSign(\n title=\"Agreement\", # Title of the document\n signers=[signer], # List of signers\n files=[\"/documents/agreement.pdf\"] # Path to the document file to be signed\n )\n \n # Send the document for signature and capture the response\n api_response = document_api.send_document(send_for_sign=send_for_sign)\n```\n\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "BoldSign API",
"version": "1.0.5",
"project_urls": {
"Homepage": "https://github.com/boldsign/boldsign-python-sdk"
},
"split_keywords": [
"boldsign",
" api",
" sdk",
" boldsign api"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "8b745b78e77cd5d22f24518db81161b53a6e67d47157793d11e555671c57dd95",
"md5": "4e3d801563393b10eedd176bf0d1a777",
"sha256": "eea3b55b73359085d9c2305ee4721ff851b04208b7e46d550ecaa8976a242a67"
},
"downloads": -1,
"filename": "kamaleshpython-1.0.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4e3d801563393b10eedd176bf0d1a777",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 355892,
"upload_time": "2025-07-10T04:30:42",
"upload_time_iso_8601": "2025-07-10T04:30:42.478470Z",
"url": "https://files.pythonhosted.org/packages/8b/74/5b78e77cd5d22f24518db81161b53a6e67d47157793d11e555671c57dd95/kamaleshpython-1.0.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "6079466234b97576e94dc9dbc90d17ffb1a9d0e0d26a5b32f47d11a12f0cc98d",
"md5": "4711273c54e7a3fb614f71db1589f403",
"sha256": "c8c7a91706c7434eb87ad30c8c90b6fbc7f6ebe1e304cbc3e16058039a4d1998"
},
"downloads": -1,
"filename": "kamaleshpython-1.0.5.tar.gz",
"has_sig": false,
"md5_digest": "4711273c54e7a3fb614f71db1589f403",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 128956,
"upload_time": "2025-07-10T04:30:44",
"upload_time_iso_8601": "2025-07-10T04:30:44.323545Z",
"url": "https://files.pythonhosted.org/packages/60/79/466234b97576e94dc9dbc90d17ffb1a9d0e0d26a5b32f47d11a12f0cc98d/kamaleshpython-1.0.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-10 04:30:44",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "boldsign",
"github_project": "boldsign-python-sdk",
"travis_ci": true,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "python_dateutil",
"specs": [
[
">=",
"2.5.3"
]
]
},
{
"name": "setuptools",
"specs": [
[
">=",
"21.0.0"
]
]
},
{
"name": "urllib3",
"specs": [
[
">=",
"1.25.3"
]
]
},
{
"name": "pydantic",
"specs": [
[
">=",
"2"
]
]
},
{
"name": "typing-extensions",
"specs": [
[
">=",
"4.7.1"
]
]
}
],
"tox": true,
"lcname": "kamaleshpython"
}
JSON
