# Volcengine TOS SDK for Python
The TOS Python SDK enables Python developers to easily work with TOS(Tinder Object Storage) service in the volcengine.
This document will show developers some basic examples about TOS bucket and object operation.
## Install
### Requirements
- Python3
# Quick Start
This section introduces how to create a bucket, upload/download/delete an object in TOS service through our SDK.
## Create a TOS Client
You can interact with TOS service after initiating a TOSClient instance.
The accesskey and secretkey of your account, endpoint and region are required as params.
```python
import tos
ak = "your access key"
sk = "your secret key"
endpoint = "your endpoint"
region = "your region"
bucket_name = "your bucket name"
object_key = "your object key"
client = tos.TosClientV2(ak, sk, endpoint, region)
```
## Create a bucket
The bucket is a kind of unique namespace in TOS, which is a container to store data.
This example shows you how to create a bucket.
```python
import tos
ak = "your access key"
sk = "your secret key"
endpoint = "your endpoint"
region = "your region"
bucket_name = "your bucket name"
client = tos.TosClientV2(ak, sk, endpoint, region)
client.create_bucket(bucket_name)
```
## Put Object
You can put your file as an object into your own bucket.
```python
# call put_object to upload you data to the TOS
client.put_object(bucket_name, object_key, content="123")
assert resp.status_code == 200
```
## Get Object
You can download objects in the TOS bucket through our SDK.
```python
# call get_object to download your data from your bucket
client.get_object(bucket_name, object_key)
```
## Delete Object
Your can delete your objects in the bucket：
```python
# call put_object to upload you data to the TOS
resp = client.put_object(bucket_name, key_name, content="123")
assert resp.status_code == 200
# call delete_object to delete an object in your bucket
resp = client.delete_object(bucket_name, key_name)
assert resp.status_code == 204
```
## License
[Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0.html)
Raw data
{
"_id": null,
"home_page": "https://www.volcengine.com/",
"name": "tos",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "boilerplate",
"author": "sunyushan",
"author_email": "sunyushan.jason@bytedance.com",
"download_url": "https://files.pythonhosted.org/packages/47/8f/4e28239c2e8f7a1300a2ce1b83e706255f29dcc9a2aa7d14467586ae42bf/tos-2.8.1.tar.gz",
"platform": null,
"description": "\n# Volcengine TOS SDK for Python\nThe TOS Python SDK enables Python developers to easily work with TOS(Tinder Object Storage) service in the volcengine.\nThis document will show developers some basic examples about TOS bucket and object operation.\n\n\n## Install\n### Requirements\n- Python3\n# Quick Start\n\nThis section introduces how to create a bucket, upload/download/delete an object in TOS service through our SDK.\n\n## Create a TOS Client\n\nYou can interact with TOS service after initiating a TOSClient instance.\nThe accesskey and secretkey of your account, endpoint and region are required as params.\n\n```python\nimport tos\n\nak = \"your access key\"\nsk = \"your secret key\"\nendpoint = \"your endpoint\"\nregion = \"your region\"\nbucket_name = \"your bucket name\"\nobject_key = \"your object key\"\nclient = tos.TosClientV2(ak, sk, endpoint, region) \n```\n\n## Create a bucket\n\nThe bucket is a kind of unique namespace in TOS, which is a container to store data.\nThis example shows you how to create a bucket.\n\n```python\nimport tos\n\nak = \"your access key\"\nsk = \"your secret key\"\nendpoint = \"your endpoint\"\nregion = \"your region\"\nbucket_name = \"your bucket name\"\nclient = tos.TosClientV2(ak, sk, endpoint, region)\nclient.create_bucket(bucket_name) \n```\n\n## Put Object\n\nYou can put your file as an object into your own bucket.\n\n```python\n# call put_object to upload you data to the TOS \nclient.put_object(bucket_name, object_key, content=\"123\")\nassert resp.status_code == 200 \n```\n## Get Object\nYou can download objects in the TOS bucket through our SDK.\n\n```python\n# call get_object to download your data from your bucket\nclient.get_object(bucket_name, object_key)\n```\n\n## Delete Object\n\nYour can delete your objects in the bucket\uff1a\n\n```python\n# call put_object to upload you data to the TOS \nresp = client.put_object(bucket_name, key_name, content=\"123\")\nassert resp.status_code == 200 \n# call delete_object to delete an object in your bucket\nresp = client.delete_object(bucket_name, key_name)\nassert resp.status_code == 204\n```\n\n## License\n[Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0.html)\n",
"bugtrack_url": null,
"license": null,
"summary": "Volc TOS (Tinder Object Storage) SDK",
"version": "2.8.1",
"project_urls": {
"Homepage": "https://www.volcengine.com/"
},
"split_keywords": [
"boilerplate"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "478f4e28239c2e8f7a1300a2ce1b83e706255f29dcc9a2aa7d14467586ae42bf",
"md5": "71db64af2916a1164c65a82ddbadebce",
"sha256": "38f9ecedd536c1b28a8e349a333bc16c674154b6f1b643f9d45f6ebea727639c"
},
"downloads": -1,
"filename": "tos-2.8.1.tar.gz",
"has_sig": false,
"md5_digest": "71db64af2916a1164c65a82ddbadebce",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 124111,
"upload_time": "2024-12-12T02:25:23",
"upload_time_iso_8601": "2024-12-12T02:25:23.196615Z",
"url": "https://files.pythonhosted.org/packages/47/8f/4e28239c2e8f7a1300a2ce1b83e706255f29dcc9a2aa7d14467586ae42bf/tos-2.8.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-12 02:25:23",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "tos"
}
JSON