update Documentation

Author: HungKNguyen

README.md

@@ -54,35 +54,12 @@ The documentation for Nutrient DWS Python Client is also available on [Context7]
 
 ## Quick Start
 
-## Authentication
-
-### Direct API Key
-
-Provide your API key directly:
-
 ```python
 from nutrient_dws import NutrientClient
 
 client = NutrientClient(api_key='your_api_key')
 ```
 
-### Token Provider
-
-Use an async token provider to fetch tokens from a secure source:
-
-```python
-import httpx
-from nutrient_dws import NutrientClient
-
-async def get_token():
-    async with httpx.AsyncClient() as http_client:
-        response = await http_client.get('/api/get-nutrient-token')
-        data = response.json()
-        return data['token']
-
-client = NutrientClient(api_key=get_token)
-```
-
 ## Direct Methods
 
 The client provides numerous async methods for document processing:
@@ -109,7 +86,7 @@ async def main():
 asyncio.run(main())
 ```
 
-For a complete list of available methods with examples, see the [Methods Documentation](./METHODS.md).
+For a complete list of available methods with examples, see the [Methods Documentation](docs/METHODS.md).
 
 ## Workflow System
 
@@ -146,7 +123,7 @@ The workflow system follows a staged approach:
 3. Set output format
 4. Execute or perform a dry run
 
-For detailed information about the workflow system, including examples and best practices, see the [Workflow Documentation](./WORKFLOW.md).
+For detailed information about the workflow system, including examples and best practices, see the [Workflow Documentation](docs/WORKFLOW.md).
 
 ## Error Handling
 
@@ -241,7 +218,7 @@ Quick start for contributors:
 5. Ensure type checking passes with mypy
 6. Follow Python code style with ruff
 
-For detailed contribution guidelines, see the [Contributing Guide](./CONTRIBUTING.md).
+For detailed contribution guidelines, see the [Contributing Guide](docs/CONTRIBUTING.md).
 
 ## Project Structure
 

context7.json

@@ -2,6 +2,6 @@
   "$schema": "https://context7.com/schema/context7.json",
   "projectTitle": "Nutrient DWS Python Client",
   "description": "Python client library for Nutrient Document Web Services (DWS) API.\n",
-  "excludeFolders": ["src", "example", ".github"],
-  "excludeFiles": ["CONTRIBUTING.md", "coverage-report.md", "METHODS.md", "README.md", "WORKFLOW.md"]
+  "excludeFolders": ["src", "docs", "example", ".github"],
+  "excludeFiles": ["README.md"]
 }

CONTRIBUTING.md renamed to docs/CONTRIBUTING.md

@@ -19,6 +19,32 @@ Parameters:
 - `base_url` (optional): Custom API base URL (defaults to `https://api.nutrient.io`)
 - `timeout` (optional): Request timeout in milliseconds
 
+#### Authentication
+
+Provide your API key directly:
+
+```python
+from nutrient_dws import NutrientClient
+
+client = NutrientClient(api_key='your_api_key')
+```
+
+Or use an async token provider to fetch tokens from a secure source:
+
+```python
+import httpx
+from nutrient_dws import NutrientClient
+
+async def get_token():
+    async with httpx.AsyncClient() as http_client:
+        response = await http_client.get('/api/get-nutrient-token')
+        data = response.json()
+        return data['token']
+
+client = NutrientClient(api_key=get_token)
+```
+
+
 #### Account Methods
 
 ##### get_account_info()
@@ -815,7 +841,7 @@ with open('modified-document.pdf', 'wb') as f:
 
 ## Workflow Builder Methods
 
-The workflow builder provides a fluent interface for chaining multiple operations. See [WORKFLOW.md](./WORKFLOW.md) for detailed information about workflow methods including:
+The workflow builder provides a fluent interface for chaining multiple operations. See [WORKFLOW.md](WORKFLOW.md) for detailed information about workflow methods including:
 
 - `workflow()` - Create a new workflow builder
 - `add_file_part()` - Add file parts to the workflow

METHODS.md renamed to docs/METHODS.md

@@ -64,7 +64,6 @@ This will:
 2. Extract text from the PDF
 3. Add a watermark to the PDF
 4. Merge multiple documents
-5. Process sample.pdf directly with text extraction and image watermarking
 
 ### Workflow Examples
 
@@ -79,7 +78,6 @@ This will:
 2. Create a document merging with watermark workflow
 3. Extract text with JSON output
 4. Execute a complex multi-step workflow
-5. Process sample.pdf using workflow pattern
 
 ## Output
 
@@ -90,5 +88,5 @@ All processed files will be saved to the `output/` directory. You can examine th
 For more information about the Nutrient DWS Python Client, refer to:
 
 - [README.md](../README.md) - Main documentation
-- [METHODS.md](../METHODS.md) - Direct methods documentation
-- [LLM_DOC.md](../LLM_DOC.md) - Complete API documentation
+- [METHODS.md](../docs/METHODS.md) - Direct methods documentation
+- [WORKFLOW.md](../docs/WORKFLOW.md) - Workflow system documentation

WORKFLOW.md renamed to docs/WORKFLOW.md

@@ -125,38 +125,7 @@ async def merge_documents():
         raise error
 
 
-# Example 5: Process sample.pdf directly
-async def process_sample_pdf():
-    print('\nExample 5: Processing sample.pdf directly')
 
-    try:
-        pdf_path = assets_dir / 'sample.pdf'
-
-        # Extract text from sample.pdf
-        extract_result = await client.extract_text(pdf_path)
-        extract_output_path = output_dir / 'sample-pdf-extracted-text.json'
-        with open(extract_output_path, 'w') as f:
-            json.dump(extract_result['data'], f, indent=2, default=str)
-
-        watermark_image_path = assets_dir / 'sample.png'
-
-        # Add watermark to sample.pdf
-        watermark_result = await client.watermark_image(pdf_path, watermark_image_path, {
-            'opacity': 0.4,
-        })
-
-        watermark_output_path = output_dir / 'sample-pdf-watermarked.pdf'
-        with open(watermark_output_path, 'wb') as f:
-            f.write(watermark_result['buffer'])
-
-        print('Sample PDF processing successful.')
-        print(f'Extracted text saved to: {extract_output_path}')
-        print(f'Watermarked PDF saved to: {watermark_output_path}')
-
-        return watermark_output_path
-    except Exception as error:
-        print(f'Sample PDF processing failed: {error}')
-        raise error
 
 
 # Run all examples
@@ -169,7 +138,6 @@ async def run_examples():
         await extract_text(converted_pdf_path)
         await add_watermark(converted_pdf_path)
         await merge_documents()
-        await process_sample_pdf()
 
         print('\nAll examples completed successfully!')
     except Exception as error:

examples/README.md

@@ -11,8 +11,8 @@ where = ["src"]
 [tool.setuptools.package-data]
 nutrient_dws = [
     "py.typed",
-    "../../WORKFLOW.md",
-    "../../METHODS.md",
+    "../../docs/WORKFLOW.md",
+    "../../docs/METHODS.md",
     "../../LLM_DOC.md",
 ]
 

examples/src/direct_method.py

@@ -545,7 +545,7 @@ async def execute(
                 mime_info = BuildOutputs.getMimeTypeForOutput(output_config)
                 result["success"] = True
                 result["output"] = ContentOutput(
-                    content=cast("str", response),
+                    content=cast("bytes", response).decode("utf-8"),
                     mimeType=mime_info["mimeType"],
                     filename=mime_info.get("filename"),
                 )