runbooks 0.1.1__py3-none-any.whl

cloudops/__init__.py

@@ -0,0 +1,10 @@
+"""
+CloudOps: CloudOps Toolkit
+
+Provides utility functions for math operations, AWS S3 interactions, and data management.
+"""
+
+__version__ = "0.1.1"
+
+from .toolkit import add, divide, multiply, subtract
+# from .s3 import S3Client

cloudops/toolkit.py

@@ -0,0 +1,147 @@
+from typing import Tuple, Union
+
+from loguru import logger
+
+## Define a type alias for supported numeric types
+Number = Union[float, int]
+
+
+def add(a: Number, b: Number) -> float:
+    """Compute and return the sum of two numbers.
+
+    Examples:
+        >>> add(4.0, 2.0)
+        6.0
+        >>> add(4, 2)
+        6.0
+
+    Args:
+        a: The first number in the addition.
+        b: The second number in the addition.
+
+    Returns:
+        float: The arithmetic sum of `a` and `b`.
+
+    Raises:
+        TypeError: If inputs are not numbers.
+    """
+    if not isinstance(a, (int, float)) or not isinstance(b, (int, float)):
+        raise TypeError("Both inputs must be integers or floats.")
+
+    logger.debug(f"Adding {a} + {b}")
+    return float(a + b)
+
+
+def subtract(a: Number, b: Number) -> float:
+    """Compute and return the subtraction of two numbers.
+
+    Examples:
+        >>> subtract(4.0, 2.0)
+        2.0
+        >>> subtract(4, 2)
+        2.0
+
+    Args:
+        a: The first number in the subtraction.
+        b: The second number in the subtraction.
+
+    Returns:
+        float: The arithmetic subtraction of `a` and `b`.
+
+    Raises:
+        TypeError: If inputs are not numbers.
+    """
+    if not isinstance(a, (int, float)) or not isinstance(b, (int, float)):
+        raise TypeError("Both inputs must be integers or floats.")
+
+    logger.debug(f"Subtracting {a} - {b}")
+    return float(a - b)
+
+
+def multiply(a: Number, b: Number) -> float:
+    """Compute and return the multiplication of two numbers.
+
+    Examples:
+        >>> multiply(4.0, 2.0)
+        8.0
+        >>> multiply(4, 2)
+        8.0
+
+    Args:
+        a: The first number in the multiplication.
+        b: The second number in the multiplication.
+
+    Returns:
+        float: The arithmetic multiplication of `a` and `b`.
+
+    Raises:
+        TypeError: If inputs are not numbers.
+    """
+    if not isinstance(a, (int, float)) or not isinstance(b, (int, float)):
+        raise TypeError("Both inputs must be integers or floats.")
+
+    logger.debug(f"Multiplying {a} * {b}")
+    return float(a * b)
+
+
+def divide(a: Number, b: Number) -> float:
+    """Compute and return the division of two numbers.
+
+    Examples:
+        >>> divide(4.0, 2.0)
+        2.0
+        >>> divide(4, 2)
+        2.0
+
+    Args:
+        a: The numerator.
+        b: The denominator.
+
+    Returns:
+        float: The result of dividing `a` by `b`.
+
+    Raises:
+        TypeError: If inputs are not numbers.
+        ZeroDivisionError: If the denominator is zero.
+    """
+    if not isinstance(a, (int, float)) or not isinstance(b, (int, float)):
+        raise TypeError("Both inputs must be integers or floats.")
+    if b == 0:
+        logger.error("Attempted division by zero.")
+        raise ZeroDivisionError("division by zero")
+
+    logger.debug(f"Dividing {a} / {b}")
+    return float(a / b)
+
+
+def divide(a: Number, b: Number) -> float:
+    """Compute and return the division of two numbers.
+
+    Examples:
+        >>> divide(4.0, 2.0)
+        2.0
+        >>> divide(4, 2)
+        2.0
+
+    Args:
+        a: The numerator.
+        b: The denominator.
+
+    Returns:
+        float: The result of dividing `a` by `b`.
+
+    Raises:
+        TypeError: If inputs are not numbers.
+        ZeroDivisionError: If the denominator is zero.
+    """
+    # Input validation
+    if not isinstance(a, (int, float)) or not isinstance(b, (int, float)):
+        raise TypeError("Both inputs must be integers or floats.")
+
+    # Handle division by zero
+    if b == 0:
+        raise ZeroDivisionError("division by zero")
+
+    # Perform division
+    logger.debug(f"Dividing {a} / {b}")
+    return float(a / b)

