Open
Description
this was inspired by @Zeitsperre comment around how the python version badge is created
there are two ways of indicating the compatibility of Python for a package; classifiers is for users (i.e. for the badge) and requires-python is for pip (for the dependency resolver)
We'd want to add information about
- adding core badges that indicate things such as:
- what versions of python a package supports
- pypi and conda-forge publication versions
- github actions pass/fail
- documentation pass/fail.
if someone wants to start this page focusing on just a specific type of badge and how to create it that is also welcome! we can then chip away at building out the page
badges reference the colored indicators of a package's status often found in the readme file. See xclim readme as an example.
I think that we might want to rethikn this just a bit and add some discussion around
- how badges can in some cases be a maintenance issue (if things break)
- consider what badges make the most sense for your package in terms of
- highlighting publication / joss / pyos
- highlight for users what version is current and what python versions are supported.
So a section on thinking about the types of badges that make the most sense for the specific package.
Metadata
Metadata
Assignees
Type
Projects
Status
Python Package Guide