Merge pull request #860 from AdobeDocs/py-devdocs-imports

Python SDK 4.0 doc fixes

Author: jasnoors

src/pages/overview/document-generation-api/gettingstarted.md

@@ -374,35 +374,9 @@ const fs = require("fs");
 # Run the sample:
 # python src/documentmerge/merge_document_to_pdf.py
 
-import json
-import logging
-import os
-from datetime import datetime
-
-from adobe.pdfservices.operation.auth.service_principal_credentials import ServicePrincipalCredentials
-from adobe.pdfservices.operation.exception.exceptions import ServiceApiException, ServiceUsageException, SdkException
-from adobe.pdfservices.operation.io.cloud_asset import CloudAsset
-from adobe.pdfservices.operation.io.stream_asset import StreamAsset
-from adobe.pdfservices.operation.pdf_services import PDFServices
-from adobe.pdfservices.operation.pdf_services_media_type import PDFServicesMediaType
-from adobe.pdfservices.operation.pdfjobs.jobs.document_merge_job import DocumentMergeJob
-from adobe.pdfservices.operation.pdfjobs.params.documentmerge.document_merge_params import DocumentMergeParams
-from adobe.pdfservices.operation.pdfjobs.params.documentmerge.output_format import OutputFormat
-from adobe.pdfservices.operation.pdfjobs.result.document_merge_result import DocumentMergePDFResult
-
 # Initialize the logger
 logging.basicConfig(level=logging.INFO)
 
-
-#
-# This sample illustrates how to merge the Word based document template with the input JSON data to generate
-# the output document in the PDF format.
-#
-# To know more about document generation and document templates, please see the
-# <a href="http://www.adobe.com/go/dcdocgen_overview_doc">documentation</a>
-#
-# Refer to README.md for instructions on how to run the samples.
-#
 class MergeDocumentToPDF:
     def __init__(self):
         try:
@@ -863,39 +837,9 @@ const fs = require("fs");
 # Run the sample:
 # python src/documentmerge/merge_document_to_docx_with_fragments.py
 
-import logging
-import os
-from datetime import datetime
-
-from adobe.pdfservices.operation.auth.service_principal_credentials import ServicePrincipalCredentials
-from adobe.pdfservices.operation.exception.exceptions import ServiceApiException, ServiceUsageException, SdkException
-from adobe.pdfservices.operation.io.cloud_asset import CloudAsset
-from adobe.pdfservices.operation.io.stream_asset import StreamAsset
-from adobe.pdfservices.operation.pdf_services import PDFServices
-from adobe.pdfservices.operation.pdf_services_media_type import PDFServicesMediaType
-from adobe.pdfservices.operation.pdfjobs.jobs.document_merge_job import DocumentMergeJob
-from adobe.pdfservices.operation.pdfjobs.params.documentmerge.document_merge_params import DocumentMergeParams
-from adobe.pdfservices.operation.pdfjobs.params.documentmerge.fragments import Fragments
-from adobe.pdfservices.operation.pdfjobs.params.documentmerge.output_format import OutputFormat
-from adobe.pdfservices.operation.pdfjobs.result.document_merge_result import DocumentMergePDFResult
-
 # Initialize the logger
 logging.basicConfig(level=logging.INFO)
 
-
-#
-# This sample illustrates how to merge the Word based document template with the input JSON data and fragments JSON
-# to generate
-# the output document in the docx format.
-# The document template used in the sample covers the use of various document generation template tags.
-#
-# To know more about document generation and document templates, please see the
-# <a href="http://www.adobe.com/go/dcdocgen_overview_doc">documentation</a>
-# And to know more about fragments use-case in document generation and document templates, please see the
-# <a href="http://www.adobe.com/go/dcdocgen_fragments_support">documentation</a>
-#
-# Refer to README.md for instructions on how to run the samples.
-#
 class MergeDocumentToDOCXWithFragments:
     def __init__(self):
         try:

src/pages/overview/document-generation-api/quickstarts/python/index.md

@@ -37,11 +37,11 @@ To complete this guide, you will need:
 
 ## Step Two: Setting up the project
 