runbooks-0.1.1.dist-info/METADATA

@@ -0,0 +1,181 @@
+Metadata-Version: 2.1
+Name: runbooks
+Version: 0.1.1
+Summary: CloudOps Automation for DevOps and SRE teams.
+Author-email: runbooks maintainers <nnthanh101@gmail.com>
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Documentation
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Utilities
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+Requires-Dist: requests>=2.32.3
+Requires-Dist: loguru>=0.7.3
+Requires-Dist: typer>=0.15.1
+Requires-Dist: tqdm>=4.67.1
+Requires-Dist: boto3>=1.35.90
+Requires-Dist: moto>=5.0.25
+
+# 🔥 CloudOps Automation at Scale 🦅
+
+🌟 You can use [CloudOps Automation Runbooks](https://cloudops.oceansoft.io), built on Jupyter Notebooks, to quickly create SRE RunBooks for Runbook Automation and Cloud Infrastructure Management! 🌐
+
+> [!IMPORTANT]
+> **🏆 Mission**: Our mission is to simplify CloudOps Automation for DevOps and SRE teams by providing an extensive, community-driven repository of actions and runbooks that streamline day-to-day operations. 
+
+> [!NOTE]
+> **👁️ Vision**: Our vision is to be the 🥇 One-Stop Multi-Cloud Platform Engineering & Best Practices Solution for all CloudOps Automation needs, allowing DevOps and SRE teams to automate their workflows with ease, improve efficiency, and minimize toil.
+
+[![🐍 CloudOps PyPI version](https://img.shields.io/pypi/v/cloudops)](https://pypi.org/project/cloudops/)
+
+<div align="left">
+  <a href="https://www.linkedin.com/in/nnthanh" target="blank"><img align="center" src="https://img.shields.io/badge/-nnthanh-blue?style=flat-square&logo=Linkedin&logoColor=white&link=https://www.linkedin.com/in/nnthanh/" alt="Nhat-Thanh Nguyen" height="25" width="100" /></a>
+  <a href="https://github.com/nnthanh101/" target="blank"><img align="center" src="https://img.shields.io/github/followers/nnthanh101?label=Follow&style=social&link=https://github.com/nnthanh101/" alt="Thanh Nguyen" height="25" width="100" /></a>
+  <a href="https://www.facebook.com/groups/platformengineering" target="blank"><img align="center" src="https://img.shields.io/badge/Facebook-blue?style=flat-square&logo=facebook&logoColor=white&link=[https://www.linkedin.com/in/nnthanh/](https://www.facebook.com/groups/platformengineering)" alt="Nhat-Thanh Nguyen" height="25" width="100" /></a>  
+</div>
+
+---
+
+## 🛠️ Features
+
+* 🥉 ✅**Lightning-Fast Toolchain**: Powered by 📦 `uv` - Next-generation Python dependency and build management, 💅 `ruff` - Linting and formatting at blazing speed, and 🧪 pytest - Robust testing framework with coverage reports.
+* 🥈 ✅**Effortless CI/CD Pipelines**: 🛠️ Taskfile Automation - Say goodbye to manual SDLC repetitive tasks, 🐳 Containerized Workflows – 🛡️ Security-first practices and Multi-stage Wolfi-based Docker builds for scalable production-ready environments, and ⚙️ Auto-publish to `PyPI` and GitHub Container Registry (`GHCR`) with GitHub Actions.
+* 🥇 ☑️**CloudOps Automation and FinOps Toolkit** – Pre-configured hybrid-cloud workflows and seamlessly integrations (jupyterlab, mkdocs, boto3, moto) for managing cloud infrastructure 🌐.  
+
+| **Feature**              | **Toolchain**                            | **Purpose**                                        |
+|--------------------------|-------------------------------------|----------------------------------------------------|
+| 🛠️ Configuration         | `pyproject.toml`                 | Centralized configuration for dependencies, testing, and linting.  |
+| 🧹 Task Automation       | [`Taskfile`](https://taskfile.dev/) | Automates repetitive tasks like linting, testing, and publishing.  |
+| 📦 Python Dependencies   | [`uv`](https://docs.astral.sh/uv/)  | Lightning-fast dependency resolution, caching, and builds. |
+| 💅 Linting & Formatting  | [`ruff`](https://docs.astral.sh/ruff/) | Enforces code quality standards, auto-formatting, and import sorting.  |
+| 🧪 Testing Framework     | [`pytest`](https://docs.pytest.org/)  | Comprehensive unit tests, integration tests with coverage reporting.    |
+| 🐳 Docker Integration    | Dockerfile + [`DevContainer`](https://containers.dev/)  | Optimized wolfi-based multi-stage builds for CI/CD and local development environments. |
+| 🦾 CI/CD Pipelines       | [`GitHub Actions`](https://github.com/features/actions) | Automated builds, tests, and deployments to PyPI and GHCR. |
+| 📝 Security Compliance   | [`chainguard/wolfi-base`](https://hub.docker.com/r/chainguard/wolfi-base) + SBOM + Attestations | Ensures compliance, vulnerability scanning, and security transparency. |
+
+---
+
+### WIP
+
+- [ ] 📚 auto doc generation
+- [ ] **CLI Tools** – Typer simplifies automation for AWS resources.  
+- [ ] **Logging** – Loguru ensures structured logs for debugging. 
+- [x] 🐳 CI/CD Optimized Docker Image runs when a new *release* is created pushing to gh registry
+- [x] 🦾 GitHub actions:
+    - [x] auto publish to [`pypi`](https://pypi.org/) on push on `main`
+    - [ ] auto creating a new tag on push on `main`, sync versions
+    - [x] run `tests` and `lint` on `dev` and `main` when a PR is open
+
+## 🚀 Quick Start
+
+### 1. Clone the Repository
+
+```bash
+git clone https://github.com/nnthanh101/CloudOps.git
+cd CloudOps
+```
+
+### 2. Install Dependencies and Run CI/CD Pipelines
+
+```bash
+echo "Install Python dependencies using UV"
+task install
+
+echo "Run CI/CD pipeline tasks: clean, lint, format, test, and build"
+task ci
+
+echo "Publish the project package to PyPI"
+task publish
+```
+
+### 3. Run in DevContainer 🐳
+
+1. Open the project in **VSCode**.  
+2. Install the [Remote - Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) extension.  
+3. **Reopen in Container**:  
+   **Command Palette `Ctrl+Shift+P` → Reopen in Container**.  
+
+---
+
+## Project Structure
+
+> 🛠 End-to-end Production-grade project structure for successful 💎 CloudOps Automation and Visual Analytics FinOps projects 🚀
+
+```
+cloudops-automation/
+├── .devcontainer/     ## Dev Container configurations
+│   └── Dockerfile     ## Container image build file
+├── .github/           ## CI/CD workflows
+│   ├── workflows/     ## GitHub Actions workflows
+│   └── templates/     ## Workflow templates
+├── .vscode/           ## IDE-specific configurations
+├── config/            ## Configuration files (YAML, JSON)
+├── data               🔍 Where all your raw and processed data files are stored.
+│   ├── external       <- Data from third-party sources.
+│   ├── interim        <- Intermediate data that has been transformed.
+│   ├── processed      <- The final, canonical data sets for modeling.
+│   └── raw            <- The original, unprocessed, immutable data dump.
+│
+├── docs               📓 A default mkdocs project; see mkdocs.org for details
+│   ├── api/                 ## API documentation
+│   ├── architecture/        ## Architecture diagrams
+│   ├── tutorials/           ## Tutorials and guides
+│   ├── getting-started.md   ## Quickstart guide
+│   └── index.md             ## Overview documentation
+│
+├── logs/                    ## Log files for debugging
+|
+├── models             🧠 Store your trained and serialized models for easy access and versioning.
+│
+├── notebooks          💻 Jupyter notebooks for experiments and visualization.
+│   ├── data_exploration.ipynb
+│   ├── data_preprocessing.ipynb
+│   ├── model_training.ipynb
+│   └── model_evaluation.ipynb
+│
+├── pyproject.toml     <- Project configuration file with package metadata for 
+│                         cloudops and configuration for tools like black
+│
+├── src/                            ## 🧩 Source code for use in this project.
+│   ├── cloudops/                   ## Main module for CloudOps automation
+│   │   ├── __init__.py             ## Package initializer
+│   │   ├── s3.py                   ## S3 utility functions
+│   │   ├── ec2.py                  ## EC2 automation
+│   │   ├── rds.py                  ## RDS management
+│   │   ├── runbooks/               ## Automation runbooks
+│   │   │   ├── backup.py           ## Automated backup runbook
+│   │   │   ├── scale-out.py        ## Scale-out automation runbook
+│   │   │   └── cleanup.py          ## Cleanup automation runbook
+│   ├── utils/                      ## Utility scripts (logging, configs)
+│   ├── cli/                        ## Command-line interface
+│   │   ├── __init__.py             ## CLI module initializer
+│   │   ├── main.py                 ## CLI entry point
+│   │   └── commands.py             ## CLI commands
+│   └── tests/                      ## Unit and integration tests
+│       ├── test_s3.py              ## Test cases for S3 module
+│       ├── test_ec2.py             ## Test cases for EC2 module
+│       └── test_runbooks.py        ## Test cases for runbooks
+├── templates/                      ## Terraform and CloudFormation templates
+├── tools/                          ## Developer tools and scripts
+├── .dockerignore                   ## Docker ignore file
+├── .env                            ## Environment variables
+├── .gitignore                      ## Git ignore file
+├── .python-version                 ## Python version management
+├── .gitignore
+├── mkdocs.yml                      # Documentation generator configuration
+├── README.md          🤝 Explain your project and its structure for better collaboration.
+├── references         <- Data dictionaries, manuals, and all other explanatory materials.
+│
+├── reports            📊 Generated analysis (reports, charts, and plots) as HTML, PDF, LaTeX.
+│   └── figures        <- Generated graphics and figures to be used in reporting
+│
+├── requirements.txt   🛠 The requirements file for reproducing the analysis environment, for easy environment setup.
+└── Taskfile           <- Taskfile with convenience commands like `task data` or `task train`
+
+```

runbooks-0.1.1.dist-info/RECORD

@@ -0,0 +1,6 @@
+cloudops/__init__.py,sha256=FzKaMwt2VjEQSJ1A3_jDmHqGyxawsmmtfJtiDvcDmr4,230
+cloudops/toolkit.py,sha256=4fICu62-eaxjaxfR8TzYpFcLSzK_m5Eoll-WayU9xrE,3650
+runbooks-0.1.1.dist-info/METADATA,sha256=FDD8yt6vpj3uE0oxgBFPBIArFJAl-sAvdfBG68K2BDE,10665
+runbooks-0.1.1.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
+runbooks-0.1.1.dist-info/top_level.txt,sha256=DKYLN0RQdA42RbZhbFKw2kz4Id3KIqM0CeBFdof7RnQ,9
+runbooks-0.1.1.dist-info/RECORD,,

runbooks-0.1.1.dist-info/WHEEL

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

runbooks-0.1.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+cloudops