Merge pull request #121 from dotflow-io/feature/107

⚙️ FEATURE-#107: Rewrite dotflow init with interactive cookiecutter template

Author: FernandoCelmer

docs/nav/learn/cli/init.md

@@ -0,0 +1,51 @@
+# Init
+
+Scaffold a new dotflow project interactively.
+
+```bash
+dotflow init
+```
+
+The command prompts for project configuration:
+
+```
+project_name [my-pipeline]: my-etl
+storage [default]: s3
+```
+
+Output:
+
+```
+my-etl/
+├── my_etl/
+│   ├── __init__.py
+│   ├── actions.py
+│   └── workflow.py
+├── tests/
+│   └── test_workflow.py
+├── pyproject.toml
+└── README.md
+```
+
+## Storage options
+
+| Option | Description |
+|--------|-------------|
+| `default` | In-memory, no persistence |
+| `file` | Local disk (StorageFile) |
+| `s3` | AWS S3 (StorageS3) — adds `dotflow[aws]` dependency |
+| `gcs` | Google Cloud Storage (StorageGCS) — adds `dotflow[gcp]` dependency |
+
+## Running the generated project
+
+```bash
+cd my-etl
+pip install -e .
+python -m my_etl.workflow
+```
+
+## Running the generated tests
+
+```bash
+pytest
+```

dotflow/cli/commands/init.py

@@ -1,18 +1,19 @@
 """Command init module"""
 
-from os import system
-
+from cookiecutter.main import cookiecutter
 from rich import print  # type: ignore
 
 from dotflow.cli.command import Command
 from dotflow.settings import Settings as settings
 
+TEMPLATE_REPO = "https://github.com/dotflow-io/template"
+
 
 class InitCommand(Command):
     def setup(self):
-        if settings.GITIGNORE.exists():
-            system("echo '\n\n# Dotflow\n.output' >> .gitignore")
-            print(
-                settings.INFO_ALERT,
-                f"Installation complete! The ({settings.GITIGNORE.resolve()}) file has been modified.",
-            )
+        cookiecutter(TEMPLATE_REPO)
+
+        print(
+            settings.INFO_ALERT,
+            "Project created!",
+        )

dotflow/cli/setup.py

@@ -36,9 +36,11 @@ def __init__(self, parser):
         self.command()
 
     def setup_init(self):
-        self.cmd_init = self.subparsers.add_parser("init", help="Init")
+        self.cmd_init = self.subparsers.add_parser(
+            "init", help="Scaffold a new dotflow project"
+        )
         self.cmd_init = self.cmd_init.add_argument_group(
-            "Usage: dotflow init [OPTIONS]"
+            "Usage: dotflow init <project-name>"
         )
         self.cmd_init.set_defaults(exec=InitCommand)
 

mkdocs.yml

@@ -162,6 +162,7 @@ nav:
         - nav/learn/process-mode-parallel.md
         - nav/learn/process-mode-parallel-group.md
       - Dotflow CLI:
+        - nav/learn/cli/init.md
         - nav/learn/cli/simple-start.md
         - nav/learn/cli/with-initial-context.md
         - nav/learn/cli/with-callback.md