Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add status badges to README #303

Merged
merged 2 commits into from
Nov 19, 2024

Conversation

douglatornell
Copy link
Contributor

@douglatornell douglatornell commented Nov 17, 2024

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.

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
Copy link
Contributor Author

douglatornell commented Nov 17, 2024

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:

  • CI status - similar with appropriate URL changes
  • codecov - similar with appropriate URL changes
  • docs build status - similar with appropriate URL changes
  • benchmarked by asv - excluded because it's not applicable
  • code style black - replaced with Ruff badge because that what's used for linting & formatting
  • mypy checked - similar with appropriate URL changes
  • added pre-commit enabled badge because VirtualiZarr uses pre-commit and pre-commit.ci
  • added Apache 2.0 license badge
  • added supported Python version badge - gets Python version from requires-python item in pyproject.toml file
  • replaced PyPI release badge id with one that gets release id from GitHub because that's where the releases are created
  • PyPI downloads - similar with appropriate URL changes
  • conda downloads - please see discussion below
  • DOI - excluded because VirtualiZarr doesn't have one (yet?)
  • binder - excluded because I don't know if it's applicable
  • X - excluded because it's X and does VirtualiZarr have a social media presence?

@douglatornell
Copy link
Contributor Author

douglatornell commented Nov 17, 2024

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
Copy link
Member

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?

Swapped the Conda downloads badge URL to a consistent `shields.io` link
that provided the "conda|downloads" label. This change aligns the
appearance of the Conda badge with the other badges on the page.
@douglatornell
Copy link
Contributor Author

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

@TomNicholas TomNicholas added the documentation Improvements or additions to documentation label Nov 18, 2024
Copy link
Member

@TomNicholas TomNicholas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice!

@TomNicholas TomNicholas merged commit 3348670 into zarr-developers:main Nov 19, 2024
11 checks passed
@douglatornell douglatornell deleted the readme-badges branch November 19, 2024 19:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add some cool badges to the Readme
2 participants