Skip to content

Commit 02b4710

Browse files
authored
Standardized readme.md
1 parent f3c3fe6 commit 02b4710

File tree

1 file changed

+65
-39
lines changed

1 file changed

+65
-39
lines changed

README.md

Lines changed: 65 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,65 +1,91 @@
1-
# GroupDocs.Conversion Cloud Python SDK
1+
![](https://img.shields.io/badge/api-v2.0-lightgrey) ![PyPI](https://img.shields.io/pypi/v/groupdocs-conversion-cloud) ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/groupdocs-conversion-cloud) ![PyPI - Implementation](https://img.shields.io/pypi/implementation/groupdocs-conversion-cloud) ![PyPI - Wheel](https://img.shields.io/pypi/wheel/groupdocs-conversion-cloud) [![GitHub license](https://img.shields.io/github/license/groupdocs-conversion-cloud/groupdocs-conversion-cloud-python)](https://github.com/groupdocs-conversion-cloud/groupdocs-conversion-cloud-python/blob/master/LICENSE)
22

3-
Python package for communicating with the GroupDocs.Conversion Cloud API
3+
# Python SDK to Convert Documents in the Cloud
44

5-
## Requirements
5+
[GroupDocs.Conversion Cloud SDK for Python](https://products.groupdocs.cloud/conversion/python) wraps GroupDocs.Conversion RESTful APIs so you may integrate **Document Conversion** features in your own apps with zero initial cost.
66

7-
Python 2.7 or 3.4+
7+
GroupDocs.Conversion Cloud API allows the developers to convert between 50+ file formats including Word documents, Excel spreadsheets, PowerPoint presentations, PDF, OpenDocument files, images & more.
88

9-
## Installation
9+
## Document Conversion REST API
1010

11-
Install `groupdocs-conversion-cloud` with [PIP](https://pypi.org/project/pip/) from [PyPI](https://pypi.org/) by:
11+
- Convert the whole document to the desired target format.
12+
- Convert specific document page(s) or a page range.
13+
- Auto-detect source document format without requiring the file extension.
14+
- Load source document with extended options, such as specify password for password-protected documents.
15+
- Load specific part of the document.
16+
- Show or hide document comments.
17+
- Obtain all supported conversion formats list.
18+
- Replace missing fonts with any other font.
19+
- Add text or image watermarks to any page.
20+
- Specify resolution and quality for resultant images.
21+
- Extract metadata & basic information about the source document.
22+
- Integrated storage API.
23+
24+
Check out the [Developer's Guide](https://docs.groupdocs.cloud/conversion/developer-guide/) to know more about GroupDocs.Conversion REST API.
25+
26+
## Microsoft File Formats
27+
28+
**Microsoft Word:** DOC, DOCM, DOCX, DOT, DOTM, DOTX\
29+
**Microsoft Excel:** XLS, XLSX, XLSB, XLSM\
30+
**Microsoft PowerPoint:** PPT, PPTX, PPS, PPSX\
31+
**Microsoft Project:** MPP, MPT\
32+
**Microsoft Outlook:** MSG, EML\
33+
**Microsoft Visio:** VSD, VDX, VSS, VSX, VST, VTX, VSDX, VDW, VSSX, VSTX, VSDM, VSTM, VSSM\
34+
**Microsoft OneNote:** ONE
35+
36+
## Other Formats
37+
38+
**Page Layout Formats:** PDF, XPS\
39+
**OpenDocument:** ODT, OTT, ODS, ODP, OTP, OTS, ODG\
40+
**CAD:** DXF, DWG, IFC, STL\
41+
**Images:** DCM, BMP, GIF, JPG, PNG, TIFF, WebP, DjVu, SVG, DNG, ICO\
42+
**Web:** HTML, MHT, MHTML\
43+
**Emails:** EML, EMLX\
44+
**eBooks:** EPUB, MOBI\
45+
**Metafile:** WMF, EMF\
46+
**LaTeX:** TEX\
47+
**Others:** TXT, RTF, CSV, TSV, XML
48+
49+
## Get Started with GroupDocs.Conversion Cloud SDK for Python
50+
51+
First create an account at [GroupDocs for Cloud](https://dashboard.groupdocs.cloud/) and get your application information. Next, execute the following command.
1252

1353
```sh
1454
pip install groupdocs-conversion-cloud
1555
```
1656

17-
Or clone repository and install it via [Setuptools](http://pypi.python.org/pypi/setuptools):
57+
Or clone this repository and install it via [Setuptools](http://pypi.python.org/pypi/setuptools).
1858

1959
```sh
2060
python setup.py install
2161
```
2262

23-
## Getting Started
24-
25-
Please follow the [installation procedure](#installation) and then run following:
63+
## Convert DOCX to PDF in the Cloud
2664

2765
```python
28-
# Import module
2966
import groupdocs_conversion_cloud
3067

31-
# Get your app_sid and app_key at https://dashboard.groupdocs.cloud (free registration is required).
32-
app_sid = "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
33-
app_key = "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
68+
app_sid = "XXXX-XXXX-XXXX-XXXX"
69+
app_key = "XXXXXXXXXXXXXXXX"
3470

35-
# Create instance of the API
36-
api = groupdocs_conversion_cloud.InfoApi.from_keys(app_sid, app_key)
71+
# Create necessary API instances
72+
apiInstance = groupdocs_conversion_cloud.ConvertApi.from_keys(Common.app_sid, Common.app_key)
3773

38-
try:
39-
# Retrieve supported conversion types
40-
request = groupdocs_conversion_cloud.GetSupportedConversionTypesRequest()
41-
response = api.get_supported_conversion_types(request)
74+
# Prepare convert settings
75+
settings = groupdocs_conversion_cloud.ConvertSettings()
76+
settings.file_path = "WordProcessing/four-pages.docx"
77+
settings.format = "pdf"
78+
settings.output_path = "converted"
4279

43-
# Print out supported conversion types
44-
print("Supported conversion types:")
45-
for format in response:
46-
print('{0} to [{1}]'.format(format.source_format, ', '.join(format.target_formats)))
47-
except groupdocs_conversion_cloud.ApiException as e:
48-
print("Exception when calling get_supported_conversion_types: {0}".format(e.message))
80+
# Convert
81+
result = apiInstance.convert_document(groupdocs_conversion_cloud.ConvertDocumentRequest(settings))
4982
```
5083

51-
## Licensing
52-
53-
GroupDocs.Conversion Cloud Python SDK licensed under [MIT License](http://github.com/groupdocs-conversion-cloud/groupdocs-conversion-cloud-python/LICENSE).
54-
55-
## Resources
56-
57-
+ [**Website**](https://www.groupdocs.cloud)
58-
+ [**Product Home**](https://products.groupdocs.cloud/conversion)
59-
+ [**Documentation**](https://docs.groupdocs.cloud/conversion)
60-
+ [**Free Support Forum**](https://forum.groupdocs.cloud/c/conversion)
61-
+ [**Blog**](https://blog.groupdocs.cloud/category/conversion)
84+
## GroupDocs.Conversion Cloud SDKs in Popular Languages
6285

63-
## Contact Us
86+
| .NET | Java | PHP | Python | Ruby | Node.js | Android |
87+
|---|---|---|---|---|---|---|
88+
| [GitHub](https://github.com/groupdocs-conversion-cloud/groupdocs-conversion-cloud-dotnet) | [GitHub](https://github.com/groupdocs-conversion-cloud/groupdocs-conversion-cloud-java) | [GitHub](https://github.com/groupdocs-conversion-cloud/groupdocs-conversion-cloud-php) | [GitHub](https://github.com/groupdocs-conversion-cloud/groupdocs-conversion-cloud-python) | [GitHub](https://github.com/groupdocs-conversion-cloud/groupdocs-conversion-cloud-ruby) | [GitHub](https://github.com/groupdocs-conversion-cloud/groupdocs-conversion-cloud-node) | [GitHub](https://github.com/groupdocs-conversion-cloud/groupdocs-conversion-cloud-android) |
89+
| [NuGet](https://www.nuget.org/packages/GroupDocs.Conversion-Cloud/) | [Maven](https://repository.groupdocs.cloud/webapp/#/artifacts/browse/tree/General/repo/com/groupdocs/groupdocs-conversion-cloud) | [Composer](https://packagist.org/packages/groupdocscloud/groupdocs-conversion-cloud) | [PIP](https://pypi.org/project/groupdocs-conversion-cloud/) | [GEM](https://rubygems.org/gems/groupdocs_conversion_cloud) | [NPM](https://www.npmjs.com/package/groupdocs-conversion-cloud) | |
6490

65-
Your feedback is very important to us. Please feel free to contact us using our [Support Forums](https://forum.groupdocs.cloud/c/conversion).
91+
[Home](https://www.groupdocs.cloud/) | [Product Page](https://products.groupdocs.cloud/conversion/python) | [Documentation](https://docs.groupdocs.cloud/conversion/) | [Live Demo](https://products.groupdocs.app/conversion/total) | [API Reference](https://apireference.groupdocs.cloud/conversion/) | [Code Samples](https://github.com/groupdocs-conversion-cloud/groupdocs-conversion-cloud-python-samples) | [Blog](https://blog.groupdocs.cloud/category/conversion/) | [Free Support](https://forum.groupdocs.cloud/c/conversion) | [Free Trial](https://dashboard.groupdocs.cloud)

0 commit comments

Comments
 (0)