From dac6da5dd0c8fcc6dc5d78f783acc84921058fc0 Mon Sep 17 00:00:00 2001 From: Wouter-Michiel Vierdag Date: Wed, 30 Jul 2025 11:02:22 +0200 Subject: [PATCH 1/2] minor changes to readme --- README.md | 24 ++++++++++-------------- pixi.lock | 2 +- pyproject.toml | 1 + 3 files changed, 12 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 61ff680..83854e9 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,16 @@ -# Important Note -This repository was a fork from [here](https://github.com/astropenguin/xarray-dataclasses). We are grateful for the -work of the developer on this repo. That being said, sadly the state on main has been the case that the code was -deleted and there has been no development for a while. Therefore, we intially decided to fork the repository and -continue development here, where the community is better able to contribute to and maintain the project. We now changed -it into a standalone repository. -Note, the repository is not yet released. We are making some additional changes before release. +This repository is adapted from [here](https://github.com/astropenguin/xarray-dataclasses). We are grateful for the +work of the developer on this repo. Sadly, that repository is inactive. Thus, a fork was moved here in order to allow +for more visibility and community maintenance. # xarray-dataclasses -[![Release](https://img.shields.io/pypi/v/xarray-dataclasses?label=Release&color=cornflowerblue&style=flat-square)](https://pypi.org/project/xarray-dataclasses/) -[![Python](https://img.shields.io/pypi/pyversions/xarray-dataclasses?label=Python&color=cornflowerblue&style=flat-square)](https://pypi.org/project/xarray-dataclasses/) -[![Downloads](https://img.shields.io/pypi/dm/xarray-dataclasses?label=Downloads&color=cornflowerblue&style=flat-square)](https://pepy.tech/project/xarray-dataclasses) +[![Release](https://img.shields.io/pypi/v/xarray-dataclass?label=Release&color=cornflowerblue&style=flat-square)](https://pypi.org/project/xarray-dataclass/) +[![Python](https://img.shields.io/pypi/pyversions/xarray-dataclass?label=Python&color=cornflowerblue&style=flat-square)](https://pypi.org/project/xarray-dataclass/) +[![Downloads](https://img.shields.io/pypi/dm/xarray-dataclass?label=Downloads&color=cornflowerblue&style=flat-square)](https://pepy.tech/project/xarray-dataclass) [![DOI](https://img.shields.io/badge/DOI-10.5281/zenodo.4624819-cornflowerblue?style=flat-square)](https://doi.org/10.5281/zenodo.4624819) -[![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) -[![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) +[![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) +[![Release](https://img.shields.io/pypi/v/xarray-dataclass?label=Release&color=cornflowerblue&style=flat-square)](https://pypi.org/project/xarray-dataclass/) xarray data creation by data classes @@ -374,7 +370,7 @@ First install [pixi](https://pixi.sh/latest/installation/). Then, install projec ```shell pixi install -a -pixi run pre-commit-install +pixi run -e dev pre-commit-install ``` ### Testing, linting, and formatting @@ -386,7 +382,7 @@ in that case. ``` pixi run tests -pixi run -e dev pre-commit run --all-files +pixi run precommit # This runs pre-commit on all files. ``` ### Creating documentation diff --git a/pixi.lock b/pixi.lock index 6d53538..d58c4fd 100644 --- a/pixi.lock +++ b/pixi.lock @@ -2763,7 +2763,7 @@ packages: - pypi: ./ name: xarray-dataclass version: 1.9.1 - sha256: 5dcef31196310ef30b006bd205732b69c31adf9366518750a677dcd5e5935de7 + sha256: ca5bb14f8db5d4d045a7a8437ff1e7a35136e339badd674e468ef01b50e3b3f5 requires_dist: - numpy>=2.0.0 - typing-extensions>=4.10.0 diff --git a/pyproject.toml b/pyproject.toml index 04e1512..330629d 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -75,6 +75,7 @@ dev = { features = ["dev"], solve-group = "default" } tests = "pytest" doc_build = { cmd = "sphinx-apidoc -efT -o docs/_apidoc src/xarray_dataclasses && sphinx-build -a docs docs/_build" } doc_serve = { cmd = "sphinx-build -a docs docs/_build && python -m http.server --directory docs/_build 8000" } +precommit = { cmd = "pre-commit run --all-files"} [tool.pyright] reportMissingImports = "none" From 045f032b4cc46484477fdb137acb777c534023d6 Mon Sep 17 00:00:00 2001 From: Wouter-Michiel Vierdag Date: Wed, 30 Jul 2025 11:27:47 +0200 Subject: [PATCH 2/2] change install instructions for now --- README.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 83854e9..532c122 100644 --- a/README.md +++ b/README.md @@ -55,10 +55,8 @@ class Image(AsDataArray): There are multiple ways you can install xarray-dataclasses, dependent on what kind of dependency manager you use. ```shell -pip install xarray-dataclasses -conda install -c conda-forge xarray-dataclasses -pixi add xarray-dataclasses -pixi add --pypi xarray-dataclasses +pip install xarray-dataclass +pixi add --pypi xarray-dataclass ``` ## Basic usage