Browse our Products

If so you can download any of the below versions for testing. The product will function as normal except for an evaluation limitation. At the time of purchase we provide a license file via email that will allow the product to work in its full capacity. If you would also like an evaluation license to test without any restrictions for 30 days, please follow the directions provided here.

Product Docs Swagger Examples Blog Support Dashboard

Installation

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

pip install groupdocs-editor-cloud

PyPI - Version PyPI - Downloads Python-GroupDocsCloud

Requirements

Dependencies

The SDK automatically installs the following packages:

PackageConstraint
urllib3>= 1.15
six>= 1.10
certifi—
python-dateutil—

Quick Start

Get your API credentials

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

import groupdocs_editor_cloud

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

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

# Create instance of the Edit API
edit_api = groupdocs_editor_cloud.EditApi.from_config(configuration)

Edit a Word document

Once initialized, use this basic example to load a DOCX file, edit its HTML representation, and save the result:

import groupdocs_editor_cloud

edit_api = groupdocs_editor_cloud.EditApi.from_keys("YourClientId", "YourClientSecret")
file_api = groupdocs_editor_cloud.FileApi.from_keys("YourClientId", "YourClientSecret")

file_info = groupdocs_editor_cloud.FileInfo("WordProcessing/password-protected.docx", None, None, "password")
load_options = groupdocs_editor_cloud.WordProcessingLoadOptions()
load_options.file_info = file_info
load_options.output_path = "output"
load_result = edit_api.load(groupdocs_editor_cloud.LoadRequest(load_options))

html_file = file_api.download_file(groupdocs_editor_cloud.DownloadFileRequest(load_result.html_path))
with open(html_file, "r") as file:
    html = file.read()

html = html.replace("Sample test text", "Hello world")

with open(html_file, "w") as file:
    file.write(html)

file_api.upload_file(groupdocs_editor_cloud.UploadFileRequest(load_result.html_path, html_file))

save_options = groupdocs_editor_cloud.WordProcessingSaveOptions()
save_options.file_info = file_info
save_options.output_path = "output/edited.docx"
save_options.html_path = load_result.html_path
save_options.resources_path = load_result.resources_path
save_result = edit_api.save(groupdocs_editor_cloud.SaveRequest(save_options))

print("Document edited: " + save_result.path)

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

Get Supported File Types

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

import groupdocs_editor_cloud

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

result = info_api.get_supported_file_formats()

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

Get Document Information

Retrieve document metadata such as page count and password protection status.

import groupdocs_editor_cloud

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

file_info = groupdocs_editor_cloud.FileInfo("WordProcessing/password-protected.docx", None, None, "password")
result = info_api.get_info(groupdocs_editor_cloud.GetInfoRequest(file_info))

print("Page count = " + str(result.page_count))

Edit Spreadsheet Document

Load a specific worksheet from an XLSX file, edit its HTML content, and save back to spreadsheet format.

import groupdocs_editor_cloud

edit_api = groupdocs_editor_cloud.EditApi.from_keys("YourClientId", "YourClientSecret")
file_api = groupdocs_editor_cloud.FileApi.from_keys("YourClientId", "YourClientSecret")

file_info = groupdocs_editor_cloud.FileInfo("Spreadsheet/four-sheets.xlsx")
load_options = groupdocs_editor_cloud.SpreadsheetLoadOptions()
load_options.file_info = file_info
load_options.output_path = "output"
load_options.worksheet_index = 0
load_result = edit_api.load(groupdocs_editor_cloud.LoadRequest(load_options))

html_file = file_api.download_file(groupdocs_editor_cloud.DownloadFileRequest(load_result.html_path))
with open(html_file, "r") as file:
    html = file.read()

html = html.replace("This is sample sheet", "This is sample sheep")

with open(html_file, "w") as file:
    file.write(html)

file_api.upload_file(groupdocs_editor_cloud.UploadFileRequest(load_result.html_path, html_file))

save_options = groupdocs_editor_cloud.SpreadsheetSaveOptions()
save_options.file_info = file_info
save_options.output_path = "output/edited.xlsx"
save_options.html_path = load_result.html_path
save_options.resources_path = load_result.resources_path
save_result = edit_api.save(groupdocs_editor_cloud.SaveRequest(save_options))

print("Document edited: " + save_result.path)

Edit Presentation Document

Load a specific slide from a PPTX file, edit its HTML content, and save back to presentation format.

import groupdocs_editor_cloud

edit_api = groupdocs_editor_cloud.EditApi.from_keys("YourClientId", "YourClientSecret")
file_api = groupdocs_editor_cloud.FileApi.from_keys("YourClientId", "YourClientSecret")

