Skip to content

Allow any file extension for README file #5357

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Secrus merged 5 commits into from
May 29, 2022
Merged

Allow any file extension for README file #5357

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b7c1cae
Allow any file extension for README file
s-spindler Mar 16, 2022
c96842d
Update docs
s-spindler Mar 24, 2022
89a3af9
Correct wording in readme regarding file extension
s-spindler May 24, 2022
5be2104
Add recommendation regarding PyPI friendly READMEs
s-spindler May 24, 2022
48bffbb
Make black happy
s-spindler May 29, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion docs/cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,9 @@ my-package

* `--name`: Set the resulting package name.
* `--src`: Use the src layout for the project.
* `--readme`: Specify the readme file format. One of `md` (default) or `rst`.
* `--readme`: Specify the readme file extension. Default is `md`. If you intend to publish to PyPI
keep the [recommendations for a PyPI-friendly README](https://packaging.python.org/en/latest/guides/making-a-pypi-friendly-readme/)
in mind.


## init
Expand Down
8 changes: 0 additions & 8 deletions src/poetry/layouts/layout.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,6 @@


class Layout:
ACCEPTED_README_FORMATS = {"md", "rst"}

def __init__(
self,
project: str,
Expand All @@ -64,12 +62,6 @@ def __init__(
self._description = description

self._readme_format = readme_format.lower()
if self._readme_format not in self.ACCEPTED_README_FORMATS:
accepted_readme_formats = ", ".join(self.ACCEPTED_README_FORMATS)
raise ValueError(
f"Invalid readme format '{readme_format}', use one of"
f" {accepted_readme_formats}."
)

self._license = license
self._python = python
Expand Down
2 changes: 1 addition & 1 deletion tests/console/commands/test_new.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ def test_command_new(
verify_project_directory(path, package_name, package_path, include_from)


@pytest.mark.parametrize(("fmt",), [(None,), ("md",), ("rst",)])
@pytest.mark.parametrize(("fmt",), [(None,), ("md",), ("rst",), ("adoc",), ("creole",)])
def test_command_new_with_readme(fmt: str | None, tester: CommandTester, tmp_dir: str):
package = "package"
path = Path(tmp_dir) / package
Expand Down