-1) In your Downloads folder, find the ZIP file with your credentials: PDFServicesSDK-Python (Extract, Auto-tag)Samples.zip. If you unzip that archive, you will find a folder of samples and the `pdfservices-api-credentials.json` file.
+1) In your Downloads folder, find the ZIP file with your credentials: PDFServicesSDK-PythonSamples.zip. If you unzip that archive, you will find a folder of samples and the `pdfservices-api-credentials.json` file.
 
 ![Samples](./shot5_spc.png)
 
-2) Take the `pdfservices-api-credentials.json` file and place it in a new directory.
+2) Take the `pdfservices-api-credentials.json` file and place it in a new directory. Remember that these credential files are important and should be stored safely.
 
 3) At the command line, change to the directory you created, and run the following command to install the Python SDK: `pip install pdfservices-sdk`.
 
@@ -202,35 +202,9 @@ with open(output_file_path, "wb") as file:
 Here's the complete application (`src/documentmerge/merge_document_to_pdf.py`):
 
 ```python
-import json
-import logging
-import os
-from datetime import datetime
-
-from adobe.pdfservices.operation.auth.service_principal_credentials import ServicePrincipalCredentials
-from adobe.pdfservices.operation.exception.exceptions import ServiceApiException, ServiceUsageException, SdkException
-from adobe.pdfservices.operation.io.cloud_asset import CloudAsset
-from adobe.pdfservices.operation.io.stream_asset import StreamAsset
-from adobe.pdfservices.operation.pdf_services import PDFServices
-from adobe.pdfservices.operation.pdf_services_media_type import PDFServicesMediaType
-from adobe.pdfservices.operation.pdfjobs.jobs.document_merge_job import DocumentMergeJob
-from adobe.pdfservices.operation.pdfjobs.params.documentmerge.document_merge_params import DocumentMergeParams
-from adobe.pdfservices.operation.pdfjobs.params.documentmerge.output_format import OutputFormat
-from adobe.pdfservices.operation.pdfjobs.result.document_merge_result import DocumentMergePDFResult
-
 # Initialize the logger
 logging.basicConfig(level=logging.INFO)
 
-
-#
-# This sample illustrates how to merge the Word based document template with the input JSON data to generate
-# the output document in the PDF format.
-#
-# To know more about document generation and document templates, please see the
-# <a href="http://www.adobe.com/go/dcdocgen_overview_doc">documentation</a>
-#
-# Refer to README.md for instructions on how to run the samples.
-#
 class MergeDocumentToPDF:
     def __init__(self):
         try:

src/pages/overview/document-generation-api/quickstarts/python/shot5_spc.png

@@ -226,7 +226,7 @@ The quickest way to get up and running is to download the code samples during th
 
 1.  Download [the Java sample project](https://www.adobe.com/go/pdftoolsapi_java_samples).
 2.  Build the sample project with Maven: `mvn clean install`.
-3.  Set the environment variables `PDF_SERVICES_CLIENT_ID` and `CLIET_SECRET` by running the following commands :
+3.  Set the environment variables `PDF_SERVICES_CLIENT_ID` and `CLIENT_SECRET` by running the following commands :
 - **Windows:**
   - `set PDF_SERVICES_CLIENT_ID=<YOUR CLIENT ID>`
   - `set PDF_SERVICES_CLIENT_SECRET=<YOUR CLIENT SECRET>`
@@ -593,27 +593,42 @@ After downloading the zip, you can run the samples in the zip directly by settin
 
 #### Setup a Python environment
 
+Running any sample or custom code requires the following steps:
+
 1. Install [Python 3.10](https://www.python.org/downloads/) or higher.
 2. Verify your installation by running this command: `python --version`.
 
+<InlineAlert slots="text" />
+
+pip uses requirements.txt file to fetch pdfservices-sdk from the public PyPi repository when running the project. The .whl automatically downloads when you build the sample project. Alternatively, you can download the pdfservices-sdk .whl file, and configure your own environment.
+
+
 ##### Running the samples
 
 The quickest way to get up and running is to download the code samples during the Getting Credentials workflow. These samples provide everything from ready-to-run sample code, an embedded credential json file, and pre-configured connections to dependencies.
 
 1. Download and extract the [Python sample project](https://github.com/adobe/pdfservices-python-sdk-samples).
 2. Copy the downloaded zip to the directory that you set up for this project and unzip the files there.
-3.  Set the environment variables `PDF_SERVICES_CLIENT_ID` and `CLIET_SECRET` by running the following commands :
+3.  Set the environment variables `PDF_SERVICES_CLIENT_ID` and `CLIENT_SECRET` by running the following commands :
 - **Windows:**
   - `set PDF_SERVICES_CLIENT_ID=<YOUR CLIENT ID>`
   - `set PDF_SERVICES_CLIENT_SECRET=<YOUR CLIENT SECRET>`
 
 - **MacOS/Linux:**
   - `export PDF_SERVICES_CLIENT_ID=<YOUR CLIENT ID>`
   - `export PDF_SERVICES_CLIENT_SECRET=<YOUR CLIENT SECRET>`
-4. Go to the project directory (which contains `requirements.txt` file) and build the sample project using this command in terminal: `pip install -r requirements.txt`.
-5. Test the sample code on the command line.
-6. Refer to this document for details about running samples as well as the API Reference for API details.
-7. You can import the samples into your preferred IDE and run the samples from there or run the below commands from terminal:
+4. Go to the project directory (which contains `requirements.txt` file) and setup a virtual environment.
+
+```
+pip install virtualenv
+python -m venv myenv
+source myenv/bin/activate # on windows, use `myenv\Scripts\activate`
+```
+
+5. Now build the sample project using this command in terminal: `pip install -r requirements.txt`.
+6. Test the sample code on the command line.
+7. Refer to this document for details about running samples as well as the API Reference for API details.
+8. You can import the samples into your preferred IDE and run the samples from there or run the commands from the README.md file in terminal.
 
 #### Verifying download authenticity
 
@@ -622,7 +637,7 @@ For security reasons you may wish to confirm the installer's authenticity. To do
 1.  After downloading the package zip, run following command
 
 ```
