Installation

The package is available at PyPI and it can be installed via pip by executing following command:

pip install groupdocs-assembly-cloud

Requirements

• Python 3.4+
• pip package manager
• GroupDocs Cloud credentials — Client ID and Client Secret from the Dashboard

Dependencies

The SDK automatically installs the following packages:

Document Automation Python Cloud REST API

GroupDocs.Assembly Cloud SDK for Python empowers developers to seamlessly automate the creation of complex documents like reports, invoices, and presentations. Leverage templates, merge data from JSON or XML sources, apply rich formatting, and generate barcodes and charts, all within a scalable and secure cloud environment. This API streamlines document workflows, enhances productivity, and provides cross-platform compatibility for effortless integration into your Python web apps, scripts, and automation workflows.

Core Features

Template-Driven Document Generation - Create complex Word, Excel, PowerPoint, PDF docs from templates.
Dynamic Data Merging - Fill templates with JSON or XML data for customized reports.
Rich Formatting and Styling - Apply advanced formatting to text, tables, charts for polished documents.
Conditional Content Control - Use conditional logic to generate dynamic content based on data.
List and Table Automation - Create dynamic lists, tables, charts that auto‑update based on data.

Advanced Features

Barcode Generation - Embed barcodes directly into documents.
Hyperlink Insertion - Add clickable links to external resources or within document.
Bookmark Creation - Create bookmarks for easy navigation.
Checkbox Manipulation - Dynamically set checkbox values based on data.
Mail Merge Functionality - Generate personalized emails and attachments at scale.
Formula Calculations - Perform calculations within spreadsheets for dynamic results.

Working with Data

Data Filtering - Apply filters to select specific data subsets for reports.
Data Sorting - Arrange data in specific order (asc/desc) based on criteria.
Data Grouping - Organize data into groups for easier analysis and presentation.
Data Formatting - Control appearance of data in reports, e.g., number, date, text formatting.
Using Variables - Store and reuse values throughout a template for efficient processing.
Using Extension Methods - Leverage built‑in functions for complex manipulations within templates.

Working with Lists, Tables, and Charts

Dynamic List Generation - Generate in‑paragraph, bulleted, numbered lists with dynamic content.
Dynamic Table Generation - Generate tables with dynamic content, calculations, and formatting.
Chart Generation - Create line, column, bar, pie, scatter, bubble charts with dynamic data.
Chart Customization - Customize chart titles, series, axis titles, legends via expressions.
Conditional Chart Series - Conditionally include/exclude chart series based on conditions.

Working with Hyperlinks, Bookmarks, and Barcodes

Insert Hyperlinks - Insert hyperlinks into Word, email, spreadsheet, and presentation documents.
Dynamic Bookmark Insertion - Add bookmarks to docs/emails and define names for navigation.
Checkbox State Control - Set checkboxes checked/unchecked in Word docs using check tag.
Barcode Image Generation - Generate and insert QR, DataMatrix, UPC, EAN, ISBN, PDF417, and many other barcode types.

Developer‑Friendly Features

REST API Architecture - Leverage REST for easy integration and scalability.
Comprehensive Documentation - Access detailed API references, code examples, tutorials.
Active Community Support - Get help from active community forum and dedicated support.
Cloud-Based Flexibility - Enjoy scalability and reliability of cloud‑based processing.
JWT Authentication - Secure data and API requests with JWT authentication.

Licensing and Authentication

Evaluation Mode - Try the API with a free trial account.
Secure Authentication - Use Client ID and Client Secret for secure API access.
MIT License - The Python SDK is licensed under the MIT License.

Supported File Formats

GroupDocs.Assembly Cloud supports template-driven generation and conversion across a wide range of document types:

• Word Processing: DOC, DOCX, DOCM, DOT, DOTX, DOTM, RTF, ODT, OTT, HTML, MD, TXT, MHTML, MHT
• Spreadsheets: XLS, XLSX, XLSM, XLTX, XLTM, XLSB, ODS
• Presentations: PPT, PPTX, PPTM, PPS, PPSX, PPSM, POT, POTX, POTM, ODP, OTP
• Email: MSG, EML, EMLX
• Web and Other: PDF, EPUB, XPS, OXPS, TIFF, SVG, XAML

Supported output formats vary by source template type. For the complete format matrix, see the documentation.

Quick Start

Get your API credentials

