runbooks 0.2.5__py3-none-any.whl → 0.6.1__py3-none-any.whl

runbooks-0.6.1.dist-info/licenses/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright (c) 2025, Nhat-Thanh Nguyen <nnthanh101@gmail.com>
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

runbooks-0.6.1.dist-info/top_level.txt

@@ -0,0 +1,3 @@
+conftest
+jupyter-agent
+runbooks

runbooks/python101/calculator.py

@@ -1,34 +0,0 @@
-from typing import Union
-
-from runbooks.python101.config import DEFAULT_CONFIG
-from runbooks.python101.exceptions import CalculatorError
-
-
-class Calculator:
-    """Calculator class supporting arithmetic operations with configurable precision."""
-
-    def __init__(self, precision: int = DEFAULT_CONFIG["precision"]):
-        """Initialize calculator with configurable precision."""
-        self.precision = precision
-
-    def _format_result(self, result: Union[int, float]) -> Union[int, float]:
-        """Format result based on precision."""
-        return round(result, self.precision)
-
-    def add(self, x: Union[int, float], y: Union[int, float]) -> Union[int, float]:
-        """Adds two numbers."""
-        return self._format_result(x + y)
-
-    def subtract(self, x: Union[int, float], y: Union[int, float]) -> Union[int, float]:
-        """Subtracts second number from first."""
-        return self._format_result(x - y)
-
-    def multiply(self, x: Union[int, float], y: Union[int, float]) -> Union[int, float]:
-        """Multiplies two numbers."""
-        return self._format_result(x * y)
-
-    def divide(self, x: Union[int, float], y: Union[int, float]) -> Union[int, float]:
-        """Divides first number by second."""
-        if y == 0:
-            raise CalculatorError("Division by zero is not allowed.")
-        return self._format_result(x / y)

runbooks/python101/config.py

@@ -1 +0,0 @@
-DEFAULT_CONFIG = {"precision": 2, "allow_negative": True, "debug": False, "log_file": "calculator.log"}

runbooks/python101/exceptions.py

@@ -1,16 +0,0 @@
-class CalculatorError(Exception):
-    """Custom exception for errors in the Calculator."""
-
-    pass
-
-
-class InvalidOperationError(CalculatorError):
-    """Raised when an invalid operation is attempted."""
-
-    pass
-
-
-class InputValidationError(CalculatorError):
-    """Raised when input validation fails."""
-
-    pass

runbooks/python101/file_manager.py

