Repository navigation
Project description in Pip should pull in contents of README.md #1327
Description
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.
Activity
Byron commentedon Aug 24, 2021
Great, I didn't know this was possible. Maybe you could propose a custom README just for pip that is a digest of the current
README.mdand create a PR for it. Alternatively, it's certainly a good start to have a PR referencing the current README instead.GitPython is in maintenance mode which means it's living off PR's that are community created. Maybe there are better ways to describe this.
Thanks for your help.
Yobmod commentedon Sep 9, 2021
I tried this when I added the setup.cfg. #1294
But I kept getting pypi complaints about the imported README having restructuredtext mistakes (does pypi convert it to rst?)
So I was waiting until setuptools updates to pep621 to rewrite setup.py.
But for now, Ive imported the README.md as the long_description in setup.py #1337
It works on testpypi: https://test.pypi.org/project/gptest/1.1.72/
Byron commentedon Sep 10, 2021
Fantastic work, @Yobmod . To me this looks good and is exactly what this issue asks for.