file_info = groupdocs_editor_cloud.FileInfo("Presentation/with-notes.pptx")
load_options = groupdocs_editor_cloud.PresentationLoadOptions()
load_options.file_info = file_info
load_options.output_path = "output"
load_options.slide_number = 0
load_result = edit_api.load(groupdocs_editor_cloud.LoadRequest(load_options))

html_file = file_api.download_file(groupdocs_editor_cloud.DownloadFileRequest(load_result.html_path))
with open(html_file, "r") as file:
    html = file.read()

html = html.replace("Slide sub-heading", "Hello world!")

with open(html_file, "w") as file:
    file.write(html)

file_api.upload_file(groupdocs_editor_cloud.UploadFileRequest(load_result.html_path, html_file))

save_options = groupdocs_editor_cloud.PresentationSaveOptions()
save_options.file_info = file_info
save_options.output_path = "output/edited.pptx"
save_options.html_path = load_result.html_path
save_options.resources_path = load_result.resources_path
save_result = edit_api.save(groupdocs_editor_cloud.SaveRequest(save_options))

print("Document edited: " + save_result.path)

Edit DSV Document

Load a delimiter-separated values file, edit its HTML representation, and save back to TSV format.

import groupdocs_editor_cloud

edit_api = groupdocs_editor_cloud.EditApi.from_keys("YourClientId", "YourClientSecret")
file_api = groupdocs_editor_cloud.FileApi.from_keys("YourClientId", "YourClientSecret")

file_info = groupdocs_editor_cloud.FileInfo("Spreadsheet/sample.tsv")
load_options = groupdocs_editor_cloud.DelimitedTextLoadOptions()
load_options.file_info = file_info
load_options.output_path = "output"
load_result = edit_api.load(groupdocs_editor_cloud.LoadRequest(load_options))

html_file = file_api.download_file(groupdocs_editor_cloud.DownloadFileRequest(load_result.html_path))
with open(html_file, "r") as file:
    html = file.read()

html = html.replace("32", "66")

with open(html_file, "w") as file:
    file.write(html)

file_api.upload_file(groupdocs_editor_cloud.UploadFileRequest(load_result.html_path, html_file))

save_options = groupdocs_editor_cloud.DelimitedTextSaveOptions()
save_options.file_info = file_info
save_options.output_path = "output/edited.tsv"
save_options.html_path = load_result.html_path
save_options.resources_path = load_result.resources_path
save_result = edit_api.save(groupdocs_editor_cloud.SaveRequest(save_options))

print("Document edited: " + save_result.path)

Edit Text Document

Load a plain text file, edit its HTML representation, and save the result.

import groupdocs_editor_cloud

edit_api = groupdocs_editor_cloud.EditApi.from_keys("YourClientId", "YourClientSecret")
file_api = groupdocs_editor_cloud.FileApi.from_keys("YourClientId", "YourClientSecret")

file_info = groupdocs_editor_cloud.FileInfo("Text/document.txt")
load_options = groupdocs_editor_cloud.TextLoadOptions()
load_options.file_info = file_info
load_options.output_path = "output"
load_result = edit_api.load(groupdocs_editor_cloud.LoadRequest(load_options))

html_file = file_api.download_file(groupdocs_editor_cloud.DownloadFileRequest(load_result.html_path))
with open(html_file, "r") as file:
    html = file.read()

html = html.replace("Page Text", "New Text")

with open(html_file, "w") as file:
    file.write(html)

file_api.upload_file(groupdocs_editor_cloud.UploadFileRequest(load_result.html_path, html_file))

save_options = groupdocs_editor_cloud.TextSaveOptions()
save_options.file_info = file_info
save_options.output_path = "output/edited.txt"
save_options.html_path = load_result.html_path
save_options.resources_path = load_result.resources_path
save_result = edit_api.save(groupdocs_editor_cloud.SaveRequest(save_options))

print("Document edited: " + save_result.path)

Sample Projects on GitHub

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

CategoryExamples
GetSupportedFileTypesSupported file types
GetInfoDocument information (page count, password status)
EditOperations — WordEdit word processing documents (including password-protected)
EditOperations — SpreadsheetEdit spreadsheet documents with worksheet selection
EditOperations — PresentationEdit presentation documents with slide selection
EditOperations — DSVEdit delimiter-separated values documents (CSV, TSV)
EditOperations — TextEdit plain text documents

How to run the examples

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

For more details, visit Getting Started.

Product Docs Swagger Examples Blog Support Dashboard

Tags

Document Editing API | Python Cloud API | GroupDocs.Editor Cloud | REST API | Word Processing Formats | Spreadsheet Formats | Presentation Formats | Text Formats | CSV Files | DOCX Documents | XLSX Documents | PPTX Presentations | Password-Protected Files | Cloud Storage Integration | Document Info Retrieval | File Operations | WYSIWYG Editing | Multi-Platform Support | Secure API Access | HTML Editing | Cross-platform API

 English