Skip to content

Commit dac6da5

Browse files
committed
minor changes to readme
1 parent 4d075e1 commit dac6da5

File tree

3 files changed

+12
-15
lines changed

3 files changed

+12
-15
lines changed

README.md

Lines changed: 10 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,16 @@
1-
# Important Note
2-
This repository was a fork from [here](https://github.com/astropenguin/xarray-dataclasses). We are grateful for the
3-
work of the developer on this repo. That being said, sadly the state on main has been the case that the code was
4-
deleted and there has been no development for a while. Therefore, we intially decided to fork the repository and
5-
continue development here, where the community is better able to contribute to and maintain the project. We now changed
6-
it into a standalone repository.
71

8-
Note, the repository is not yet released. We are making some additional changes before release.
2+
This repository is adapted from [here](https://github.com/astropenguin/xarray-dataclasses). We are grateful for the
3+
work of the developer on this repo. Sadly, that repository is inactive. Thus, a fork was moved here in order to allow
4+
for more visibility and community maintenance.
95

106
# xarray-dataclasses
117

12-
[![Release](https://img.shields.io/pypi/v/xarray-dataclasses?label=Release&color=cornflowerblue&style=flat-square)](https://pypi.org/project/xarray-dataclasses/)
13-
[![Python](https://img.shields.io/pypi/pyversions/xarray-dataclasses?label=Python&color=cornflowerblue&style=flat-square)](https://pypi.org/project/xarray-dataclasses/)
14-
[![Downloads](https://img.shields.io/pypi/dm/xarray-dataclasses?label=Downloads&color=cornflowerblue&style=flat-square)](https://pepy.tech/project/xarray-dataclasses)
8+
[![Release](https://img.shields.io/pypi/v/xarray-dataclass?label=Release&color=cornflowerblue&style=flat-square)](https://pypi.org/project/xarray-dataclass/)
9+
[![Python](https://img.shields.io/pypi/pyversions/xarray-dataclass?label=Python&color=cornflowerblue&style=flat-square)](https://pypi.org/project/xarray-dataclass/)
10+
[![Downloads](https://img.shields.io/pypi/dm/xarray-dataclass?label=Downloads&color=cornflowerblue&style=flat-square)](https://pepy.tech/project/xarray-dataclass)
1511
[![DOI](https://img.shields.io/badge/DOI-10.5281/zenodo.4624819-cornflowerblue?style=flat-square)](https://doi.org/10.5281/zenodo.4624819)
16-
[![Tests](https://img.shields.io/github/actions/workflow/status/astropenguin/xarray-dataclasses/tests.yml?label=Tests&style=flat-square)](https://github.com/astropenguin/xarray-dataclasses/actions/workflows/tests.yaml)
17-
[![Release](https://github.com/melonora/xarray-dataclasses/actions/workflows/pypi.yaml/badge.svg?event=release)](https://github.com/melonora/xarray-dataclasses/actions/workflows/pypi.yaml)
12+
[![Tests](https://img.shields.io/github/actions/workflow/status/xarray-contrib/xarray-dataclass/tests.yml?label=Tests&style=flat-square)](https://github.com/xarray-contrib/xarray-dataclass/actions/workflows/tests.yaml)
13+
[![Release](https://img.shields.io/pypi/v/xarray-dataclass?label=Release&color=cornflowerblue&style=flat-square)](https://pypi.org/project/xarray-dataclass/)
1814

1915
xarray data creation by data classes
2016

@@ -374,7 +370,7 @@ First install [pixi](https://pixi.sh/latest/installation/). Then, install projec
374370

375371
```shell
376372
pixi install -a
377-
pixi run pre-commit-install
373+
pixi run -e dev pre-commit-install
378374
```
379375

380376
### Testing, linting, and formatting
@@ -386,7 +382,7 @@ in that case.
386382

387383
```
388384
pixi run tests
389-
pixi run -e dev pre-commit run --all-files
385+
pixi run precommit # This runs pre-commit on all files.
390386
```
391387

392388
### Creating documentation

pixi.lock

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

pyproject.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,7 @@ dev = { features = ["dev"], solve-group = "default" }
7575
tests = "pytest"
7676
doc_build = { cmd = "sphinx-apidoc -efT -o docs/_apidoc src/xarray_dataclasses && sphinx-build -a docs docs/_build" }
7777
doc_serve = { cmd = "sphinx-build -a docs docs/_build && python -m http.server --directory docs/_build 8000" }
78+
precommit = { cmd = "pre-commit run --all-files"}
7879

7980
[tool.pyright]
8081
reportMissingImports = "none"

0 commit comments

Comments
 (0)