layouts: add readme to pyproject.toml on creation

Relates-to: #280

Co-authored-by: Arun Babu Neelicattu <[email protected]>

Author: finswimmer

poetry/layouts/layout.py

@@ -25,6 +25,7 @@
 description = ""
 authors = []
 license = ""
+readme = ""
 packages = []
 
 [tool.poetry.dependencies]
@@ -37,6 +38,8 @@
 
 
 class Layout:
+    ACCEPTED_README_FORMATS = {"md", "rst"}
+
     def __init__(
         self,
         project: str,
@@ -56,7 +59,15 @@ def __init__(
         self._package_name = ".".join(self._package_path_relative.parts)
         self._version = version
         self._description = description
-        self._readme_format = readme_format
+
+        self._readme_format = readme_format.lower()
+        if self._readme_format not in self.ACCEPTED_README_FORMATS:
+            raise ValueError(
+                "Invalid readme format '{}', use one of {}.".format(
+                    readme_format, ", ".join(self.ACCEPTED_README_FORMATS)
+                )
+            )
+
         self._license = license
         self._python = python
         self._dependencies = dependencies or {}
@@ -120,6 +131,7 @@ def generate_poetry_content(
         else:
             poetry_content.remove("license")
 
+        poetry_content["readme"] = "README.{}".format(self._readme_format)
         packages = self.get_package_include()
         if packages:
             poetry_content["packages"].append(packages)
@@ -164,13 +176,10 @@ def _create_default(self, path: "Path", src: bool = True) -> None:
         package_init = package_path / "__init__.py"
         package_init.touch()
 
-    def _create_readme(self, path: "Path") -> None:
-        if self._readme_format == "rst":
-            readme_file = path / "README.rst"
-        else:
-            readme_file = path / "README.md"
-
+    def _create_readme(self, path: "Path") -> "Path":
+        readme_file = path.joinpath("README.{}".format(self._readme_format))
         readme_file.touch()
+        return readme_file
 
     @staticmethod
     def _create_tests(path: "Path") -> None:

tests/console/commands/test_init.py

@@ -66,6 +66,7 @@ def init_basic_toml():
 description = "This is a description"
 authors = ["Your Name <[email protected]>"]
 license = "MIT"
+readme = "README.md"
 packages = [{include = "my_package"}]
 
 [tool.poetry.dependencies]
@@ -113,6 +114,7 @@ def test_interactive_with_dependencies(tester, repo):
 description = "This is a description"
 authors = ["Your Name <[email protected]>"]
 license = "MIT"
+readme = "README.md"
 packages = [{include = "my_package"}]
 
 [tool.poetry.dependencies]
@@ -146,6 +148,7 @@ def test_empty_license(tester):
 version = "1.2.3"
 description = ""
 authors = ["Your Name <[email protected]>"]
+readme = "README.md"
 packages = [{{include = "my_package"}}]
 
 [tool.poetry.dependencies]
@@ -188,6 +191,7 @@ def test_interactive_with_git_dependencies(tester, repo):
 description = "This is a description"
 authors = ["Your Name <[email protected]>"]
 license = "MIT"
+readme = "README.md"
 packages = [{include = "my_package"}]
 
 [tool.poetry.dependencies]
@@ -231,6 +235,7 @@ def test_interactive_with_git_dependencies_with_reference(tester, repo):
 description = "This is a description"
 authors = ["Your Name <[email protected]>"]
 license = "MIT"
+readme = "README.md"
 packages = [{include = "my_package"}]
 
 [tool.poetry.dependencies]
@@ -274,6 +279,7 @@ def test_interactive_with_git_dependencies_and_other_name(tester, repo):
 description = "This is a description"
 authors = ["Your Name <[email protected]>"]
 license = "MIT"
+readme = "README.md"
 packages = [{include = "my_package"}]
 
 [tool.poetry.dependencies]
@@ -320,6 +326,7 @@ def test_interactive_with_directory_dependency(tester, repo, source_dir, fixture
 description = "This is a description"
 authors = ["Your Name <[email protected]>"]
 license = "MIT"
+readme = "README.md"
 packages = [{include = "my_package"}]
 
 [tool.poetry.dependencies]
@@ -367,6 +374,7 @@ def test_interactive_with_directory_dependency_and_other_name(
 description = "This is a description"
 authors = ["Your Name <[email protected]>"]
 license = "MIT"
+readme = "README.md"
 packages = [{include = "my_package"}]
 
 [tool.poetry.dependencies]
@@ -413,6 +421,7 @@ def test_interactive_with_file_dependency(tester, repo, source_dir, fixture_dir)
 description = "This is a description"
 authors = ["Your Name <[email protected]>"]
 license = "MIT"
+readme = "README.md"
 packages = [{include = "my_package"}]
 
 [tool.poetry.dependencies]
@@ -446,6 +455,8 @@ def test_python_option(tester):
 description = "This is a description"
 authors = ["Your Name <[email protected]>"]
 license = "MIT"
+readme = "README.md"
+packages = [{include = "my_package"}]
 
 [tool.poetry.dependencies]
 python = "~2.7 || ^3.6"
@@ -479,6 +490,7 @@ def test_predefined_dependency(tester, repo):
 description = "This is a description"
 authors = ["Your Name <[email protected]>"]
 license = "MIT"
+readme = "README.md"
 packages = [{include = "my_package"}]
 
 [tool.poetry.dependencies]
@@ -520,6 +532,8 @@ def test_predefined_and_interactive_dependencies(tester, repo):
 description = "This is a description"
 authors = ["Your Name <[email protected]>"]
 license = "MIT"
+readme = "README.md"
+packages = [{include = "my_package"}]
 
 [tool.poetry.dependencies]
 python = "~2.7 || ^3.6"
@@ -554,6 +568,8 @@ def test_predefined_dev_dependency(tester, repo):
 description = "This is a description"
 authors = ["Your Name <[email protected]>"]
 license = "MIT"
+readme = "README.md"
+packages = [{include = "my_package"}]
 
 [tool.poetry.dependencies]
 python = "~2.7 || ^3.6"
@@ -594,11 +610,15 @@ def test_predefined_and_interactive_dev_dependencies(tester, repo):
 description = "This is a description"
 authors = ["Your Name <[email protected]>"]
 license = "MIT"
+readme = "README.md"
+packages = [{include = "my_package"}]
 
 [tool.poetry.dependencies]
 python = "~2.7 || ^3.6"
 
 [tool.poetry.dev-dependencies]
+pytest = "^3.6.0"
+pytest-requests = "^0.2.0"
 """
 
     output = tester.io.fetch_output()
@@ -657,6 +677,8 @@ def test_init_non_interactive_existing_pyproject_add_dependency(
 version = "0.1.0"
 description = ""
 authors = ["Your Name <[email protected]>"]
+readme = "README.md"
+packages = [{include = "my_package"}]
 
 [tool.poetry.dependencies]
 python = "^3.6"