Skip to content

Commit

Permalink
Added storage.buckets to readme API reference
Browse files Browse the repository at this point in the history
  • Loading branch information
roll committed Sep 28, 2017
1 parent a742408 commit c849ade
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,12 @@ This driver provides an additional API:

- `base_path (str)` - a valid directory path where .sav files can be created and read. If no base_path is provided, the Storage object methods will accept file paths rather than bucket names.

#### `storage.buckets`

List all .sav and .zsav files at base path. Bucket list is only maintained if Storage has a valid base path, otherwise will return None.

- `(str[]/None)` - returns bucket list or None

#### With a base path

We can get storage with a specified base path this way:
Expand Down

0 comments on commit c849ade

Please sign in to comment.