To use GroupDocs.Assembly Cloud, sign up at GroupDocs.Cloud Dashboard and get your Client ID and Client Secret.

Initialize the API

Use the following code to start using the GroupDocs.Assembly Cloud SDK for Python:

import groupdocsassemblycloud

# Get your ClientId and ClientSecret at https://dashboard.groupdocs.cloud
client_id = "YourClientId"
client_secret = "YourClientSecret"

# Create instance of the Assembly API
assembly_api = groupdocsassemblycloud.AssemblyApi(client_id, client_secret)
assembly_api.api_client.configuration.host = "https://api.groupdocs.cloud"

Assemble document from template and JSON data

Once initialized, use this basic example to generate a document from a template and JSON data source:

import groupdocsassemblycloud
from groupdocsassemblycloud.models import requests

client_id = "YourClientId"
client_secret = "YourClientSecret"

assembly_api = groupdocsassemblycloud.AssemblyApi(client_id, client_secret)
assembly_api.api_client.configuration.host = "https://api.groupdocs.cloud"

# Upload the template file to cloud storage
with open("template.docx", "rb") as template_file:
    upload_request = requests.UploadFileRequest(template_file, path="template.docx")
    assembly_api.upload_file(upload_request)

# Read JSON data source
with open("data.json") as f:
    data = f.read()

template_file_info = groupdocsassemblycloud.TemplateFileInfo("template.docx")
options = groupdocsassemblycloud.AssembleOptions(template_file_info, save_format="docx", report_data=data)
request = requests.AssembleDocumentRequest(options)
result = assembly_api.assemble_document(request)

print("Generated document size = " + str(len(result)))

With this quick start guide, you’re all set to begin automating document generation using GroupDocs.Assembly Cloud in your Python applications. For more details, visit the documentation.

Assemble Document to PDF

Generate a PDF report from an OpenDocument template and JSON data.

import groupdocsassemblycloud
from groupdocsassemblycloud.models import requests

client_id = "YourClientId"
client_secret = "YourClientSecret"

assembly_api = groupdocsassemblycloud.AssemblyApi(client_id, client_secret)
assembly_api.api_client.configuration.host = "https://api.groupdocs.cloud"

filename = "TableFeatures.odt"
remote_name = "GroupDocs.Assembly/TableFeatures.odt"

with open("TableData.json") as f:
    data = f.read()

with open(filename, "rb") as template_file:
    upload_request = requests.UploadFileRequest(template_file, remote_name)
    assembly_api.upload_file(upload_request)

template_file_info = groupdocsassemblycloud.TemplateFileInfo(remote_name)
assemble_data = groupdocsassemblycloud.AssembleOptions(template_file_info, "pdf", data)
request = requests.AssembleDocumentRequest(assemble_data)
result = assembly_api.assemble_document(request)

print("Generated document size = " + str(len(result)))

Get Supported File Formats

Retrieve the full list of supported file formats available through the Assembly API.

import groupdocsassemblycloud
from groupdocsassemblycloud.models import requests

client_id = "YourClientId"
client_secret = "YourClientSecret"

assembly_api = groupdocsassemblycloud.AssemblyApi(client_id, client_secret)
assembly_api.api_client.configuration.host = "https://api.groupdocs.cloud"

result = assembly_api.get_supported_file_formats(requests.GetSupportedFileFormatsRequest())

for fmt in result.formats:
    print(fmt.file_format)

Sample Projects on GitHub

The GroupDocs.Assembly Cloud Python SDK repository includes ready-to-run unit tests and examples covering:

How to run the examples

1. Clone or download the SDK repository
2. Edit Settings/servercreds.json and set your AppSid and AppKey
3. Install dependencies: pip install groupdocs-assembly-cloud -U
4. Run tests from the repository root: python -m unittest discover -s test

For more details, visit Getting Started.

Tags

Document Automation | Python Cloud API | GroupDocs.Assembly Cloud | REST API | Document Generation | Template-Driven | Dynamic Data Merging | Rich Formatting | Conditional Content Control | List Automation | Table Automation | Barcode Generation | Hyperlink Insertion | Bookmark Creation | Checkbox Manipulation | Mail Merge | Formula Calculations | Chart Generation | Data Filtering | Data Sorting | Data Grouping | JWT Authentication | Microsoft Word | Microsoft Excel | Microsoft PowerPoint | Report Generation | Cloud-Based Flexibility | Secure API Access | Cross-platform API