Installation

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

pip install groupdocs-merger-cloud

Requirements

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

Dependencies

The SDK automatically installs the following packages:

Merge Documents & Pages Python Cloud REST API

GroupDocs.Merger Cloud SDK for Python empowers developers to integrate advanced document merging and page manipulation functionalities into their Python web apps, scripts, and automation workflows. Supporting over 40 file formats, this REST API allows seamless merging, splitting, and reorganization of document pages, including PDFs, Word documents, Excel spreadsheets, and more. Security features include password protection for documents, while additional file and folder operations streamline cloud storage management. Whether working with cross-format documents or performing complex page manipulations, GroupDocs.Merger delivers robust tools for secure and efficient document handling across web, desktop, and mobile platforms.

Merge Documents

Merge two or more documents - Combine multiple documents into a single file.
Merge specific pages - Merge only specific pages from different documents into one.
Join page ranges - Combine selected page ranges from multiple docs into one.
Cross-format merge - Merge documents of different formats (e.g., DOCX and PDF) into a single output.

Splitting and Page Manipulation

Split documents - Split a source document into multiple separate files.
Move pages - Move document pages within a file.
Rotate pages - Rotate document pages to adjust their orientation.
Remove pages - Remove unwanted pages from a document.
Swap pages - Swap the position of pages within a document.
Extract pages - Extract specific pages from a document into a new file.
Change page orientation - Adjust page orientation in supported document types.

Security and Document Protection

Set document password - Secure documents by setting a password.
Remove document password - Remove existing passwords from protected documents.
Update document password - Change the password on a protected document.
Check password protection - Verify whether a document is password-protected.

File Operations

Upload Files to Cloud - Upload files to cloud storage via the API.
Download Files from Cloud - Download files from cloud storage to local systems.
Copy Files - Copy files within the cloud storage to different locations.
Move Files - Move files between folders in cloud storage.
Delete Files - Delete specific files from cloud storage.

Folder Operations

Create Folder - Create new folders in the cloud storage.
Copy Folder - Duplicate folders within the cloud storage.
Move Folder - Move folders between directories in cloud storage.
Delete Folder - Remove entire folders from cloud storage.

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 Document Formats

GroupDocs.Merger Cloud supports 40+ file formats with join, split, and page manipulation capabilities:

• Word Processing: DOC, DOCX, DOCM, DOT, DOTX, DOTM, RTF, ODT, OTT, HTML, MHT, MHTML
• PDF and Page Layout: PDF, XPS, TEX, EPUB
• Presentations: PPT, PPTX, PPS, PPSX, ODP, OTP, POTX, POTM, PPSM, PPTM
• Spreadsheets: XLS, XLSX, XLSB, XLSM, XLT, XLTX, XLTM, ODS, CSV, TSV
• Diagrams: VSDX, VSDM, VSSX, VSSM, VSTX, VSTM, VDX, VSX, VTX
• Notes: ONE (Microsoft OneNote)
• Text: TXT, ERR

Supported operations vary by format. Cross-format merging to PDF/XPS and DOC/DOCX is available for many types. For the complete format matrix, see the documentation.

Quick Start

Get your API credentials

To use GroupDocs.Merger 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.Merger Cloud SDK for Python:

import groupdocs_merger_cloud

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

# Create API configuration
configuration = groupdocs_merger_cloud.Configuration(client_id, client_secret)
configuration.api_base_url = "https://api.groupdocs.cloud"

# Create instance of the Document API
document_api = groupdocs_merger_cloud.DocumentApi.from_config(configuration)

Merge multiple documents

Once initialized, use this basic example to merge Word documents into one file:

import groupdocs_merger_cloud

client_id = "YourClientId"
client_secret = "YourClientSecret"

document_api = groupdocs_merger_cloud.DocumentApi.from_keys(client_id, client_secret)

item1 = groupdocs_merger_cloud.JoinItem()
item1.file_info = groupdocs_merger_cloud.FileInfo("WordProcessing/four-pages.docx")

item2 = groupdocs_merger_cloud.JoinItem()
item2.file_info = groupdocs_merger_cloud.FileInfo("WordProcessing/one-page.docx")

options = groupdocs_merger_cloud.JoinOptions()
options.join_items = [item1, item2]
options.output_path = "Output/joined.docx"

result = document_api.join(groupdocs_merger_cloud.JoinRequest(options))

print("Output file path = " + result.path)

With this quick start guide, you’re all set to begin merging documents using GroupDocs.Merger Cloud in your Python applications. For more details, visit the documentation.

Get Supported File Formats

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

import groupdocs_merger_cloud

info_api = groupdocs_merger_cloud.InfoApi.from_keys("YourClientId", "YourClientSecret")

result = info_api.get_supported_file_formats()

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

Join Pages from Various Documents

Merge specific pages from multiple source documents into a single output file, with support for page ranges and filters.

import groupdocs_merger_cloud

