MinIO Python Client SDK for Amazon S3 Compatible Cloud Storage

The MinIO Python Client SDK provides high level APIs to access any MinIO Object Storage or other Amazon S3 compatible service.

This Quickstart Guide covers how to install the MinIO client SDK, connect to the object storage service, and create a sample file uploader.

The example below uses:

Python version 3.7+
The MinIO mc command line tool
The MinIO play test server

The play server is a public MinIO cluster located at https://play.min.io. This cluster runs the latest stable version of MinIO and may be used for testing and development. The access credentials in the example are open to the public and all data uploaded to play should be considered public and world-readable.

For a complete list of APIs and examples, see the Python Client API Reference

Install the MinIO Python SDK

The Python SDK requires Python version 3.7+. You can install the SDK with pip or from the minio/minio-py GitHub repository:

Using `pip`

pip3 install minio

Using Source From GitHub

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

Create a MinIO Client

To connect to the target service, create a MinIO client using the Minio() method with the following required parameters:

Parameter	Description
`endpoint`	URL of the target service.
`access_key`	Access key (user ID) of a user account in the service.
`secret_key`	Secret key (password) for the user account.

For example:

from minio import Minio

client = Minio("play.min.io",
    access_key="Q3AM3UQ867SPQQA43P2F",
    secret_key="zuf+tfteSlswRu7BJ86wekitnifILbZam1KYY3TG",
)

Example - File Uploader

This example does the following:

Connects to the MinIO play server using the provided credentials.
Creates a bucket named python-test-bucket if it does not already exist.
Uploads a file named test-file.txt from /tmp, renaming it my-test-file.txt.
Verifies the file was created using mc ls.

`file_uploader.py`

# file_uploader.py MinIO Python SDK example
from minio import Minio
from minio.error import S3Error

def main():
    # Create a client with the MinIO server playground, its access key
    # and secret key.
    client = Minio("play.min.io",
        access_key="Q3AM3UQ867SPQQA43P2F",
        secret_key="zuf+tfteSlswRu7BJ86wekitnifILbZam1KYY3TG",
    )

    # The file to upload, change this path if needed
    source_file = "/tmp/test-file.txt"

    # The destination bucket and filename on the MinIO server
    bucket_name = "python-test-bucket"
    destination_file = "my-test-file.txt"
    
    # Make the bucket if it doesn't exist.
    found = client.bucket_exists(bucket_name)
    if not found:
        client.make_bucket(bucket_name)
        print("Created bucket", bucket_name)
    else:
        print("Bucket", bucket_name, "already exists")

    # Upload the file, renaming it in the process
    client.fput_object(
        bucket_name, destination_file, source_file,
    )
    print(
        source_file, "successfully uploaded as object",
        destination_file, "to bucket", bucket_name,
    )

if __name__ == "__main__":
    try:
        main()
    except S3Error as exc:
        print("error occurred.", exc)

To run this example:

Create a file in /tmp named test-file.txt. To use a different path or filename, modify the value of source_file.
Run file_uploader.py with the following command:

python file_uploader.py

If the bucket does not exist on the server, the output resembles the following:

Created bucket python-test-bucket
/tmp/test-file.txt successfully uploaded as object my-test-file.txt to bucket python-test-bucket

Verify the uploaded file with mc ls:

mc ls play/python-test-bucket
[2023-11-03 22:18:54 UTC]  20KiB STANDARD my-test-file.txt

More References

Explore Further

Complete Documentation

Contribute

Contributors Guide

License

This SDK is distributed under the Apache License, Version 2.0, see LICENSE and NOTICE for more information.

Metadata

Release files for minio 7.2.10

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for minio 7.2.10
File	Size	Uploaded
minio-7.2.10.tar.gz	135.4 kB	Oct 24, 2024	Details

Built distribution (wheel)

Table of built distributions (wheels) for minio 7.2.10
File	Interpreter	ABI	Platform	Reset
minio-7.2.10-py3-none-any.whl 93.9 kB Oct 24, 2024	Python 3	none	any	Details

Total release size: 229.3 kB

Release files / minio-7.2.10.tar.gz

Download URL	minio-7.2.10.tar.gz
Size	135.4 kB
Tags	Source
SHA-256 checksum How to use checksums	`418c31ac79346a580df04a0e14db1becbc548a6e7cca61f9bc4ef3bcd336c449`
BLAKE2b-256 checksum How to use checksums	`84d804b4c8ceaa7bae49a674ccdba53530599e73fb3c6a8f8cf8e26ee0eb390d`
Upload date	Oct 24, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/5.1.1 CPython/3.10.12`

Release files / minio-7.2.10-py3-none-any.whl

Download URL	minio-7.2.10-py3-none-any.whl
Size	93.9 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`5961c58192b1d70d3a2a362064b8e027b8232688998a6d1251dadbb02ab57a7d`
BLAKE2b-256 checksum How to use checksums	`206f1b1f5025bf43c2a4ca8112332db586c8077048ec8bcea2deb269eac84577`
Upload date	Oct 24, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/5.1.1 CPython/3.10.12`