-pip hash <download_dir>/pdfservices-sdk-3.0.0.tar.gz
+pip hash <download_dir>/pdfservices-sdk-4.0.0.tar.gz
 ```
 
 1.  Above command will return the hash of downloaded package.

src/pages/overview/pdf-accessibility-auto-tag-api/gettingstarted.md

@@ -29,6 +29,8 @@ the SDK supports custom timeouts for the API calls. You can tailor the
 timeout settings for your environment and network speed. In addition to
 the details below, you can refer to working code samples:
 
+[//]: # (TODO update python sample)
+
 -   [Java](https://github.com/adobe/pdfservices-java-sdk-samples/blob/master/src/main/java/com/adobe/pdfservices/operation/samples/customconfigurations/CreatePDFWithCustomTimeouts.java)
 -   [.NET](https://github.com/adobe/PDFServices.NET.SDK.Samples/blob/master/CreatePDFWithCustomTimeouts/Program.cs)
 -   [Node.js](https://github.com/adobe/pdfservices-node-sdk-samples/blob/master/src/customconfigurations/create-pdf-with-custom-timeouts.js)
@@ -107,13 +109,10 @@ const clientConfig = new ClientConfig({
 Available properties:
 
 - **connectTimeout**: Default: 4000. The number of milliseconds
-    Requests will wait for the client to establish a connection to
-    Server.
+  Requests will wait for the client to establish a connection to
+  Server.
 - **readTimeout**: Default: 10000. The number of milliseconds the
-    client will wait for the server to send a response.
-- **processingTimeout**: Default: 600000. The maximum allowed time
-      in milliseconds for processing the documents. Any operation taking more time than the specified `processingTimeout` will result in an operation timeout exception.
-  - **Note :** It is advisable to set the `processingTimeout` to higher values for processing large files.
+  client will wait for the server to send a response.
 
 Override the timeout properties via a custom `ClientConfig` class:
 
@@ -122,9 +121,8 @@ Override the timeout properties via a custom `ClientConfig` class:
 ### 
 
 ```javascript
-client_config = ClientConfig.builder()
-    .with_connect_timeout(10000)
-    .with_read_timeout(40000)
-    .with_processing_timeout(900000)
-    .build()
+client_config = ClientConfig(
+    connect_timeout=4000,
+    read_timeout=10000
+)
 ```