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

Create an official Poetry badge #119

Merged
merged 5 commits into from
Jul 6, 2023
Merged

Create an official Poetry badge #119

merged 5 commits into from
Jul 6, 2023

Conversation

johnthagen
Copy link
Contributor

@johnthagen johnthagen commented May 29, 2023

Resolves: python-poetry/poetry#7270
Resolves: python-poetry/poetry#8011

Related documentation PR:

To test embedding it (pointing to built preview for the current fork):

[![Poetry](https://img.shields.io/endpoint?url=https://website-9cvbcandi-python-poetry.vercel.app/badge/v0.json)](https://python-poetry.org/)

To embed it after merge:

[![Poetry](https://img.shields.io/endpoint?url=https://python-poetry.org/badge/v0.json)](https://python-poetry.org/)

@johnthagen
Copy link
Contributor Author

@Secrus If you could review, that'd be great.

@radoering radoering added the safe label May 30, 2023
@github-actions
Copy link

github-actions bot commented May 30, 2023

Deploy preview for website ready!

✅ Preview
https://website-7owwebroa-python-poetry.vercel.app

Built with commit dbdbcad.
This pull request is being automatically deployed with vercel-action

@Secrus
Copy link
Member

Secrus commented Jun 3, 2023

@johnthagen I was thinking something like: https://hatch.pypa.io/latest/next-steps/#community.
Please add a "community" page in docs describing the usage of the badge, with a JSON file hosted statically in this repo.

@johnthagen
Copy link
Contributor Author

@Secrus Let me know what you think of

README.md Outdated
@@ -1,9 +1,13 @@
# Poetry Website

This is the source of the official [Poetry website](https://python-poetry.org).
[![Poetry](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/python-poetry/website/main/static/badge/v0.json)][official website]
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
[![Poetry](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/python-poetry/website/main/static/badge/v0.json)][official website]
[![Poetry](https://img.shields.io/endpoint?url=https://python-poetry.org/static/badge/v0.json)][official website]

Could you make it so that this URL would work? I guess it would require some Hugo reconfiguration.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hmm, I'm not sure I have the experience to make that work. The way it's implemented now is how Ruff's badge works, and it seemed like a good approach?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@Secrus It looks like this could in fact work (from the preview website, I validated that /badge/v0.json is accessible):

So the link would look like:

[![Poetry](https://img.shields.io/endpoint?url=https://python-poetry.org/badge/v0.json)][official website]

Is this what you prefer? I personally think routing it to GitHub is pretty simple, but if you'd prefer we point shields.io at the Poetry website instead, I'm happy to make the changes to the PRs.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@Secrus 4e9bac3 updates the badge URL to point to python-poetry.org hosted badge JSON.

Let me know if there is anything else you'd like updated.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@Secrus Just checking it to see if you wanted any more changes here.

@Secrus Secrus merged commit 47fef35 into python-poetry:main Jul 6, 2023
@johnthagen johnthagen deleted the poetry-badge branch July 6, 2023 14:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create an official Poetry badge
3 participants