binnev-python-template 1.2.2__py3-none-any.whl → 5.3.0__py3-none-any.whl

{binnev_python_template-1.2.2.dist-info → binnev_python_template-5.3.0.dist-info}/METADATA

@@ -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.dist-info/RECORD

@@ -0,0 +1,15 @@
+src/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+src/api/__init__.py,sha256=sMZ_Q3pHNHBOBkJ3_K3VIH4de_UvfBsUnxfNKLgPnnU,28
+src/api/app.py,sha256=pwmavYIVvWcucQ13Wf4V-iH4qy-2cr06XI2zfMZj_Pg,149
+src/api/calculator.py,sha256=a5sJRHbznv91ldM3LtjFJBqaJ0O6w0HqyQ1If5Y_r68,1664
+src/cli/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+src/cli/calculator.py,sha256=Zc2o1ACWA6qhneGWnh6Y8Jyn6W0ifZEruJrU5drteOw,2284
+src/cli/greeter.py,sha256=mh9Bzwa6B_vRBi6xZcXvAONAAYWMcSXhOYVnhEOO5T4,1157
+src/core/__init__.py,sha256=jPUwX9NxOYxJ-G3jnlWF7_z5iis37as0BOIo1qxSO9I,55
+src/core/calculator.py,sha256=rYsUuuAbmRnkdDjmZBFlTgOmIAexF332ELzWVQPoQw0,1790
+src/core/greeter.py,sha256=lsfF9KhkYCcBW42MabmZMotiwD8cnj15ApBMr7tZWqI,226
+binnev_python_template-5.3.0.dist-info/METADATA,sha256=STmQZ7YJZVFQvToo5p029oZvPPYDHnJZ9vQjfUmAtCQ,2531
+binnev_python_template-5.3.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+binnev_python_template-5.3.0.dist-info/entry_points.txt,sha256=HKdmBrnYHfEJEmcrurGU7a3VXJ0_X9hp76jc4GhznXY,103
+binnev_python_template-5.3.0.dist-info/top_level.txt,sha256=74rtVfumQlgAPzR5_2CgYN24MB0XARCg0t-gzk6gTrM,4
+binnev_python_template-5.3.0.dist-info/RECORD,,

binnev_python_template-5.3.0.dist-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.dist-info/top_level.txt

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

{cli → 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()

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()

{core → src/core}/__init__.py

@@ -1,2 +1,2 @@
 __app_name__ = "python-template"
-__version__ = "1.2.2"
+__version__ = "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.dist-info/RECORD

@@ -1,13 +0,0 @@
-__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-api/__init__.py,sha256=sMZ_Q3pHNHBOBkJ3_K3VIH4de_UvfBsUnxfNKLgPnnU,28
-api/app.py,sha256=pwmavYIVvWcucQ13Wf4V-iH4qy-2cr06XI2zfMZj_Pg,149
-api/calculator.py,sha256=a5sJRHbznv91ldM3LtjFJBqaJ0O6w0HqyQ1If5Y_r68,1664
-cli/__init__.py,sha256=JuQR1P36bOLj9DU5rMC_4OPRsj48OkFaBSPFTMjlUSc,35
-cli/__main__.py,sha256=yhh9JvWC840Ev_lWj3QovGBR2Tj6eUzgWYh0as1spLc,62
-cli/calculator.py,sha256=cvsrwMbizv8l4sDXjbaXogRBRr4d3DZEyXXtCLAK614,2168
-core/__init__.py,sha256=R3pyZpIhsGzw3M3SbELzxNis7FzslLTZwxjOrmowkdU,55
-core/calculator.py,sha256=rYsUuuAbmRnkdDjmZBFlTgOmIAexF332ELzWVQPoQw0,1790
-binnev_python_template-1.2.2.dist-info/METADATA,sha256=1RMu2CJLsWMBLSliLht8bfLhgAWugc00N0gxVizOyyI,2502
-binnev_python_template-1.2.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-binnev_python_template-1.2.2.dist-info/top_level.txt,sha256=tnrNGeZWxGB7wuuBAehLylpPK3dJdsMjjMfpCEYgrxc,22
-binnev_python_template-1.2.2.dist-info/RECORD,,

binnev_python_template-1.2.2.dist-info/top_level.txt

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

cli/__init__.py

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

cli/__main__.py

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