python-poetry / python-poetry/poetry
Validate README format
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 34.3k
- Forks
- 2.5k
- Avg merge
- 2d 19h
- Merged PRs (30d)
- 30
Description
It seems that poetry doesn't validate the README markup. Furthermore, because no setup.py file is present in a poetry project, I cannot use readme_renderer (which is usually invoke via python setup.py check -r -s).
It would be nice to have a way to invoke such setup check routines, or better yet, have poetry validate the README itself.
Related: #761
A temporary workaround is to use python -m readme_renderer README.rst >/dev/null to check.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the issue's proposed README validation approaches and the related discussion in #761. Compare the existing workaround, python -m readme_renderer README.rst >/dev/null, with the requested Poetry behavior. Done should mean that a Poetry project can validate its README markup through a clearly defined Poetry-supported workflow.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- build-system
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100