Skip to content

Alyetama/uploadcare-python

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Uploadcare-Python

🚀 Python wrapper for UploadCare's Upload API.

GitHub Pages Supported Python versions PEP8

Requirements

⬇️ Installation

pip install uploadcare

⌨️ Usage

from uploadcare import UploadCare

uc = UploadCare(pub_key='my-public-key')

📕 Examples

file = 'https://upload.wikimedia.org/wikipedia/en/a/a9/Example.jpg'  # or a local file

url = uc.upload(file)
print(url)
# 'https://ucarecdn.com/d30aff21-a441-4ae4-82e0-ead56bfabdc9/Example.jpg'

uc.info(url)
# {'size': 27661, 'total': 27661, 'done': 27661, 'uuid': 'd30aff21-a441-4ae4-82e0-ead56bfabdc9', 'file_id': 'd30aff21-a441-4ae4-82e0-ead56bfabdc9', 'original_filename': 'Example.jpg', 'is_image': True, 'is_stored': False, 'image_info': {'dpi': [72, 72], 'width': 275, 'format': 'JPEG', 'height': 297, 'sequence': False, 'color_mode': 'RGB', 'orientation': None, 'geo_location': None, 'datetime_original': None}, 'video_info': None, 'content_info': {'mime': {'mime': 'image/jpeg', 'type': 'image', 'subtype': 'jpeg'}, 'image': {'dpi': [72, 72], 'width': 275, 'format': 'JPEG', 'height': 297, 'sequence': False, 'color_mode': 'RGB', 'orientation': None, 'geo_location': None, 'datetime_original': None}}, 'is_ready': True, 'filename': 'Example.jpg', 'mime_type': 'image/jpeg', 'metadata': {}}

print(uc.info(url, pretty=True))
# Expand the output below:
Expand
{
  "size": 27661,
  "total": 27661,
  "done": 27661,
  "uuid": "d30aff21-a441-4ae4-82e0-ead56bfabdc9",
  "file_id": "d30aff21-a441-4ae4-82e0-ead56bfabdc9",
  "original_filename": "Example.jpg",
  "is_image": true,
  "is_stored": false,
  "image_info": {
      "dpi": [
          72,
          72
      ],
      "width": 275,
      "format": "JPEG",
      "height": 297,
      "sequence": false,
      "color_mode": "RGB",
      "orientation": null,
      "geo_location": null,
      "datetime_original": null
  },
  "video_info": null,
  "content_info": {
      "mime": {
          "mime": "image/jpeg",
          "type": "image",
          "subtype": "jpeg"
      },
      "image": {
          "dpi": [
              72,
              72
          ],
          "width": 275,
          "format": "JPEG",
          "height": 297,
          "sequence": false,
          "color_mode": "RGB",
          "orientation": null,
          "geo_location": null,
          "datetime_original": null
      }
  },
  "is_ready": true,
  "filename": "Example.jpg",
  "mime_type": "image/jpeg",
  "metadata": {}
}

🔑 Supports Secure Upload

  • A secure signature is generated automatically. But if you want to use a custom signature, you can pass it as a keyword argument.
uc = UploadCare(pub_key='my-public-key', secret_key='my-secret-key')

# Set expiration as a unix timestamp
url = uc.upload(file, expire=1653429047) 

# Or, as a string
url = uc.upload(file, expire='in 30m')
url = uc.upload(file, expire='in 3 days')
url = uc.upload(file, expire='31-05-2022')

To view all supported methods, see: uploadcare.UploadCare