Skip to content

Commit

Permalink
chore(readme): add cloud platform support table
Browse files Browse the repository at this point in the history
  • Loading branch information
justindujardin committed Apr 23, 2021
1 parent ca2befc commit 6f139ce
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
[![Pypi version](https://badgen.net/pypi/v/pathy)](https://pypi.org/project/pathy/)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)

Pathy is a python package (_with type annotations_) for working with Bucket storage providers. It provides a CLI app for basic file operations between local files and remote buckets. It enables a smooth developer experience by supporting local file-system backed buckets during development and testing. It makes converting bucket blobs into local files a snap with optional local file caching of blobs.
Pathy is a python package (_with type annotations_) for working with Cloud Bucket storage providers using a pathlib interface. It provides an easy-to-use API bundled with a CLI app for basic file operations between local files and remote buckets. It enables a smooth developer experience by letting developers work against the local file system during development and only switch over to live APIs for deployment. It also makes converting bucket blobs into local files a snap with optional local file caching.

## 🚀 Quickstart

Expand All @@ -15,7 +15,7 @@ You can install `pathy` from pip:
pip install pathy
```

The package exports the `Pathy` class and utilities for configuring the bucket storage provider to use. By default Pathy prefers GoogleCloudStorage paths of the form `gs://bucket_name/folder/blob_name.txt`. Internally Pathy can convert GCS paths to local files, allowing for a nice developer experience.
The package exports the `Pathy` class and utilities for configuring the bucket storage provider to use.

```python
from pathy import Pathy, use_fs
Expand All @@ -37,6 +37,16 @@ greeting.unlink()
assert not greeting.exists()
```

## Supported Clouds

The table below details the supported cloud provider APIs.

| Cloud Service | Support | Install Extras |
| :------------------- | :-----: | :----------------------: |
| Google Cloud Storage || `pip install pathy[gcs]` |
| Amazon S3 || `pip install pathy[s3]` |
| Azure || |

## Semantic Versioning

Before Pathy reaches v1.0 the project is not guaranteed to have a consistent API, which means that types and classes may move around or be removed. That said, we try to be predictable when it comes to breaking changes, so the project uses semantic versioning to help users avoid breakage.
Expand Down

0 comments on commit 6f139ce

Please sign in to comment.