add examples

Author: andreascaglioni

examples/example_1_calculator.py

@@ -0,0 +1,53 @@
+"""
+example_1_calculator.py
+
+Basic example usage for the Calculator and Operation classes. This script demonstrates:
+
+- Initializing a Calculator instance.
+- Registering and applying a custom unary operation (square).
+- Registering and applying a binary operation (addition) from the API.
+- Chaining multiple operations together.
+- Composing unary operations to create a new callable.
+
+Each operation is tested and the results are printed to verify correct behavior.
+"""
+
+from python_project_template import Calculator, Operation
+
+from python_project_template import ADD, NEG
+
+
+# Initialize new calculator
+calc = Calculator()
+
+
+# Adding and using a unary opeartion
+def square(x):
+    return x * x
+
+
+sqr_op = Operation(name="sqr", func=square)
+calc.register(sqr_op)
+sq_n = calc.apply("sqr", 4)
+sq_str = 'calc.apply("sqr", 4)'
+print(f"{sq_str} = {sq_n}")
+
+# Adding an opeartion from the API to current calculator
+add_op = Operation(name="add", func=ADD, arity=2)
+calc.register(add_op)
+add_result = calc.apply("add", 2, 3)
+add_str = 'calc.apply("add", 2, 3)'
+print(f"{add_str} = {add_result}")
+
+# Chaining opeartions
+chain_res = calc.chain(["add", 5, "sqr"], initial=2)
+chain_str = "calc.chain(['add', 5, 'sqr'], initial=2)"
+print(f"{chain_str} = {chain_res}")
+
+# Generate a Callable from composing unary operations (computed right-to-left)
+neg_op = Operation(name="neg", func=NEG, arity=1)
+calc.register(neg_op)
+sqr_neg = calc.compose(["neg", "sqr"], left_to_right=False)
+comp_test = sqr_neg(16)
+comp_str = "sqr_neg(16)"
+print(f"{comp_str} = {comp_test}")

examples/example_2_replace_operation.py

@@ -0,0 +1,25 @@
+"""
+example_2_replace_operation.py
+
+Example on registering and replacing an operation with a new one (by the same name) in the Calculator class.
+"""
+
+from python_project_template.calculator import Calculator
+from python_project_template.operations import Operation
+
+
+if __name__ == "__main__":
+    calc = Calculator()
+
+    def add_v1(a, b):
+        return a + b
+
+    def add_v2(a, b):
+        return (a + b) * 10
+
+    calc.register(Operation(name="add", func=add_v1))
+    assert calc.apply("add", 1, 2) == 3
+
+    # replace existing operation
+    calc.register(Operation(name="add", func=add_v2), replace=True)
+    assert calc.apply("add", 1, 2) == 30

examples/write_logo.py

@@ -1,31 +1,23 @@
-#!/usr/bin/env python3
 """
-Generate a simple rectangular SVG logo that fits the text with symmetric padding.
-
-This is intentionally dependency-free (writes plain SVG XML).
-Tweak `text`, `font_size`, `padding`, `rx`, and `fill` as needed.
+Generate the py-project-template logo.
 """
 
+# SETTINGS
 text = "py-project-template"
 font_family = "Segoe UI, Roboto, Arial, sans-serif"
-font_size = 28  # px
-padding = 16  # px on left and right
-height = 64  # svg height in px
+font_size = 28  # in px
+padding = 16  # on left and right
+height = 64  # final image height in px
 rx = 6  # corner radius
 fill = "#2b6cb0"
 text_color = "#ffffff"
 
-# Simple width estimate: average character width ~ 0.6 * font_size
-avg_char_width = 0.45 * font_size
-text_width = int(len(text) * avg_char_width)
-
+# GENERATE
+text_width = int(len(text) * 0.45 * font_size)  # Simple width estimate
 canvas_width = padding * 2 + text_width
-# Add a little extra safety margin
-canvas_width += 4
 
-text_x = padding
-# baseline: approximate vertical position so text sits nicely in the rectangle
-text_y = int(height * 0.7)
+text_x = padding  # horizontal text position
+text_y = int(height * 0.7)  # vertical text position
 
 svg = f"""<svg xmlns="http://www.w3.org/2000/svg" width="{canvas_width}" height="{height}" viewBox="0 0 {canvas_width} {height}" role="img" aria-label="python project template logo">
   <rect width="{canvas_width}" height="{height}" rx="{rx}" fill="{fill}" />