Python SDK

Overview

Cloudinary's Python SDK provides simple, yet comprehensive image and video upload, transformation, optimization, and delivery capabilities that you can implement using code that integrates seamlessly with your existing Python application.

Tip
In this guide you'll learn how to get started with the Python SDK, but if you are not familiar with Cloudinary, we advise reading How to integrate Cloudinary first for a high-level overview of integrating Cloudinary into your code, and an introduction to the main concepts.

Related topics
This guide relates to the latest released version of the Cloudinary Python library.

For details on all new features and fixes from previous versions, see the CHANGELOG.

Note
Most of the functionality provided by Cloudinary can be implemented using Python, regardless of your framework. Some features are only available with Django, as described in the documentation.

Quick example: Transformations

Take a look at the following transformation code and the image it delivers:

Python:
Copy to clipboard
CloudinaryImage("front_face.png").image(secure=True, transformation=[
  {'width': 150, 'height': 150, 'gravity': "face", 'crop': "thumb"},
  {'radius': 20},
  {'effect': "sepia"},
  {'overlay': "cloudinary_icon_blue", 'gravity': "south_east", 'x': 5, 'y': 5, 'width': 50, 'opacity': 60, 'effect': "brightness:200"},
  {'angle': 10}
  ])
sample transformation

This relatively simple code performs all of the following on the original front_face.jpg image before delivering it:

  • Crop to a 150x150 thumbnail using face-detection gravity to automatically determine the location for the crop
  • Round the corners with a 20 pixel radius
  • Apply a sepia effect
  • Overlay the Cloudinary logo on the southeast corner of the image (with a slight offset). The logo is scaled down to a 50 pixel width, with increased brightness and partial transparency (opacity = 60%)
  • Rotate the resulting image (including the overlay) by 10 degrees
  • Convert and deliver the image in PNG format (the originally uploaded image was a JPG)

And here's the URL that would be included in the image tag that's automatically generated from the above code:

In a similar way, you can transform a video.

Quick example: File upload

The following Python code uploads the dog.mp4 video to the specified account sub-folder using the public_id, my_dog. The video will overwrite the my_dog video if it already exists. When the video upload is complete, the specified notification URL will receive details about the uploaded media asset.

Copy to clipboard
cloudinary.uploader.upload("dog.mp4", 
  folder = "myfolder/mysubfolder/", 
  public_id = "my_dog",
  overwrite = true, 
  notification_url = "https://mysite.example.com/notify_endpoint", 
  resource_type = "video")

Python Library features

Installation

Cloudinary's Python integration library is available as open-source Python code.

  1. Install Cloudinary's module using either easy_install or pip package management tools:

    Copy to clipboard
    pip install cloudinary
  2. Add cloudinary to the list of INSTALLED_APPS in settings.py.

  3. Include Cloudinary's Python classes in your code:

    Copy to clipboard
    import cloudinary
    import cloudinary.uploader
    import cloudinary.api

Note
You can also initialize Cloudinary tags in your Django templates by entering: {% load cloudinary %}

Configuration

To use the Cloudinary Python library, you have to configure at least your cloud_name. Your api_key and api_secret are also needed for secure API calls to Cloudinary (e.g., image and video uploads). You can find your account-specific configuration credentials in the Dashboard page of the account console.

In addition to the required configuration parameters, you can define a number of optional configuration parameters if relevant.

Setting the configuration parameters can be done globally, using either an environment variable or the config method, or programmatically in each call to a Cloudinary method. Parameters set in a call to a Cloudinary method override globally set parameters.

Note
For backward compatibility reasons, the default value of the optional secure configuration parameter is false. However, for most modern applications, it's recommended to configure the secure parameter to true to ensure that your transformation URLs are always generated as HTTPS.

Setting the CLOUDINARY_URL environment variable

You can configure the required cloud_name, api_key, and api_secret by defining the CLOUDINARY_URL environment variable. The CLOUDINARY_URL value is available in the Dashboard page of the account console. When using Cloudinary through a PaaS add-on (e.g., Heroku or AppFog), this environment variable is automatically defined in your deployment environment. For example:

Copy to clipboard
CLOUDINARY_URL=cloudinary://my_key:my_secret@my_cloud_name

Set additional parameters, for example upload_prefix and cname, to the environment variable:

Copy to clipboard
CLOUDINARY_URL=cloudinary://my_key:my_secret@my_cloud_name?cname=mydomain.com&upload_prefix=myprefix.com

Setting configuration parameters globally

Here's an example of setting configuration parameters globally in your Django application:

Copy to clipboard
cloudinary.config( 
  cloud_name = "sample", 
  api_key = "874837483274837", 
  api_secret = "a676b67565c6767a6767d6767f676fe1",
  secure = true
)

Python capitalization and data type guidelines

When using the Python SDK, keep these guidelines in mind:

  • Parameter names: snake_case. For example: public_id
  • Classes: PascalCase. For example: CloudinaryField
  • Methods: snake_case. For example: add_tag
  • Pass parameter data as: dict or named arguments

Sample projects

For additional useful code samples and learn how to integrate Cloudinary with your Python applications, take a look at our Sample Projects.

  • Basic python sample: Uploading local and remote images to Cloudinary and generating various transformation URLs.
  • Django Photo Album: A fully working web application that allows you to upload photos, maintain a database with references, list images with their metadata, and display them using various cloud-based transformations. Image uploading is performed both from the server side and directly from the browser using a jQuery plugin.

Note
The Django Photo Album web application can only be implemented with Django.

Related topics

✔️ Feedback sent!

Rate this page: