zarr-developers / VirtualiZarr

Create virtual Zarr stores from archival data files using xarray syntax
https://virtualizarr.readthedocs.io/en/stable/api.html
Apache License 2.0
124 stars 24 forks source link

Add status badges to README #303

Closed douglatornell closed 1 week ago

douglatornell commented 1 week ago

Inserted various status badges for CI, code coverage, documentation, linting, type checking, license, Python versions, latest release, and package downloads. These badges provide quick visual indicators of the project's current state and integrations.

douglatornell commented 1 week ago

Please see the rendered README at https://github.com/douglatornell/VirtualiZarr/tree/readme-badges

Similarities and differences from the collection of badges in the xarray README:

douglatornell commented 1 week ago

I can't get the conda downloads badge to work as I would like. As committed the badge says "downloads" instead of "conda|downloads". That's from: https://anaconda.org/conda-forge/virtualizarr/badges/downloads.svg?label=conda%7Cdownloads which is the URL that has to be used to get the number of downloads to show. Using a URL similar to that in the xarray README: https://img.shields.io/conda/dn/anaconda/vitrualizarr?label=conda%7Cdownloads results in "not found" for the number of downloads.

TomNicholas commented 1 week ago

Awesome, thank you @douglatornell !

DOI - excluded because VirtualiZarr doesn't have one (yet?)

Oh good point. I think we could just make one? Raised #305 to track this idea.

X - excluded because it's X and does VirtualiZarr have a social media presence?

VirtualiZarr has nothing specific, but we could link to the @zarr-developers handle. But also X sucks so let's hold off on that.

I can't get the conda downloads badge to work as I would like. As committed the badge says "downloads" instead of "conda|downloads". That's from: https://anaconda.org/conda-forge/virtualizarr/badges/downloads.svg?label=conda%7Cdownloads

The xarray badge seems a little different - I think it might refer to the number of downloads from the anaconda distribution itself, not just conda-forge. VirtualiZarr isn't in the anaconda distribution.

https://img.shields.io/conda/dn/anaconda/vitrualizarr?label=conda%7Cdownloads results in "not found" for the number of downloads.

There's a typo in the word "virtualizarr" in this link - could that be the issue?

douglatornell commented 1 week ago

It turns out that there's a conda downloads badge defined on shields.io. I just needed to look in the right place: https://shields.io/badges/conda-downloads