Skip to content

Commit

Permalink
Add file based credentials to extended feature list
Browse files Browse the repository at this point in the history
  • Loading branch information
yanghua committed Nov 26, 2024
1 parent c97b1b3 commit 2ba29fb
Showing 1 changed file with 17 additions and 2 deletions.
19 changes: 17 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,13 @@ TOSFS builds on [Volcengine TOS Python SDK](https://github.com/volcengine/ve-tos

## Features

* Excellent read/write performance (optimized by multi-threading and multi-disk staging).
* Excellent read/write performance than `s3fs` (optimized by multi-threading and multi-disk staging).
* Solid stability (fine-grained judgment on response codes for TOS services).
* Outstanding compatibility (cross-validation completed on the version matrix of four Python versions and two fsspec versions).
* TOS HNS (Hierarchical NameSpace) Bucket support (in adaptation and verification).
* TOS HNS (Hierarchical NameSpace) Bucket support(Beta).
* Native [append API](https://www.volcengine.com/docs/6349/74863) support.
* Extended features:
* support assume role credentials;
* batch list iterate;
* multiple thread walk;
* support special characters in local path;
Expand Down Expand Up @@ -76,6 +77,20 @@ tosfs = TosFileSystem(
)
```

* Init via assume role(temporary ak/sk and session token).

make sure you have an assume role credential generator, then you can init the `TosFileSystem` like this:

```python
from tosfs import TosFileSystem
from tosfs.certification import FileCredentialsProvider
fs = TosFileSystem(
endpoint="http://tos-cn-beijing.volces.com",
region="cn-beijing",
credentials_provider=FileCredentialsProvider("/etc/secret/las"), # replace to real path
)
```

### Access FS and file operation APIs

After getting the instance of `TosFileSystem` by following the above guidance,
Expand Down

0 comments on commit 2ba29fb

Please sign in to comment.