# The Official PandaDoc Python client SDK
PandaDoc SDK spans a broad range of functionality to help you build incredible documents automation experiences inside your product.
## Docs
- [Official public API documentation](https://developers.pandadoc.com/reference/about)
## Requirements
Python >= 3.6
## Installation
#### pip install
If the python package is hosted on a repository, you can install directly using:
```sh
pip install pandadoc-python-client
```
(you may need to run `pip` with root permission: `sudo pip install pandadoc-python-client`)
Then import the package:
```python
import pandadoc_client
```
## Getting Started
```python
from pprint import pprint
import pandadoc_client
from pandadoc_client.api import templates_api
# Configure API key authorization: apiKey
api_key = "YOUR_API_KEY"
# Defining the host is optional and defaults to https://api.pandadoc.com
# See configuration.py for a list of all supported configuration parameters.
cfg = pandadoc_client.Configuration(
host="https://api.pandadoc.com",
api_key={"apiKey": f"API-Key {api_key}"},
)
# Enter a context with an instance of the API client
with pandadoc_client.ApiClient(cfg) as api_client:
# Create an instance of the API class
api_instance = templates_api.TemplatesApi(api_client)
try:
resp = api_instance.list_templates(tag=["doe-inc-proposals"])
pprint(resp)
except pandadoc_client.ApiException as e:
pprint("Exception when calling TemplatesApi->list_templates: %s\n" % e)
```
## Authorization
### apiKey
- **Type**: API key
- **API key parameter name**: Authorization
- **Location**: HTTP header
### oauth2
- **Type**: OAuth
- **Flow**: accessCode
- **Authorization URL**: https://app.pandadoc.com/oauth2/authorize
- **Scopes**:
- **read+write**: Use `read+write` to create, send, delete, and download documents, and `read` to view templates and document details.
## Examples
- [Create and send document from a template](https://github.com/PandaDoc/pandadoc-api-python-client/blob/main/examples/create_from_template_and_send.py)
- [Create and send document from the pdf url](https://github.com/PandaDoc/pandadoc-api-python-client/blob/main/examples/create_from_pdf_by_url_and_send.py)
## Docs
### Official PandaDoc public API docs
https://developers.pandadoc.com/reference/about
## License
SDK is licensed under the following [License](https://github.com/PandaDoc/pandadoc-api-python-client/blob/main/LICENSE).
Raw data
{
"_id": null,
"home_page": "https://github.com/PandaDoc/pandadoc-api-python-client",
"name": "pandadoc-python-client",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "OpenAPI, PandaDoc Public API",
"author": "PandaDoc",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/ff/de/1788dc19bb480664110f2a1f3456a8562446413ccb0ddfdc2819da40eaa4/pandadoc-python-client-6.2.0.tar.gz",
"platform": null,
"description": " # The Official PandaDoc Python client SDK\nPandaDoc SDK spans a broad range of functionality to help you build incredible documents automation experiences inside your product.\n\n## Docs\n- [Official public API documentation](https://developers.pandadoc.com/reference/about)\n\n## Requirements\nPython >= 3.6\n\n## Installation\n#### pip install\nIf the python package is hosted on a repository, you can install directly using:\n```sh\npip install pandadoc-python-client\n```\n(you may need to run `pip` with root permission: `sudo pip install pandadoc-python-client`)\n\nThen import the package:\n```python\nimport pandadoc_client\n```\n\n## Getting Started\n\n```python\nfrom pprint import pprint\n\nimport pandadoc_client\nfrom pandadoc_client.api import templates_api\n\n# Configure API key authorization: apiKey\napi_key = \"YOUR_API_KEY\"\n\n# Defining the host is optional and defaults to https://api.pandadoc.com\n# See configuration.py for a list of all supported configuration parameters.\ncfg = pandadoc_client.Configuration(\n host=\"https://api.pandadoc.com\",\n api_key={\"apiKey\": f\"API-Key {api_key}\"},\n)\n\n# Enter a context with an instance of the API client\nwith pandadoc_client.ApiClient(cfg) as api_client:\n # Create an instance of the API class\n api_instance = templates_api.TemplatesApi(api_client)\n\n try:\n resp = api_instance.list_templates(tag=[\"doe-inc-proposals\"])\n pprint(resp)\n except pandadoc_client.ApiException as e:\n pprint(\"Exception when calling TemplatesApi->list_templates: %s\\n\" % e)\n```\n\n## Authorization\n### apiKey\n- **Type**: API key\n- **API key parameter name**: Authorization\n- **Location**: HTTP header\n### oauth2\n- **Type**: OAuth\n- **Flow**: accessCode\n- **Authorization URL**: https://app.pandadoc.com/oauth2/authorize\n- **Scopes**: \n - **read+write**: Use `read+write` to create, send, delete, and download documents, and `read` to view templates and document details.\n\n## Examples\n\n- [Create and send document from a template](https://github.com/PandaDoc/pandadoc-api-python-client/blob/main/examples/create_from_template_and_send.py)\n- [Create and send document from the pdf url](https://github.com/PandaDoc/pandadoc-api-python-client/blob/main/examples/create_from_pdf_by_url_and_send.py)\n\n## Docs\n### Official PandaDoc public API docs\nhttps://developers.pandadoc.com/reference/about\n\n## License\nSDK is licensed under the following [License](https://github.com/PandaDoc/pandadoc-api-python-client/blob/main/LICENSE).\n\n \n",
"bugtrack_url": null,
"license": "MIT",
"summary": "PandaDoc Public API",
"version": "6.2.0",
"project_urls": {
"Homepage": "https://github.com/PandaDoc/pandadoc-api-python-client"
},
"split_keywords": [
"openapi",
" pandadoc public api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "aa39aec7ae9705bc84d2f8139f9c519f6654dff342425fe29bebc9289f62a8dc",
"md5": "0a6b9127084a1c8e9cbebe0a602add54",
"sha256": "2786399a489ddd4c05fb2f4dc26d662e88b1961b2e48cbe3eebe7365c8a21d24"
},
"downloads": -1,
"filename": "pandadoc_python_client-6.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0a6b9127084a1c8e9cbebe0a602add54",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 485836,
"upload_time": "2024-04-08T08:40:58",
"upload_time_iso_8601": "2024-04-08T08:40:58.026618Z",
"url": "https://files.pythonhosted.org/packages/aa/39/aec7ae9705bc84d2f8139f9c519f6654dff342425fe29bebc9289f62a8dc/pandadoc_python_client-6.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ffde1788dc19bb480664110f2a1f3456a8562446413ccb0ddfdc2819da40eaa4",
"md5": "8b3b5e3d4f49f5fa99d938895ffa13eb",
"sha256": "81530256f6cbaaee9c18059ed514153a833b19cf95061040a548c63d6b1cb3d3"
},
"downloads": -1,
"filename": "pandadoc-python-client-6.2.0.tar.gz",
"has_sig": false,
"md5_digest": "8b3b5e3d4f49f5fa99d938895ffa13eb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 113600,
"upload_time": "2024-04-08T08:41:00",
"upload_time_iso_8601": "2024-04-08T08:41:00.295634Z",
"url": "https://files.pythonhosted.org/packages/ff/de/1788dc19bb480664110f2a1f3456a8562446413ccb0ddfdc2819da40eaa4/pandadoc-python-client-6.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-08 08:41:00",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "PandaDoc",
"github_project": "pandadoc-api-python-client",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "pandadoc-python-client"
}
JSON
