MinIO Python Library for Amazon S3 Compatible Cloud Storage

The MinIO Python Client SDK provides simple APIs to access any Amazon S3 compatible object storage server.

This quickstart guide will show you how to install the client SDK and execute an example python program. For a complete list of APIs and examples, please take a look at the Python Client API Reference documentation.

This document assumes that you have a working Python setup in place.

Minimum Requirements

• Python 2.7 or higher

Download from pip

pip install minio

Download from pip3

pip3 install minio

Download from source

git clone https://github.com/minio/minio-py
cd minio-py
python setup.py install

Initialize MinIO Client

You need four items in order to connect to MinIO object storage server.

from minio import Minio
from minio.error import ResponseError

minioClient = Minio('play.min.io',
                  access_key='Q3AM3UQ867SPQQA43P2F',
                  secret_key='zuf+tfteSlswRu7BJ86wekitnifILbZam1KYY3TG',
                  secure=True)

NOTE on concurrent usage: The Minio object is thread safe when using the Python threading library. Specifically, it is NOT safe to share it between multiple processes, for example when using multiprocessing.Pool. The solution is simply to create a new Minio object in each process, and not share it between processes.

Quick Start Example - File Uploader

This example program connects to a MinIO object storage server, makes a bucket on the server and then uploads a file to the bucket.

We will use the MinIO server running at https://play.min.io in this example. Feel free to use this service for testing and development. Access credentials shown in this example are open to the public.

file-uploader.py

# Import MinIO library.
from minio import Minio
from minio.error import (ResponseError, BucketAlreadyOwnedByYou,
                         BucketAlreadyExists)

# Initialize minioClient with an endpoint and access/secret keys.
minioClient = Minio('play.min.io',
                    access_key='Q3AM3UQ867SPQQA43P2F',
                    secret_key='zuf+tfteSlswRu7BJ86wekitnifILbZam1KYY3TG',
                    secure=True)

# Make a bucket with the make_bucket API call.
try:
       minioClient.make_bucket("maylogs", location="us-east-1")
except BucketAlreadyOwnedByYou as err:
       pass
except BucketAlreadyExists as err:
       pass
except ResponseError as err:
       raise

# Put an object 'pumaserver_debug.log' with contents from 'pumaserver_debug.log'.
try:
       minioClient.fput_object('maylogs', 'pumaserver_debug.log', '/tmp/pumaserver_debug.log')
except ResponseError as err:
       print(err)

Run file-uploader

python file_uploader.py

mc ls play/maylogs/
[2016-05-27 16:41:37 PDT]  12MiB pumaserver_debug.log

API Reference

The full API Reference is available here.

• Complete API Reference

API Reference : Bucket Operations

• make_bucket
• list_buckets
• bucket_exists
• remove_bucket
• list_objects
• list_objects_v2
• list_incomplete_uploads

API Reference : Bucket policy Operations

• get_bucket_policy
• set_bucket_policy

API Reference : Bucket notification Operations

• set_bucket_notification
• get_bucket_notification
• remove_all_bucket_notification
• listen_bucket_notification

API Reference : Default bucket encryption configuration Operations

• put_bucket_encryption
• get_bucket_encryption
• delete_bucket_encryption

API Reference : File Object Operations

• fput_object
• fget_object

API Reference : Object Operations

• get_object
• put_object
• stat_object
• copy_object
• get_partial_object
• remove_object
• remove_objects
• remove_incomplete_upload

API Reference : Presigned Operations

• presigned_get_object
• presigned_put_object
• presigned_post_policy

Full Examples

Full Examples : Bucket Operations

• make_bucket.py
• list_buckets.py
• bucket_exists.py
• list_objects.py
• remove_bucket.py
• list_incomplete_uploads.py

Full Examples : Bucket policy Operations

• set_bucket_policy.py
• get_bucket_policy.py

Full Examples: Bucket notification Operations

• set_bucket_notification.py
• get_bucket_notification.py
• remove_all_bucket_notification.py
• listen_bucket_notification.py

Full Examples: Default bucket encryption configuration Operations

• put_bucket_encryption.py
• get_bucket_encryption.py
• delete_bucket_encryption.py

Full Examples : File Object Operations

• fput_object.py
• fget_object.py

Full Examples : Object Operations

• get_object.py
• put_object.py
• stat_object.py
• copy_object.py
• get_partial_object.py
• remove_object.py
• remove_objects.py
• remove_incomplete_upload.py

Full Examples : Presigned Operations

• presigned_get_object.py
• presigned_put_object.py
• presigned_post_policy.py

Explore Further

• Complete Documentation
• MinIO Python SDK API Reference

Contribute

Contributors Guide