aspose-words-cloud 19.12.0

Aspose.Words for Cloud API Reference

Aspose.Words Cloud SDK for Python

This repository contains Aspose.Words Cloud SDK for Python source code. This SDK allows you to work with Aspose.Words Cloud REST APIs in your Python applications quickly and easily, with zero initial cost.

Aspose.Words Cloud
API Reference

Key Features

• Conversion between various document-related formats (20+ formats supported), including PDF<->Word conversion
• Mail merge and reports generation
• Splitting Word documents
• Accessing Word document metadata and statistics
• Find and replace
• Watermarks and protection
• Full read & write access to Document Object Model, including sections, paragraphs, text, images, tables, headers/footers and many others

How to use the SDK?

The complete source code is available in this repository folder. You can either directly use it in your project via source code or get PyPi (recommended). For more details, please visit our documentation website.

Prerequisites

To use Aspose Words for Cloud Python SDK you need to register an account with Aspose Cloud and lookup/create App Key and SID at Cloud Dashboard. There is free quota available. For more details, see Aspose Cloud Pricing.

Installation & Usage

pip install

If the python package is hosted on Github, you can install directly from Github

pip install aspose-words-cloud

(you may need to run pip with root permission: sudo pip install aspose-words-cloud)

Then import the package:

import asposewordscloud

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import asposewordscloud

Getting Started

Please follow the installation procedure and then run the following:

import asposewordscloud
import asposewordscloud.models.requests
api_client = asposewordscloud.ApiClient()
api_client.configuration.host = 'https://api.aspose.cloud'
api_client.configuration.api_key['api_key'] = '' # Put your appKey here
api_client.configuration.api_key['app_sid'] = '' # Put your appSid here
storage_api = asposestoragecloud.StorageApi(asposestoragecloud.ApiClient('', '')) # Same credentials for storage
storage_api.api_client.configuration.base_url = 'https://api.aspose.cloud/v1.1'
words_api = asposewordscloud.WordsApi(api_client)
filename = 'test_doc.docx'
remote_name = 'TestDeleteDocumentWatermark.docx'

with open(os.path.join(self.local_common_folder, filename), 'rb') as f:
    file = f.read()
self.storage_api.put_create(os.path.join(self.remote_test_folder, self.test_folder, remote_name), file)
request = asposewordscloud.models.requests.DeleteDocumentWatermarkRequest(remote_name,
                                                                           os.path.join(
                                                                                 self.remote_test_folder,
                                                                                 self.test_folder))
result = words_api.delete_document_watermark(request)
self.assertTrue(result.code == 200, 'Error has occurred while delete document watermark')

Test contain various examples of using the SDK. Please put your credentials into Configuration.

Dependencies

• Python 2.7(End of Life in 2020) and 3.7
• referenced packages (see here for more details)

Licensing

All Aspose.Words Cloud SDKs, helper scripts and templates are licensed under MIT License.

Contact Us

Your feedback is very important to us. Please feel free to contact us using our Support Forums.

Resources

Website
Product Home
API Reference
Documentation
Blog

Other languages

We generate our SDKs in different languages so you may check if yours is available in our list.

If you don't find your language in the list, feel free to request it from us, or use raw REST API requests as you can find it here.