diff options
author | Alex Auvolat <alex@adnab.me> | 2023-01-02 15:07:44 +0100 |
---|---|---|
committer | Alex Auvolat <alex@adnab.me> | 2023-01-02 15:07:44 +0100 |
commit | 939a6d67e8ace1aa38998281f52511a61f4b4d94 (patch) | |
tree | b94c84bd21ef45e2480c653dc7ed2b37fd5907fb /doc/book/build/python.md | |
parent | 6b857a9b8cd454721a2a1e69e108794be07d36a2 (diff) | |
parent | 76230f20282e73a5a5afa33af68152acaf732cf5 (diff) | |
download | garage-939a6d67e8ace1aa38998281f52511a61f4b4d94.tar.gz garage-939a6d67e8ace1aa38998281f52511a61f4b4d94.zip |
Merge branch 'main' into internals-reworkinternals-rework
Diffstat (limited to 'doc/book/build/python.md')
-rw-r--r-- | doc/book/build/python.md | 59 |
1 files changed, 51 insertions, 8 deletions
diff --git a/doc/book/build/python.md b/doc/book/build/python.md index 19912e85..5b797897 100644 --- a/doc/book/build/python.md +++ b/doc/book/build/python.md @@ -5,16 +5,59 @@ weight = 20 ## S3 -*Coming soon* +### Using Minio SDK + +First install the SDK: + +```bash +pip3 install minio +``` + +Then instantiate a client object using garage root domain, api key and secret: + +```python +import minio + +client = minio.Minio( + "your.domain.tld", + "GKyourapikey", + "abcd[...]1234", + # Force the region, this is specific to garage + region="region", +) +``` -Some refs: - - Minio SDK - - [Reference](https://docs.min.io/docs/python-client-api-reference.html) +Then use all the standard S3 endpoints as implemented by the Minio SDK: + +``` +# List buckets +print(client.list_buckets()) + +# Put an object containing 'content' to /path in bucket named 'bucket': +content = b"content" +client.put_object( + "bucket", + "path", + io.BytesIO(content), + len(content), +) + +# Read the object back and check contents +data = client.get_object("bucket", "path").read() +assert data == content +``` + +For further documentation, see the Minio SDK +[Reference](https://docs.min.io/docs/python-client-api-reference.html) + +### Using Amazon boto3 + +*Coming soon* - - Amazon boto3 - - [Installation](https://boto3.amazonaws.com/v1/documentation/api/latest/guide/quickstart.html) - - [Reference](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/s3.html) - - [Example](https://boto3.amazonaws.com/v1/documentation/api/latest/guide/s3-uploading-files.html) +See the official documentation: + - [Installation](https://boto3.amazonaws.com/v1/documentation/api/latest/guide/quickstart.html) + - [Reference](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/s3.html) + - [Example](https://boto3.amazonaws.com/v1/documentation/api/latest/guide/s3-uploading-files.html) ## K2V |