Skip to content

Commit

Permalink
Merge pull request #7 from kerthcet/feat/add-oss-s3
Browse files Browse the repository at this point in the history
Update Readme.md
  • Loading branch information
InftyAI-Agent authored Aug 14, 2024
2 parents e7444b4 + 2a01e7e commit 4d36c01
Showing 1 changed file with 46 additions and 0 deletions.
46 changes: 46 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,48 @@
# OmniStore

[![Latest Release](https://img.shields.io/github/v/release/inftyai/omnistore?include_prereleases)](https://github.com/inftyai/omnistore/releases/latest)

An unified python client to communicate with various kinds of object-store providers.

## How to use

### Installation

```cmd
pip install omnistore
```

### Methods

```python
from omnistore.objstore import StoreFactory

# Initialization
client = StoreFactory.new_client(
provider=provider, endpoint=endpoint, bucket=bucket
)

# Upload
client.upload(src, dest)

# Download
client.download(src, dest)

# Exists
client.exists(filename)

# Delete
client.delete(filename)
```

## Supported List

- [Alibaba Cloud OSS](https://www.alibabacloud.com/help/en/oss/)

## Contributions

🚀 All kinds of contributions are welcomed ! Please follow [Contributing](./CONTRIBUTING.md). Thanks to all these contributors.

<a href="https://github.com/inftyai/omnistore/graphs/contributors">
<img src="https://contrib.rocks/image?repo=inftyai/omnistore" />
</a>

0 comments on commit 4d36c01

Please sign in to comment.