Add lessons (#2)

* add initial tests

* add lesson 02

* rename tests so they don't get collected

* add lesson 03

* add help lesson

* add types lesson

* blacken

* blacken all

* add part 02

* remove shebangs from tests

* move i/o to part 03

* add lesson 02

* add part 02 skeleton

* add stderr test

* add solution 01

* reorder decorators

* add test 01

* add 02

* formatting

* update setup instructions

* update tox tests

Author: tylerdave

README.md

@@ -17,6 +17,8 @@ PyCon 2019 Tutorial: Writing Command Line Applications that Click
 
 ### Installation
 
+This repo is a Python package. You will create a virtualenv and install the package which will install its dependencies and make new commands available.
+
 * Open a terminal / command prompt.
   * Recommended on Windows: [PowerShell](https://docs.microsoft.com/en-us/powershell/scripting/getting-started/getting-started-with-windows-powershell?view=powershell-6) or [WSL](https://docs.microsoft.com/en-us/windows/wsl/install-win10).
 * Clone this repo:<br> `git clone https://github.com/tylerdave/PyCon2019-Click-Tutorial.git`
@@ -36,10 +38,7 @@ PyCon 2019 Tutorial: Writing Command Line Applications that Click
     * On Mac/Linux: `source env/bin/activate`
     * On Windows: `.\env\Scripts\activate`
     * `pip install -e .`
-* Verify installation:<br>`tutorial verify`
-
-## Running the Tutorial
+* Verify installation:<br>`pycon verify`
 
-Instructions coming soon 😁
 
 

click_tutorial/__init__.py

@@ -3,5 +3,5 @@
 """Top-level package for Click Tutorial."""
 
 __author__ = """Dave Forgac"""
-__email__ = '[email protected]'
-__version__ = '0.0.1'
+__email__ = "[email protected]"
+__version__ = "0.0.1"

click_tutorial/checks.py

@@ -1,20 +1,32 @@
 import sys
 
+
 def get_python_version():
-    return sys.version.replace('\n', '')
+    return sys.version.replace("\n", "")
+
 
 def check_python_35_plus():
-    if sys.version_info.major == 3 and sys.version_info.minor >=5:
+    if sys.version_info.major == 3 and sys.version_info.minor >= 5:
         return True
     else:
         return False
 
+
 def check_pytest():
     import pytest
+
     return True
 
+
+def check_cookiecutter():
+    import cookiecutter
+
+    return True
+
+
 ALL_CHECKS = {
-    'Python Version': get_python_version,
-    'Python 3.5+': check_python_35_plus,
-    'PyTest Installed': check_pytest,
-}
+    "Python Version": get_python_version,
+    "Python 3.5+": check_python_35_plus,
+    "Has PyTest": check_pytest,
+    "Has Cookiecutter": check_cookiecutter,
+}

click_tutorial/cli.py

@@ -5,9 +5,17 @@
 
 from click_tutorial.checks import ALL_CHECKS
 
-@click.group()
+
+@click.group(name="pycon")
 def main(args=None):
-    """Click tutorial runner."""
+    """PyCon Tutorial."""
+
+
+@main.command()
+def hello():
+    """Say hello."""
+    click.echo("Hello!")
+
 
 @main.command()
 def verify():
@@ -26,9 +34,12 @@ def verify():
             click.secho(message=str(err), fg="red", bg="yellow")
             any_failures = True
     if any_failures:
-        click.secho("\nVerification failed. Please see setup instructions.", fg="red")
+        click.secho("\nVerification failed. 😢 Please see setup instructions.", fg="red")
     else:
-        click.secho("\nVerification successful! You're ready to run the tutorial!", fg="blue")
+        click.secho(
+            "\nVerification successful! Your system will be albe to run the tutorial! ✨",
+            fg="blue",
+        )
 
 
 if __name__ == "__main__":

click_tutorial/hello_example.py

@@ -3,24 +3,29 @@
 import click
 import time
 
+
 @click.group()
 def cli():
     """Command group."""
 
+
 @cli.command()
 @click.argument("name")
-@click.option("--color", default='green', type=click.Choice(['red', 'black', 'green']))
-@click.option("--count", "-c", type=int, default=1, help="number of times to print message")
+@click.option("--color", default="green", type=click.Choice(["red", "black", "green"]))
+@click.option(
+    "--count", "-c", type=int, default=1, help="number of times to print message"
+)
 def hello(name, color, count):
     """A command that says hello."""
     click.echo("color: {}".format(color), err=True)
     for i in range(count):
         click.secho("Hello, {}!".format(name), fg=color)
-    
+
     items = range(100)
     with click.progressbar(items) as bar:
         for item in bar:
-            time.sleep(0.03)     
+            time.sleep(0.03)
+
 
 if __name__ == "__main__":
-    cli()
+    cli()

lessons/part_01/__init__.py

@@ -2,9 +2,11 @@
 
 import click
 
+
 @click.command()
 def cli():
-    print("Hello")
+    print("Hello.")
+
 
 if __name__ == "__main__":
-    cli()
+    cli()

click_tutorial/hello.py renamed to lessons/part_01/cli.py

@@ -0,0 +1,12 @@
+#!/usr/bin/env python
+
+import click
+
+
+@click.command()
+def cli():
+    print("Hello!")
+
+
+if __name__ == "__main__":
+    cli()

lessons/part_01/solutions/cli_01_hello.py

@@ -0,0 +1,14 @@
+#!/usr/bin/env python
+
+import click
+
+
+@click.command()
+@click.argument("names", nargs=-1)
+def cli(names):
+    for name in names:
+        print("Hello, {}!".format(name))
+
+
+if __name__ == "__main__":
+    cli()

lessons/part_01/solutions/cli_02_args.py

@@ -0,0 +1,20 @@
+#!/usr/bin/env python
+
+import click
+
+
+@click.command()
+@click.argument("names", nargs=-1)
+@click.option("--greeting", "-g", default="Hello")
+@click.option("--question/--no-question")
+def cli(names, greeting, question):
+    if question:
+        punctuation = "?"
+    else:
+        punctuation = "!"
+    for name in names:
+        print("{}, {}{}".format(greeting, name, punctuation))
+
+
+if __name__ == "__main__":
+    cli()

lessons/part_01/solutions/cli_03_opts.py

@@ -0,0 +1,21 @@
+#!/usr/bin/env python
+
+import click
+
+
+@click.command(name="greet")
+@click.argument("names", nargs=-1)
+@click.option("--greeting", "-g", default="Hello", help="The greeting to display.")
+@click.option("--question/--no-question", help="Make the greeting a question.")
+def cli(names, greeting, question):
+    """Displays a greeting."""
+    if question:
+        punctuation = "?"
+    else:
+        punctuation = "!"
+    for name in names:
+        print("{}, {}{}".format(greeting, name, punctuation))
+
+
+if __name__ == "__main__":
+    cli()

lessons/part_01/solutions/cli_04_help.py

@@ -0,0 +1,35 @@
+#!/usr/bin/env python
+
+import click
+
+
+@click.command(name="greet")
+@click.argument("names", nargs=-1)
+@click.option("--int-option", type=click.INT)
+@click.option("--float-option", type=click.FLOAT)
+@click.option("--bool-option", type=click.BOOL)
+@click.option("--choice-option", type=click.Choice(["A", "B", "C"]))
+@click.option("--greeting", "-g", default="Hello", help="The greeting to display.")
+@click.option("--question/--no-question", help="Make the greeting a question.")
+def cli(
+    names, int_option, float_option, bool_option, choice_option, greeting, question
+):
+    """Displays a greeting."""
+    if question:
+        punctuation = "?"
+    else:
+        punctuation = "!"
+    for name in names:
+        print("{}, {}{}".format(greeting, name, punctuation))
+    if int_option:
+        print("int: {}".format(int_option))
+    if float_option:
+        print("float: {}".format(float_option))
+    if bool_option:
+        print("bool: {}".format(bool_option))
+    if choice_option:
+        print("choice: {}".format(choice_option))
+
+
+if __name__ == "__main__":
+    cli()

lessons/part_01/solutions/cli_05_types.py

@@ -0,0 +1,7 @@
+from .base import BaseTutorialLesson
+
+
+class TestTutorialHelloWorld(BaseTutorialLesson):
+    def test_cli_outputs_hello_message(self):
+        result = self.run_command()
+        assert result.output == "Hello!\n"

lessons/part_01/tests/01_hello.py

@@ -0,0 +1,17 @@
+from .base import BaseTutorialLesson
+
+
+class TestTutorialBasicArguments(BaseTutorialLesson):
+    def test_00_cli_with_single_argument(self):
+        result = self.run_command(["Tutorial"])
+        assert result.output == "Hello, Tutorial!\n"
+
+    def test_01_cli_with_multiple_arguments(self):
+        result = self.run_command(["Tutorial", "Cleveland", "Everybody"])
+        assert (
+            result.output == "Hello, Tutorial!\nHello, Cleveland!\nHello, Everybody!\n"
+        )
+
+    def test_02_cli_with_no_argument(self):
+        result = self.run_command()
+        assert result.output == ""

lessons/part_01/tests/02_args.py

@@ -0,0 +1,23 @@
+from .base import BaseTutorialLesson
+
+
+class TestTutorialBasicOptions(BaseTutorialLesson):
+    def test_00_greeting_option(self):
+        result = self.run_command(["--greeting", "Ahoy", "Tutorial"])
+        assert result.output == "Ahoy, Tutorial!\n"
+
+    def test_01_greeting_short_option(self):
+        result = self.run_command(["-g", "Ahoy", "Tutorial"])
+        assert result.output == "Ahoy, Tutorial!\n"
+
+    def test_02_greeting_default(self):
+        result = self.run_command(["Tutorial"])
+        assert result.output == "Hello, Tutorial!\n"
+
+    def test_03_question_option(self):
+        result = self.run_command(["--question", "Tutorial"])
+        assert result.output == "Hello, Tutorial?\n"
+
+    def test_04_no_question_option(self):
+        result = self.run_command(["--no-question", "Tutorial"])
+        assert result.output == "Hello, Tutorial!\n"

lessons/part_01/tests/03_opts.py

@@ -0,0 +1,23 @@
+import re
+
+from .base import BaseTutorialLesson
+
+
+class TestTutorialBasicUsageDocumentation(BaseTutorialLesson):
+    def test_00_cli_gets_help_output_from_docstring(self):
+        result = self.run_command(["--help"])
+        assert result.output.startswith("Usage: greet")
+        assert "Displays a greeting." in result.output
+
+    def test_01_cli_includes_help_text_from_option(self):
+        result = self.run_command(["--help"])
+        assert re.search(
+            r"--question / --no-question\W+Make the greeting a question\.",
+            result.output,
+        )
+
+    def test_03_cli_with_subcommand_shows_short_help(self):
+        result = self.run_command(["--help"])
+        assert re.search(
+            r"-g, --greeting TEXT\W+The greeting to display.", result.output
+        )

lessons/part_01/tests/04_help.py

@@ -0,0 +1,42 @@
+import pytest
+
+from .base import BaseTutorialLesson
+
+
+class TestBasicTypes(BaseTutorialLesson):
+    def test_00_cli_valid_int_option(self):
+        result = self.run_command(["--int-option", "42"])
+        assert "int: 42\n" in result.output
+
+    def test_01_cli_invalid_int_option(self):
+        result = self.run_command(["--int-option", "3.14"])
+        assert "Invalid value" in result.output
+        assert result.exit_code == 2
+
+    def test_02_cli_valid_float_option(self):
+        result = self.run_command(["--float-option", "3.14"])
+        assert "float: 3.14\n" in result.output
+
+    def test_03_cli_invalid_float_option(self):
+        result = self.run_command(["--float-option", "abcd"])
+        assert "Invalid value" in result.output
+        assert result.exit_code == 2
+
+    def test_04_cli_valid_bool_option(self):
+        result = self.run_command(["--bool-option", "True"])
+        assert "bool: True\n" in result.output
+
+    def test_05_cli_invalid_bool_option(self):
+        result = self.run_command(["--bool-option", "3.14"])
+        assert "Invalid value" in result.output
+        assert result.exit_code == 2
+
+    @pytest.mark.parametrize("test_input", ["A", "B", "C"])
+    def test_06_cli_valid_choice_option(self, test_input):
+        result = self.run_command(["--choice-option", test_input])
+        assert "choice: {}\n".format(test_input) in result.output
+
+    def test_07_cli_invalid_choice_option(self):
+        result = self.run_command(["--choice-option", "1"])
+        assert "Invalid value" in result.output
+        assert result.exit_code == 2

lessons/part_01/tests/05_types.py

@@ -0,0 +1,13 @@
+from click.testing import CliRunner
+
+from lessons.part_01.cli import cli
+
+
+class BaseTutorialLesson:
+    def setup(self):
+        self.runner = CliRunner()
+        self.command = cli
+
+    def run_command(self, arguments=None, **kwargs):
+        result = self.runner.invoke(self.command, arguments, **kwargs)
+        return result