document_api = groupdocs_merger_cloud.DocumentApi.from_keys("YourClientId", "YourClientSecret")

item1 = groupdocs_merger_cloud.JoinItem()
item1.file_info = groupdocs_merger_cloud.FileInfo("WordProcessing/sample-10-pages.docx")
item1.pages = [3, 6, 8]

item2 = groupdocs_merger_cloud.JoinItem()
item2.file_info = groupdocs_merger_cloud.FileInfo("WordProcessing/four-pages.docx")
item2.start_page_number = 1
item2.end_page_number = 4
item2.range_mode = "OddPages"

options = groupdocs_merger_cloud.JoinOptions()
options.join_items = [item1, item2]
options.output_path = "Output/joined-pages.docx"

result = document_api.join(groupdocs_merger_cloud.JoinRequest(options))

print("Output file path = " + result.path)

Merge Documents Across Formats into PDF

Merge documents of different formats (e.g., password-protected PDF and DOCX) into a single PDF file.

import groupdocs_merger_cloud

document_api = groupdocs_merger_cloud.DocumentApi.from_keys("YourClientId", "YourClientSecret")

item1 = groupdocs_merger_cloud.JoinItem()
item1.file_info = groupdocs_merger_cloud.FileInfo(
    "Pdf/one-page-password.pdf", None, None, "password"
)

item2 = groupdocs_merger_cloud.JoinItem()
item2.file_info = groupdocs_merger_cloud.FileInfo("WordProcessing/one-page.docx")

options = groupdocs_merger_cloud.JoinOptions()
options.join_items = [item1, item2]
options.output_path = "Output/joined.pdf"

result = document_api.join(groupdocs_merger_cloud.JoinRequest(options))

print("Output file path = " + result.path)

Split Document into Single Pages

Split a document into separate files by specifying exact page numbers.

import groupdocs_merger_cloud

document_api = groupdocs_merger_cloud.DocumentApi.from_keys("YourClientId", "YourClientSecret")

options = groupdocs_merger_cloud.SplitOptions()
options.file_info = groupdocs_merger_cloud.FileInfo("WordProcessing/sample-10-pages.docx")
options.output_path = "Output/split-document"
options.pages = [1, 3]
options.mode = "Pages"

result = document_api.split(groupdocs_merger_cloud.SplitRequest(options))

print("Documents count = " + str(len(result.documents)))

Extract Pages by Numbers

Extract specific pages from a document into a new file.

import groupdocs_merger_cloud

pages_api = groupdocs_merger_cloud.PagesApi.from_keys("YourClientId", "YourClientSecret")

options = groupdocs_merger_cloud.ExtractOptions()
options.file_info = groupdocs_merger_cloud.FileInfo("WordProcessing/sample-10-pages.docx")
options.output_path = "Output/extract-pages-by-numbers.docx"
options.pages = [2, 4, 7]

result = pages_api.extract(groupdocs_merger_cloud.ExtractRequest(options))

print("Output file path = " + result.path)

Rotate Document Pages

Rotate selected pages in a PDF document to adjust their orientation.

import groupdocs_merger_cloud

pages_api = groupdocs_merger_cloud.PagesApi.from_keys("YourClientId", "YourClientSecret")

options = groupdocs_merger_cloud.RotateOptions()
options.file_info = groupdocs_merger_cloud.FileInfo("Pdf/ten-pages.pdf")
options.output_path = "Output/rotate-pages.pdf"
options.pages = [2, 4]
options.mode = "Rotate90"

result = pages_api.rotate(groupdocs_merger_cloud.RotateRequest(options))

print("Output file path = " + result.path)

Add Password to Document

Secure a document by adding password protection.

import groupdocs_merger_cloud

security_api = groupdocs_merger_cloud.SecurityApi.from_keys("YourClientId", "YourClientSecret")

options = groupdocs_merger_cloud.Options()
options.file_info = groupdocs_merger_cloud.FileInfo(
    "WordProcessing/one-page.docx", None, None, "password"
)
options.output_path = "Output/add-password.docx"

result = security_api.add_password(groupdocs_merger_cloud.AddPasswordRequest(options))

print("Output file path = " + result.path)

Sample Projects on GitHub

The GroupDocs.Merger Cloud Python Samples repository includes ready-to-run examples covering:

How to run the examples

1. Clone or download the samples repository
2. Edit Examples/Common.py and set your client_id and client_secret
3. Go to the Examples directory
4. Run pip install groupdocs-merger-cloud -U
5. Execute python RunExamples.py

For more details, visit Getting Started.

Tags

Document Merging API | Python Cloud API | GroupDocs.Merger Cloud | REST API | Page Manipulation | Document Security | Password Protection | Cloud Storage Integration | File Operations | Folder Operations | Document Splitting | PDF Merging | Cross-format Merging | Word Document Merging | Excel File Merging | Presentation Merging | Document Reorganization | Secure API Access | Document Joining | Document Manipulation API | Merge Multiple Formats | Cross-platform API