Updated on 2025-02-26 21:18:16. Version: 2.0.0

.github/workflows/python.yml

@@ -0,0 +1,31 @@
+# NOTE: This file is auto generated by OpenAPI Generator.
+# URL: https://openapi-generator.tech
+#
+# ref: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
+
+name: docspring Python package
+
+on: [push, pull_request]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+          pip install -r test-requirements.txt
+      - name: Test with pytest
+        run: |
+          pytest --cov={{packageName}}

.gitignore

@@ -45,7 +45,9 @@ coverage.xml
 *,cover
 .hypothesis/
 venv/
+.venv/
 .python-version
+.pytest_cache
 
 # Translations
 *.mo
@@ -62,8 +64,3 @@ target/
 
 #Ipython Notebook
 .ipynb_checkpoints
-
-# Custom
-test/venv-2/
-test/venv-3/
-.pytest_cache

.gitlab-ci.yml

@@ -0,0 +1,31 @@
+# NOTE: This file is auto generated by OpenAPI Generator.
+# URL: https://openapi-generator.tech
+#
+# ref: https://docs.gitlab.com/ee/ci/README.html
+# ref: https://gitlab.com/gitlab-org/gitlab/-/blob/master/lib/gitlab/ci/templates/Python.gitlab-ci.yml
+
+stages:
+  - test
+
+.pytest:
+  stage: test
+  script:
+   - pip install -r requirements.txt
+   - pip install -r test-requirements.txt
+   - pytest --cov=docspring
+
+pytest-3.8:
+  extends: .pytest
+  image: python:3.8-alpine
+pytest-3.9:
+  extends: .pytest
+  image: python:3.9-alpine
+pytest-3.10:
+  extends: .pytest
+  image: python:3.10-alpine
+pytest-3.11:
+  extends: .pytest
+  image: python:3.11-alpine
+pytest-3.12:
+  extends: .pytest
+  image: python:3.12-alpine

.openapi-generator/FILES

