|
1 | | -# PYTHON LANGUAGE PROGRAMMING LAB (KCS-453) PROGRAMS |
2 | | - |
| 1 | +# Python-Foundation-Libraries-And-Scripts-Python-Lib |
| 2 | + |
| 3 | +[](https://github.com/chirag127/Python-Foundation-Libraries-And-Scripts-Python-Lib/actions/workflows/ci.yml) |
| 4 | +[](https://codecov.io/gh/chirag127/Python-Foundation-Libraries-And-Scripts-Python-Lib) |
| 5 | +[](https://www.python.org/) |
| 6 | +[](https://github.com/astral-sh/ruff) |
| 7 | +[](https://creativecommons.org/licenses/by-nc/4.0/) |
| 8 | +[](https://github.com/chirag127/Python-Foundation-Libraries-And-Scripts-Python-Lib/stargazers) |
| 9 | + |
| 10 | +### ⭐ Star this Repo |
| 11 | + |
| 12 | +--- |
| 13 | + |
| 14 | +A curated collection of foundational Python libraries and scripts designed for robust development, automation, and data processing. Optimized for efficiency and modularity. |
| 15 | + |
| 16 | +--- |
| 17 | + |
| 18 | +## 🚀 Project Overview |
| 19 | + |
| 20 | +This repository serves as a comprehensive toolkit for Python developers, offering a high-quality, modular collection of essential libraries and utility scripts. It is engineered for reliability, performance, and ease of integration into diverse projects, from complex automation workflows to intricate data processing pipelines. |
| 21 | + |
| 22 | +--- |
| 23 | + |
| 24 | +## 🌳 Project Structure |
| 25 | + |
| 26 | +bash |
| 27 | +Python-Foundation-Libraries-And-Scripts-Python-Lib/ |
| 28 | +├── src/ |
| 29 | +│ ├── __init__.py |
| 30 | +│ ├── core/ |
| 31 | +│ │ ├── __init__.py |
| 32 | +│ │ └── utils.py |
| 33 | +│ ├── automation/ |
| 34 | +│ │ ├── __init__.py |
| 35 | +│ │ └── file_ops.py |
| 36 | +│ └── data_processing/ |
| 37 | +│ ├── __init__.py |
| 38 | +│ └── analysis.py |
| 39 | +├── scripts/ |
| 40 | +│ ├── run_automation.py |
| 41 | +│ └── process_data.py |
| 42 | +├── tests/ |
| 43 | +│ ├── __init__.py |
| 44 | +│ ├── core/test_utils.py |
| 45 | +│ ├── automation/test_file_ops.py |
| 46 | +│ └── data_processing/test_analysis.py |
| 47 | +├── .gitignore |
| 48 | +├── LICENSE |
| 49 | +├── README.md |
| 50 | +├── AGENTS.md |
| 51 | +├── pyproject.toml |
| 52 | +├── .ruff.toml |
| 53 | +├── .github/workflows/ci.yml |
| 54 | +├── .github/CONTRIBUTING.md |
| 55 | +├── .github/ISSUE_TEMPLATE/bug_report.md |
| 56 | +├── .github/PULL_REQUEST_TEMPLATE.md |
| 57 | +└── .github/SECURITY.md |
| 58 | + |
| 59 | + |
| 60 | +--- |
| 61 | + |
| 62 | +## 📜 Table of Contents |
| 63 | + |
| 64 | +- [🚀 Project Overview](#-project-overview) |
| 65 | +- [🌳 Project Structure](#-project-structure) |
| 66 | +- [📜 Table of Contents](#-table-of-contents) |
| 67 | +- [🛠️ Core Features](#️-core-features) |
| 68 | +- [⚙️ Technology Stack](#️-technology-stack) |
| 69 | +- [💡 Development & Setup](#-development--setup) |
| 70 | +- [🚀 Running Scripts](#-running-scripts) |
| 71 | +- [🧪 Testing](#-testing) |
| 72 | +- [🛡️ Development Principles](#-development-principles) |
| 73 | +- [🤖 AI AGENT DIRECTIVES](#-ai-agent-directives) |
| 74 | +- [🤝 Contributing](#-contributing) |
| 75 | +- [⚖️ License](#️-license) |
| 76 | + |
| 77 | +--- |
| 78 | + |
| 79 | +## 🛠️ Core Features |
| 80 | + |
| 81 | +* **Modular Design:** Highly organized codebase promoting reusability and maintainability. |
| 82 | +* **Robust Utilities:** Core Python utilities for common development tasks. |
| 83 | +* **Automation Scripts:** Pre-built scripts for automating repetitive tasks (e.g., file operations, system commands). |
| 84 | +* **Data Processing:** Efficient modules for data manipulation, cleaning, and analysis. |
| 85 | +* **Performance Optimized:** Written with efficiency and speed in mind. |
| 86 | + |
| 87 | +--- |
| 88 | + |
| 89 | +## ⚙️ Technology Stack |
| 90 | + |
| 91 | +* **Language:** Python 3.10+ |
| 92 | +* **Package Management:** `uv` (Ultra-fast, reliable dependency management) |
| 93 | +* **Linting & Formatting:** `Ruff` (Blazingly fast Python linter and formatter) |
| 94 | +* **Testing:** `Pytest` (Powerful and flexible testing framework) |
| 95 | + |
| 96 | +--- |
| 97 | + |
| 98 | +## 💡 Development & Setup |
| 99 | + |
| 100 | +1. **Clone the Repository:** |
| 101 | + bash |
| 102 | + git clone https://github.com/chirag127/Python-Foundation-Libraries-And-Scripts-Python-Lib.git |
| 103 | + cd Python-Foundation-Libraries-And-Scripts-Python-Lib |
| 104 | + |
| 105 | + |
| 106 | +2. **Install Dependencies using uv:** |
| 107 | + bash |
| 108 | + uv install |
| 109 | + |
| 110 | + This command will read the `pyproject.toml` file and install all project dependencies, including development tools. |
| 111 | + |
| 112 | +3. **Verify Setup:** |
| 113 | + Ensure linting and formatting are correctly set up: |
| 114 | + bash |
| 115 | + ruff check . |
| 116 | + ruff format . |
| 117 | + |
| 118 | + |
| 119 | +--- |
| 120 | + |
| 121 | +## 🚀 Running Scripts |
| 122 | + |
| 123 | +Execute utility scripts directly from the `scripts/` directory. |
| 124 | + |
| 125 | +* **Run Automation Script:** |
| 126 | + bash |
| 127 | + python scripts/run_automation.py --help |
| 128 | + |
| 129 | + |
| 130 | +* **Run Data Processing Script:** |
| 131 | + bash |
| 132 | + python scripts/process_data.py --help |
| 133 | + |
| 134 | + |
| 135 | +--- |
| 136 | + |
| 137 | +## 🧪 Testing |
| 138 | + |
| 139 | +Execute all tests using `pytest`: |
| 140 | + |
| 141 | +bash |
| 142 | +pytest |
| 143 | + |
| 144 | + |
| 145 | +To run tests with coverage: |
| 146 | + |
| 147 | +bash |
| 148 | +pytest --cov=src/ |
| 149 | + |
| 150 | + |
| 151 | +--- |
| 152 | + |
| 153 | +## 🛡️ Development Principles |
| 154 | + |
| 155 | +* **SOLID:** Design principles promoting maintainable and scalable object-oriented software. |
| 156 | +* **DRY (Don't Repeat Yourself):** Avoid redundancy in code and configuration. |
| 157 | +* **YAGNI (You Ain't Gonna Need It):** Implement only necessary features. |
| 158 | +* **Modularity:** Ensure components are loosely coupled and highly cohesive. |
| 159 | + |
| 160 | +--- |
| 161 | + |
| 162 | +## 🤖 AI AGENT DIRECTIVES |
| 163 | + |
| 164 | +<details> |
| 165 | +<summary>Click to Expand AI Agent Directives</summary> |
| 166 | + |
| 167 | +This repository is managed by the **Apex Technical Authority** (December 2025 Edition), operating under strict AI Agent protocols. |
| 168 | + |
| 169 | +### 1. IDENTITY & PRIME DIRECTIVE |
| 170 | +* **Role:** Senior Principal Software Architect, Master Technical Copywriter. |
| 171 | +* **Context:** December 2025; building for 2026 standards. |
| 172 | +* **Output Standard:** **EXECUTION-ONLY**. No plans, only executed code/docs. |
| 173 | +* **Philosophy:** "Zero-Defect, High-Velocity, Future-Proof." |
| 174 | + |
| 175 | +### 2. INPUT PROCESSING & COGNITION |
| 176 | +* **Speech-to-Text Interpretation:** **STRICTLY FORBIDDEN** from executing literal typos. Must infer technical intent. |
| 177 | +* **Logic Anchor:** `README.md` is the Single Source of Truth (SSOT). |
| 178 | +* **Mandatory MCP Instrumentation:** Use `linkup`/`brave` for December 2025 standards, `docfork` for API verification, and `clear-thought-two` for complex flow architecting. |
| 179 | + |
| 180 | +### 3. CONTEXT-AWARE APEX TECH STACKS (LATE 2025 STANDARDS) |
| 181 | +* **Project Type:** Python (`pyproject.toml` detection). |
| 182 | +* **Apex Toolchain (Python):** |
| 183 | + * **Stack:** Python 3.10+, `uv` (Package Management), `Ruff` (Linting/Formatting), `Pytest` (Testing). |
| 184 | + * **Architecture:** **Modular Monolith**. |
| 185 | + |
| 186 | +### 4. APEX NAMING CONVENTION |
| 187 | +* **Format:** `<Product>-<Function>-<Platform>-<Type>` (e.g., `Python-Foundation-Libraries-And-Scripts-Python-Lib`). |
| 188 | + |
| 189 | +### 5. THE README REPLICATION PROTOCOL |
| 190 | +* **Content:** Must be a self-contained Project Operating System. |
| 191 | +* **Sections:** Visual Authority, Structural Clarity, AI Agent Directives, Development Standards. |
| 192 | +* **Badges:** `flat-square` style, `chirag127` username, mandatory badges (Build, Coverage, Tech Stack, Lint, License, Stars). |
| 193 | + |
| 194 | +### 6. CHAIN OF THOUGHT (CoT) PROTOCOL |
| 195 | +* **Pre-Execution Audit:** Analyze repo, decide Pivot/Archive, apply Naming Strategy, draft AI Directives, generate files, polish, ensure strict adherence to `AGENTS.md`. |
| 196 | + |
| 197 | +### 7. DYNAMIC URL & BADGE PROTOCOL |
| 198 | +* **Base URL:** `https://github.com/chirag127/Python-Foundation-Libraries-And-Scripts-Python-Lib` |
| 199 | +* **Consistency:** Use **new** repository name for all links and badges. |
| 200 | +* **AGENTS.md Customization:** Adapt content to specific tech stack (Python in this case), retain core Apex principles. |
| 201 | + |
| 202 | +</details> |
| 203 | + |
| 204 | +--- |
| 205 | + |
| 206 | +## 🤝 Contributing |
| 207 | + |
| 208 | +We welcome contributions to enhance this foundational library. Please follow the guidelines in the [CONTRIBUTING.md](https://github.com/chirag127/Python-Foundation-Libraries-And-Scripts-Python-Lib/blob/main/.github/CONTRIBUTING.md) file. |
| 209 | + |
| 210 | +--- |
| 211 | + |
| 212 | +## ⚖️ License |
| 213 | + |
| 214 | +This project is licensed under the **Creative Commons Attribution-NonCommercial 4.0 International (CC BY-NC 4.0)** license. See the [LICENSE](https://github.com/chirag127/Python-Foundation-Libraries-And-Scripts-Python-Lib/blob/main/LICENSE) file for more details. |
0 commit comments