convertapi
Project description
cloudmersive_convert_api_client
Convert API lets you effortlessly convert file formats and types.
This Python package provides a native API client for Cloudmersive Document Conversion
- API version: v1
- Package version: 2.2.1
- Build package: io.swagger.codegen.languages.PythonClientCodegen
Requirements.
Python 2.7 and 3.4+
Installation & Usage
pip install
If the python package is hosted on Github, you can install directly from Github
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
(you may need to run pip
with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
)
Then import the package:
import cloudmersive_convert_api_client
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 cloudmersive_convert_api_client
Getting Started
Please follow the installation procedure and then run the following:
from __future__ import print_function
import time
import cloudmersive_convert_api_client
from cloudmersive_convert_api_client.rest import ApiException
from pprint import pprint
# Configure API key authorization: Apikey
configuration = cloudmersive_convert_api_client.Configuration()
configuration.api_key['Apikey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Apikey'] = 'Bearer'
# create an instance of the API class
api_instance = cloudmersive_convert_api_client.CompareDocumentApi(cloudmersive_convert_api_client.ApiClient(configuration))
input_file1 = '/path/to/file.txt' # file | First input file to perform the operation on.
input_file2 = '/path/to/file.txt' # file | Second input file to perform the operation on (more than 2 can be supplied).
try:
# Compare Two Word DOCX
api_response = api_instance.compare_document_docx(input_file1, input_file2)
pprint(api_response)
except ApiException as e:
print("Exception when calling CompareDocumentApi->compare_document_docx: %s\n" % e)
Documentation for API Endpoints
All URIs are relative to https://api.cloudmersive.com
Class | Method | HTTP request | Description |
---|---|---|---|
CompareDocumentApi | compare_document_docx | POST /convert/compare/docx | Compare Two Word DOCX |
ConvertDataApi | convert_data_csv_to_json | POST /convert/csv/to/json | Convert CSV to JSON conversion |
ConvertDataApi | convert_data_xls_to_json | POST /convert/xls/to/json | Convert Excel (97-2003) XLS to JSON conversion |
ConvertDataApi | convert_data_xlsx_to_json | POST /convert/xlsx/to/json | Convert Excel XLSX to JSON conversion |
ConvertDataApi | convert_data_xml_to_json | POST /convert/xml/to/json | Convert XML to JSON conversion |
ConvertDocumentApi | convert_document_autodetect_get_info | POST /convert/autodetect/get-info | Get document type information |
ConvertDocumentApi | convert_document_autodetect_to_pdf | POST /convert/autodetect/to/pdf | Convert Document to PDF |
ConvertDocumentApi | convert_document_autodetect_to_png_array | POST /convert/autodetect/to/png | Convert Document to PNG array |
ConvertDocumentApi | convert_document_autodetect_to_txt | POST /convert/autodetect/to/txt | Convert Document to Text |
ConvertDocumentApi | convert_document_csv_to_xlsx | POST /convert/csv/to/xlsx | Convert CSV to Excel XLSX Spreadsheet |
ConvertDocumentApi | convert_document_doc_to_docx | POST /convert/doc/to/docx | Convert Word DOC (97-03) Document to DOCX |
ConvertDocumentApi | convert_document_doc_to_pdf | POST /convert/doc/to/pdf | Convert Word DOC (97-03) Document to PDF |
ConvertDocumentApi | convert_document_docx_to_pdf | POST /convert/docx/to/pdf | Convert Word DOCX Document to PDF |
ConvertDocumentApi | convert_document_docx_to_txt | POST /convert/docx/to/txt | Convert Word DOCX Document to Text |
ConvertDocumentApi | convert_document_html_to_pdf | POST /convert/html/to/pdf | Convert HTML to PDF Document |
ConvertDocumentApi | convert_document_html_to_png | POST /convert/html/to/png | Convert HTML to PNG image array |
ConvertDocumentApi | convert_document_pdf_to_docx | POST /convert/pdf/to/docx | Convert PDF to Word DOCX Document |
ConvertDocumentApi | convert_document_pdf_to_png_array | POST /convert/pdf/to/png | Convert PDF to PNG Image Array |
ConvertDocumentApi | convert_document_pdf_to_png_single | POST /convert/pdf/to/png/merge-single | Convert PDF to Single PNG image |
ConvertDocumentApi | convert_document_pdf_to_pptx | POST /convert/pdf/to/pptx | Convert PDF to PowerPoint PPTX Presentation |
ConvertDocumentApi | convert_document_pdf_to_txt | POST /convert/pdf/to/txt | Convert PDF Document to Text |
ConvertDocumentApi | convert_document_png_array_to_pdf | POST /convert/png/to/pdf | Convert PNG Array to PDF |
ConvertDocumentApi | convert_document_ppt_to_pdf | POST /convert/ppt/to/pdf | Convert PowerPoint PPT (97-03) Presentation to PDF |
ConvertDocumentApi | convert_document_ppt_to_pptx | POST /convert/ppt/to/pptx | Convert PowerPoint PPT (97-03) Presentation to PPTX |
ConvertDocumentApi | convert_document_pptx_to_pdf | POST /convert/pptx/to/pdf | Convert PowerPoint PPTX Presentation to PDF |
ConvertDocumentApi | convert_document_pptx_to_txt | POST /convert/pptx/to/txt | Convert PowerPoint PPTX Presentation to Text |
ConvertDocumentApi | convert_document_xls_to_csv | POST /convert/xls/to/csv | Convert Excel XLS (97-03) Spreadsheet to CSV |
ConvertDocumentApi | convert_document_xls_to_pdf | POST /convert/xls/to/pdf | Convert Excel XLS (97-03) Spreadsheet to PDF |
ConvertDocumentApi | convert_document_xls_to_xlsx | POST /convert/xls/to/xlsx | Convert Excel XLS (97-03) Spreadsheet to XLSX |
ConvertDocumentApi | convert_document_xlsx_to_csv | POST /convert/xlsx/to/csv | Convert Excel XLSX Spreadsheet to CSV |
ConvertDocumentApi | convert_document_xlsx_to_pdf | POST /convert/xlsx/to/pdf | Convert Excel XLSX Spreadsheet to PDF |
ConvertDocumentApi | convert_document_xlsx_to_txt | POST /convert/xlsx/to/txt | Convert Excel XLSX Spreadsheet to Text |
ConvertImageApi | convert_image_get_image_info | POST /convert/image/get-info | Get information about an image |
ConvertImageApi | convert_image_image_format_convert | POST /convert/image/{format1}/to/{format2} | Image format conversion |
ConvertImageApi | convert_image_image_set_dpi | POST /convert/image/set-dpi/{dpi} | Change image DPI |
ConvertImageApi | convert_image_multipage_image_format_convert | POST /convert/image-multipage/{format1}/to/{format2} | Multi-page image format conversion |
ConvertTemplateApi | convert_template_apply_docx_template | POST /convert/template/docx/apply | Apply Word DOCX template |
ConvertTemplateApi | convert_template_apply_html_template | POST /convert/template/html/apply | Apply HTML template |
ConvertWebApi | convert_web_html_to_docx | POST /convert/html/to/docx | Convert HTML to Word DOCX Document |
ConvertWebApi | convert_web_html_to_pdf | POST /convert/web/html/to/pdf | Convert HTML string to PDF |
ConvertWebApi | convert_web_html_to_png | POST /convert/web/html/to/png | Convert HTML string to PNG |
ConvertWebApi | convert_web_md_to_html | POST /convert/web/md/to/html | Convert Markdown to HTML |
ConvertWebApi | convert_web_url_to_pdf | POST /convert/web/url/to/pdf | Convert a URL to PDF |
ConvertWebApi | convert_web_url_to_screenshot | POST /convert/web/url/to/screenshot | Take screenshot of URL |
EditDocumentApi | edit_document_begin_editing | POST /convert/edit/begin-editing | Begin editing a document |
EditDocumentApi | edit_document_docx_body | POST /convert/edit/docx/get-body | Get body from a Word DOCX document |
EditDocumentApi | edit_document_docx_delete_pages | POST /convert/edit/docx/delete-pages | Delete, remove pages from a Word DOCX document |
EditDocumentApi | edit_document_docx_get_headers_and_footers | POST /convert/edit/docx/get-headers-and-footers | Get content of a footer from a Word DOCX document |
EditDocumentApi | edit_document_docx_get_images | POST /convert/edit/docx/get-images | Get images from a Word DOCX document |
EditDocumentApi | edit_document_docx_get_sections | POST /convert/edit/docx/get-sections | Get sections from a Word DOCX document |
EditDocumentApi | edit_document_docx_get_styles | POST /convert/edit/docx/get-styles | Get styles from a Word DOCX document |
EditDocumentApi | edit_document_docx_get_tables | POST /convert/edit/docx/get-tables | Get tables in Word DOCX document |
EditDocumentApi | edit_document_docx_insert_image | POST /convert/edit/docx/insert-image | Insert image into a Word DOCX document |
EditDocumentApi | edit_document_docx_insert_paragraph | POST /convert/edit/docx/insert-paragraph | Insert a new paragraph into a Word DOCX document |
EditDocumentApi | edit_document_docx_insert_table | POST /convert/edit/docx/insert-table | Insert a new table into a Word DOCX document |
EditDocumentApi | edit_document_docx_insert_table_row | POST /convert/edit/docx/insert-table-row | Insert a new row into an existing table in a Word DOCX document |
EditDocumentApi | edit_document_docx_pages | POST /convert/edit/docx/get-pages | Get pages and content from a Word DOCX document |
EditDocumentApi | edit_document_docx_remove_headers_and_footers | POST /convert/edit/docx/remove-headers-and-footers | Remove headers and footers from Word DOCX document |
EditDocumentApi | edit_document_docx_remove_object | POST /convert/edit/docx/remove-object | Delete any object in a Word DOCX document |
EditDocumentApi | edit_document_docx_replace | POST /convert/edit/docx/replace-all | Replace string in Word DOCX document |
EditDocumentApi | edit_document_docx_set_footer | POST /convert/edit/docx/set-footer | Set the footer in a Word DOCX document |
EditDocumentApi | edit_document_docx_set_footer_add_page_number | POST /convert/edit/docx/set-footer/add-page-number | Add page number to footer in a Word DOCX document |
EditDocumentApi | edit_document_docx_set_header | POST /convert/edit/docx/set-header | Set the header in a Word DOCX document |
EditDocumentApi | edit_document_finish_editing | POST /convert/edit/finish-editing | Download result from document editing |
EditDocumentApi | edit_document_pptx_replace | POST /convert/edit/pptx/replace-all | Replace string in PowerPoint PPTX presentation |
EditDocumentApi | edit_document_xlsx_get_columns | POST /convert/edit/xlsx/get-columns | Get rows and cells from a Excel XLSX spreadsheet, worksheet |
EditDocumentApi | edit_document_xlsx_get_images | POST /convert/edit/xlsx/get-images | Get images from a Excel XLSX spreadsheet, worksheet |
EditDocumentApi | edit_document_xlsx_get_rows_and_cells | POST /convert/edit/xlsx/get-rows-and-cells | Get rows and cells from a Word XLSX spreadsheet, worksheet |
EditDocumentApi | edit_document_xlsx_get_styles | POST /convert/edit/xlsx/get-styles | Get styles from a Excel XLSX spreadsheet, worksheet |
EditDocumentApi | edit_document_xlsx_get_worksheets | POST /convert/edit/xlsx/get-worksheets | Get worksheets from a Excel XLSX spreadsheet |
EditDocumentApi | edit_document_xlsx_insert_worksheet | POST /convert/edit/xlsx/insert-worksheet | Insert a new worksheet into an Excel XLSX spreadsheet |
EditPdfApi | edit_pdf_decrypt | POST /convert/edit/pdf/decrypt | Decrypt and password-protect a PDF |
EditPdfApi | edit_pdf_delete_pages | POST /convert/edit/pdf/pages/delete | Remove / delete pages from a PDF document |
EditPdfApi | edit_pdf_encrypt | POST /convert/edit/pdf/encrypt | Encrypt and password-protect a PDF |
EditPdfApi | edit_pdf_get_form_fields | POST /convert/edit/pdf/form/get-fields | Gets PDF Form fields and values |
EditPdfApi | edit_pdf_get_metadata | POST /convert/edit/pdf/get-metadata | Get PDF document metadata |
EditPdfApi | edit_pdf_get_pdf_text_by_pages | POST /convert/edit/pdf/pages/get-text | Get text in a PDF document by page |
EditPdfApi | edit_pdf_insert_pages | POST /convert/edit/pdf/pages/insert | Insert / copy pages from one PDF document into another |
EditPdfApi | edit_pdf_rasterize | POST /convert/edit/pdf/rasterize | Rasterize a PDF to an image-based PDF |
EditPdfApi | edit_pdf_set_form_fields | POST /convert/edit/pdf/form/set-fields | Sets ands fills PDF Form field values |
EditPdfApi | edit_pdf_set_metadata | POST /convert/edit/pdf/set-metadata | Sets PDF document metadata |
EditPdfApi | edit_pdf_set_permissions | POST /convert/edit/pdf/encrypt/set-permissions | Encrypt, password-protect and set restricted permissions on a PDF |
EditPdfApi | edit_pdf_watermark_text | POST /convert/edit/pdf/watermark/text | Add a text watermark to a PDF |
MergeDocumentApi | merge_document_docx | POST /convert/merge/docx | Merge Two Word DOCX Together |
MergeDocumentApi | merge_document_docx_multi | POST /convert/merge/docx/multi | Merge Multple Word DOCX Together |
MergeDocumentApi | merge_document_pdf | POST /convert/merge/pdf | Merge Two PDF Files Together |
MergeDocumentApi | merge_document_pdf_multi | POST /convert/merge/pdf/multi | Merge Multple PDF Files Together |
MergeDocumentApi | merge_document_png | POST /convert/merge/png/vertical | Merge Multple PNG Files Together |
MergeDocumentApi | merge_document_pptx | POST /convert/merge/pptx | Merge Two PowerPoint PPTX Together |
MergeDocumentApi | merge_document_pptx_multi | POST /convert/merge/pptx/multi | Merge Multple PowerPoint PPTX Together |
MergeDocumentApi | merge_document_xlsx | POST /convert/merge/xlsx | Merge Two Excel XLSX Together |
MergeDocumentApi | merge_document_xlsx_multi | POST /convert/merge/xlsx/multi | Merge Multple Excel XLSX Together |
SplitDocumentApi | split_document_pdf_by_page | POST /convert/split/pdf | Split a PDF file into separate PDF files, one per page |
SplitDocumentApi | split_document_xlsx | POST /convert/split/xlsx | Split a single Excel XLSX into Separate Worksheets |
ValidateDocumentApi | validate_document_autodetect_validation | POST /convert/validate/autodetect | Autodetect content type and validate |
ValidateDocumentApi | validate_document_docx_validation | POST /convert/validate/docx | Validate a Word document (DOCX) |
ValidateDocumentApi | validate_document_executable_validation | POST /convert/validate/executable | Validate if a file is executable |
ValidateDocumentApi | validate_document_json_validation | POST /convert/validate/json | Validate a JSON file |
ValidateDocumentApi | validate_document_pdf_validation | POST /convert/validate/pdf | Validate a PDF document file |
ValidateDocumentApi | validate_document_pptx_validation | POST /convert/validate/pptx | Validate a PowerPoint presentation (PPTX) |
ValidateDocumentApi | validate_document_xlsx_validation | POST /convert/validate/xlsx | Validate a Excel document (XLSX) |
ValidateDocumentApi | validate_document_xml_validation | POST /convert/validate/xml | Validate an XML file |
ViewerToolsApi | viewer_tools_create_simple | POST /convert/viewer/create/web/simple | Create a web-based viewer |
Documentation For Models
- AlternateFileFormatCandidate
- AutodetectDocumentValidationResult
- AutodetectGetInfoResult
- AutodetectToPngResult
- ConvertedPngPage
- DocumentValidationError
- DocumentValidationResult
- DocxBody
- DocxCellStyle
- DocxFooter
- DocxHeader
- DocxImage
- DocxInsertImageRequest
- DocxInsertImageResponse
- DocxPage
- DocxParagraph
- DocxRemoveObjectRequest
- DocxRemoveObjectResponse
- DocxRun
- DocxSection
- DocxSetFooterAddPageNumberRequest
- DocxSetFooterRequest
- DocxSetFooterResponse
- DocxSetHeaderRequest
- DocxSetHeaderResponse
- DocxStyle
- DocxTable
- DocxTableCell
- DocxTableRow
- DocxTemplateApplicationRequest
- DocxTemplateOperation
- DocxText
- ExifValue
- FinishEditingRequest
- GetDocxBodyRequest
- GetDocxBodyResponse
- GetDocxHeadersAndFootersRequest
- GetDocxHeadersAndFootersResponse
- GetDocxImagesRequest
- GetDocxImagesResponse
- GetDocxPagesRequest
- GetDocxPagesResponse
- GetDocxSectionsRequest
- GetDocxSectionsResponse
- GetDocxStylesRequest
- GetDocxStylesResponse
- GetDocxTablesRequest
- GetDocxTablesResponse
- GetImageInfoResult
- GetXlsxColumnsRequest
- GetXlsxColumnsResponse
- GetXlsxImagesRequest
- GetXlsxImagesResponse
- GetXlsxRowsAndCellsRequest
- GetXlsxRowsAndCellsResponse
- GetXlsxStylesRequest
- GetXlsxStylesResponse
- GetXlsxWorksheetsRequest
- GetXlsxWorksheetsResponse
- HtmlMdResult
- HtmlTemplateApplicationRequest
- HtmlTemplateApplicationResponse
- HtmlTemplateOperation
- HtmlToOfficeRequest
- HtmlToPdfRequest
- HtmlToPngRequest
- InsertDocxInsertParagraphRequest
- InsertDocxInsertParagraphResponse
- InsertDocxTableRowRequest
- InsertDocxTableRowResponse
- InsertDocxTablesRequest
- InsertDocxTablesResponse
- InsertXlsxWorksheetRequest
- InsertXlsxWorksheetResponse
- MultipageImageFormatConversionResult
- PageConversionResult
- PdfDocument
- PdfFormField
- PdfFormFields
- PdfMetadata
- PdfPageText
- PdfTextByPageResult
- PdfToPngResult
- RemoveDocxHeadersAndFootersRequest
- RemoveDocxHeadersAndFootersResponse
- RemoveDocxPagesRequest
- ReplaceStringRequest
- ScreenshotRequest
- SetFormFieldValue
- SetPdfFormFieldsRequest
- SetPdfMetadataRequest
- SplitPdfResult
- SplitXlsxWorksheetResult
- TextConversionResult
- ViewerResponse
- WorksheetResult
- XlsxImage
- XlsxSpreadsheetCell
- XlsxSpreadsheetColumn
- XlsxSpreadsheetRow
- XlsxWorksheet
Documentation For Authorization
Apikey
- Type: API key
- API key parameter name: Apikey
- Location: HTTP header
Author
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Hashes for cloudmersive_convert_api_client-2.2.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6200673ce71000f2b3f25e96054d62f36e810e76939dc8c5dc605d322d32274f |
|
MD5 | 2ad9ef481c95ddcff1c9edfb427a3a6f |
|
BLAKE2b-256 | 3716ac3a2a3b7f0aedc5b7f64955269cbfd0caa2be1b0a1941547322931bf3dc |