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

api/__init__.py

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

api/app.py

@@ -0,0 +1,7 @@
+from fastapi import FastAPI
+
+from .calculator import calculator_router
+
+app = FastAPI()
+
+app.include_router(calculator_router, prefix="/calculator")

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

binnev_python_template-1.2.2.dist-info/METADATA

@@ -0,0 +1,54 @@
+Metadata-Version: 2.4
+Name: binnev-python-template
+Version: 1.2.2
+Summary: Add your description here
+Author-email: Robin Neville <robin.m.neville@gmail.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/binnev/python-template
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown
+Requires-Dist: fastapi>=0.115.12
+Requires-Dist: httpx>=0.28.1
+Requires-Dist: typer>=0.15.4
+Requires-Dist: uvicorn>=0.34.2
+Provides-Extra: dev
+Requires-Dist: pytest>=8.3.5; extra == "dev"
+Requires-Dist: pytest-asyncio>=1.0.0; extra == "dev"
+Requires-Dist: pytest-dotenv>=0.5.2; extra == "dev"
+Requires-Dist: pytest-watcher>=0.4.3; extra == "dev"
+Requires-Dist: pytest-cov>=6.1.1; extra == "dev"
+Requires-Dist: pytest-xdist>=3.6.1; extra == "dev"
+Requires-Dist: pytest-sugar>=1.0.0; extra == "dev"
+Requires-Dist: pytest-better-parametrize>=0.2.0; extra == "dev"
+Requires-Dist: coverage>=7.8.0; extra == "dev"
+Requires-Dist: ruff>=0.11.10; extra == "dev"
+Requires-Dist: mypy>=1.15.0; extra == "dev"
+Requires-Dist: mkdocs>=1.6.1; extra == "dev"
+Requires-Dist: mkdocs-material>=9.6.14; extra == "dev"
+Requires-Dist: mkdocstrings[python]>=0.29.1; extra == "dev"
+Requires-Dist: mkdocs-mermaid2-plugin>=1.2.1; extra == "dev"
+Requires-Dist: mike>=2.1.3; extra == "dev"
+Requires-Dist: commitizen>=4.7.2; extra == "dev"
+Requires-Dist: pre-commit>=4.2.0; extra == "dev"
+Requires-Dist: build>=1.2.2.post1; extra == "dev"
+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. 
+
+## Documentation
+To view the documentation, run: 
+```sh
+mkdocs serve
+```
+and go to [localhost:8000](http://localhost:8000) in your browser.
+
+The documentation provides a detailed guide to the project. It is structured using the [Diátaxis framework](https://diataxis.fr/) to help you navigate and understand the project effectively. This framework consists of 4 categories:
+
+1. **Tutorials**: Guides that teach a concept.
+2. **How-To Guides**: Step-by-step instructions to achieve specific goals or tasks.
+3. **Reference**: Technical descriptions of the project's components and APIs.
+4. **Explanations**: In-depth discussions of concepts and motivations. 
+

binnev_python_template-1.2.2.dist-info/RECORD

@@ -0,0 +1,13 @@
+__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/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

binnev_python_template-1.2.2.dist-info/top_level.txt

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

cli/__init__.py

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

cli/__main__.py

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

cli/calculator.py

@@ -0,0 +1,94 @@
+"""
+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
+
+app = typer.Typer()
+
+
+@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}")
+
+
+@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}")
+
+
+@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}")
+
+
+@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()
+
+
+@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

core/__init__.py

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

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