binnev-python-template 1.2.2__tar.gz

binnev_python_template-1.2.2/PKG-INFO

@@ -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/README.md

@@ -0,0 +1,19 @@
+# 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/pyproject.toml

@@ -0,0 +1,77 @@
+[project]
+urls = { Homepage = "https://github.com/binnev/python-template" }
+
+name = "binnev-python-template"
+version = "1.2.2"
+authors = [{ name = "Robin Neville", email = "robin.m.neville@gmail.com" }]
+description = "Add your description here"
+readme = "README.md"
+requires-python = ">=3.13"
+license = "MIT"
+dependencies = [
+    "fastapi>=0.115.12",
+    "httpx>=0.28.1",
+    "typer>=0.15.4",
+    "uvicorn>=0.34.2",
+]
+[project.optional-dependencies]
+dev = [
+    "pytest>=8.3.5",
+    "pytest-asyncio>=1.0.0",
+    "pytest-dotenv>=0.5.2",
+    "pytest-watcher>=0.4.3",
+    "pytest-cov>=6.1.1",
+    "pytest-xdist>=3.6.1",
+    "pytest-sugar>=1.0.0",
+    "pytest-better-parametrize>=0.2.0",
+    "coverage>=7.8.0",
+    "ruff>=0.11.10",
+    "mypy>=1.15.0",
+    "mkdocs>=1.6.1",
+    "mkdocs-material>=9.6.14",
+    "mkdocstrings[python]>=0.29.1",
+    "mkdocs-mermaid2-plugin>=1.2.1",
+    "mike>=2.1.3",
+    "commitizen>=4.7.2",
+    "pre-commit>=4.2.0",
+    "build>=1.2.2.post1",
+    "twine>=6.1.0",
+]
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+asyncio_default_fixture_loop_scope = "session"
+addopts = ["-p no:cacheprovider"]
+testpaths = ["tests"]
+
+[tool.coverage.report]
+show_missing = true
+skip_covered = true
+fail_under = 70
+exclude_lines = [
+    "if __name__ == .__main__.:",
+    "pragma: no cover",
+    "def __repr__",
+    "raise NotImplementedError",
+]
+
+[tool.pytest-watcher]
+now = true           # run tests immediately; don't wait for the first file edit
+clear = true         # clear the terminal before each test run
+delay = 0.2
+runner = "pytest"
+runner_args = []
+patterns = ["*.py"]
+ignore_patterns = []
+
+[tool.commitizen]
+name = "cz_conventional_commits"
+tag_format = "$version"
+version_scheme = "semver2"
+version_provider = "pep621"
+update_changelog_on_bump = false
+version_files = ["pyproject.toml:version", "src/core/__init__.py:__version__"]
+
+[tool.ruff]
+line-length = 80
+select = ["E", "F", "W", "C90", "B", "I", "N"]

binnev_python_template-1.2.2/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

binnev_python_template-1.2.2/src/api/__init__.py

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

binnev_python_template-1.2.2/src/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")

binnev_python_template-1.2.2/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))

binnev_python_template-1.2.2/src/binnev_python_template.egg-info/PKG-INFO

@@ -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/src/binnev_python_template.egg-info/SOURCES.txt

@@ -0,0 +1,20 @@
+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/dependency_links.txt

@@ -0,0 +1 @@
+

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

@@ -0,0 +1,26 @@
+fastapi>=0.115.12
+httpx>=0.28.1
+typer>=0.15.4
+uvicorn>=0.34.2
+
+[dev]
+pytest>=8.3.5
+pytest-asyncio>=1.0.0
+pytest-dotenv>=0.5.2
+pytest-watcher>=0.4.3
+pytest-cov>=6.1.1
+pytest-xdist>=3.6.1
+pytest-sugar>=1.0.0
+pytest-better-parametrize>=0.2.0
+coverage>=7.8.0
+ruff>=0.11.10
+mypy>=1.15.0
+mkdocs>=1.6.1
+mkdocs-material>=9.6.14
+mkdocstrings[python]>=0.29.1
+mkdocs-mermaid2-plugin>=1.2.1
+mike>=2.1.3
+commitizen>=4.7.2
+pre-commit>=4.2.0
+build>=1.2.2.post1
+twine>=6.1.0

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

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

