search

groupdocs-translation-cloud / groupdocs-translation-cloud-python

Python library for communicating with the GroupDocs.Translation Cloud API
5 stars 5 forks source link

readme

Python SDK for Translating Cloud Documents

PyPi PyPi GitHub license

Product Page | Docs | Demos | Swagger UI | Examples | Blog | Search | Free Support | Free Trial

GroupDocs.Translation Cloud is Cloud API to translate Word (including RTF and TXT files), Excel (including CSV / TSV files), PowerPoint, PDF, HTML, Markdown (including Markdown with Hugo syntax), OpenDocument, RESX, SRT files, images of JPG, PNG, SVG, BMP and GIF formats and scanned PDFs as well as plain text.

For convenience of our Python customers, we introduce a simple SDK that assists to add translation of all document and image file formats mentioned above and plain text to your app with merely a few lines of code.

In detail, it's a set of SDKs for document and plain text translation in our Cloud. It supports translation of .doc, .docx, .docm, .xls, .xlsx, .xlsm, .ppt, .pptx, .pptm, .pdf, .html, .md, .odt, .ods, .odp, .csv, .tsv, .rtf, .txt, .resx, .srt, .png, .jpg, .svg, .bmp and .gif files. Just pass a specific file or text to the GroupDocs.Translation Cloud API, and it will translate and save translated file in S3 or will return translated text.

It is easy to get started with GroupDocs.Translation Cloud and there is nothing to install. Create an account at GroupDocs Cloud and get your application information, then you are ready to use SDKs.

Cloud Document Translation Features

Supported Translation Formats

You shoukd specify format of document to translate putting in the request’s body the appropriate enum value.

Additionally, user could obtain translated file in any other format available for conversion. Just specify output format of translated document by putting file extension in the request’s body:

Please visit Supported Formats for details.

Supported Translation Languages

JSON Request Details

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

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

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

Structure

This project includes:

Dependencies

Versions support:

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

Class Method HTTP request Description
TranslationApi autoPost POST /auto Translate any supported file
TranslationApi csvPost POST /csv Translate CSV and TSV files
TranslationApi documentPost POST /document Translate Microsoft Word documents, rtf, txt, odt
TranslationApi documentRequestIdGet GET /document/{requestId} Return document translation status. Also return URLs for downloading of translated document if translation was successful
TranslationApi documentTrialPost POST /document/trial Trial translate Microsoft Word documents, rtf, txt, odt without conversation. Translate only first page or 1000 symbols.
TranslationApi hcGet GET /hc Health check for all services.
TranslationApi htmlPost POST /html Translate HTML files
TranslationApi hugoGet GET /hugo Get hugo syntax structure from markdown file
TranslationApi hugoPost POST /hugo Run hugo syntax structure analyzing from markdown file
TranslationApi imageToFilePost POST /image-to-file Translate image or scanned pdf and return file
TranslationApi imageToTextPost POST /image-to-text Translate text on image or scanned pdf
TranslationApi languagesGet GET /languages Return list of available language pairs
TranslationApi markdownPost POST /markdown Translate Markdown files
TranslationApi pdfPost POST /pdf Translate pdf files
TranslationApi pdfTrialPost POST /pdf/trial Trial pdf translation. Translate only first page without conversion to another format.
TranslationApi presentationPost POST /presentation Translate Microsoft PowerPoint presentations, odp
TranslationApi resxPost POST /resx Translate RESX files
TranslationApi spreadsheetPost POST /spreadsheet Translate Microsoft Excel workbooks, ods
TranslationApi textPost POST /text Translate text
TranslationApi textRequestIdGet GET /text/{requestId} Return text translation status. Also return translated text if translation was successful
TranslationApi textTrialPost POST /text/trial Trial translate text. Translate only 1000 symbols.

Documentation for Models

GroupDocs.Translation Cloud SDKs in Popular Languages

.NET Java Python Android
GitHub GitHub GitHub GitHub
NuGet Maven PIP Maven

Product Page | Docs | Demos | Swagger UI | Examples | Blog | Search | Free Support | Free Trial