Name | skribble-sdk JSON |
Version |
0.17
JSON |
| download |
home_page | None |
Summary | A Python SDK for the Skribble API |
upload_time | 2025-01-26 14:58:19 |
maintainer | None |
docs_url | None |
author | None |
requires_python | >=3.7 |
license | MIT License Copyright (c) 2024 This is an unofficial, open-source SDK for Skribble's API. This project is not affiliated with, endorsed by, or connected to Skribble AG. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
keywords |
skribble
api
sdk
|
VCS |
 |
bugtrack_url |
|
requirements |
No requirements were recorded.
|
Travis-CI |
No Travis.
|
coveralls test coverage |
No coveralls.
|
# Skribble SDK
A Python SDK for interacting with the Skribble API.
## Installation
You can install the Skribble SDK using pip:
```
pip install skribble-sdk
```
## Basic Usage
Here is a basic example of how to use the Skribble Python SDK to create a signature request:
```python
import skribble
# Replace with your actual API credentials
USERNAME = "your_username"
API_KEY = "your_api_key"
# Initialize the SDK and get the access token
token = skribble.init(USERNAME, API_KEY)
print(f"Access token: {token}")
# Create a signature request
signature_request = {
"title": "Test Signature Request",
"message": "Please sign this test document",
"file_url": "https://pdfobject.com/pdf/sample.pdf",
"signatures": [
{
"account_email": "signer1@example.com"
}
],
}
create_response = skribble.signature_request.create(signature_request)
print(create_response)
```
For more detailed examples and advanced usage, please refer to the [Documentation](https://skribblesdk.mintlify.app/).
Raw data
{
"_id": null,
"home_page": null,
"name": "skribble-sdk",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "skribble, api, sdk",
"author": null,
"author_email": "Eric Campos <ec@webix.ch>",
"download_url": "https://files.pythonhosted.org/packages/a1/a8/c10b46c5fc83b6ec10a75097fc8eadb6f8909f5ce213154422cbbbf85885/skribble_sdk-0.17.tar.gz",
"platform": null,
"description": "# Skribble SDK\r\n\r\nA Python SDK for interacting with the Skribble API.\r\n\r\n## Installation\r\n\r\nYou can install the Skribble SDK using pip:\r\n\r\n```\r\npip install skribble-sdk\r\n```\r\n\r\n## Basic Usage\r\n\r\nHere is a basic example of how to use the Skribble Python SDK to create a signature request:\r\n\r\n```python\r\nimport skribble\r\n\r\n# Replace with your actual API credentials\r\nUSERNAME = \"your_username\"\r\nAPI_KEY = \"your_api_key\"\r\n\r\n# Initialize the SDK and get the access token\r\ntoken = skribble.init(USERNAME, API_KEY)\r\nprint(f\"Access token: {token}\")\r\n\r\n# Create a signature request\r\nsignature_request = {\r\n \"title\": \"Test Signature Request\",\r\n \"message\": \"Please sign this test document\",\r\n \"file_url\": \"https://pdfobject.com/pdf/sample.pdf\",\r\n \"signatures\": [\r\n {\r\n \"account_email\": \"signer1@example.com\"\r\n }\r\n ],\r\n}\r\n\r\ncreate_response = skribble.signature_request.create(signature_request)\r\nprint(create_response)\r\n```\r\n\r\nFor more detailed examples and advanced usage, please refer to the [Documentation](https://skribblesdk.mintlify.app/).\r\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 This is an unofficial, open-source SDK for Skribble's API. This project is not affiliated with, endorsed by, or connected to Skribble AG. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "A Python SDK for the Skribble API",
"version": "0.17",
"project_urls": {
"Documentation": "https://skribblesdk.mintlify.app/",
"Homepage": "https://github.com/LeEricCH/skribble-sdk",
"Repository": "https://github.com/LeEricCH/skribble-sdk.git"
},
"split_keywords": [
"skribble",
" api",
" sdk"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "834c91fa3b031f13ce090906a7a296b8d3084013dd9f8a813ee72ac453cfceef",
"md5": "7e40e1ef83193209b78b34cf8d38e422",
"sha256": "ef7943fd39f1710d871b65b396729a5854d5e6aee866f49d4e81c85eb4f8d329"
},
"downloads": -1,
"filename": "skribble_sdk-0.17-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7e40e1ef83193209b78b34cf8d38e422",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 17914,
"upload_time": "2025-01-26T14:58:16",
"upload_time_iso_8601": "2025-01-26T14:58:16.440619Z",
"url": "https://files.pythonhosted.org/packages/83/4c/91fa3b031f13ce090906a7a296b8d3084013dd9f8a813ee72ac453cfceef/skribble_sdk-0.17-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a1a8c10b46c5fc83b6ec10a75097fc8eadb6f8909f5ce213154422cbbbf85885",
"md5": "53c92d4dc46c4c5dba2ebc5a5e36dac3",
"sha256": "4c80dda7fb4fa81d7b5bb217bd4e5c4b3cd340fd1ce96fa6a3e2219007a2a140"
},
"downloads": -1,
"filename": "skribble_sdk-0.17.tar.gz",
"has_sig": false,
"md5_digest": "53c92d4dc46c4c5dba2ebc5a5e36dac3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 19881,
"upload_time": "2025-01-26T14:58:19",
"upload_time_iso_8601": "2025-01-26T14:58:19.991933Z",
"url": "https://files.pythonhosted.org/packages/a1/a8/c10b46c5fc83b6ec10a75097fc8eadb6f8909f5ce213154422cbbbf85885/skribble_sdk-0.17.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-26 14:58:19",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "LeEricCH",
"github_project": "skribble-sdk",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "skribble-sdk"
}