This example project demonstrates how to use the Nutrient DWS Python Client for document processing operations.

• assets/ - Contains sample files for processing (PDF, DOCX, PNG)
• src/ - Contains Python source files
  • direct_method.py - Examples using direct method calls
  • workflow.py - Examples using the workflow builder pattern
• output/ - Directory where processed files will be saved
• .env.example - Example environment variables file

• Python 3.10 or higher
• pip

1. Clone the repository:

   git clone https://github.com/pspdfkit-labs/nutrient-dws-client-python.git
   cd nutrient-dws-client-python

2. Build the package from source:

   python -m build

3. Navigate to the examples directory:

   cd examples

4. Set up and activate the virtual environment:

   # Set up the virtual environment and install dependencies
   python setup_venv.py
   
   # Activate the virtual environment
   # On macOS/Linux:
   source example_venv/bin/activate
   
   # On Windows:
   example_venv\Scripts\activate

5. Create a .env file from the example:

   cp .env.example .env

6. Edit the .env file and add your Nutrient DWS Processor API key. You can sign up for a free API key by visiting Nutrient:

   NUTRIENT_API_KEY=your_api_key_here
   

1. Clone the repository:

   git clone https://github.com/pspdfkit-labs/nutrient-dws-client-python.git
   cd nutrient-dws-client-python

2. Install the main package in development mode:

   pip install -e .

3. Navigate to the examples directory:

   cd examples

4. Install dependencies for the example project:

   pip install -r requirements.txt

5. Create a .env file from the example:

   cp .env.example .env

6. Edit the .env file and add your Nutrient DWS Processor API key. You can sign up for a free API key by visiting Nutrient:

   NUTRIENT_API_KEY=your_api_key_here
   

To run the direct method examples:

python src/direct_method.py

This will:

1. Convert a DOCX file to PDF
2. Extract text from the PDF
3. Add a watermark to the PDF
4. Merge multiple documents

To run the workflow examples:

python src/workflow.py

This will:

1. Perform a basic document conversion workflow
2. Create a document merging with watermark workflow
3. Extract text with JSON output
4. Execute a complex multi-step workflow

All processed files will be saved to the output/ directory. You can examine these files to see the results of the document processing operations.

For more information about the Nutrient DWS Python Client, refer to:

• README.md - Main documentation
• METHODS.md - Direct methods documentation
• WORKFLOW.md - Workflow system documentation