Merge pull request #1 from DavidVujic/generate_readme

Add a README.md when creating a new Polylith workspace

poetry_polylith_plugin/__init__.py

@@ -1,5 +1,5 @@
 from poetry_polylith_plugin.plugin import PolylithPlugin
 
-__version__ = "0.1.2"
+__version__ = "0.2.0"
 
 __all__ = ["PolylithPlugin"]

poetry_polylith_plugin/components/log.py

@@ -0,0 +1,21 @@
+import logging
+
+
+def getHandler():
+    handler = logging.StreamHandler()
+    formatter = logging.Formatter("%(name)s: %(message)s")
+
+    handler.setFormatter(formatter)
+
+    return handler
+
+
+def getLogger(name="poetry-polylith-plugin"):
+    logger = logging.getLogger(name)
+
+    if not logger.hasHandlers():
+        handler = getHandler()
+        logger.addHandler(handler)
+        logger.setLevel(logging.INFO)
+
+    return logger

poetry_polylith_plugin/components/readme.py

@@ -0,0 +1,31 @@
+from pathlib import Path
+
+from poetry_polylith_plugin.components import log, repo
+
+
+template = """\
+# A Python Polylith repo
+The top namespace is `{namespace}`.
+
+
+## Docs
+The official Polylith documentation:
+[high-level documentation](https://polylith.gitbook.io/polylith)
+
+A Python implementation of the Polylith tool:
+[poetry-polylith-plugin](https://github.com/DavidVujic/poetry-polylith-plugin#poetry-polylith-plugin)
+"""
+
+
+logger = log.getLogger()
+
+
+def create_workspace_readme(path: Path, namespace: str):
+    fullpath = path / repo.readme_file
+
+    if fullpath.exists():
+        logger.info(f"A {repo.readme_file} already exists. Skipping this step.")
+        return
+
+    with fullpath.open("w", encoding="utf-8") as f:
+        f.write(template.format(namespace=namespace))

poetry_polylith_plugin/components/repo.py

@@ -3,6 +3,7 @@
 
 workspace_file = "workspace.toml"
 default_toml = "pyproject.toml"
+readme_file = "README.md"
 
 
 def is_repo_root(cwd: Path) -> bool:

poetry_polylith_plugin/components/workspaces.py

@@ -1,7 +1,7 @@
 from pathlib import Path
 
 import tomlkit
-from poetry_polylith_plugin.components import bases, components, projects, repo
+from poetry_polylith_plugin.components import bases, components, projects, readme, repo
 from poetry_polylith_plugin.components.development import create_development
 from poetry_polylith_plugin.components.dirs import create_dir
 
@@ -38,3 +38,5 @@ def create_workspace(path: Path, namespace: str):
     create_development(path, keep=True)
 
     create_workspace_config(path, namespace)
+
+    readme.create_workspace_readme(path, namespace)

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "poetry-polylith-plugin"
-version = "0.1.2"
+version = "0.2.0"
 description = "A Poetry plugin that aims to simplify working with Polylith monorepos"
 authors = ["David Vujic"]
 homepage = "https://github.com/davidvujic/poetry-polylith-plugin"