Installation

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

pip install groupdocs-translation-cloud

JSON Request Details

You can put the following information in the requests body to translate a document:

• format — format of file for translation
• outputFormat — format of translated file (e.g. pdf)
• sourceLanguage — language of original document (e.g. en)
• targetLanguages — languages of translation as list (e.g. [fr, de])
• file — file to translate in form of array of bytes
• url — link to file to translate, either file or url should be provided
• originalFileName — original name of file to translate, if null or empty request id will be used
• masters — if masters slides should be translated (only for presentations, pass true or false)
• elements — slide pages to translate (only for presentations, pass empty list to translate whole presentation)
• separator — delimiter for CSV files
• ranges - dictionary of ranges in Excel workbook
• shortcodedict — dictionary of short code syntax in Hugo to translate, where the key is zero based short code index, and value is a list of parameters names that require translation
• frontmatterdict — dictionary of front matter syntax in Hugo to translate, where the key is zero based front matter index and value is list of paths to values that require translation, each path is also a list.

To translate plain text the following information should be put in the requests body:

• sourceLanguage — language of original text (e.g. en)
• targetLanguages — languages of translation as list (e.g. [fr, de])
• texts — list of texts to translate (e.g. [hello world])
• contains-markdown — true if text contains markdown syntax

How to use the SDK?

Our API is completely independent of your operating system, database system, or development language. You can use any language and platform that supports HTTP to interact with our API. However, manually writing client code can be difficult, error-prone, and time-consuming. Therefore, we have provided and support SDKs in many development languages to make it easier for your Cloud Apps to integrate with us.

Quickstart

1. Get API keys if you haven’t

Make a personal account on GroupDocs Cloud Dashboard and click Get Keys. These keys are useful for all GroupDocs Cloud products. If you have any trouble, look at this detailed manual. Once your keys are received, please follow this article to try GroupDocs.Translation Cloud or familiarize with Developer guide for further details.

2. Install SDK

Install groupdocs-translation-cloud with PIP from PyPI by:

pip install groupdocs-translation-cloud

Or clone repository and install it via Setuptools:

python setup.py install

3. Run Demo

• Checkout the SDK or get from PiPy
• Set Your client_id & client_secret
• Run Jupyter Notebook demo.ipynb

Structure

This project includes:

• Module “groupdocstranslationcloud”, this is SDK. You can integrate it in your application. It contains both Translation and Storage API
• Module “test”, unittests. You can take a look at them to see various code examples.
• Jupyter notebook “demo”. Sample demo notebook.

Dependencies

• See requirements.txt

Versions support

Python :: 2.7, Python :: 3, Python :: 3.4, Python :: 3.5, Python :: 3.6, Python :: 3.7, Python :: 3.8

Translate Plain text

# Load the gem
import groupdocs_translation_cloud
# Get Client Id and Client Secret from https://dashboard.groupdocs.cloud
my_client_id = ""
my_client_secret = ""

# Create instance of the API
configuration = Configuration(apiKey=my_client_secret, appSid=my_client_id)
api = TranslationApi(configuration)

#document translation
pair = "en-fr"
_format = "docx"
storage = "First Storage"
name = "test.docx"
folder = ""
savepath = ""
savefile = "test_python.docx"  
masters = False
elements = []
translator = TranslateDocument(pair, _format, storage, name, folder, savepath, savefile, masters, elements)
request = translator.to_string()
res_doc = api.post_translate_document(request)
print(res_doc.message)

Documentation for API Endpoints

All URIs are relative to https://api.groupdocs.cloud/v2.0/translation

Documentation for Models

CloudFileResponse, CloudHugoResponse, CloudTextResponse, CsvFileRequest, FileRequest, HealthCheckStatus, HtmlFileRequest, HttpStatusCode, HugoRequest, ImageToFileRequest, ImageToTextRequest, LanguagePairData, MarkdownFileRequest, PdfFileRequest, PresentationFileRequest, ResxFileRequest, SpreadsheetFileRequest, StatusResponse, StringStringTuple, TextDocumentFileRequest, TextRequest, UrlFileInfo, WorksheetData

GroupDocs.Translation Cloud SKDs

GitHub

Package Manager