Skip to main content

Python Cloud SDK wraps Aspose.Words Cloud API so you could seamlessly integrate Microsoft Word file generation, manipulation, conversion & inspection features into your own python applications.

Project description

Python Cloud SDK wraps Aspose.Words Cloud API so you could seamlessly integrate Microsoft Word® file generation, manipulation, conversion & inspection features into your own python applications.

Aspose.Words Cloud SDK for Python allows to work with Word document headers, footers, page numbering, tables, sections, document comments, drawing objects, FormFields, fonts, hyperlinks, ranges, paragraphs, math objects, watermarks, revisions and document protection. It also assists in appending documents, splitting documents as well as converting document to other supported file formats. Please feel free to explore the Developer's Guide for all possible usage scenarios.

Document Processing Features

  • Programmatically create new documents of various file formats.
  • Availability of Mail Merge and report generation features.
  • Split or merge documents on demand.
  • Manage watermarks and protection.
  • Full read & write access to Document Object Model.
  • Fetch web pages via URL and save in Microsoft Word file formats.
  • Get document information in JSON or XML representation.
  • Fetch statistical data of a document.
  • Remove all macros contained in a specific document.
  • Convert a document to desired file format along with detailed settings.
  • Convert an encrypted PDF document into Word document format.

Enhancements in Version 22.6

  • Added 'DeleteBookmark' and 'DeleteBookmarkOnline' API methods for delete bookmarks by name from the document.
  • Added 'DeleteBookmarks' and 'DeleteBookmarksOnline' API methods for delete all bookmarks from the document.
  • Added 'InsertBookmark' and 'InsertBookmarkOnline' API methods for create new bookmarks in the document.
  • Support all save formats for 'CreateDocument' operation.

Enhancements in Version 22.5

  • Internal API fixes and improvments.

Enhancements in Version 22.4

  • Added ExportShapesAsSvg to HtmlSaveOption.
  • Added new endpoint '~/styles/copy_from'.

Enhancements in Version 22.3

  • Online methods returns the dictionary of files with included original filename as key instead of single file content in responses.
  • Parameters contained sensitive data should be passed in encrypted form. Names of the parameters have 'encrypted' prefix.
  • Added Encrypt method to encrypt data on the API public key. Use it to prepare values for parameters required encrypted data.
  • GetPublicKey method is not billable.
  • Changed type of enumerations for members of SaveOptionsData and other inherited classes from string to enum.

Enhancements in Version 22.2

  • Made 'SaveOprionsData.SaveFormat' property readonly with default value.
  • Added subclasses for all formats of SaveOprionsData with specified SaveFormat.
  • 'SaveOptionsData', 'FixedPageSaveOptionsData', 'ImageSaveOptionsData', 'OoxmlSaveOptionsData', 'TxtSaveOptionsBaseData' classes now is abstract.

Enhancements in Version 22.1

  • Added 'FieldOptions.FieldUpdateCultureName' to set Culture for fields
  • Added 'DocumentEntry.Password' to set an encrypted password for appending document
  • Added 'encryptedPassword2' query parameter to CompareDocuments to set an encrypted password for the second comparing document

Enhancements in Version 21.12

  • Added FieldOptions parameter to mail merge operations
  • Added timeout parameter to api configuration

Enhancements in Version 21.11

Enhancements in Version 21.10

  • Removed 'GraphicsQualityOptions' image save option as it no longer supported.
  • Added query parameter 'displayIntermediateResults' for batch requests. If 'false', the last response in batch will be returned only. Default is 'true'
  • Added 'JsonDataLoadOptions' and 'XmlDataLoadOptions' to 'ReportEngineSettings'

Enhancements in Version 21.8

  • Added new api methods to get, insert, update or delete custom xml parts from documents.
  • Added parameter 'ResultDocumentFormat' to Compare API
  • Added 'ExportLanguageToSpanTag' pdf save option
  • Added 'FlatOpcXmlMappingOnly' save option

Enhancements in Version 21.7

  • ImlRenderingMode option introduced witch is used to determine how ink (InkML) objects are rendered
  • MaxCharactersPerLine option introduced which is used to specify the maximum number of characters per one line
  • Added new API method to get a RSA public key to encrypt document passwords
  • Added encryptedPassword common query option to pass an encrypted document password

Enhancements in Version 21.6

  • Implemented beta version of CompareDocumentOnline feature with both document sending in request
  • CompareDocument method now can handle PDF files
  • AcceptAllRevisionsBeforeComparison option introduced which is used to specify if accept all revisions before comparison

Enhancements in Version 21.5

  • Update dependencies in sdk

Enhancements in Version 21.4

  • Removed obsolete pdf save option 'EscapeUri'
  • SaveOptions now contains CustomTimeZoneInfo to set custom timezone when SdtType.Date structured document tag updated from custom XML
  • Url of child requests in batch can be full now (earlier it can be only relative)
  • Added 'RquestId' header to all responses