@@ -0,0 +1,169 @@
+.github/workflows/python.yml
+.gitignore
+.gitlab-ci.yml
+.travis.yml
+README.md
+docs/AddFieldsData.md
+docs/BatchGeneratePdfs201Response.md
+docs/CombinePdfsData.md
+docs/CombinedSubmission.md
+docs/CombinedSubmissionAction.md
+docs/CombinedSubmissionData.md
+docs/CopyTemplateOptions.md
+docs/CreateCombinedSubmissionResponse.md
+docs/CreateCustomFileData.md
+docs/CreateCustomFileResponse.md
+docs/CreateFolderData.md
+docs/CreateHtmlSubmissionData.md
+docs/CreateHtmlTemplate.md
+docs/CreatePdfSubmissionData.md
+docs/CreatePdfTemplate.md
+docs/CreateSubmissionDataRequestData.md
+docs/CreateSubmissionDataRequestEventRequest.md
+docs/CreateSubmissionDataRequestEventResponse.md
+docs/CreateSubmissionDataRequestResponse.md
+docs/CreateSubmissionDataRequestTokenResponse.md
+docs/CreateSubmissionResponse.md
+docs/CustomFile.md
+docs/ErrorResponse.md
+docs/Folder.md
+docs/JsonSchema.md
+docs/ListSubmissionsResponse.md
+docs/MoveFolderData.md
+docs/MoveTemplateData.md
+docs/MultipleErrorsResponse.md
+docs/PDFApi.md
+docs/RenameFolderData.md
+docs/Submission.md
+docs/SubmissionAction.md
+docs/SubmissionBatch.md
+docs/SubmissionBatchData.md
+docs/SubmissionBatchWithSubmissions.md
+docs/SubmissionDataRequest.md
+docs/SubmissionDataRequestEvent.md
+docs/SubmissionDataRequestShow.md
+docs/SubmissionDataRequestToken.md
+docs/SubmissionPreview.md
+docs/SuccessErrorResponse.md
+docs/SuccessMultipleErrorsResponse.md
+docs/Template.md
+docs/TemplateAddFieldsResponse.md
+docs/TemplatePreview.md
+docs/UpdateHtmlTemplate.md
+docs/UpdateSubmissionDataRequestData.md
+docs/UploadPresignResponse.md
+docspring/__init__.py
+docspring/api/__init__.py
+docspring/api/pdf_api.py
+docspring/api_client.py
+docspring/api_response.py
+docspring/configuration.py
+docspring/exceptions.py
+docspring/models/__init__.py
+docspring/models/add_fields_data.py
+docspring/models/batch_generate_pdfs201_response.py
+docspring/models/combine_pdfs_data.py
+docspring/models/combined_submission.py
+docspring/models/combined_submission_action.py
+docspring/models/combined_submission_data.py
+docspring/models/copy_template_options.py
+docspring/models/create_combined_submission_response.py
+docspring/models/create_custom_file_data.py
+docspring/models/create_custom_file_response.py
+docspring/models/create_folder_data.py
+docspring/models/create_html_submission_data.py
+docspring/models/create_html_template.py
+docspring/models/create_pdf_submission_data.py
+docspring/models/create_pdf_template.py
+docspring/models/create_submission_data_request_data.py
+docspring/models/create_submission_data_request_event_request.py
+docspring/models/create_submission_data_request_event_response.py
+docspring/models/create_submission_data_request_response.py
+docspring/models/create_submission_data_request_token_response.py
+docspring/models/create_submission_response.py
+docspring/models/custom_file.py
+docspring/models/error_response.py
+docspring/models/folder.py
+docspring/models/json_schema.py
+docspring/models/list_submissions_response.py
+docspring/models/move_folder_data.py
+docspring/models/move_template_data.py
+docspring/models/multiple_errors_response.py
+docspring/models/rename_folder_data.py
+docspring/models/submission.py
+docspring/models/submission_action.py
+docspring/models/submission_batch.py
+docspring/models/submission_batch_data.py
+docspring/models/submission_batch_with_submissions.py
+docspring/models/submission_data_request.py
+docspring/models/submission_data_request_event.py
+docspring/models/submission_data_request_show.py
+docspring/models/submission_data_request_token.py
+docspring/models/submission_preview.py
+docspring/models/success_error_response.py
+docspring/models/success_multiple_errors_response.py
+docspring/models/template.py
+docspring/models/template_add_fields_response.py
+docspring/models/template_preview.py
+docspring/models/update_html_template.py
+docspring/models/update_submission_data_request_data.py
+docspring/models/upload_presign_response.py
+docspring/py.typed
+docspring/rest.py
+git_push.sh
+pyproject.toml
+requirements.txt
+setup.cfg
+setup.py
+test-requirements.txt
+test/__init__.py
+test/test_add_fields_data.py
+test/test_batch_generate_pdfs201_response.py
+test/test_combine_pdfs_data.py
+test/test_combined_submission.py
+test/test_combined_submission_action.py
+test/test_combined_submission_data.py
+test/test_copy_template_options.py
+test/test_create_combined_submission_response.py
+test/test_create_custom_file_data.py
+test/test_create_custom_file_response.py
+test/test_create_folder_data.py
+test/test_create_html_submission_data.py
+test/test_create_html_template.py
+test/test_create_pdf_submission_data.py
+test/test_create_pdf_template.py
+test/test_create_submission_data_request_data.py
+test/test_create_submission_data_request_event_request.py
+test/test_create_submission_data_request_event_response.py
+test/test_create_submission_data_request_response.py
+test/test_create_submission_data_request_token_response.py
+test/test_create_submission_response.py
+test/test_custom_file.py
+test/test_error_response.py
+test/test_folder.py
+test/test_json_schema.py
+test/test_list_submissions_response.py
+test/test_move_folder_data.py
+test/test_move_template_data.py
+test/test_multiple_errors_response.py
+test/test_pdf_api.py
+test/test_rename_folder_data.py
+test/test_submission.py
+test/test_submission_action.py
+test/test_submission_batch.py
+test/test_submission_batch_data.py
+test/test_submission_batch_with_submissions.py
+test/test_submission_data_request.py
+test/test_submission_data_request_event.py
+test/test_submission_data_request_show.py
+test/test_submission_data_request_token.py
+test/test_submission_preview.py
+test/test_success_error_response.py
+test/test_success_multiple_errors_response.py
+test/test_template.py
+test/test_template_add_fields_response.py
+test/test_template_preview.py
+test/test_update_html_template.py
+test/test_update_submission_data_request_data.py
+test/test_upload_presign_response.py
+tox.ini

.openapi-generator/VERSION

@@ -1 +1 @@
-3.3.0
+7.11.0

.travis.yml

@@ -1,14 +1,17 @@
 # ref: https://docs.travis-ci.com/user/languages/python
 language: python
 python:
-  - "2.7"
-  - "3.2"
-  - "3.3"
-  - "3.4"
-  - "3.5"
-  #- "3.5-dev" # 3.5 development branch
-  #- "nightly" # points to the latest development branch e.g. 3.6-dev
+  - "3.8"
+  - "3.9"
+  - "3.10"
+  - "3.11"
+  - "3.12"
+  # uncomment the following if needed
+  #- "3.12-dev"  # 3.12 development branch
+  #- "nightly"  # nightly build
 # command to install dependencies
-install: "pip install -r requirements.txt"
+install:
+  - "pip install -r requirements.txt"
+  - "pip install -r test-requirements.txt"
 # command to run tests
-script: nosetests
+script: pytest --cov=docspring

CHANGELOG.md

@@ -1,3 +1,8 @@
+### 2.0.0 [February 23, 2025]
+
+- **BREAKING CHANGE**: Updated default host to our new synchronous API subdomain: sync.api.docspring.com. (EU customers should use sync.api-eu.docspring.com). Removed all custom polling code from library since this logic is now handled by the API service running on our sync subdomain
+- Fixed User-Agent header: docspring-python-x.x.x
+
 ### 1.3.2 [November 28, 2021]
 
 - Added 'password' parameter to Generate PDF and Combine PDF API endpoints. You can now encrypt each generated PDF with a unique password.