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 package health badges #158

Open
da-wad opened this issue Jun 14, 2021 · 4 comments
Open

Add package health badges #158

da-wad opened this issue Jun 14, 2021 · 4 comments
Labels

Comments

@da-wad
Copy link
Contributor

da-wad commented Jun 14, 2021

Suggestion: For packages on PyPI it could be helpful to give visitors the indication of package health from Synk.

e.g. [![segyio](https://snyk.io/advisor/python/segyio/badge.svg)](https://snyk.io/advisor/python/segyio) gives segyio

Any thoughts?

@JustinGOSSES
Copy link
Contributor

JustinGOSSES commented Jun 15, 2021

I like that it provides more information.

I have slightly mixed feelings about adding more requirements given awesome lists work mainly because they are easy to add to, though this is a small one.

I wonder if it means packages get not shared due to the intimidation factor?

Also, do you know about costs? From a 2 minute glance, it seems you get 200 calls a month free? If there's 200 projects on this one awesome list does adding a badge mean 1 call per badge per pull request? What happens after 200 calls in a month? Do you use Synk already and could advise on that?

https://snyk.io/plans/

@da-wad
Copy link
Contributor Author

da-wad commented Jun 15, 2021

I suspect many come to this list to find recommendations for awesome tools, but your definition of awesome could be met by a project which has long since been abandoned. One extra line of markdown here for each python package is hardly an overhead compared to making the python package itself... It may be a good idea to reformat all the lists as tables though, this would keep the package names/icons/descriptions and badges neatly aligned for readability.

Are the packages here mostly added by their maintainers or users? Even if it's maintainers, I would hope that this simply acts as encouragement to be more awesome.

As far as costs go, I don't think these badges are part of the product. For example, I can visit https://snyk.io/advisor/python/seismic-zfp without logging in or signing up!

@JustinGOSSES
Copy link
Contributor

@da-wad Got some more time to look into this by looking up several JavaScript and Python packages from the Awesome List in their search interface https://snyk.io/advisor/npm-package/wellio

It seems to be a lot of the "is this package used" stats wrong. For instance, it says Lasio isn't used by any Python packages when it is probably one of the most well used geoscience Python packages. Also, it frequently misses the existence of "code-of-conduct" and "contributing" documents if they are not at top level of a repository with a single possible spelling. Both of these falsely ding the project "health". Developing this type of service is hard, but I'm not sure I'm a fan due to the low information quality as it exists currently.

I think the idea of a badge that tells the user about the health of the package is good. Thanks for bringing it up! However, I'm not sure this instance provides high enough quality information.

@JustinGOSSES
Copy link
Contributor

Just wanted to pop into this old thread to say that the state of what's available and how reliable the data is has changed. Might be worth looking at this again at some point now that's it is easier and more reliable.

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

No branches or pull requests

2 participants