Skip to content

Commit 4d36c01

Browse files
Merge pull request #7 from kerthcet/feat/add-oss-s3
Update Readme.md
2 parents e7444b4 + 2a01e7e commit 4d36c01

File tree

1 file changed

+46
-0
lines changed

1 file changed

+46
-0
lines changed

README.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,48 @@
11
# OmniStore
2+
3+
[![Latest Release](https://img.shields.io/github/v/release/inftyai/omnistore?include_prereleases)](https://github.com/inftyai/omnistore/releases/latest)
4+
25
An unified python client to communicate with various kinds of object-store providers.
6+
7+
## How to use
8+
9+
### Installation
10+
11+
```cmd
12+
pip install omnistore
13+
```
14+
15+
### Methods
16+
17+
```python
18+
from omnistore.objstore import StoreFactory
19+
20+
# Initialization
21+
client = StoreFactory.new_client(
22+
provider=provider, endpoint=endpoint, bucket=bucket
23+
)
24+
25+
# Upload
26+
client.upload(src, dest)
27+
28+
# Download
29+
client.download(src, dest)
30+
31+
# Exists
32+
client.exists(filename)
33+
34+
# Delete
35+
client.delete(filename)
36+
```
37+
38+
## Supported List
39+
40+
- [Alibaba Cloud OSS](https://www.alibabacloud.com/help/en/oss/)
41+
42+
## Contributions
43+
44+
🚀 All kinds of contributions are welcomed ! Please follow [Contributing](./CONTRIBUTING.md). Thanks to all these contributors.
45+
46+
<a href="https://github.com/inftyai/omnistore/graphs/contributors">
47+
<img src="https://contrib.rocks/image?repo=inftyai/omnistore" />
48+
</a>

0 commit comments

Comments
 (0)