Skip to content
New issue

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

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

Already on GitHub? # to your account

Create an official Poetry badge #7270

Closed
1 task done
johnthagen opened this issue Dec 31, 2022 · 2 comments · Fixed by python-poetry/website#119
Closed
1 task done

Create an official Poetry badge #7270

johnthagen opened this issue Dec 31, 2022 · 2 comments · Fixed by python-poetry/website#119
Labels
area/docs Documentation issues/improvements status/triage This issue needs to be triaged

Comments

@johnthagen
Copy link
Contributor

johnthagen commented Dec 31, 2022

  • I have searched the issues of this repo and believe that this is not a duplicate.

Issue

Projects such as black and isort have official badges that they provide to users to allow them to promote their projects to great affect.

Code style: black
Imports: isort

Poetry could create a badge for the project to help users of Poetry promote the tool in a similar way.

An example could look like:

Packaged with Poetry

[![Packaged with Poetry][poetry-badge]](https://python-poetry.org/)

[poetry-badge]: https://img.shields.io/badge/packaging-poetry-cyan.svg

The colors could optionally be tweaked using the official logo colors:

image

Logo in SVG format is here: https://github.com/python-poetry/website/blob/main/static/images/logo-origami.svg

The badge could be hosted on https://python-poetry.org/ to allow easy referencing from projects and a snippet of how to add the badge could be added to the docs.

@johnthagen johnthagen added area/docs Documentation issues/improvements status/triage This issue needs to be triaged labels Dec 31, 2022
@johnthagen
Copy link
Contributor Author

johnthagen commented Mar 20, 2023

Some recent examples.

Ruff

Ruff

Ruff uses the shields.io JSON API: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v1.json

Hatch

Hatch project

Hatch actually uses encodes a standard unicode (egg 🥚) emoji directly into the shield.io URL: https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg

Copy link

This issue has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Feb 29, 2024
# for free to subscribe to this conversation on GitHub. Already have an account? #.
Labels
area/docs Documentation issues/improvements status/triage This issue needs to be triaged
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant