# 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<2.1.0,>=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
from boldsign.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.boldsign.com
# See configuration.py for a list of all supported configuration parameters.
configuration = boldsign.Configuration(
host = "https://api.boldsign.com",
api_key = "***your_api_key***"
)
# Configure with access_token generated using OAuth.
# configuration = boldsign.Configuration(
# host = "https://api.boldsign.com",
# access_token = "***your_access_token***"
# )
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Enter a context with an instance of the API client
with boldsign.ApiClient(configuration) as api_client:
# Create an instance of the DocumentApi class
api_instance = boldsign.DocumentApi(api_client)
# Define the signature field to be added to the document
signatureField = boldsign.FormField(
id="sign",
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
isRequired=True, # Mark this field as required
font="Helvetica" # Specify the font
)
# 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
)
try:
# Send the document for signature and capture the response
api_response = api_instance.send_document(send_for_sign=send_for_sign)
print("The response from DocumentApi->send_document:\n")
pprint(api_response)
except Exception as e:
# Print an error message if an exception occurs
print(f"Exception when calling DocumentApi->send_document: {e}\n")
```
Raw data
{
"_id": null,
"home_page": "https://github.com/boldsign/api-csharp-sdk",
"name": "boldsign",
"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/f4/a4/a3276bc5823301a302fc6419dbcf2c609779df6928cf5ff851aeefddd71e/boldsign-1.0.0b0.tar.gz",
"platform": null,
"description": "# boldsign\r\n\r\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.\r\n\r\n## Prerequisites\r\n\r\n- Python 3.7+\r\n- Free [developer account](https://boldsign.com/esignature-api/)\r\n\r\n## Documentation\r\n\r\n- [Official API documentation](https://developers.boldsign.com/)\r\n\r\n## Installation & Usage\r\n\r\nYou can install this package by using the pip tool: \r\n```sh\r\npip install boldsign\r\n```\r\n(You may need to run pip with root permission: sudo pip install boldsign)\r\n\r\nThen import the package:\r\n```python\r\nimport boldsign\r\n```\r\n\r\n## Dependencies\r\n\r\nThis package requires the following dependencies to function properly. They will be installed automatically when you install the package:\r\n \r\n- urllib3<2.1.0,>=1.25.3 \r\n- python-dateutil \r\n- pydantic>=2 \r\n- typing-extensions>=4.7.1 \r\n\r\n## Getting Started\r\n\r\nPlease follow the [installation procedure](#installation--usage) and then run the following:\r\n\r\n```python\r\n\r\nimport boldsign\r\nfrom boldsign.rest import ApiException\r\nfrom pprint import pprint\r\n\r\n# Defining the host is optional and defaults to https://api.boldsign.com\r\n# See configuration.py for a list of all supported configuration parameters.\r\nconfiguration = boldsign.Configuration(\r\n host = \"https://api.boldsign.com\",\r\n api_key = \"***your_api_key***\"\r\n)\r\n\r\n# Configure with access_token generated using OAuth. \r\n# configuration = boldsign.Configuration(\r\n# host = \"https://api.boldsign.com\",\r\n# access_token = \"***your_access_token***\"\r\n# )\r\n\r\n# The client must configure the authentication and authorization parameters\r\n# in accordance with the API server security policy.\r\n# Examples for each auth method are provided below, use the example that\r\n# satisfies your auth use case.\r\n\r\n# Enter a context with an instance of the API client\r\nwith boldsign.ApiClient(configuration) as api_client:\r\n # Create an instance of the DocumentApi class\r\n api_instance = boldsign.DocumentApi(api_client)\r\n\r\n # Define the signature field to be added to the document\r\n signatureField = boldsign.FormField(\r\n id=\"sign\",\r\n fieldType=\"Signature\", # Field type is Signature\r\n pageNumber=1, # Specify the page number\r\n bounds=boldsign.Rectangle(x=100, y=100, width=100, height=50), # Position and size of the signature field\r\n isRequired=True, # Mark this field as required\r\n font=\"Helvetica\" # Specify the font\r\n )\r\n\r\n # Define the signer with a name and email address\r\n signer = boldsign.DocumentSigner(\r\n name=\"David\", # Name of the signer\r\n emailAddress=\"david@example.com\", # Signer's email address\r\n signerType=\"Signer\", # Specify the signer type\r\n formFields=[signatureField] # Assign the signature field to the signer\r\n )\r\n\r\n # Prepare the request body for sending the document for signature\r\n send_for_sign = boldsign.SendForSign(\r\n title=\"Agreement\", # Title of the document\r\n signers=[signer], # List of signers\r\n files=[\"/documents/agreement.pdf\"] # Path to the document file to be signed\r\n )\r\n\r\n try:\r\n # Send the document for signature and capture the response\r\n api_response = api_instance.send_document(send_for_sign=send_for_sign)\r\n print(\"The response from DocumentApi->send_document:\\n\")\r\n pprint(api_response)\r\n except Exception as e:\r\n # Print an error message if an exception occurs\r\n print(f\"Exception when calling DocumentApi->send_document: {e}\\n\")\r\n```\r\n\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "BoldSign API",
"version": "1.0.0b0",
"project_urls": {
"Homepage": "https://github.com/boldsign/api-csharp-sdk"
},
"split_keywords": [
"boldsign",
" api",
" sdk",
" boldsign api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a3b1f6e9896fe8ac486990ac14f6dad8b8d7a28b01ac79fbe15c28028d2038eb",
"md5": "cfb7e831a8fa51e7f88bf16033d62642",
"sha256": "3ed45d5fbe577db630e40a555c1e7db92e5f714b41c6e96f2e0580629d850c51"
},
"downloads": -1,
"filename": "boldsign-1.0.0b0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "cfb7e831a8fa51e7f88bf16033d62642",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 313341,
"upload_time": "2024-10-17T12:39:30",
"upload_time_iso_8601": "2024-10-17T12:39:30.030953Z",
"url": "https://files.pythonhosted.org/packages/a3/b1/f6e9896fe8ac486990ac14f6dad8b8d7a28b01ac79fbe15c28028d2038eb/boldsign-1.0.0b0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f4a4a3276bc5823301a302fc6419dbcf2c609779df6928cf5ff851aeefddd71e",
"md5": "30508573636bce6f3c40bc85ce1ead43",
"sha256": "71ef76367446e7645caf6b593d55d6d154f67f6dbe1ccd98d5ad4abc744af079"
},
"downloads": -1,
"filename": "boldsign-1.0.0b0.tar.gz",
"has_sig": false,
"md5_digest": "30508573636bce6f3c40bc85ce1ead43",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 114221,
"upload_time": "2024-10-17T12:39:32",
"upload_time_iso_8601": "2024-10-17T12:39:32.924991Z",
"url": "https://files.pythonhosted.org/packages/f4/a4/a3276bc5823301a302fc6419dbcf2c609779df6928cf5ff851aeefddd71e/boldsign-1.0.0b0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-17 12:39:32",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "boldsign",
"github_project": "api-csharp-sdk",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "boldsign"
}
JSON
