Document Conversion Library for Python

File conversion example using Python

The ConvertAPI Python library offers developers a straightforward way to integrate advanced file conversion and document handling features into their Python applications. With support for a vast range of formats, covering PDFs, Office documents, images, and beyond - it simplifies complex operations such as merging files, compressing large datasets, extracting critical information, and securely removing sensitive content.

Install the ConvertAPI Python library into your project

To get started, install the ConvertAPI Python package using PyPi:

Convert PDF to TXT example

The ConvertAPI Python library simplifies extracting readable text from your PDF files, making it effortless to work with document data in your Python projects. Whether you’re building search indexes, performing text analysis, or integrating content into other systems, the library provides straightforward methods to transform PDFs into text with just a few lines of code. Its flexible parameters and broad format support ensure that you gain quick, accurate access to the underlying text, freeing you from the complexity of manual extraction and letting you focus on delivering value through your application’s features.

Here is an example of text extraction from a PDF document using Python:

Convert File Stream

This example demonstrates converting text content directly from memory into a PDF, eliminating the need for intermediate file storage. It is ideal for applications that generate content dynamically and require immediate conversion without disk I/O.

Key Features:

• Utilizes UploadIO to handle in-memory text data.
• Performs conversion to PDF format.
• Saves the resulting PDF to a temporary directory.

convertapi.api_credentials = os.environ['CONVERT_API_TOKEN'] # your api token

# Example of using content stream to convert to pdf
# https://www.convertapi.com/txt-to-pdf

content = "Test content string"
upload_io = convertapi.UploadIO(content, 'test.txt')
result = convertapi.convert('pdf', { 'File': upload_io })
saved_files = result.save_files(tempfile.gettempdir())

print("The PDF saved to %s" % saved_files)

Convert URL to PDF

Illustrates how to convert a live web page into a PDF by providing its URL, facilitating the capture of web content in a portable format. It's useful for archiving web pages or generating PDF versions of online content for offline access or record-keeping.

• Accepts a web page URL as input.
• Converts the web page to a PDF document.
• Stores the PDF in a specified directory.

convertapi.api_credentials = os.environ['CONVERT_API_TOKEN'] # your api token

# Example of converting Web Page URL to PDF file
# https://www.convertapi.com/web-to-pdf

result = convertapi.convert(
    'pdf',
    {
        'Url': 'https://en.wikipedia.org/wiki/Data_conversion',
        'FileName': 'web-example',
    },
    from_format = 'web',
    timeout = 180,
)

saved_files = result.save_files(tempfile.gettempdir())

print("The web page PDF saved to %s" % saved_files)

Conversion chaining (workflow)

Below you will find an example that demonstrates a multi-step conversion process, such as converting a DOCX file to PDF and then compressing the PDF, showcasing how to chain multiple conversions seamlessly. It is meant for complex workflows requiring multiple file transformations in a specific sequence.

Key Features:

• Performs sequential conversions using intermediate results.
• Manages multiple steps within a single process.
• Outputs the final converted file after all transformations.

convertapi.api_credentials = os.environ['CONVERT_API_TOKEN'] # your api token

# Short example of conversions chaining, the PDF pages extracted and saved as separated JPGs and then ZIP'ed
# https://www.convertapi.com/doc/chaining

print('Converting PDF to JPG and compressing result files with ZIP')

jpg_result = convertapi.convert('jpg', { 'File': 'files/test.pdf' })

print("Conversions done. Cost: %s. Total files created: %s" % (jpg_result.conversion_cost, len(jpg_result.files)))

zip_result = convertapi.convert('zip', { 'Files': jpg_result.files })

print("Conversions done. Cost: %s. Total files created: %s" % (zip_result.conversion_cost, len(zip_result.files)))

saved_files = zip_result.save_files(tempfile.gettempdir())

print("File saved to %s" % saved_files)

Retrieve user information

The final example illustrates how to retrieve account information, such as usage statistics and remaining conversion credits, using the ConvertAPI Python library. It is important for monitoring account usage and managing conversion quotas programmatically.

convertapi.api_credentials = os.environ['CONVERT_API_TOKEN'] # your api token

# Retrieve user information
# https://www.convertapi.com/doc/user

print(convertapi.user())

With our Python SDK, you can seamlessly access more than 500+ converters and document handling features, all within one cohesive platform.

Whether you supply documents by URL, file stream, or local file path, integrating them into your current setup is effortless. For even better performance, consider setting up conversion workflows, allowing you to handle several operations at once and streamline the entire process.

For detailed guidance and advanced best practices, don’t forget to check out our GitHub repository.