Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

`readme` is not required in pyproject.toml, but docs say it is

See original GitHub issue

The docs say that the readme key is required:

readme

The readme file of the package. Required

The file can be either README.rst or README.md.

but poetry check works just fine without any mention of the readme in pyproject.toml.

Issue Analytics

State:
Created 5 years ago
Comments:10 (9 by maintainers)

Top GitHub Comments

2reactions

nchammascommented, Jul 29, 2018

Should we close this since #242 got merged in? The “Closes #237” text on there didn’t trigger an automatic close here because develop is not the default branch.

@sdispater - FWIW, I think it will be confusing to have people submit PRs against different branches depending on the type of change. If possible, I recommend having one branch to land incoming changes and making it the default branch. That will address issues like the one here.

1reaction

cauebscommented, Jun 20, 2018

poetry new creates a new README.rst but doesn’t add it to the pyproject.toml. That could be changed as well, right? (I also think it should default to markdown, but that’s arguable)

Top Results From Across the Web

readme is not required in pyproject.toml, but docs say it is #237

The docs say that the readme key is required: readme The readme file of the package. Required The file can be either README.rst...

The pyproject.toml file | Documentation | Poetry

Poetry supports extras to allow expression of: optional dependencies, which enhance a package, but are not required; and; clusters of optional dependencies.

Configuring setuptools using pyproject.toml files

Starting with PEP 621, the Python community selected pyproject.toml as a standard way of specifying project metadata. Setuptools has adopted this standard ...

How to Create and Upload Your First Python Package to PyPI

A few weeks ago, I wanted to learn how to build my first Python package, and I was trying to figure out where...

Flit Documentation

New projects created with flit init now declare that they require flit_core >=2,<4 (PR #328). Any projects using pyproject.toml (not flit.ini) ...