Skip to content

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

Open
@lwasser

Description

@lwasser

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

  • 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

Metadata

Metadata

Assignees

No one assigned

    Labels

    help wantedWe welcome a contributor to work on this issue! thank you in advance!new-contentNew feature or requestsprintable

    Type

    No type

    Projects

    Status

    Python Package Guide

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions