Quiet in command line (#58)

* ✨ non-verbose mode. #38

* 📚update shell instructions

* 🔨 refactor yehua's own template

* :sparkles; update coding style

* 💚 yehua.yml is now able to have default values and jinja2 template too. #49

* 📚 update text info

* This is an auto-commit

Co-authored-by: chfw <[email protected]>

Author: chfw

CHANGELOG.rst

@@ -16,6 +16,7 @@ Change log
 **Added**
 
 #. `#37 <https://github.com/moremoban/yehua/issues/37>`_: cookiecutter support
+#. `#38 <https://github.com/moremoban/yehua/issues/38>`_: non-verbose mode
 #. added moban update work flow
 #. python filesystem 2 support. yehua templates and cookiecutter templates can
    be in git, zip, s3, etc.

changelog.yml

@@ -11,6 +11,7 @@ releases:
   - action: Added
     details:
     - "`#37`: cookiecutter support"
+    - "`#38`: non-verbose mode"
     - "added moban update work flow"
     - "python filesystem 2 support. yehua templates and cookiecutter templates can be in git, zip, s3, etc."
   date: 2020

test.sh

@@ -1,3 +1,3 @@
 pip freeze
 pip install -e .
-pytest --cov=yehua --cov=tests tests/
+pytest --cov=yehua --cov=tests tests/ --ignore=tests/fixtures/project_s

tests/test_cookie_cutter.py

@@ -35,9 +35,8 @@ def test_local_cookie_cutter_package(fake_inputs):
     shutil.rmtree(project_name)
 
 
-@patch("yehua.project._git_add")
 @patch("yehua.cookiecutter.get_user_inputs")
-def test_github_package(fake_inputs, fake_system):
+def test_github_package(fake_inputs):
     project_name = "git_package_test"
     file_name = "yehua_test"
     fake_inputs.return_value = {

tests/test_main.py

@@ -8,12 +8,13 @@
 from nose.tools import eq_, raises
 
 
-@patch("os.system")
+@patch("yehua.project.os.chdir")
+@patch("yehua.project._run_command")
 @patch("yehua.project.get_user_inputs")
 @patch("yehua.utils.mkdir")
 @patch("yehua.utils.save_file")
 @patch("yehua.utils.copy_file")
-def test_main(copy, save, mkdir, inputs, os_system):
+def test_main(copy, save, mkdir, inputs, *_):
     copy.return_value = 0
     save.return_value = 0
     mkdir.return_value = 0

tests/test_project.py

@@ -144,7 +144,7 @@ def test_template():
 
     questions_with_template = [
         {"hello": "hello?"},
-        {"foo": "foo [{{yehua.hello}}]"},
+        {"foo": "foo [{{hello}}]"},  # note yehua does not require a prefix
         {"bar": "bar [{{cookiecutter.hello}}]"},
     ]
 

yehua/cookiecutter.py

@@ -85,6 +85,9 @@ def templating(self):
             project_yaml = deepcopy(self.answers)
             project_yaml.pop("now")  # is not required
             dump_yaml(project_yaml, f)
+        utils.color_print(
+            f"\u2713 Your answers are saved in [info]{path}[/info]!"
+        )
 
         moban_file = utils.load_yaml(MOBAN_FILE_FOR_COOKIE_CUTTER)
         moban_file["configuration"]["configuration"] = (
@@ -102,7 +105,12 @@ def templating(self):
                 + "/"
                 + self.cookie_cutter_dir
             )
-        with open(
-            os.path.join(self.answers["project_name"], ".moban.yml"), "w"
-        ) as f:
+        moban_file_path = os.path.join(
+            self.answers["project_name"], ".moban.yml"
+        )
+        with open(moban_file_path, "w") as f:
             dump_yaml(moban_file, f)
+        utils.color_print(
+            f"\u2713 [info]{moban_file_path}[/info]! l"
+            + "inks your project with the template."
+        )

yehua/cookiecutter_to_yehua.py

@@ -9,6 +9,7 @@
 INTRODUCTION = """
 [info]Yehua /'jɛhwa/[/info] will walk you through cookiecutter template wizard
 Press ^C to quit at any time.
+
 """
 
 

yehua/project.py

@@ -1,4 +1,5 @@
 import os
+import subprocess
 from datetime import datetime
 
 import yehua.utils as utils
@@ -50,8 +51,15 @@ def copy_static_files(self):
                 utils.copy_file(source, dest)
 
     def inflate_all_by_moban(self):
-        cmd = "cd %s && moban" % self.answers["project_name"]
-        os.system(cmd)
+        current = os.getcwd()
+        project_name = self.answers["project_name"]
+        os.chdir(project_name)
+        cmd = "moban"
+        _run_command(cmd)
+        os.chdir(current)
+        utils.color_print(
+            f"\u2713 Files are generated under [info]{project_name}[/info]"
+        )
 
     def post_moban(self):
         if "post-moban" not in self.directives:
@@ -62,14 +70,27 @@ def post_moban(self):
 
     def initialize_git_and_add_all(self, project_files):
         project_name = self.answers["project_name"]
-        cmd = "cd %s && git init" % project_name
-        os.system(cmd)
+        current = os.getcwd()
+        os.chdir(project_name)
+        cmd = "git init"
+        _run_command(cmd)
         for file_name in project_files:
-            _git_add(project_name, file_name)
-        print("Please review changes before commit!")
+            _run_command(f"git add {file_name}")
+        os.chdir(current)
+        utils.color_print(
+            f"\u2713 Git repo initialized under [info]{project_name}[/info]"
+            + " and is ready to commit"
+        )
 
     def end(self):
-        print("All done!! project %s is created" % self.project_name)
+        utils.color_print(
+            "All done!! project [info]%s[/info] is created."
+            % self.project_name
+        )
+        utils.color_print(
+            "In the future, "
+            + "run [info]moban[/info] to synchronize with the project template"
+        )
 
     def _ask_questions(self):
         content = read_unicode(self.project_file)
@@ -119,6 +140,9 @@ def _create_jj2_environment(self, path):
         return environment
 
 
-def _git_add(project_name, file_name):
-    cmd = "cd %s && git add %s" % (project_name, file_name)
-    os.system(cmd)
+def _run_command(command):
+    subprocess.check_call(
+        command.split(" "),
+        stdout=subprocess.DEVNULL,
+        stderr=subprocess.DEVNULL,
+    )

yehua/resources/yehua.yml

@@ -1,22 +1,25 @@
 introduction: |
-  Yehua will walk you through creating a blank python package.
+  [info]Yehua[/info] will walk you through creating a blank python package.
   Press ^C to quit at any time.
 configuration:
   template_path: ./templates
   static_path: ./static
 questions:
-  - project_name: "project name:"
-  - description: "description:"
-  - license: "license:(mit or newbsd)"
-  - author: "author:"
-  - contact: "contact email:"
-  - organisation: "github profile/organisation:"
-  - company: "copyright owner:"
+  - project_name: "project name [yehua boilerplate]: "
+  - description: "description [Moremoban organisation's best template]: "
+  - license:
+    - question: "license: "
+      "1. mit": "N/A"
+      "2. newbsd": "N/A"
+  - author: "author: "
+  - contact: "contact email: "
+  - organisation: "github profile/organisation: "
+  - company: "copyright owner [{{author}}]: "
   - project_type:
-    - question: "project type?"
+    - question: "project type: "
       "1. library": "N/A"
       "2. command line interface":
-        - cli: "cli executable name?"
+        - cli: "cli executable name: "
       "3. C extension":
         - sources: "source files?(Comma separated list is expected. For example: pymodule.c,file.c)"
 layout:

yehua/utils.py

@@ -109,7 +109,7 @@ def get_user_inputs(questions):  # refactor this later
                     # {"bar": "bar [{{cookiecutter.hello}}]"}
                     template = env.from_string(question)
                     question = template.render(
-                        cookiecutter=answers, yehua=answers
+                        cookiecutter=answers, **answers
                     )
 
                 match = re.match(r"(.*)\[(.*)\].*", question)
@@ -181,4 +181,3 @@ def color_print(rich_text):
     theme = Theme(THEME)
     console = Console(theme=theme)
     console.print(rich_text)
-    print("\n")