@@ -1,218 +0,0 @@
-#!/usr/bin/env python3
-
-"""
-Utilities to create a specified folder and an empty file inside it with safe error handling.
-
-Author: Python Developer
-Date: 2025-01-05
-Version: 1.0.0
-
-Usage:
-    file_manager.py <folder_name> <file_name>
-"""
-
-import os
-import sys
-from pathlib import Path
-from typing import Union
-
-
-## ==============================
-## VALIDATION UTILITIES
-## ==============================
-def validate_input(value: Union[str, float, int]) -> float:
-    """
-    Validates and converts input into a float.
-
-    Args:
-        value (Union[str, float, int]): The input value to validate and convert.
-
-    Returns:
-        float: The validated and converted float value.
-
-    Raises:
-        TypeError: If input type is unsupported.
-        ValueError: If input cannot be converted to float, or fails constraints.
-    """
-
-    ## ✅ Step 1.1: Input Type Validation
-    if not isinstance(value, (str, int, float)):
-        raise TypeError(f"Invalid type '{type(value).__name__}'. Expected str, int, or float.")
-
-    ## ✅ Step 1.2: Handle Empty String
-    if isinstance(value, str) and not value.strip():
-        raise ValueError(f"Invalid input '{value}'. Input cannot be empty or whitespace-only.")
-
-    ## ✅ Step 2: Convert Input to Float
-    try:
-        result = float(value)  ## Attempt numeric conversion
-    except ValueError as e:
-        raise ValueError(f"Invalid input '{value}'. Must be a valid number.") from e
-
-    ## ✅ Step 3: Return Validated Float
-    return result
-
-
-def validate_folder_name(folder_name: str) -> None:
-    """
-    Validates folder name for OS-specific constraints.
-
-    Args:
-        folder_name (str): The folder name to validate.
-
-    Raises:
-        ValueError: If the folder name violates naming constraints.
-    """
-    if not folder_name:
-        raise ValueError("Folder name cannot be empty.")
-
-    if len(folder_name) > 255:  # Max length in most file systems
-        raise ValueError("Folder name exceeds maximum length (255 characters).")
-
-    invalid_chars = '<>:"/\\|?*'  # Reserved characters in Windows
-    if any(char in invalid_chars for char in folder_name):
-        raise ValueError(f"Folder name '{folder_name}' contains invalid characters.")
-
-    if folder_name in {"CON", "PRN", "AUX", "NUL"}:  # Reserved Windows names
-        raise ValueError(f"Folder name '{folder_name}' is a reserved keyword.")
-
-    if folder_name.startswith(" ") or folder_name.endswith(" "):
-        raise ValueError("Folder name cannot start or end with spaces.")
-
-
-def validate_file_name(file_name: str) -> None:
-    """
-    Validates file name for OS-specific constraints.
-
-    Args:
-        file_name (str): The file name to validate.
-
-    Raises:
-        ValueError: If the file name violates naming constraints.
-    """
-    if not file_name:
-        raise ValueError("File name cannot be empty.")
-
-    if len(file_name) > 255:
-        raise ValueError("File name exceeds maximum length (255 characters).")
-
-    invalid_chars = '<>:"/\\|?*'
-    if any(char in invalid_chars for char in file_name):
-        raise ValueError(f"File name '{file_name}' contains invalid characters.")
-
-    if file_name.startswith(" ") or file_name.endswith(" "):
-        raise ValueError("File name cannot start or end with spaces.")
-
-    if len(Path(file_name).suffix) == 0:  # Ensure file has an extension
-        raise ValueError("File name must include a valid extension (e.g., '.txt').")
-
-
-## ==============================
-## FILE SYSTEM UTILITIES
-## ==============================
-def create_folder_and_file(folder_name: str, file_name: str) -> None:
-    """
-    Create a folder and an empty file safely with robust error handling.
-
-    Args:
-        folder_name (str): Name of the folder to be created.
-        file_name (str): Name of the file to be created inside the folder.
-
-    Raises:
-        FileExistsError: If the folder already exists.
-        FileNotFoundError: If the folder path is invalid.
-        PermissionError: If there are insufficient permissions.
-        ValueError: If inputs are invalid.
-    """
-    ## ✅ Input Validation
-    validate_folder_name(folder_name)
-    validate_file_name(file_name)
-
-    ## ✅ Create Path Object
-    folder_path = Path(folder_name)
-    file_path = folder_path / file_name
-
-    try:
-        ## ✅ Create folder if it doesn't exist; same behavior as the POSIX `mkdir -p` command
-        folder_path.mkdir(parents=True, exist_ok=True)  ## Safe parent directory creation
-        print(f"✅ Folder '{folder_name}' created successfully.")
-
-        ## ✅ Create an empty file inside the folder
-        # os.chdir(folder_name) ## May Raise FileNotFoundError
-        # with open(file_name, 'a'):
-        #     pass
-        if file_path.exists():
-            raise FileExistsError(f"File '{file_name}' already exists in '{folder_name}'.")
-
-        file_path.touch(exist_ok=False)  ## Create an empty file; Fails safely if file exists
-        print(f"✅ File '{file_name}' created successfully inside '{folder_name}'.")
-
-    except FileExistsError as e:
-        raise FileExistsError(str(e))  # Re-raise exception without exiting
-
-    except PermissionError:
-        print("❌ Permission denied. Check your user permissions.")
-        sys.exit(1)
-
-    except Exception as e:
-        print(f"❌ Unexpected error: {e}")
-        sys.exit(1)
-
-
-## ✅ Handle Arguments Dynamically for Terminal and Debugger Compatibility
-def parse_arguments() -> tuple[str, str]:
-    """
-    Parses and validates command-line arguments for both terminal and VSCode debugger compatibility.
-
-    Returns:
-        tuple[str, str]: A tuple containing folder_name and file_name.
-
-    Raises:
-        ValueError: If arguments are invalid or insufficient.
-    """
-    import shlex  # Safely split arguments with quotes (if present)
-
-    ## ✅ Check Arguments Length
-    if len(sys.argv) < 2:
-        raise ValueError("Provide exactly 2 arguments: <folder_name> <file_name>")
-
-    ## ✅ Handle Debugger Inputs (Single Combined Argument)
-    if len(sys.argv) == 2:
-        args = shlex.split(sys.argv[1])  # Split safely with quote handling
-    else:
-        args = sys.argv[1:]  # Use normal command-line arguments
-
-    ## ✅ Validate Number of Arguments
-    if len(args) != 2:
-        raise ValueError("❌ Invalid arguments. Provide exactly 2 arguments: <folder_name> <file_name>")
-
-    ## ✅ Extract Folder and File Names
-    folder_name, file_name = args[0], args[1]
-    return folder_name, file_name
-
-
-## ==============================
-## MAIN FUNCTION
-## ==============================
-def main() -> None:
-    """
-    Main entry point for the script.
-    """
-    try:
-        ## ✅ Handle Debugger Arguments (Optional for Debugging Tools)
-        folder_name, file_name = parse_arguments()
-
-        ## ✅ Execute Function for Folder and File Creation
-        print(f"✅ Usage: file_manager.py '{folder_name}' '{file_name}'")
-        create_folder_and_file(folder_name, file_name)
-    except ValueError as e:
-        print(f"❌ Error: {e}")
-        sys.exit(1)
-
-    except Exception as e:
-        print(f"❌ Unexpected Error: {e}")
-        sys.exit(1)
-
-
-if __name__ == "__main__":
-    main()

