From b7c1cae1fab7973df2f2d38ae2a0d4da6ccd3bcd Mon Sep 17 00:00:00 2001 From: s-spindler <25225092+s-spindler@users.noreply.github.com> Date: Wed, 16 Mar 2022 22:52:03 +0100 Subject: [PATCH 1/5] Allow any file extension for README file --- src/poetry/layouts/layout.py | 7 ------- tests/console/commands/test_new.py | 2 +- 2 files changed, 1 insertion(+), 8 deletions(-) diff --git a/src/poetry/layouts/layout.py b/src/poetry/layouts/layout.py index 5877101806b..e289ae51558 100644 --- a/src/poetry/layouts/layout.py +++ b/src/poetry/layouts/layout.py @@ -41,7 +41,6 @@ class Layout: - ACCEPTED_README_FORMATS = {"md", "rst"} def __init__( self, @@ -64,12 +63,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 diff --git a/tests/console/commands/test_new.py b/tests/console/commands/test_new.py index 7af8d6f0db7..79f09e20f27 100644 --- a/tests/console/commands/test_new.py +++ b/tests/console/commands/test_new.py @@ -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 From c96842d132bbc979881158592d13f23b6538496c Mon Sep 17 00:00:00 2001 From: s-spindler <25225092+s-spindler@users.noreply.github.com> Date: Thu, 24 Mar 2022 22:06:36 +0100 Subject: [PATCH 2/5] Update docs --- docs/cli.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/cli.md b/docs/cli.md index d95615a21d6..8d0dcdc91eb 100644 --- a/docs/cli.md +++ b/docs/cli.md @@ -103,7 +103,7 @@ 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 format. Default is `md`. ## init From 89a3af9cce758eaae1ddbecbc323344773fc4398 Mon Sep 17 00:00:00 2001 From: Stephan Spindler <25225092+s-spindler@users.noreply.github.com> Date: Tue, 24 May 2022 12:57:43 +0200 Subject: [PATCH 3/5] Correct wording in readme regarding file extension Co-authored-by: Bjorn Neergaard --- docs/cli.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/cli.md b/docs/cli.md index 8d0dcdc91eb..f40f1bf885f 100644 --- a/docs/cli.md +++ b/docs/cli.md @@ -103,7 +103,7 @@ my-package * `--name`: Set the resulting package name. * `--src`: Use the src layout for the project. -* `--readme`: Specify the readme file format. Default is `md`. +* `--readme`: Specify the readme file extension. Default is `md`. ## init From 5be2104364da8ff0b9d205546dee70739461402f Mon Sep 17 00:00:00 2001 From: s-spindler <25225092+s-spindler@users.noreply.github.com> Date: Tue, 24 May 2022 13:04:22 +0200 Subject: [PATCH 4/5] Add recommendation regarding PyPI friendly READMEs --- docs/cli.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/cli.md b/docs/cli.md index f40f1bf885f..11de33fa6db 100644 --- a/docs/cli.md +++ b/docs/cli.md @@ -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 extension. Default is `md`. +* `--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 From 48bffbb3f8d90019b4cbc8797baa74455c197074 Mon Sep 17 00:00:00 2001 From: s-spindler <25225092+s-spindler@users.noreply.github.com> Date: Sun, 29 May 2022 14:57:15 +0200 Subject: [PATCH 5/5] Make black happy --- src/poetry/layouts/layout.py | 1 - 1 file changed, 1 deletion(-) diff --git a/src/poetry/layouts/layout.py b/src/poetry/layouts/layout.py index e289ae51558..6bb073c47d9 100644 --- a/src/poetry/layouts/layout.py +++ b/src/poetry/layouts/layout.py @@ -41,7 +41,6 @@ class Layout: - def __init__( self, project: str,