1Metadata-Version: 2.1
2Name: minio
3Version: 4.0.21
4Summary: MinIO Python Library for Amazon S3 Compatible Cloud Storage for Python
5Home-page: https://github.com/minio/minio-py
6Author: MinIO, Inc.
7Author-email: dev@min.io
8License: Apache License 2.0
9Download-URL: https://github.com/minio/minio-py
10Description: # MinIO Python Library for Amazon S3 Compatible Cloud Storage [![Slack](https://slack.min.io/slack?type=svg)](https://slack.min.io)
11
12        The MinIO Python Client SDK provides simple APIs to access any Amazon S3 compatible object storage server.
13
14        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](https://docs.min.io/docs/python-client-api-reference) documentation.
15
16        This document assumes that you have a working [Python](https://www.python.org/downloads/) setup in place.
17
18        ## Minimum Requirements
19
20        - Python 2.7 or higher
21
22        ## Download from pip
23
24        ```sh
25        pip install minio
26        ```
27
28        ## Download from pip3
29
30        ```sh
31        pip3 install minio
32        ```
33
34        ## Download from source
35
36        ```sh
37        git clone https://github.com/minio/minio-py
38        cd minio-py
39        python setup.py install
40        ```
41
42        ## Initialize MinIO Client
43
44        You need four items in order to connect to MinIO object storage server.
45
46        | Params     | Description |
47        | :------- | :---- |
48        | endpoint | URL to object storage service. |
49        | access_key| Access key is like user ID that uniquely identifies your account.   |
50        | secret_key| Secret key is the password to your account.    |
51        |secure|Set this value to 'True' to enable secure (HTTPS) access.|
52
53        ```py
54        from minio import Minio
55        from minio.error import ResponseError
56
57        minioClient = Minio('play.min.io',
58                          access_key='Q3AM3UQ867SPQQA43P2F',
59                          secret_key='zuf+tfteSlswRu7BJ86wekitnifILbZam1KYY3TG',
60                          secure=True)
61        ```
62
63
64        ## Quick Start Example - File Uploader
65        This example program connects to a MinIO object storage server, makes a bucket on the server and then uploads a file to the bucket.
66
67        We will use the MinIO server running at [https://play.min.io](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.
68
69        #### file-uploader.py
70
71        ```py
72        # Import MinIO library.
73        from minio import Minio
74        from minio.error import (ResponseError, BucketAlreadyOwnedByYou,
75                                 BucketAlreadyExists)
76
77        # Initialize minioClient with an endpoint and access/secret keys.
78        minioClient = Minio('play.min.io',
79                            access_key='Q3AM3UQ867SPQQA43P2F',
80                            secret_key='zuf+tfteSlswRu7BJ86wekitnifILbZam1KYY3TG',
81                            secure=True)
82
83        # Make a bucket with the make_bucket API call.
84        try:
85               minioClient.make_bucket("maylogs", location="us-east-1")
86        except BucketAlreadyOwnedByYou as err:
87               pass
88        except BucketAlreadyExists as err:
89               pass
90        except ResponseError as err:
91               raise
92        else:
93                # Put an object 'pumaserver_debug.log' with contents from 'pumaserver_debug.log'.
94                try:
95                       minioClient.fput_object('maylogs', 'pumaserver_debug.log', '/tmp/pumaserver_debug.log')
96                except ResponseError as err:
97                       print(err)
98        ```
99
100        #### Run file-uploader
101
102        ```bash
103        python file_uploader.py
104
105        mc ls play/maylogs/
106        [2016-05-27 16:41:37 PDT]  12MiB pumaserver_debug.log
107        ```
108
109        ## API Reference
110
111        The full API Reference is available here.
112        * [Complete API Reference](https://docs.min.io/docs/python-client-api-reference)
113
114        ### API Reference : Bucket Operations
115
116        * [`make_bucket`](https://docs.min.io/docs/python-client-api-reference#make_bucket)
117        * [`list_buckets`](https://docs.min.io/docs/python-client-api-reference#list_buckets)
118        * [`bucket_exists`](https://docs.min.io/docs/python-client-api-reference#bucket_exists)
119        * [`remove_bucket`](https://docs.min.io/docs/python-client-api-reference#remove_bucket)
120        * [`list_objects`](https://docs.min.io/docs/python-client-api-reference#list_objects)
121        * [`list_objects_v2`](https://docs.min.io/docs/python-client-api-reference#list_objects_v2)
122        * [`list_incomplete_uploads`](https://docs.min.io/docs/python-client-api-reference#list_incomplete_uploads)
123
124        ### API Reference : Bucket policy Operations
125
126        * [`get_bucket_policy`](https://docs.min.io/docs/python-client-api-reference#get_bucket_policy)
127        * [`set_bucket_policy`](https://docs.min.io/docs/python-client-api-reference#set_bucket_policy)
128
129        ### API Reference : Bucket notification Operations
130
131        * [`set_bucket_notification`](https://docs.min.io/docs/python-client-api-reference#set_bucket_notification)
132        * [`get_bucket_notification`](https://docs.min.io/docs/python-client-api-reference#get_bucket_notification)
133        * [`remove_all_bucket_notification`](https://docs.min.io/docs/python-client-api-reference#remove_all_bucket_notification)
134        * [`listen_bucket_notification`](https://docs.min.io/docs/python-client-api-reference#listen_bucket_notification)
135
136        ### API Reference : File Object Operations
137
138        * [`fput_object`](https://docs.min.io/docs/python-client-api-reference#fput_object)
139        * [`fget_object`](https://docs.min.io/docs/python-client-api-reference#fget_object)
140
141        ### API Reference : Object Operations
142
143        * [`get_object`](https://docs.min.io/docs/python-client-api-reference#get_object)
144        * [`put_object`](https://docs.min.io/docs/python-client-api-reference#put_object)
145        * [`stat_object`](https://docs.min.io/docs/python-client-api-reference#stat_object)
146        * [`copy_object`](https://docs.min.io/docs/python-client-api-reference#copy_object)
147        * [`get_partial_object`](https://docs.min.io/docs/python-client-api-reference#get_partial_object)
148        * [`remove_object`](https://docs.min.io/docs/python-client-api-reference#remove_object)
149        * [`remove_objects`](https://docs.min.io/docs/python-client-api-reference#remove_objects)
150        * [`remove_incomplete_upload`](https://docs.min.io/docs/python-client-api-reference#remove_incomplete_upload)
151
152        ### API Reference : Presigned Operations
153
154        * [`presigned_get_object`](https://docs.min.io/docs/python-client-api-reference#presigned_get_object)
155        * [`presigned_put_object`](https://docs.min.io/docs/python-client-api-reference#presigned_put_object)
156        * [`presigned_post_policy`](https://docs.min.io/docs/python-client-api-reference#presigned_post_policy)
157
158        ## Full Examples
159
160        #### Full Examples : Bucket Operations
161
162        * [make_bucket.py](https://github.com/minio/minio-py/blob/master/examples/make_bucket.py)
163        * [list_buckets.py](https://github.com/minio/minio-py/blob/master/examples/list_buckets.py)
164        * [bucket_exists.py](https://github.com/minio/minio-py/blob/master/examples/bucket_exists.py)
165        * [list_objects.py](https://github.com/minio/minio-py/blob/master/examples/list_objects.py)
166        * [remove_bucket.py](https://github.com/minio/minio-py/blob/master/examples/remove_bucket.py)
167        * [list_incomplete_uploads.py](https://github.com/minio/minio-py/blob/master/examples/list_incomplete_uploads.py)
168
169        #### Full Examples : Bucket policy Operations
170
171        * [set_bucket_policy.py](https://github.com/minio/minio-py/blob/master/examples/set_bucket_policy.py)
172        * [get_bucket_policy.py](https://github.com/minio/minio-py/blob/master/examples/get_bucket_policy.py)
173
174        #### Full Examples: Bucket notification Operations
175
176        * [set_bucket_notification.py](https://github.com/minio/minio-py/blob/master/examples/set_bucket_notification.py)
177        * [get_bucket_notification.py](https://github.com/minio/minio-py/blob/master/examples/get_bucket_notification.py)
178        * [remove_all_bucket_notification.py](https://github.com/minio/minio-py/blob/master/examples/remove_all_bucket_notification.py)
179        * [listen_bucket_notification.py](https://github.com/minio/minio-py/blob/master/examples/listen_notification.py)
180
181        #### Full Examples : File Object Operations
182
183        * [fput_object.py](https://github.com/minio/minio-py/blob/master/examples/fput_object.py)
184        * [fget_object.py](https://github.com/minio/minio-py/blob/master/examples/fget_object.py)
185
186        #### Full Examples : Object Operations
187
188        * [get_object.py](https://github.com/minio/minio-py/blob/master/examples/get_object.py)
189        * [put_object.py](https://github.com/minio/minio-py/blob/master/examples/put_object.py)
190        * [stat_object.py](https://github.com/minio/minio-py/blob/master/examples/stat_object.py)
191        * [copy_object.py](https://github.com/minio/minio-py/blob/master/examples/copy_object.py)
192        * [get_partial_object.py](https://github.com/minio/minio-py/blob/master/examples/get_partial_object.py)
193        * [remove_object.py](https://github.com/minio/minio-py/blob/master/examples/remove_object.py)
194        * [remove_objects.py](https://github.com/minio/minio-py/blob/master/examples/remove_objects.py)
195        * [remove_incomplete_upload.py](https://github.com/minio/minio-py/blob/master/examples/remove_incomplete_upload.py)
196
197        #### Full Examples : Presigned Operations
198
199        * [presigned_get_object.py](https://github.com/minio/minio-py/blob/master/examples/presigned_get_object.py)
200        * [presigned_put_object.py](https://github.com/minio/minio-py/blob/master/examples/presigned_put_object.py)
201        * [presigned_post_policy.py](https://github.com/minio/minio-py/blob/master/examples/presigned_post_policy.py)
202
203        ## Explore Further
204
205        * [Complete Documentation](https://docs.min.io)
206        * [MinIO Python SDK API Reference](https://docs.min.io/docs/python-client-api-reference)
207
208        ## Contribute
209
210        [Contributors Guide](https://github.com/minio/minio-py/blob/master/CONTRIBUTING.md)
211
212        [![PYPI](https://img.shields.io/pypi/v/minio.svg)](https://pypi.python.org/pypi/minio)
213        [![Build Status](https://travis-ci.org/minio/minio-py.svg)](https://travis-ci.org/minio/minio-py)
214        [![Build status](https://ci.appveyor.com/api/projects/status/1d05e6nvxcelmrak?svg=true)](https://ci.appveyor.com/project/harshavardhana/minio-py)
215
216Platform: UNKNOWN
217Classifier: Development Status :: 5 - Production/Stable
218Classifier: Intended Audience :: Developers
219Classifier: License :: OSI Approved :: Apache Software License
220Classifier: Natural Language :: English
221Classifier: Operating System :: OS Independent
222Classifier: Programming Language :: Python
223Classifier: Programming Language :: Python :: 2.7
224Classifier: Programming Language :: Python :: 3.4
225Classifier: Programming Language :: Python :: 3.5
226Classifier: Programming Language :: Python :: 3.6
227Classifier: Programming Language :: Python :: 3.7
228Classifier: Topic :: Software Development :: Libraries :: Python Modules
229Description-Content-Type: text/markdown
230