Skip to content
Open
Changes from 1 commit
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
15 changes: 13 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,24 @@
This repository offers a [cookiecutter](https://cookiecutter.readthedocs.io)
for creating your own Zarr store implementation.

To use it:
### Setting up the repo

```sh
pip install cookiecutter
cookiecutter https://github.com/zarr-developers/cookiecutter-zarr-store
```
And answer the questions :smile:
After launching above commands, you'll be see a few questions on your terminal. For the first question use the name of the store you want to work with. E.g. `zip_store` for Zip Store, `sqlite_store` for SQLitreStore, `mongodb_store` for MongoDBStore and so on.

For remaining questions use the value indicated in the `[ ]`. These are the default values set by the maintainers.

### Once you're done with above setup you can move to

- [storage.py](https://github.com/zarr-developers/zarr-python/blob/main/zarr/storage.py) and start separating the desired store's code and integrating into your repository under `zarr-something-short/storage.py`
- Pick up corresponding tests from [tests_storage.py](https://github.com/zarr-developers/zarr-python/blob/main/zarr/tests/test_storage.py) and start adding them into your repository under `zarr-something-short/tests/tests_storage.py`

### Testing the code

Before running tests make sure to install `pytest` via `pip install pytest`

In order to run the tests, be sure to initialize git:
```sh
Expand Down