Python Library
ConvertAPI Python Client
Convert your files with our online file conversion API
ConvertAPI helps to convert various file formats. Creating PDF and Images from various sources like Word, Excel, Powerpoint, images, web pages or raw HTML codes. Merge, Encrypt, Split, Repair and Decrypt PDF files and many other manipulations. You can integrate it into your application in just a few minutes and use it easily.
Installation
Install with pip:
pip install --upgrade convertapi
Install from source with:
python setup.py install
Requirements
- Python 2.7+ or Python 3.3+
Usage
Configuration
You can get your secret at https://www.convertapi.com/a
import convertapi
convertapi.api_secret = 'your-api-secret'
Proxy configuration
If you need to use a proxy, you can specify it using HTTPS_PROXY
environment variable when running your script.
Example:
CONVERT_API_SECRET=secret HTTPS_PROXY=https://user:pass@127.0.0.1:9000/ python convert_word_to_pdf_and_png.py
File conversion
Convert a file to PDF example. All supported file formats and options can be found here.
result = convertapi.convert('pdf', { 'File': '/path/to/my_file.docx' })
# save to file
result.file.save('/path/to/save/file.pdf')
Other result operations:
# save all result files to folder
result.save_files('/path/to/save/files')
# get conversion cost
conversion_cost = result.conversion_cost
Convert file url
result = convertapi.convert('pdf', { 'File': 'https://website/my_file.docx' })
Specifying from format
result = convertapi.convert(
'pdf',
{ 'File': '/path/to/my_file' },
from_format = 'docx'
)
Additional conversion parameters
ConvertAPI accepts additional conversion parameters depending on selected formats. All conversion parameters and explanations can be found here.
result = convertapi.convert(
'pdf',
{
'File': '/path/to/my_file.docx',
'PageRange': '1-10',
'PdfResolution': '150',
}
)
User information
You can always check your remaining seconds amount programatically by fetching user information.
user_info = convertapi.user()
print(user_info['SecondsLeft'])
More examples
Find more advanced examples in the /examples folder.
Development
Execute CONVERT_API_SECRET=your_secret nosetests --nocapture
to run the tests.
Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/ConvertAPI/convertapi-python. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
License
The gem is available as open source under the terms of the MIT License.