binnev_python_template-1.2.2/src/cli/__init__.py

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

binnev_python_template-1.2.2/src/cli/__main__.py

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

binnev_python_template-1.2.2/src/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

binnev_python_template-1.2.2/src/core/__init__.py

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

binnev_python_template-1.2.2/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

binnev_python_template-1.2.2/tests/test_api.py

@@ -0,0 +1,50 @@
+import pytest
+from httpx import ASGITransport, AsyncClient
+
+from src.api.app import app
+
+
+@pytest.fixture
+def test_client() -> AsyncClient:
+    return AsyncClient(
+        transport=ASGITransport(app=app),
+        base_url="http://test",
+    )
+
+
+async def test_add(test_client: AsyncClient):
+    response = await test_client.get("/calculator/add", params={"a": 1, "b": 2})
+    assert response.status_code == 200
+    assert response.json() == {"result": 3}
+
+
+async def test_subtract(test_client: AsyncClient):
+    response = await test_client.get(
+        "/calculator/subtract", params={"a": 5, "b": 3}
+    )
+    assert response.status_code == 200
+    assert response.json() == {"result": 2}
+
+
+async def test_multiply(test_client: AsyncClient):
+    response = await test_client.get(
+        "/calculator/multiply", params={"a": 4, "b": 2}
+    )
+    assert response.status_code == 200
+    assert response.json() == {"result": 8}
+
+
+async def test_divide(test_client: AsyncClient):
+    response = await test_client.get(
+        "/calculator/divide", params={"a": 10, "b": 2}
+    )
+    assert response.status_code == 200
+    assert response.json() == {"result": 5}
+
+
+async def test_divide_by_zero(test_client: AsyncClient):
+    response = await test_client.get(
+        "/calculator/divide", params={"a": 10, "b": 0}
+    )
+    assert response.status_code == 400
+    assert response.json()["detail"] == "Cannot divide by zero."

binnev_python_template-1.2.2/tests/test_async_stuff.py

@@ -0,0 +1,18 @@
+import asyncio
+import time
+
+import pytest
+
+N = 100
+
+
+@pytest.mark.parametrize("n", range(N))
+async def test_blocking(n: int):
+    """These tests won't benefit from asyncio.gather"""
+    time.sleep(0.1)
+
+
+@pytest.mark.parametrize("n", range(N))
+async def test_non_blocking(n: int):
+    """These tests won't benefit from asyncio.gather"""
+    await asyncio.sleep(0.1)

binnev_python_template-1.2.2/tests/test_calculator.py

@@ -0,0 +1,30 @@
+import pytest
+
+from src.core.calculator import add, divide, multiply, subtract
+
+
+def test_add():
+    assert add(2, 3) == 5
+    assert add(-1, 1) == 0
+    assert add(0, 0) == 0
+
+
+def test_subtract():
+    assert subtract(10, 5) == 5
+    assert subtract(0, 5) == -5
+    assert subtract(-5, -5) == 0
+
+
+def test_multiply():
+    assert multiply(3, 4) == 12
+    assert multiply(-2, 3) == -6
+    assert multiply(0, 5) == 0
+
+
+def test_divide():
+    assert divide(10, 2) == 5
+    assert divide(-6, 3) == -2
+    assert divide(5, 2) == 2.5
+
+    with pytest.raises(ValueError):
+        divide(10, 0)

binnev_python_template-1.2.2/tests/test_cli.py

@@ -0,0 +1,36 @@
+from typer.testing import CliRunner
+
+from src.cli.calculator import app
+from src.core import __version__
+
+runner = CliRunner()
+
+
+def test_add_command():
+    result = runner.invoke(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"])
+    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"])
+    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"])
+    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"])
+    assert result.exit_code == 0
+    assert result.output.strip() == f"python-template v{__version__}"