MinIO Python SDK for Amazon S3 Compatible Cloud Storage
Project description
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
mccommand line tool - The MinIO
playtest 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
playserver using the provided credentials. - Creates a bucket named
python-test-bucketif it does not already exist. - Uploads a file named
test-file.txtfrom/tmp, renaming itmy-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
/tmpnamedtest-file.txt. To use a different path or filename, modify the value ofsource_file. -
Run
file_uploader.pywith 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
Contribute
License
This SDK is distributed under the Apache License, Version 2.0, see LICENSE and NOTICE for more information.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file minio-7.2.20.tar.gz.
File metadata
- Download URL: minio-7.2.20.tar.gz
- Upload date:
- Size: 136.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
95898b7a023fbbfde375985aa77e2cd6a0762268db79cf886f002a9ea8e68598
|
|
| MD5 |
d10dda8b9bc2e495605c6045e59bf705
|
|
| BLAKE2b-256 |
40df6dfc6540f96a74125a11653cce717603fd5b7d0001a8e847b3e54e72d238
|
File details
Details for the file minio-7.2.20-py3-none-any.whl.
File metadata
- Download URL: minio-7.2.20-py3-none-any.whl
- Upload date:
- Size: 93.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
eb33dd2fb80e04c3726a76b13241c6be3c4c46f8d81e1d58e757786f6501897e
|
|
| MD5 |
d7ca5dfb336e225f67cdfae29d493b3d
|
|
| BLAKE2b-256 |
3e9ab697530a882588a84db616580f2ba5d1d515c815e11c30d219145afeec87
|
