Skip to content

Commit 1bf7568

Browse files
authored
Standardized readme.md
1 parent 8942c23 commit 1bf7568

File tree

1 file changed

+43
-20
lines changed

1 file changed

+43
-20
lines changed

README.md

Lines changed: 43 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,44 @@
1-
# GroupDocs.Annotation Cloud Python SDK
1+
![](https://img.shields.io/badge/api-v2.0-lightgrey) ![PyPI](https://img.shields.io/pypi/v/groupdocs-annotation-cloud) ![PyPI - Implementation](https://img.shields.io/pypi/implementation/groupdocs-annotation-cloud) ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/groupdocs-annotation-cloud) ![PyPI - Wheel](https://img.shields.io/pypi/wheel/groupdocs-annotation-cloud) ![PyPI - Downloads](https://img.shields.io/pypi/dm/groupdocs-annotation-cloud) ![PyPI - Status](https://img.shields.io/pypi/status/groupdocs-annotation-cloud) [![GitHub license](https://img.shields.io/github/license/groupdocs-annotation-cloud/groupdocs-annotation-cloud-python)](https://github.com/groupdocs-annotation-cloud/groupdocs-annotation-cloud-python/blob/master/LICENSE)
22

3-
Python package for communicating with the GroupDocs.Annotation Cloud API
3+
# Annotate Documents via Python
44

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

7-
Python 2.7 or 3.4+
7+
The solution helps in applying annotations, sticky notes, watermark overlays, redactions, text replacements and markups to documents, presentations, emails, spreadsheets, PDF, images, and other file formats.
88

9-
## Installation
9+
## Annotate Documents & Images in the Cloud
1010

11-
Install `groupdocs-annotation-cloud` with [PIP](https://pypi.org/project/pip/) from [PyPI](https://pypi.org/) by:
11+
- Import document annotations.
12+
- Add or remove annotations.
13+
- Export annotated document back to its original format.
14+
- Preview document pages as images.
15+
- Fetch document information, such as, page count & file size.
16+
17+
Check out the [Developer's Guide](https://docs.groupdocs.cloud/annotation/developer-guide/) to know more about GroupDocs.Annotation REST API.
18+
19+
## Microsoft Office Formats
20+
21+
**Microsoft Word:** DOC, DOCM, DOCX, DOT, DOTM, DOTX, RTF\
22+
**Microsoft Excel:** XLS, XLSX\
23+
**Microsoft PowerPoint:** PPT, PPTX, PPSX\
24+
**Microsoft Visio:** VSSX, VSS, VSSM, VDX, VSD, VSDX, VSDM, VSTM, VSX, VTX\
25+
**Microsoft Outlook:** EML, EMLX, MSG
26+
27+
## Other Document Formats
28+
29+
**Portable:** PDF\
30+
**OpenDocument:** ODT, OTT, ODP, OTP\
31+
**Images:** BMP, PNG, JPG, JPEG, TIFF, TIF, GIF\
32+
**Web:** MHTML\
33+
**Others:** TXT
34+
35+
## Get Started with GroupDocs.Annotation Cloud SDK for Ruby
36+
37+
First create an account at [GroupDocs for Cloud](https://dashboard.groupdocs.cloud/) and get your application information. Next, follow the installation steps to get started.
38+
39+
### Installation
40+
41+
GroupDocs.Annotation Cloud SDK for Python is available at [PyPI](https://pypi.org/project/groupdocs-annotation-cloud/) so install it using [PIP](https://pypi.org/project/pip/) as follows.
1242

1343
```sh
1444
pip install groupdocs-annotation-cloud
@@ -20,7 +50,7 @@ Or clone repository and install it via [Setuptools](http://pypi.python.org/pypi/
2050
python setup.py install
2151
```
2252

23-
## Getting Started
53+
## Get Supported File Formats for Annotation
2454

2555
Please follow the [installation procedure](#installation) and then run following:
2656

@@ -47,18 +77,11 @@ except groupdocs_annotation_cloud.ApiException as e:
4777
print("Exception when calling get_supported_file_formats: {0}".format(e.message))
4878
```
4979

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

62-
## Contact Us
82+
| .NET | Java | PHP | Python | Ruby | Node.js |
83+
|---|---|---|---|---|---|
84+
| [GitHub](https://github.com/groupdocs-annotation-cloud/groupdocs-annotation-cloud-dotnet) | [GitHub](https://github.com/groupdocs-annotation-cloud/groupdocs-annotation-cloud-java) | [GitHub](https://github.com/groupdocs-annotation-cloud/groupdocs-annotation-cloud-php) | [GitHub](https://github.com/groupdocs-annotation-cloud/groupdocs-annotation-cloud-python) | [GitHub](https://github.com/groupdocs-annotation-cloud/groupdocs-annotation-cloud-ruby) | [GitHub](https://github.com/groupdocs-annotation-cloud/groupdocs-annotation-cloud-node) |
85+
| [NuGet](https://www.nuget.org/packages/GroupDocs.Annotation-Cloud/) | [Maven](https://repository.groupdocs.cloud/webapp/#/artifacts/browse/tree/General/repo/com/groupdocs/groupdocs-annotation-cloud) | [Composer](https://packagist.org/packages/groupdocscloud/groupdocs-annotation-cloud) | [PIP](https://pypi.org/project/groupdocs-annotation-cloud/) | [GEM](https://rubygems.org/gems/groupdocs_annotation_cloud) | [NPM](https://www.npmjs.com/package/groupdocs-annotation-cloud) |
6386

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

0 commit comments

Comments
 (0)