binnev-python-template 1.2.2__tar.gz → 5.3.0__tar.gz

{binnev_python_template-1.2.2 → binnev_python_template-5.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: binnev-python-template
-Version: 1.2.2
+Version: 5.3.0
 Summary: Add your description here
 Author-email: Robin Neville <robin.m.neville@gmail.com>
 License-Expression: MIT
@@ -36,7 +36,7 @@ Requires-Dist: twine>=6.1.0; extra == "dev"
 # Python project template 
 This project is a template for new python projects. It contains up-to-date tooling for tests, docs, versioning, and dependency management. 
 
-In a nutshell, the idea is that you clone/fork this project, and then modify it to suit your new project. The [`docs/how-to/getting-started.md`](tutorials/getting-started.md) page provides a step-by-step guide. 
+In a nutshell, the idea is that you clone/fork this project, and then modify it to suit your new project. The [Getting Started](https://binnev.github.io/python-template/latest/tutorials/getting-started/) page provides a step-by-step guide. 
 
 ## Documentation
 To view the documentation, run: 

{binnev_python_template-1.2.2 → binnev_python_template-5.3.0}/README.md

@@ -1,7 +1,7 @@
 # Python project template 
 This project is a template for new python projects. It contains up-to-date tooling for tests, docs, versioning, and dependency management. 
 
-In a nutshell, the idea is that you clone/fork this project, and then modify it to suit your new project. The [`docs/how-to/getting-started.md`](tutorials/getting-started.md) page provides a step-by-step guide. 
+In a nutshell, the idea is that you clone/fork this project, and then modify it to suit your new project. The [Getting Started](https://binnev.github.io/python-template/latest/tutorials/getting-started/) page provides a step-by-step guide. 
 
 ## Documentation
 To view the documentation, run: 

{binnev_python_template-1.2.2/src → binnev_python_template-5.3.0}/binnev_python_template.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: binnev-python-template
-Version: 1.2.2
+Version: 5.3.0
 Summary: Add your description here
 Author-email: Robin Neville <robin.m.neville@gmail.com>
 License-Expression: MIT
@@ -36,7 +36,7 @@ Requires-Dist: twine>=6.1.0; extra == "dev"
 # Python project template 
 This project is a template for new python projects. It contains up-to-date tooling for tests, docs, versioning, and dependency management. 
 
-In a nutshell, the idea is that you clone/fork this project, and then modify it to suit your new project. The [`docs/how-to/getting-started.md`](tutorials/getting-started.md) page provides a step-by-step guide. 
+In a nutshell, the idea is that you clone/fork this project, and then modify it to suit your new project. The [Getting Started](https://binnev.github.io/python-template/latest/tutorials/getting-started/) page provides a step-by-step guide. 
 
 ## Documentation
 To view the documentation, run: 

binnev_python_template-5.3.0/binnev_python_template.egg-info/SOURCES.txt

@@ -0,0 +1,23 @@
+README.md
+pyproject.toml
+binnev_python_template.egg-info/PKG-INFO
+binnev_python_template.egg-info/SOURCES.txt
+binnev_python_template.egg-info/dependency_links.txt
+binnev_python_template.egg-info/entry_points.txt
+binnev_python_template.egg-info/requires.txt
+binnev_python_template.egg-info/top_level.txt
+src/__init__.py
+src/api/__init__.py
+src/api/app.py
+src/api/calculator.py
+src/cli/__init__.py
+src/cli/calculator.py
+src/cli/greeter.py
+src/core/__init__.py
+src/core/calculator.py
+src/core/greeter.py
+tests/test_api.py
+tests/test_async_stuff.py
+tests/test_calculator.py
+tests/test_cli.py
+tests/test_greeter.py

binnev_python_template-5.3.0/binnev_python_template.egg-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+calculator = src.cli.calculator:calculator_app
+greeter = src.cli.greeter:greeter_app

binnev_python_template-5.3.0/binnev_python_template.egg-info/top_level.txt

@@ -0,0 +1 @@
+src

{binnev_python_template-1.2.2 → binnev_python_template-5.3.0}/pyproject.toml

@@ -2,7 +2,7 @@
 urls = { Homepage = "https://github.com/binnev/python-template" }
 
 name = "binnev-python-template"
-version = "1.2.2"
+version = "5.3.0"
 authors = [{ name = "Robin Neville", email = "robin.m.neville@gmail.com" }]
 description = "Add your description here"
 readme = "README.md"
@@ -14,6 +14,14 @@ dependencies = [
     "typer>=0.15.4",
     "uvicorn>=0.34.2",
 ]
+
+[project.scripts]
+calculator = "src.cli.calculator:calculator_app"
+greeter = "src.cli.greeter:greeter_app"
+
+[tool.setuptools.packages.find]
+include = ["src*"]
+
 [project.optional-dependencies]
 dev = [
     "pytest>=8.3.5",

{binnev_python_template-1.2.2 → binnev_python_template-5.3.0}/src/cli/calculator.py

@@ -16,10 +16,10 @@ import typer
 from src import core
 from src.core import calculator
 
-app = typer.Typer()
+calculator_app = typer.Typer()
 
 
-@app.command()
+@calculator_app.command()
 def add(a: float, b: float) -> None:
     """
     Add two numbers.
@@ -32,7 +32,7 @@ def add(a: float, b: float) -> None:
     typer.echo(f"The result of addition is: {result}")
 
 
-@app.command()
+@calculator_app.command()
 def subtract(a: float, b: float) -> None:
     """
     Subtract two numbers.
@@ -45,7 +45,7 @@ def subtract(a: float, b: float) -> None:
     typer.echo(f"The result of subtraction is: {result}")
 
 
-@app.command()
+@calculator_app.command()
 def multiply(a: float, b: float) -> None:
     """
     Multiply two numbers.
@@ -58,7 +58,7 @@ def multiply(a: float, b: float) -> None:
     typer.echo(f"The result of multiplication is: {result}")
 
 
-@app.command()
+@calculator_app.command()
 def divide(a: float, b: float) -> None:
     """
     Divide two numbers.
@@ -79,7 +79,7 @@ def _version_callback(value: bool) -> None:
         raise typer.Exit()
 
 
-@app.callback()
+@calculator_app.callback()
 def main(
     version: Optional[bool] = typer.Option(
         None,
@@ -92,3 +92,7 @@ def main(
 ) -> None:
     """Handles the --version flag"""
     return
+
+
+if __name__ == "__main__":
+    calculator_app()

binnev_python_template-5.3.0/src/cli/greeter.py

@@ -0,0 +1,57 @@
+"""
+This module provides CLI commands for greeting people.
+
+The module relies on the `core.greeter` module for the actual greeting logic.
+"""
+
+from typing import Annotated, Optional
+
+import typer
+
+from src import core
+from src.core import greeter
+
+greeter_app = typer.Typer()
+
+
+@greeter_app.command()
+def greet(
+    name: Annotated[
+        str,
+        typer.Argument(help="The name of the person to greet."),
+    ] = "",
+) -> None:
+    """
+    Greet someone.
+
+    Args:
+        name: The name of the person to greet. If name is omitted, the world
+            will be greeted.
+    """
+    greeting = greeter.greeting(name)
+    typer.echo(greeting)
+
+
+def _version_callback(value: bool) -> None:
+    if value:
+        typer.echo(f"{core.__app_name__} v{core.__version__}")
+        raise typer.Exit()
+
+
+@greeter_app.callback()
+def main(
+    version: Optional[bool] = typer.Option(
+        None,
+        "--version",
+        "-v",
+        help="Show the application's version and exit.",
+        callback=_version_callback,
+        is_eager=True,
+    ),
+) -> None:
+    """Handles the --version flag"""
+    return
+
+
+if __name__ == "__main__":
+    greeter_app()

{binnev_python_template-1.2.2 → binnev_python_template-5.3.0}/src/core/__init__.py

@@ -1,2 +1,2 @@
 __app_name__ = "python-template"
-__version__ = "1.2.2"
+__version__ = "5.3.0"

binnev_python_template-5.3.0/src/core/greeter.py

@@ -0,0 +1,12 @@
+def greeting(name: str = "") -> str:
+    """
+    Greet a person.
+
+    Args:
+        name: the name of the person to greet
+
+    Returns:
+        A greeting string
+    """
+    name = name or "world"
+    return f"Hello, {name}!"

{binnev_python_template-1.2.2 → binnev_python_template-5.3.0}/tests/test_async_stuff.py

@@ -3,7 +3,7 @@ import time
 
 import pytest
 
-N = 100
+N = 5
 
 
 @pytest.mark.parametrize("n", range(N))

{binnev_python_template-1.2.2 → binnev_python_template-5.3.0}/tests/test_cli.py

@@ -1,36 +1,47 @@
 from typer.testing import CliRunner
 
-from src.cli.calculator import app
+from src.cli.calculator import calculator_app
+from src.cli.greeter import greeter_app
 from src.core import __version__
 
 runner = CliRunner()
 
 
 def test_add_command():
-    result = runner.invoke(app, ["add", "2", "3"])
+    result = runner.invoke(calculator_app, ["add", "2", "3"])
     assert result.exit_code == 0
     assert result.output.strip() == "The result of addition is: 5.0"
 
 
 def test_subtract_command():
-    result = runner.invoke(app, ["subtract", "5", "3"])
+    result = runner.invoke(calculator_app, ["subtract", "5", "3"])
     assert result.exit_code == 0
     assert result.output.strip() == "The result of subtraction is: 2.0"
 
 
 def test_multiply_command():
-    result = runner.invoke(app, ["multiply", "4", "3"])
+    result = runner.invoke(calculator_app, ["multiply", "4", "3"])
     assert result.exit_code == 0
     assert result.output.strip() == "The result of multiplication is: 12.0"
 
 
 def test_divide_command():
-    result = runner.invoke(app, ["divide", "10", "2"])
+    result = runner.invoke(calculator_app, ["divide", "10", "2"])
     assert result.exit_code == 0
     assert result.output.strip() == "The result of division is: 5.0"
 
 
 def test_version_flag():
-    result = runner.invoke(app, ["--version"])
+    result = runner.invoke(calculator_app, ["--version"])
     assert result.exit_code == 0
     assert result.output.strip() == f"python-template v{__version__}"
+
+
+def test_greeter():
+    result = runner.invoke(greeter_app, ["greet"])
+    assert result.exit_code == 0
+    assert result.output.strip() == "Hello, world!"
+
+    result = runner.invoke(greeter_app, ["greet", "Johnny"])
+    assert result.exit_code == 0
+    assert result.output.strip() == "Hello, Johnny!"

binnev_python_template-5.3.0/tests/test_greeter.py

@@ -0,0 +1,14 @@
+import pytest
+
+from src.core.greeter import greeting
+
+
+@pytest.mark.parametrize(
+    ["name", "expected_greeting"],
+    [
+        ("", "Hello, world!"),
+        ("Johnny", "Hello, Johnny!"),
+    ],
+)
+def test_greeting(name: str, expected_greeting: str) -> None:
+    assert greeting(name) == expected_greeting

binnev_python_template-1.2.2/src/binnev_python_template.egg-info/SOURCES.txt

@@ -1,20 +0,0 @@
-README.md
-pyproject.toml
-src/__init__.py
-src/api/__init__.py
-src/api/app.py
-src/api/calculator.py
-src/binnev_python_template.egg-info/PKG-INFO
-src/binnev_python_template.egg-info/SOURCES.txt
-src/binnev_python_template.egg-info/dependency_links.txt
-src/binnev_python_template.egg-info/requires.txt
-src/binnev_python_template.egg-info/top_level.txt
-src/cli/__init__.py
-src/cli/__main__.py
-src/cli/calculator.py
-src/core/__init__.py
-src/core/calculator.py
-tests/test_api.py
-tests/test_async_stuff.py
-tests/test_calculator.py
-tests/test_cli.py

binnev_python_template-1.2.2/src/binnev_python_template.egg-info/top_level.txt

@@ -1,4 +0,0 @@
-__init__
-api
-cli
-core

binnev_python_template-1.2.2/src/cli/__init__.py

@@ -1 +0,0 @@
-from .calculator import app as app

binnev_python_template-1.2.2/src/cli/__main__.py

@@ -1,4 +0,0 @@
-from src.cli import app
-
-if __name__ == "__main__":
-    app()