Skip to content

Project description in Pip should pull in contents of README.md #1327

Closed
@jgstew

Description

@jgstew

The Project description in Pip should pull in the README.md by moving the long_description in setup.py to setup.cfg like:

Example setup.cfg

[metadata]
long_description = file: README.md
long_description_content_type = text/markdown

It probably also makes sense to remove the language from the README.md that suggests GitPython is not actively developed anymore since that does not seem to be the case.

Alternatively, there could be a Pip Product Description specific markdown file to use instead of the default README.md but I think cleaning up and improve the existing README.md a bit and using that for the pip product description makes the most sense.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions