binnev-python-template 7.0.2__py3-none-any.whl → 7.0.4__py3-none-any.whl

{binnev_python_template-7.0.2.dist-info → binnev_python_template-7.0.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: binnev-python-template
-Version: 7.0.2
+Version: 7.0.4
 Summary: Add your description here
 Author-email: Robin Neville <robin.m.neville@gmail.com>
 License-Expression: MIT

binnev_python_template-7.0.4.dist-info/RECORD

@@ -0,0 +1,16 @@
+src/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+src/api/__init__.py,sha256=sMZ_Q3pHNHBOBkJ3_K3VIH4de_UvfBsUnxfNKLgPnnU,28
+src/api/app.py,sha256=SQ3YPyBedIBhm801HRi6-dJQDN185DCt9j_h3_afc_o,188
+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=2UXwBQihnc3rEoHkoTMCmv1euxqvweZ9PkTu61MFtvQ,128
+src/core/calculator.py,sha256=rYsUuuAbmRnkdDjmZBFlTgOmIAexF332ELzWVQPoQw0,1790
+src/core/greeter.py,sha256=lsfF9KhkYCcBW42MabmZMotiwD8cnj15ApBMr7tZWqI,226
+src/core/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+binnev_python_template-7.0.4.dist-info/METADATA,sha256=LN-tWHG-TP0gyfCcwzbGuWX3VDxPQGiqdxq86AycR_k,1522
+binnev_python_template-7.0.4.dist-info/WHEEL,sha256=mOdXR9C3wMVov7cSY8PY-XCzo3SmmWCHvGQr5csJoao,91
+binnev_python_template-7.0.4.dist-info/entry_points.txt,sha256=HKdmBrnYHfEJEmcrurGU7a3VXJ0_X9hp76jc4GhznXY,103
+binnev_python_template-7.0.4.dist-info/top_level.txt,sha256=74rtVfumQlgAPzR5_2CgYN24MB0XARCg0t-gzk6gTrM,4
+binnev_python_template-7.0.4.dist-info/RECORD,,

binnev_python_template-7.0.4.dist-info/top_level.txt

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

src/api/__init__.py

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

src/api/app.py

@@ -0,0 +1,11 @@
+from fastapi import FastAPI
+
+from .calculator import calculator_router
+
+app = FastAPI()
+
+app.include_router(calculator_router, prefix="/calculator")
+
+
+if __name__ == "__main__":
+    app()

src/api/calculator.py

@@ -0,0 +1,75 @@
+from fastapi import APIRouter, HTTPException
+
+from src.core import calculator
+
+calculator_router = APIRouter()
+
+
+@calculator_router.get("/add")
+def add(a: float, b: float):
+    """
+    Endpoint to add two numbers.
+
+    Args:
+        a (float): The first number to add.
+        b (float): The second number to add.
+
+    Returns:
+        dict: The result of the addition.
+    """
+    result = calculator.add(a, b)
+    return {"result": result}
+
+
+@calculator_router.get("/subtract")
+def subtract(a: float, b: float):
+    """
+    Endpoint to subtract two numbers.
+
+    Args:
+        a (float): The number to subtract from.
+        b (float): The number to subtract.
+
+    Returns:
+        dict: The result of the subtraction.
+    """
+    result = calculator.subtract(a, b)
+    return {"result": result}
+
+
+@calculator_router.get("/multiply")
+def multiply(a: float, b: float):
+    """
+    Endpoint to multiply two numbers.
+
+    Args:
+        a (float): The first number to multiply.
+        b (float): The second number to multiply.
+
+    Returns:
+        dict: The result of the multiplication.
+    """
+    result = calculator.multiply(a, b)
+    return {"result": result}
+
+
+@calculator_router.get("/divide")
+def divide(a: float, b: float):
+    """
+    Endpoint to divide two numbers.
+
+    Args:
+        a (float): The numerator.
+        b (float): The denominator.
+
+    Returns:
+        dict: The result of the division.
+
+    Raises:
+        HTTPException: If division by zero is attempted.
+    """
+    try:
+        result = calculator.divide(a, b)
+        return {"result": result}
+    except ValueError as e:
+        raise HTTPException(status_code=400, detail=str(e))

src/cli/calculator.py

@@ -0,0 +1,98 @@
+"""
+This module provides CLI commands for performing basic arithmetic operations.
+
+It uses the `typer` library to define commands for addition, subtraction,
+multiplication, and division. Each command takes two numbers as input and prints
+the result to the console.
+
+The module relies on the `core.calculator` module for the actual arithmetic
+operations.
+"""
+
+from typing import Optional
+
+import typer
+
+from src import core
+from src.core import calculator
+
+calculator_app = typer.Typer()
+
+
+@calculator_app.command()
+def add(a: float, b: float) -> None:
+    """
+    Add two numbers.
+
+    Args:
+        a (float): The first number to add.
+        b (float): The second number to add.
+    """
+    result = calculator.add(a, b)
+    typer.echo(f"The result of addition is: {result}")
+
+
+@calculator_app.command()
+def subtract(a: float, b: float) -> None:
+    """
+    Subtract two numbers.
+
+    Args:
+        a (float): The number to subtract from.
+        b (float): The number to subtract.
+    """
+    result = calculator.subtract(a, b)
+    typer.echo(f"The result of subtraction is: {result}")
+
+
+@calculator_app.command()
+def multiply(a: float, b: float) -> None:
+    """
+    Multiply two numbers.
+
+    Args:
+        a (float): The first number to multiply.
+        b (float): The second number to multiply.
+    """
+    result = calculator.multiply(a, b)
+    typer.echo(f"The result of multiplication is: {result}")
+
+
+@calculator_app.command()
+def divide(a: float, b: float) -> None:
+    """
+    Divide two numbers.
+    Args:
+        a (float): The numerator.
+        b (float): The denominator.
+    """
+    try:
+        result = calculator.divide(a, b)
+        typer.echo(f"The result of division is: {result}")
+    except ValueError as e:
+        typer.echo(f"Error: {e}")
+
+
+def _version_callback(value: bool) -> None:
+    if value:
+        typer.echo(f"{core.__app_name__} v{core.__version__}")
+        raise typer.Exit()
+
+
+@calculator_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__":
+    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()

src/core/__init__.py

@@ -0,0 +1,5 @@
+__app_name__ = "python-template"
+__version__ = "7.0.4"
+
+from . import calculator as calculator
+from . import greeter as greeter

src/core/calculator.py

@@ -0,0 +1,95 @@
+"""The core calculator library with basic arithmetic operations."""
+
+
+def add(a: float, b: float) -> float:
+    """
+    Return the sum of two numbers.
+
+    The `add` function is a simple utility designed to perform the addition of
+    two floating-point numbers. It takes two arguments, `a` and `b`, both of
+    which are expected to be of type `float`. The function returns their sum,
+    also as a `float`.
+
+    Args:
+        a: The first number.
+        b: The second number.
+
+    Returns:
+        The sum of the two numbers.
+
+    Examples:
+        >>> add(2, 3)
+        5
+
+        >>> add(-1, 1)
+        0
+    """
+    return a + b
+
+
+def subtract(a: float, b: float) -> float:
+    """
+    Return the difference of two numbers.
+
+    Args:
+        a: The first number.
+        b: The second number.
+
+    Returns:
+        The difference of the two numbers.
+
+    Examples:
+        >>> subtract(5, 3)
+        2
+
+        >>> subtract(2, 5)
+        -3
+    """
+    return a - b
+
+
+def multiply(a: float, b: float) -> float:
+    """
+    Return the product of two numbers.
+
+    Args:
+        a: The first number.
+        b: The second number.
+
+    Returns:
+        The product of the two numbers.
+
+    Examples:
+        >>> multiply(2, 3)
+        6
+
+        >>> multiply(-1, 4)
+        -4
+    """
+    return a * b
+
+
+def divide(a: float, b: float) -> float:
+    """
+    Return the division of two numbers. Raise an error if dividing by zero.
+
+    Args:
+        a: The numerator.
+        b: The denominator.
+
+    Returns:
+        The result of the division.
+
+    Raises:
+        ValueError: If the denominator is zero.
+
+    Examples:
+        >>> divide(6, 3)
+        2.0
+
+        >>> divide(5, 2)
+        2.5
+    """
+    if b == 0:
+        raise ValueError("Cannot divide by zero.")
+    return a / b

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

@@ -1,6 +0,0 @@
-python_template/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-binnev_python_template-7.0.2.dist-info/METADATA,sha256=nJVZjv677UqvrJ_0x6S0POXWFCUilWmZpHQbAvgPDgQ,1522
-binnev_python_template-7.0.2.dist-info/WHEEL,sha256=mOdXR9C3wMVov7cSY8PY-XCzo3SmmWCHvGQr5csJoao,91
-binnev_python_template-7.0.2.dist-info/entry_points.txt,sha256=HKdmBrnYHfEJEmcrurGU7a3VXJ0_X9hp76jc4GhznXY,103
-binnev_python_template-7.0.2.dist-info/top_level.txt,sha256=bQLLBdRq2654KL-rN6TKe04B9u9abV0tTHt4ub1SVYY,16
-binnev_python_template-7.0.2.dist-info/RECORD,,

binnev_python_template-7.0.2.dist-info/top_level.txt

@@ -1 +0,0 @@
-python_template