pyOpenSci / python-package-guide

Scientific Python package recommendations & guidance curated by pyOpenSci
https://www.pyopensci.org/python-package-guide/
Other
103 stars 56 forks source link

Feature: Add guidebook page that overviews using badges in a package readme #209

Open lwasser opened 8 months ago

lwasser commented 8 months ago

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)

badges reference the colored indicators of a package's status often found in the readme file. See xclim readme as an example.

Screenshot 2024-04-08 at 11 41 36 AM

we'd want to add information about