runbooks/python101/toolkit.py

@@ -1,153 +0,0 @@
-"""
-Toolkit Module: Implements basic arithmetic operations.
-
-This module provides functions to perform addition, subtraction,
-multiplication, and division with detailed input validation.
-
-Features:
-- Handles edge cases like NaN, Infinity, and division by zero.
-- Supports logging for better traceability.
-- Enforces type checks for input safety.
-
-Author: Python Developer
-"""
-
-from typing import Union
-
-from loguru import logger
-
-# Define a type alias for supported numeric types
-Number = Union[int, float]
-
-# Configure loguru logger to simplify logs for testing
-logger.remove()
-logger.add(lambda msg: print(msg, end=""), format="{message}", level="DEBUG")
-
-
-def _validate_inputs(a: Number, b: Number, allow_zero: bool = True) -> None:
-    """
-    Validates numeric inputs and checks edge cases.
-
-    Args:
-        a (Number): The first input value.
-        b (Number): The second input value.
-        allow_zero (bool): Whether zero is allowed as a value for `b`. Default is True.
-
-    Raises:
-        TypeError: If inputs are not integers or floats.
-        ValueError: If inputs are NaN or Infinity.
-        ZeroDivisionError: If `b` is zero and `allow_zero` is False.
-    """
-    # Type check
-    if not isinstance(a, (int, float)) or not isinstance(b, (int, float)):
-        raise TypeError(f"Inputs must be numbers. Received: {type(a)} and {type(b)}")
-
-    # Edge cases: NaN or Infinity
-    for value in [a, b]:
-        if value != value or value in [float("inf"), float("-inf")]:
-            raise ValueError(f"Invalid input {value}. Must be a finite number.")
-
-    # Zero Division Check
-    if not allow_zero and b == 0:
-        raise ZeroDivisionError("division by zero")
-
-
-def add(a: Number, b: Number) -> float:
-    """
-    Adds two numbers and returns the result.
-
-    Examples:
-        >>> add(4.0, 2.0)
-        6.0
-        >>> add(4, 2)
-        6.0
-
-    Args:
-        a (Number): The first number.
-        b (Number): The second number.
-
-    Returns:
-        float: The sum of `a` and `b`.
-
-    Raises:
-        TypeError: If inputs are not numbers.
-    """
-    _validate_inputs(a, b)
-    logger.debug(f"Adding {a} + {b}")
-    return float(a + b)
-
-
-def subtract(a: Number, b: Number) -> float:
-    """
-    Subtracts the second number from the first.
-
-    Examples:
-        >>> subtract(4.0, 2.0)
-        2.0
-        >>> subtract(4, 2)
-        2.0
-
-    Args:
-        a (Number): The first number.
-        b (Number): The second number.
-
-    Returns:
-        float: The result of `a - b`.
-
-    Raises:
-        TypeError: If inputs are not numbers.
-    """
-    _validate_inputs(a, b)
-    logger.debug(f"Subtracting {a} - {b}")
-    return float(a - b)
-
-
-def multiply(a: Number, b: Number) -> float:
-    """
-    Multiplies two numbers and returns the result.
-
-    Examples:
-        >>> multiply(4.0, 2.0)
-        8.0
-        >>> multiply(4, 2)
-        8.0
-
-    Args:
-        a (Number): The first number.
-        b (Number): The second number.
-
-    Returns:
-        float: The result of `a * b`.
-
-    Raises:
-        TypeError: If inputs are not numbers.
-    """
-    _validate_inputs(a, b)
-    logger.debug(f"Multiplying {a} * {b}")
-    return float(a * b)
-
-
-def divide(a: Number, b: Number) -> float:
-    """
-    Divides the first number by the second.
-
-    Examples:
-        >>> divide(4.0, 2.0)
-        2.0
-        >>> divide(4, 2)
-        2.0
-
-    Args:
-        a (Number): The numerator.
-        b (Number): The denominator.
-
-    Returns:
-        float: The result of `a / b`.
-
-    Raises:
-        TypeError: If inputs are not numbers.
-        ZeroDivisionError: If `b` is zero.
-    """
-    _validate_inputs(a, b, allow_zero=False)
-    logger.debug(f"Dividing {a} / {b}")
-    return float(a / b)