Enhancements in Version 21.3

  • Added 'UpdateCreatedTimeProperty' save option
  • Added Tables into HeaderFooter so it's possible to address paragraphs inside table which is located in headerfooter (sections/0/headersfooters/1/tables/0/rows/0/cells/0/paragraphs/0)

Enhancements in Version 21.2

  • Added delete all comments method

Enhancements in Version 21.1

  • Added online version for all API methods

Enhancements in Version 20.11

  • In configuration json file appSid / appKey has been replaced to clientId / clientSecret.
  • In Words API initialization methods clientId parameter precedes clientSecret parameter.

Enhancements in Version 20.10

  • Internal API changes.

Enhancements in Version 20.9

  • Added Batch API feature

Enhancements in Version 20.8

  • Added new api method (PUT '/words/{name}/compatibility/optimize') which is allows to optimize the document contents as well as default Aspose.Words behavior to a particular versions of MS Word
  • Added 'ApplyBaseDocumentHeadersAndFootersToAppendingDocuments' option to 'DocumentEntryList' for AppendDocument API
  • WithoutNodePath methods have been removed, pass null values instead

Enhancements in Version 20.7

  • Added 'Markdown' save format
  • Added endpoint to update paragraph format without node path (PUT '/words/{name}/paragraphs/{index}/format')

Enhancements in Version 20.6

  • Added new methods:
    • DeleteAllParagraphTabStopsWithoutNodePath
    • DeleteParagraphTabStopWithoutNodePath
    • GetParagraphTabStopsWithoutNodePath
    • InsertOrUpdateParagraphTabStopWithoutNodePath
    • InsertParagraphWithoutNodePath
    • UpdateParagraphFormatWithoutNodePath
    • UpdateParagraphListFormatWithoutNodePath
    • DeleteParagraphListFormatWithoutNodePath
  • DrawingObject related methods have been changed body content. Special request classes are introduced instead of strings.
  • InsertOrUpdateParagraphTabStop, DeleteParagraphTabStop methods have been changed parameter order
  • OoxmlSaveOptionsData.CompressionLevel property has been added

Enhancements in Version 20.5

  • Added methods to work with Word document lists
    • GetLists
    • GetList
    • InsertList
    • UpdateList
    • UpdateListLevel
  • Added methods to work with styles
    • GetStyles
    • UpdateStyle
    • InsertStyle
    • CopyStyle
    • GetStyleFromDocumentElement
    • ApplyStyleToDocumentElement
  • Added methods to work with paragraph list format
    • GetParagraphListFormat
    • GetParagraphListFormatWithoutNodePath
    • UpdateParagraphListFormat
    • DeleteParagraphListFormat
  • Added methods to work with paragraph tab stops
    • GetParagraphTabStops
    • InsertOrUpdateParagraphTabStop
    • DeleteAllParagraphTabStops
    • DeleteParagraphTabStop
  • Added methods to build reports
    • BuildReport
    • BuildReportOnline
  • Added Shading property to ParagraphFormat

Read & Write Document Formats

Microsoft Word: DOC, DOCX, RTF, DOT, DOTX, DOTM, FlatOPC (XML) OpenOffice: ODT, OTT WordprocessingML: XML Web: HTML, MHTML, HtmlFixed Text: TXT Fixed Layout: PDF

Save Document As

Fixed Layout: PDF/A, XPS, OpenXPS, PS Images: JPEG, PNG, BMP, SVG, TIFF, EMF Others: PCL

Platform Independence

Aspose.Words Cloud’s platform independent document manipulation API is a true REST API that can be used from any platform. You can use it with any language or platform that supports REST, be it the web, desktop, mobile, or the cloud. The API integrates with other cloud services to provide you the flexibility you require for processing documents. It is suitable for the most types of businesses, documents, or content.

Getting Started with Aspose.Words Cloud SDK for Python

Firstly, create an account at Aspose for Cloud to get your application information and free quota to use the API. Now execute pip install aspose-words-cloud from the command line to fetch the SDK. Then import the package via import asposewordscloud.

Install via Setuptools

Execute python setup.py install --user and import the package as import asposewordscloud.

The complete source code is available at GitHub Repository.

Delete Watermarks from Word Document via Python

        # Start README example

        self.words_api = asposewordscloud.WordsApi(client_id, client_secret, base_url)

        upload_request = asposewordscloud.models.requests.UploadFileRequest(
            open(os.path.join(local_folder, filename), 'rb'), os.path.join(remote_folder, remote_name))
        self.words_api.upload_file(upload_request)

        request = asposewordscloud.models.requests.DeleteWatermarkRequest(remote_name, remote_folder)
        self.words_api.delete_watermark(request)

        # End README example

Product Page | Documentation | API Reference | Code Samples | Blog | Free Support | Free Trial

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

aspose-words-cloud-22.6.0.tar.gz (451.6 kB view hashes)

Uploaded source

Built Distribution

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page