Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Bump version number to v0.11.0 #52

Merged
merged 4 commits into from
May 8, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 15 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,10 @@ The cache is automatically updated based on ETag headers, ensuring that you alwa
Install Minato using pip:

```bash
pip install minato[all]
pip install minato # minimal installation for only local/http(s) file I/O
pip install minato[s3] # for Amazon S3
pip install minato[gcp] # for Google Cloud Storage
pip install minato[all] # for all supported file I/O
```

## Usage
Expand All @@ -49,13 +52,22 @@ with minato.open(s3_path, "w") as f:
Access cached online resources in local storage:

```python
import minato

# Cache a remote file and get its local path
remote_path = "http://example.com/path/to/archive.zip!inner/path/to/file"
local_filename = minato.cached_path(remote_path)
```

Access files inside archives like zip by connecting the archive path and inner file path with an exclamation mark (`!`) like above.

Automatically decompress files with gzip / lzma / bz2 compression:

```python
with minato.open("data.txt.gz", "rt", decompress=True) as f:
content = f.read()
```

In the example above, Minato will automatically detect the file format based on the file's content or filename and decompress the file accordingly.

### Cache Management

```bash
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "minato"
version = "0.10.0"
version = "0.11.0"
description = "A Unified File I/O Library for Python"
authors = ["Yasuhiro Yamaguchi <altescy@fastmail.com>"]
license = "MIT License"
Expand Down
2 changes: 1 addition & 1 deletion tests/test_minato.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@


def test_version() -> None:
assert minato.__version__ == "0.10.0"
assert minato.__version__ == "0.11.0"


def test_open() -> None:
Expand Down