Skip to content

Xarray BadgeΒ #10593

@ianhi

Description

@ianhi

Is your feature request related to a problem?

Projects that build on Xarray may want to include an Xarray badge in their readme or on their docs. For example like on the Hatch project which shows the usage of Hatch and Ruff:

Image

I think this would be a nice fun thing for downstream packages to have. It was suggested to me today by @srivarra

Describe the solution you'd like

It's possible to define a logo in the shields.io format (the defacto standard for these badges as far as I can tell) using a json file hosted in this repo or on xarray.dev. Here is how ruff defines theirs: https://github.com/astral-sh/ruff/blob/main/assets/badge/v2.json

I took the Xarray logo and secondary color from the Xarray Brand Guide and came up with this (background color could be changed to any hex color)

Image

Which is made from this link: https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/ianhi/13d9737b1b6cded140de5adde9806944/raw/14a0347146a83762f4159ec68b0a50b454285ba5/gistfile1.json

which points at this gist: https://gist.github.com/ianhi/13d9737b1b6cded140de5adde9806944

We can host a json file in an Xarray controlled repo.

Describe alternatives you've considered

Not have a badge easily available :(

Additional context

No response

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions