Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Joseph Hamman committed Apr 5, 2022
1 parent 23492bc commit 6c39dd1
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions README.md
Expand Up @@ -17,16 +17,22 @@ Schema validation for Xarray

## installation

Install xarray-schema from pypi:
Install xarray-schema from PyPI:

```shell
pip install xarray-schema
```

Conda:

```shell
conda install -c conda-forge xarray-schema
```

Or install it from source:

```shell
pip install git+git://github.com/carbonplan/xarray-schema
pip install git+https://github.com/carbonplan/xarray-schema
```

## usage
Expand Down Expand Up @@ -88,9 +94,9 @@ dtype_json = dtype_schama.to_json()

This is a very early prototype of a library. Some key things are missing:

1. Validation of `coords` and `attrs`. These are implemented yet.
1. Validation of `coords` and `attrs`. These are not implemented yet.
1. Exceptions: Pandera accumulates schema exceptions and reports them all at once. Currently, we are a eagerly raising `SchemaErrors` when the are found.
1. Roundtrip schemas to/from JSON and/or YAML format
1. Roundtrip schemas to/from JSON and/or YAML format.

## license

Expand Down

0 comments on commit 6c39dd1

Please sign in to comment.