Improve create command (#137)

* Allow description, name and email to be empty

* Add test

* Bump pre-commit versions

* Copy from pyscript config

* Run pre-commit and update tests

* trigger pre-commit

* Prompt users for an app name instead of blowing up

* Allow to pass .py files at the same level as the call

* Actually wrap the file automatically if using single .py file

Author: FabioRosado

src/pyscript/_generator.py

@@ -100,8 +100,12 @@ def create_project(
             assert app_or_file_name is not None
             app_name = app_or_file_name.removesuffix(".py")
     else:
-        assert app_or_file_name is not None
-        app_name = app_or_file_name
+        if app_or_file_name and app_or_file_name.endswith(".py"):
+            app_name = app_or_file_name.removesuffix(".py")
+        else:
+            # At this point we should always have a name, but typing
+            # was complaining so let's add a default
+            app_name = app_or_file_name or "my-pyscript-app"
 
     context = {
         "name": app_name,
@@ -111,6 +115,7 @@ def create_project(
         "author_email": author_email,
         "version": f"{date_stamp.year}.{'{:02d}'.format(date_stamp.month)}.1",
     }
+
     app_dir = Path(".") / app_name
     app_dir.mkdir()
     manifest_file = app_dir / config["project_config_filename"]
@@ -128,9 +133,12 @@ def create_project(
     python_filepath = app_dir / "main.py"
 
     if not wrap:
-        # Save the new python file
-        with python_filepath.open("w", encoding="utf-8") as fp:
-            fp.write(TEMPLATE_PYTHON_CODE)
+        if app_or_file_name and app_or_file_name.endswith(".py"):
+            python_filepath.write_bytes(Path(app_or_file_name).read_bytes())
+        else:
+            # Save the new python file
+            with python_filepath.open("w", encoding="utf-8") as fp:
+                fp.write(TEMPLATE_PYTHON_CODE)
     else:
         if command:
             with python_filepath.open("w", encoding="utf-8") as fp:

src/pyscript/plugins/create.py

@@ -49,9 +49,7 @@ def create(
     a python file instead.
     """
     if not app_or_file_name and not command:
-        raise cli.Abort(
-            "Must provide either an input '.py' file or a command with the '-c' option."
-        )
+        app_or_file_name = typer.prompt("App name", default="my-pyscript-app")
 
     if app_or_file_name and command:
         raise cli.Abort("Cannot provide both an input '.py' file and '-c' option.")

tests/conftest.py

@@ -8,11 +8,15 @@
 @pytest.fixture
 def auto_enter(monkeypatch):
     """
-    Monkey patch 'typer.confirm' to always hit <Enter>".
+    Monkey patch 'typer.prompt' to always hit <Enter>".
     """
 
     def user_hit_enter(*args, **kwargs):
-        return ""
+        # This makes sure that if there is a default value on a prompt
+        # we will return it, otherwise we will return an empty string
+        # which isn't the same as hitting enter!
+        default_value = kwargs.get("default", "")
+        return default_value
 
     monkeypatch.setattr("typer.prompt", user_hit_enter)
 

tests/test_cli.py

@@ -72,6 +72,65 @@ def test_create_command(
     assert 'author_email = ""' in config_text
 
 
+def test_create_command_no_app_name(
+    invoke_cli: CLIInvoker, tmp_path: Path, app_details_args: list[str], auto_enter
+) -> None:
+    result = invoke_cli("create")
+    assert result.exit_code == 0
+
+    expected_path = tmp_path / "my-pyscript-app"
+    assert expected_path.exists()
+
+    expected_main_py_path = expected_path / "main.py"
+    assert expected_main_py_path.exists()
+
+    expected_config_path = expected_path / config["project_config_filename"]
+    assert expected_config_path.exists()
+    with expected_config_path.open() as fp:
+        config_text = fp.read()
+
+    assert 'name = "my-pyscript-app' in config_text
+    # Assert that description, author name and email are empty
+    assert 'description = ""' in config_text
+    assert 'author_name = ""' in config_text
+    assert 'author_email = ""' in config_text
+
+
+def test_create_command_with_single_py_file(
+    invoke_cli: CLIInvoker, tmp_path: Path, app_details_args: list[str], auto_enter
+):
+    """
+    Test that when create is called with a single python file as input,
+    the project is created correctly
+    """
+    input_file = tmp_path / "hello.py"
+    with input_file.open("w") as fp:
+        fp.write('print("Yo!")')
+
+    result = invoke_cli("create", "hello.py", *app_details_args)
+    assert result.exit_code == 0
+
+    expected_path = tmp_path / "hello"
+    assert expected_path.exists()
+
+    expected_main_py_path = expected_path / "main.py"
+    assert expected_main_py_path.exists()
+    with expected_main_py_path.open() as fp:
+        py_text = fp.read()
+
+    assert 'print("Yo!")' in py_text
+
+    expected_config_path = expected_path / config["project_config_filename"]
+    assert expected_config_path.exists()
+    with expected_config_path.open() as fp:
+        config_text = fp.read()
+
+    assert 'name = "hello' in config_text
+    # Assert that description, author name and email are empty
+    assert 'description = "tester-app"' in config_text
+    assert 'author_name = "tester"' in config_text
+
+
 @pytest.mark.parametrize("flag", ["-c", "--command"])
 def test_wrap_command(
     invoke_cli: CLIInvoker, tmp_path: Path, flag: str, app_details_args: list[str]