{"id":19383928,"url":"https://github.com/docspring/docspring-python","last_synced_at":"2026-06-13T04:31:40.790Z","repository":{"id":66068863,"uuid":"220522781","full_name":"DocSpring/docspring-python","owner":"DocSpring","description":"Python API Client for DocSpring","archived":false,"fork":false,"pushed_at":"2025-09-24T00:58:59.000Z","size":416,"stargazers_count":0,"open_issues_count":1,"forks_count":2,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-04-29T06:07:46.782Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://pypi.org/project/docspring/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/DocSpring.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2019-11-08T18:11:03.000Z","updated_at":"2025-09-24T00:59:03.000Z","dependencies_parsed_at":"2025-09-24T02:33:19.431Z","dependency_job_id":"2b6f1ea5-1a3b-41d4-b6e3-a30768e5d7bc","html_url":"https://github.com/DocSpring/docspring-python","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"purl":"pkg:github/DocSpring/docspring-python","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DocSpring%2Fdocspring-python","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DocSpring%2Fdocspring-python/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DocSpring%2Fdocspring-python/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DocSpring%2Fdocspring-python/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DocSpring","download_url":"https://codeload.github.com/DocSpring/docspring-python/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DocSpring%2Fdocspring-python/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34272603,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-13T02:00:06.617Z","response_time":62,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-10T09:28:25.828Z","updated_at":"2026-06-13T04:31:40.784Z","avatar_url":"https://github.com/DocSpring.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# docspring\nUse DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.\n\nThis Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: v1\n- Package version: 3.0.0\n- Generator version: 7.16.0-DOCSPRING\n- Build package: org.openapitools.codegen.languages.PythonClientCodegen\n\n## Requirements.\n\nPython 3.9+\n\n## Installation \u0026 Usage\n### pip install\n\nIf the python package is hosted on a repository, you can install directly using:\n\n```sh\npip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git\n```\n(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)\n\nThen import the package:\n```python\nimport docspring\n```\n\n### Setuptools\n\nInstall via [Setuptools](http://pypi.python.org/pypi/setuptools).\n\n```sh\npython setup.py install --user\n```\n(or `sudo python setup.py install` to install the package for all users)\n\nThen import the package:\n```python\nimport docspring\n```\n\n### Tests\n\nExecute `pytest` to run the tests.\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```python\n\nimport docspring\nfrom docspring.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to https://sync.api.docspring.com/api/v1\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = docspring.Configuration(\n    host = \"https://sync.api.docspring.com/api/v1\"\n)\n\n# The client must configure the authentication and authorization parameters\n# in accordance with the API server security policy.\n# Examples for each auth method are provided below, use the example that\n# satisfies your auth use case.\n\n# Configure HTTP basic authorization: api_token_basic\nconfiguration = docspring.Configuration(\n    username = os.environ[\"USERNAME\"],\n    password = os.environ[\"PASSWORD\"]\n)\n\n\n# Enter a context with an instance of the API client\nwith docspring.ApiClient(configuration) as api_client:\n    # Create an instance of the API class\n    api_instance = docspring.Client(api_client)\n    template_id = 'tpl_1234567890abcdef02' # str | \n    data = docspring.AddFieldsData() # AddFieldsData | \n\n    try:\n        # Add new fields to a Template\n        api_response = api_instance.add_fields_to_template(template_id, data)\n        print(\"The response of Client-\u003eadd_fields_to_template:\\n\")\n        pprint(api_response)\n    except ApiException as e:\n        print(\"Exception when calling Client-\u003eadd_fields_to_template: %s\\n\" % e)\n\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *https://sync.api.docspring.com/api/v1*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*Client* | [**add_fields_to_template**](docs/Client.md#add_fields_to_template) | **PUT** /templates/{template_id}/add_fields | Add new fields to a Template\n*Client* | [**batch_generate_pdfs**](docs/Client.md#batch_generate_pdfs) | **POST** /submissions/batches | Generate multiple PDFs\n*Client* | [**combine_pdfs**](docs/Client.md#combine_pdfs) | **POST** /combined_submissions | Merge submission PDFs, template PDFs, or custom files\n*Client* | [**copy_template**](docs/Client.md#copy_template) | **POST** /templates/{template_id}/copy | Copy a template\n*Client* | [**create_custom_file_from_upload**](docs/Client.md#create_custom_file_from_upload) | **POST** /custom_files | Create a new custom file from a cached S3 upload\n*Client* | [**create_data_request_event**](docs/Client.md#create_data_request_event) | **POST** /data_requests/{data_request_id}/events | Create a new event for emailing a signee a request for signature\n*Client* | [**create_data_request_token**](docs/Client.md#create_data_request_token) | **POST** /data_requests/{data_request_id}/tokens | Create a new data request token for form authentication\n*Client* | [**create_folder**](docs/Client.md#create_folder) | **POST** /folders/ | Create a folder\n*Client* | [**create_html_template**](docs/Client.md#create_html_template) | **POST** /templates?endpoint_variant\u0026#x3D;create_html_template | Create a new HTML template\n*Client* | [**create_pdf_template**](docs/Client.md#create_pdf_template) | **POST** /templates | Create a new PDF template with a form POST file upload\n*Client* | [**create_pdf_template_from_upload**](docs/Client.md#create_pdf_template_from_upload) | **POST** /templates?endpoint_variant\u0026#x3D;create_template_from_cached_upload | Create a new PDF template from a cached S3 file upload\n*Client* | [**delete_folder**](docs/Client.md#delete_folder) | **DELETE** /folders/{folder_id} | Delete a folder\n*Client* | [**delete_template**](docs/Client.md#delete_template) | **DELETE** /templates/{template_id} | Delete a template\n*Client* | [**expire_combined_submission**](docs/Client.md#expire_combined_submission) | **DELETE** /combined_submissions/{combined_submission_id} | Expire a combined submission\n*Client* | [**expire_submission**](docs/Client.md#expire_submission) | **DELETE** /submissions/{submission_id} | Expire a PDF submission\n*Client* | [**generate_pdf**](docs/Client.md#generate_pdf) | **POST** /templates/{template_id}/submissions | Generate a PDF\n*Client* | [**generate_preview**](docs/Client.md#generate_preview) | **POST** /submissions/{submission_id}/generate_preview | Generate a preview PDF for partially completed data requests\n*Client* | [**get_combined_submission**](docs/Client.md#get_combined_submission) | **GET** /combined_submissions/{combined_submission_id} | Check the status of a combined submission (merged PDFs)\n*Client* | [**get_data_request**](docs/Client.md#get_data_request) | **GET** /data_requests/{data_request_id} | Look up a submission data request\n*Client* | [**get_full_template**](docs/Client.md#get_full_template) | **GET** /templates/{template_id}?full\u0026#x3D;true | Fetch the full attributes for a PDF template\n*Client* | [**get_presign_url**](docs/Client.md#get_presign_url) | **GET** /uploads/presign | Get a presigned S3 URL for direct file upload\n*Client* | [**get_submission**](docs/Client.md#get_submission) | **GET** /submissions/{submission_id} | Check the status of a PDF\n*Client* | [**get_submission_batch**](docs/Client.md#get_submission_batch) | **GET** /submissions/batches/{submission_batch_id} | Check the status of a submission batch job\n*Client* | [**get_template**](docs/Client.md#get_template) | **GET** /templates/{template_id} | Check the status of an uploaded template\n*Client* | [**get_template_schema**](docs/Client.md#get_template_schema) | **GET** /templates/{template_id}/schema | Fetch the JSON schema for a template\n*Client* | [**list_combined_submissions**](docs/Client.md#list_combined_submissions) | **GET** /combined_submissions | Get a list of all combined submissions\n*Client* | [**list_folders**](docs/Client.md#list_folders) | **GET** /folders/ | Get a list of all folders\n*Client* | [**list_submissions**](docs/Client.md#list_submissions) | **GET** /submissions | List all submissions\n*Client* | [**list_template_submissions**](docs/Client.md#list_template_submissions) | **GET** /templates/{template_id}/submissions | List all submissions for a given template\n*Client* | [**list_templates**](docs/Client.md#list_templates) | **GET** /templates | Get a list of all templates\n*Client* | [**move_folder_to_folder**](docs/Client.md#move_folder_to_folder) | **POST** /folders/{folder_id}/move | Move a folder\n*Client* | [**move_template_to_folder**](docs/Client.md#move_template_to_folder) | **POST** /templates/{template_id}/move | Move Template to folder\n*Client* | [**publish_template_version**](docs/Client.md#publish_template_version) | **POST** /templates/{template_id}/publish_version | Publish a template version\n*Client* | [**rename_folder**](docs/Client.md#rename_folder) | **POST** /folders/{folder_id}/rename | Rename a folder\n*Client* | [**restore_template_version**](docs/Client.md#restore_template_version) | **POST** /templates/{template_id}/restore_version | Restore a template version\n*Client* | [**test_authentication**](docs/Client.md#test_authentication) | **GET** /authentication | Test authentication\n*Client* | [**update_data_request**](docs/Client.md#update_data_request) | **PUT** /data_requests/{data_request_id} | Update a submission data request\n*Client* | [**update_template**](docs/Client.md#update_template) | **PUT** /templates/{template_id} | Update a Template\n*Client* | [**update_template_document**](docs/Client.md#update_template_document) | **PUT** /templates/{template_id}?endpoint_variant\u0026#x3D;update_template_pdf_with_form_post | Update a template\u0026#39;s document with a form POST file upload\n*Client* | [**update_template_document_from_upload**](docs/Client.md#update_template_document_from_upload) | **PUT** /templates/{template_id}?endpoint_variant\u0026#x3D;update_template_pdf_with_cached_upload | Update a template\u0026#39;s document with a cached S3 file upload\n\n\n## Documentation For Models\n\n - [AddFieldsData](docs/AddFieldsData.md)\n - [BatchGeneratePdfs201Response](docs/BatchGeneratePdfs201Response.md)\n - [CombinePdfsData](docs/CombinePdfsData.md)\n - [CombinedSubmission](docs/CombinedSubmission.md)\n - [CombinedSubmissionAction](docs/CombinedSubmissionAction.md)\n - [CopyTemplateOptions](docs/CopyTemplateOptions.md)\n - [CreateCombinedSubmissionResponse](docs/CreateCombinedSubmissionResponse.md)\n - [CreateCustomFileData](docs/CreateCustomFileData.md)\n - [CreateCustomFileResponse](docs/CreateCustomFileResponse.md)\n - [CreateFolderData](docs/CreateFolderData.md)\n - [CreateHtmlTemplate](docs/CreateHtmlTemplate.md)\n - [CreatePdfSubmissionData](docs/CreatePdfSubmissionData.md)\n - [CreatePdfTemplate](docs/CreatePdfTemplate.md)\n - [CreateSubmissionDataRequestData](docs/CreateSubmissionDataRequestData.md)\n - [CreateSubmissionDataRequestEventRequest](docs/CreateSubmissionDataRequestEventRequest.md)\n - [CreateSubmissionDataRequestEventResponse](docs/CreateSubmissionDataRequestEventResponse.md)\n - [CreateSubmissionDataRequestResponse](docs/CreateSubmissionDataRequestResponse.md)\n - [CreateSubmissionDataRequestTokenResponse](docs/CreateSubmissionDataRequestTokenResponse.md)\n - [CreateSubmissionResponse](docs/CreateSubmissionResponse.md)\n - [CustomFile](docs/CustomFile.md)\n - [ErrorOrMultipleErrorsResponse](docs/ErrorOrMultipleErrorsResponse.md)\n - [ErrorResponse](docs/ErrorResponse.md)\n - [Folder](docs/Folder.md)\n - [JsonSchema](docs/JsonSchema.md)\n - [ListSubmissionsResponse](docs/ListSubmissionsResponse.md)\n - [MoveFolderData](docs/MoveFolderData.md)\n - [MoveTemplateData](docs/MoveTemplateData.md)\n - [MultipleErrorsResponse](docs/MultipleErrorsResponse.md)\n - [PublishVersionData](docs/PublishVersionData.md)\n - [RenameFolderData](docs/RenameFolderData.md)\n - [RestoreVersionData](docs/RestoreVersionData.md)\n - [Submission](docs/Submission.md)\n - [Submission422Response](docs/Submission422Response.md)\n - [SubmissionAction](docs/SubmissionAction.md)\n - [SubmissionBatch](docs/SubmissionBatch.md)\n - [SubmissionBatchData](docs/SubmissionBatchData.md)\n - [SubmissionBatchWithSubmissions](docs/SubmissionBatchWithSubmissions.md)\n - [SubmissionDataRequest](docs/SubmissionDataRequest.md)\n - [SubmissionDataRequestEvent](docs/SubmissionDataRequestEvent.md)\n - [SubmissionDataRequestShow](docs/SubmissionDataRequestShow.md)\n - [SubmissionDataRequestToken](docs/SubmissionDataRequestToken.md)\n - [SubmissionPreview](docs/SubmissionPreview.md)\n - [SuccessErrorResponse](docs/SuccessErrorResponse.md)\n - [SuccessMultipleErrorsResponse](docs/SuccessMultipleErrorsResponse.md)\n - [Template](docs/Template.md)\n - [TemplateAddFieldsResponse](docs/TemplateAddFieldsResponse.md)\n - [TemplateDeleteResponse](docs/TemplateDeleteResponse.md)\n - [TemplatePreview](docs/TemplatePreview.md)\n - [TemplatePublishVersionResponse](docs/TemplatePublishVersionResponse.md)\n - [UpdateHtmlTemplate](docs/UpdateHtmlTemplate.md)\n - [UpdatePdfTemplate](docs/UpdatePdfTemplate.md)\n - [UpdateSubmissionDataRequestData](docs/UpdateSubmissionDataRequestData.md)\n - [UploadPresignResponse](docs/UploadPresignResponse.md)\n\n\n\u003ca id=\"documentation-for-authorization\"\u003e\u003c/a\u003e\n## Documentation For Authorization\n\n\nAuthentication schemes defined for the API:\n\u003ca id=\"api_token_basic\"\u003e\u003c/a\u003e\n### api_token_basic\n\n- **Type**: HTTP basic authentication\n\n\n## Author\n\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdocspring%2Fdocspring-python","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdocspring%2Fdocspring-python","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdocspring%2Fdocspring-python/lists"}