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

Refreshing URL guidance #15

Open
jaraco opened this issue Jun 21, 2024 · 0 comments
Open

Refreshing URL guidance #15

jaraco opened this issue Jun 21, 2024 · 0 comments

Comments

@jaraco
Copy link

jaraco commented Jun 21, 2024

Thanks for the post on project URLs! It got a great page rank and is in some sense becoming the de facto spec for URLs.

In that post, there's a screenshot showing "Source" for the source code repo. However, in the example code below it, the source repo is indicated with "repository" as the label:

repository = "https://github.com/me/spam.git"

It does seem that "Source" is the popular convention. In my estimation, it would be a lot less confusing if the screenshot matched the example. Would you consider changing the example to use Source =?

I also learned today that some systems (tea.xyz in particular) are parsing the package metadata and finding that Homepage is an unreliable key for finding a GitHub URL, so they've stopped including it in their discovery and instead relying entirely on Source.

Based on my reading of your blog and my past experience with Setuptools setting the url to "Homepage", I was thinking that if a project had just one URL, it should be "Homepage", but now that I've learned that field is unreliable, I'm leaning toward advising users to set the "Source" URL to the GitHub repo (assuming that's what they do) and omit "Homepage", but that goes against the implied advice in the example:

# Project homepage, often a link to GitHub or GitLab
# Often specified in the [project] table
homepage = "https://example.com"
# The source code repository, don't use this if your homepage
# is the repo
repository = "https://github.com/me/spam.git"

How would you feel about recommending the use of Source (first and foremost) and reserve recommending Homepage for a web page that's not a source repository?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant