viperx 0.9.5__tar.gz

viperx-0.9.5/PKG-INFO

@@ -0,0 +1,236 @@
+Metadata-Version: 2.3
+Name: viperx
+Version: 0.9.5
+Summary: Professional Python Project Initializer with uv, ml/dl support, and embedded config.
+Keywords: python,project-template,uv,data-science,machine-learning
+Author: Ivann KAMDEM
+Author-email: Ivann KAMDEM <kapoivha@gmail.com>
+License: MIT
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Build Tools
+Requires-Dist: gitpython>=3.1.46
+Requires-Dist: jinja2>=3.1.6
+Requires-Dist: rich>=14.2.0
+Requires-Dist: typer>=0.21.1
+Requires-Dist: pyyaml>=6.0.1
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+
+# 🐍 ViperX
+
+> **Professional Python Project Initializer**
+> *The modern, snake-fast way to bootstrap Python projects.*
+
+**ViperX** is a CLI tool designed to generate production-ready Python projects instantly. It leverages **[uv](https://github.com/astral-sh/uv)** for blazing fast dependency management and offers specialized templates for **Machine Learning** (`ml`) and **Deep Learning** (`dl`).
+
+## ✨ Features
+
+- **Blazing Fast**: Built on top of `uv`.
+- **Pre-configured**: `pyproject.toml`, proper `src` layout, `ruff` ready.
+- **ML/DL First**: Templates with `torch`, `tensorflow`, `kagglehub` and **Smart Caching**.
+- **Smart Caching**: Auto-downloads and caches datasets to `~/.cache/viperx/data` (or local `data/`).
+- **Strict Isolation**: Environment variables (`.env`) isolated in `src/<pkg>/` for better security.
+- **Config-in-Package**: Solves the "Colab/Kaggle doesn't see my config" problem.
+- **Platform Agnostic**: Works on Local, VSCode, Colab, and Kaggle.
+
+## 📦 Installation
+
+**Recommended (Global Tool)**
+```bash
+pipx install viperx
+```
+
+**Alternative (uv)**
+```bash
+uv tool install viperx
+```
+
+## 🚀 Usage
+
+### `init`
+Initialize a new project (Classic, ML, or DL).
+
+```bash
+# Classic Lib (Standard Layout)
+viperx init -n my-lib
+
+# Machine Learning ( + Notebooks, Pandas, Scikit-learn, Smart Loader)
+viperx init -n churn-pred -t ml
+
+# Deep Learning ( + PyTorch/TensorFlow, CUDA checks)
+viperx init -n deep-vision -t dl --framework pytorch
+# Deep Learning ( + PyTorch/TensorFlow, CUDA checks)
+viperx init -n deep-vision -t dl --framework pytorch
+
+# ✨ Declarative Config (Infrastructure as Code)
+viperx config init                  # Generate template
+viperx init -c viperx.yaml          # Apply config
+```
+
+### `package`
+Manage workspace packages (Monorepo style).
+
+```bash
+# Add a new package to the current workspace
+viperx package add -n my-api -t classic
+
+# Remove a package
+viperx package delete -n my-api
+```
+
+## 🚀 Quick Start
+
+Initialize a new project with a single command:
+
+```bash
+# Classic Package
+viperx init -n my-lib -d "My awesome library"
+
+# Deep Learning Project (PyTorch ready)
+viperx init -n deep-vision -t dl --description "Vision Transformer implementation"
+
+# Machine Learning Project (Scikit-learn ready)
+viperx init -n churn-prediction -t ml
+```
+
+## 🧱 Structure
+
+📂 **Standard Layout**
+```text
+my-lib/
+├── pyproject.toml      # Managed by uv
+├── README.md
+├── README.md
+├── .gitignore
+└── src/
+    └── my_lib/
+        ├── __init__.py
+        ├── main.py     # Entry point
+        ├── config.yaml # Data URLs & Params
+        ├── config.py   # Loader
+        ├── .env        # Secrets (Isolated)
+        └── utils/
+            └── data_loader.py # Generic URL/CSV Loader
+```
+
+### 🧠 Machine Learning & Deep Learning
+For type `ml` or `dl`, you get:
+- **Notebooks**:
+  - `Base_Kaggle.ipynb`: Loads data via `kagglehub`.
+  - `Base_General.ipynb`: Loads data via `data_loader.py` (URL/Local).
+- **Data Loader**: `src/<pkg>/data_loader.py` handles caching downloads to `data/`.
+- **Config**: Pre-filled with "Hello World" datasets (Iris, Titanic).
+
+### ⚙️ Configurationstalls dependencies (`torch`, `pandas`...).
+
+```text
+deep-vision/
+├── pyproject.toml
+├── notebooks/
+│   └── Base.ipynb      # Pre-configured notebook (Colab/Kaggle ready)
+└── src/
+    └── deep_vision/
+        ├── ...         # Same robust package structure
+```
+
+## 💻 CLI Usage
+
+### `init` - Create a new project
+
+```bash
+viperx init [OPTIONS]
+```
+
+**Options:**
+- `-n, --name TEXT`: Project name **(Required)**.
+- `-t, --type TEXT`: Project type (`classic`, `ml`, `dl`). Default: `classic`.
+- `-d, --description TEXT`: Project description.
+- `-a, --author TEXT`: Author name (defaults to git user).
+- `-l, --license TEXT`: License type (`MIT`, `Apache-2.0`, `GPLv3`). Default: `MIT`.
+- `-f, --framework TEXT`: DL Framework (`pytorch`, `tensorflow`). Default: `pytorch` (only for `-t dl`).
+- `-v, --verbose`: Enable verbose logging for transparent output.
+
+**Examples:**
+
+```bash
+# Classic Library
+viperx init -n my-lib
+
+# Deep Learning (PyTorch Default)
+viperx init -n vision-ai -t dl
+
+# Deep Learning (TensorFlow)
+viperx init -n tf-legacy -t dl -f tensorflow
+# Deep Learning (TensorFlow)
+viperx init -n tf-legacy -t dl -f tensorflow
+
+# From Config File
+viperx init -c viperx.yaml
+```
+
+### `config` - Declarative Mode
+
+Manage your project infrastructure using a YAML file.
+
+```bash
+viperx config init
+```
+Generates a `viperx.yaml` template in the current directory.
+
+```bash
+viperx init --config viperx.yaml
+```
+Applies the configuration. This is **idempotent**:
+- Creates the project if it doesn't exist.
+- **Hydrates** the directory if it exists but is empty (e.g., git init).
+- **Updates** the workspace if the project exists (adds missing packages defined in YAML).
+
+### `package` - Manage Workspace
+
+Manage packages in your workspace hierarchy (add, update, delete).
+
+#### `add`
+Add a new package to your project. Upgrades standalone projects to workspaces automatically.
+```bash
+```bash
+viperx package add -n worker-node -t classic --no-readme
+```
+**Options:**
+- `--readme / --no-readme`: Generate a local `README.md` for the package. Default: `True`.
+- `--env / --no-env`: Generate isolated `.env` and `.env.example` in `src/<pkg>/`.
+
+#### `delete`
+Remove a package from the workspace (deletes folder & updates `pyproject.toml`).
+```bash
+viperx package delete -n worker-node
+```
+
+#### `update`
+Update a package's dependencies (runs `uv lock --upgrade`).
+```bash
+viperx package update -n worker-node
+```
+
+---## 📦 "Magical" Configuration
+
+Every project comes with a robust `config.py` using `importlib.resources`.
+
+**In your code / notebooks:**
+```python
+from my_package import SETTINGS, get_dataset_path
+
+# Works everywhere: Local, Installed, Colab, Kaggle
+print(SETTINGS['project_name'])
+```
+
+## 🤝 Contributing
+
+This project is built 100% with `uv`.
+
+1. Clone the repo
+2. Sync dependencies: `uv sync`
+3. Run the CLI: `uv run viperx`
+
+---
+*Built with ❤️ by KpihX*

viperx-0.9.5/README.md

@@ -0,0 +1,217 @@
+# 🐍 ViperX
+
+> **Professional Python Project Initializer**
+> *The modern, snake-fast way to bootstrap Python projects.*
+
+**ViperX** is a CLI tool designed to generate production-ready Python projects instantly. It leverages **[uv](https://github.com/astral-sh/uv)** for blazing fast dependency management and offers specialized templates for **Machine Learning** (`ml`) and **Deep Learning** (`dl`).
+
+## ✨ Features
+
+- **Blazing Fast**: Built on top of `uv`.
+- **Pre-configured**: `pyproject.toml`, proper `src` layout, `ruff` ready.
+- **ML/DL First**: Templates with `torch`, `tensorflow`, `kagglehub` and **Smart Caching**.
+- **Smart Caching**: Auto-downloads and caches datasets to `~/.cache/viperx/data` (or local `data/`).
+- **Strict Isolation**: Environment variables (`.env`) isolated in `src/<pkg>/` for better security.
+- **Config-in-Package**: Solves the "Colab/Kaggle doesn't see my config" problem.
+- **Platform Agnostic**: Works on Local, VSCode, Colab, and Kaggle.
+
+## 📦 Installation
+
+**Recommended (Global Tool)**
+```bash
+pipx install viperx
+```
+
+**Alternative (uv)**
+```bash
+uv tool install viperx
+```
+
+## 🚀 Usage
+
+### `init`
+Initialize a new project (Classic, ML, or DL).
+
+```bash
+# Classic Lib (Standard Layout)
+viperx init -n my-lib
+
+# Machine Learning ( + Notebooks, Pandas, Scikit-learn, Smart Loader)
+viperx init -n churn-pred -t ml
+
+# Deep Learning ( + PyTorch/TensorFlow, CUDA checks)
+viperx init -n deep-vision -t dl --framework pytorch
+# Deep Learning ( + PyTorch/TensorFlow, CUDA checks)
+viperx init -n deep-vision -t dl --framework pytorch
+
+# ✨ Declarative Config (Infrastructure as Code)
+viperx config init                  # Generate template
+viperx init -c viperx.yaml          # Apply config
+```
+
+### `package`
+Manage workspace packages (Monorepo style).
+
+```bash
+# Add a new package to the current workspace
+viperx package add -n my-api -t classic
+
+# Remove a package
+viperx package delete -n my-api
+```
+
+## 🚀 Quick Start
+
+Initialize a new project with a single command:
+
+```bash
+# Classic Package
+viperx init -n my-lib -d "My awesome library"
+
+# Deep Learning Project (PyTorch ready)
+viperx init -n deep-vision -t dl --description "Vision Transformer implementation"
+
+# Machine Learning Project (Scikit-learn ready)
+viperx init -n churn-prediction -t ml
+```
+
+## 🧱 Structure
+
+📂 **Standard Layout**
+```text
+my-lib/
+├── pyproject.toml      # Managed by uv
+├── README.md
+├── README.md
+├── .gitignore
+└── src/
+    └── my_lib/
+        ├── __init__.py
+        ├── main.py     # Entry point
+        ├── config.yaml # Data URLs & Params
+        ├── config.py   # Loader
+        ├── .env        # Secrets (Isolated)
+        └── utils/
+            └── data_loader.py # Generic URL/CSV Loader
+```
+
+### 🧠 Machine Learning & Deep Learning
+For type `ml` or `dl`, you get:
+- **Notebooks**:
+  - `Base_Kaggle.ipynb`: Loads data via `kagglehub`.
+  - `Base_General.ipynb`: Loads data via `data_loader.py` (URL/Local).
+- **Data Loader**: `src/<pkg>/data_loader.py` handles caching downloads to `data/`.
+- **Config**: Pre-filled with "Hello World" datasets (Iris, Titanic).
+
+### ⚙️ Configurationstalls dependencies (`torch`, `pandas`...).
+
+```text
+deep-vision/
+├── pyproject.toml
+├── notebooks/
+│   └── Base.ipynb      # Pre-configured notebook (Colab/Kaggle ready)
+└── src/
+    └── deep_vision/
+        ├── ...         # Same robust package structure
+```
+
+## 💻 CLI Usage
+
+### `init` - Create a new project
+
+```bash
+viperx init [OPTIONS]
+```
+
+**Options:**
+- `-n, --name TEXT`: Project name **(Required)**.
+- `-t, --type TEXT`: Project type (`classic`, `ml`, `dl`). Default: `classic`.
+- `-d, --description TEXT`: Project description.
+- `-a, --author TEXT`: Author name (defaults to git user).
+- `-l, --license TEXT`: License type (`MIT`, `Apache-2.0`, `GPLv3`). Default: `MIT`.
+- `-f, --framework TEXT`: DL Framework (`pytorch`, `tensorflow`). Default: `pytorch` (only for `-t dl`).
+- `-v, --verbose`: Enable verbose logging for transparent output.
+
+**Examples:**
+
+```bash
+# Classic Library
+viperx init -n my-lib
+
+# Deep Learning (PyTorch Default)
+viperx init -n vision-ai -t dl
+
+# Deep Learning (TensorFlow)
+viperx init -n tf-legacy -t dl -f tensorflow
+# Deep Learning (TensorFlow)
+viperx init -n tf-legacy -t dl -f tensorflow
+
+# From Config File
+viperx init -c viperx.yaml
+```
+
+### `config` - Declarative Mode
+
+Manage your project infrastructure using a YAML file.
+
+```bash
+viperx config init
+```
+Generates a `viperx.yaml` template in the current directory.
+
+```bash
+viperx init --config viperx.yaml
+```
+Applies the configuration. This is **idempotent**:
+- Creates the project if it doesn't exist.
+- **Hydrates** the directory if it exists but is empty (e.g., git init).
+- **Updates** the workspace if the project exists (adds missing packages defined in YAML).
+
+### `package` - Manage Workspace
+
+Manage packages in your workspace hierarchy (add, update, delete).
+
+#### `add`
+Add a new package to your project. Upgrades standalone projects to workspaces automatically.
+```bash
+```bash
+viperx package add -n worker-node -t classic --no-readme
+```
+**Options:**
+- `--readme / --no-readme`: Generate a local `README.md` for the package. Default: `True`.
+- `--env / --no-env`: Generate isolated `.env` and `.env.example` in `src/<pkg>/`.
+
+#### `delete`
+Remove a package from the workspace (deletes folder & updates `pyproject.toml`).
+```bash
+viperx package delete -n worker-node
+```
+
+#### `update`
+Update a package's dependencies (runs `uv lock --upgrade`).
+```bash
+viperx package update -n worker-node
+```
+
+---## 📦 "Magical" Configuration
+
+Every project comes with a robust `config.py` using `importlib.resources`.
+
+**In your code / notebooks:**
+```python
+from my_package import SETTINGS, get_dataset_path
+
+# Works everywhere: Local, Installed, Colab, Kaggle
+print(SETTINGS['project_name'])
+```
+
+## 🤝 Contributing
+
+This project is built 100% with `uv`.
+
+1. Clone the repo
+2. Sync dependencies: `uv sync`
+3. Run the CLI: `uv run viperx`
+
+---
+*Built with ❤️ by KpihX*

viperx-0.9.5/pyproject.toml

@@ -0,0 +1,31 @@
+[project]
+name = "viperx"
+version = "0.9.5"
+description = "Professional Python Project Initializer with uv, ml/dl support, and embedded config."
+readme = "README.md"
+authors = [
+    { name = "Ivann KAMDEM", email = "kapoivha@gmail.com" }
+]
+license = { text = "MIT" }
+keywords = ["python", "project-template", "uv", "data-science", "machine-learning"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "Topic :: Software Development :: Build Tools",
+]
+requires-python = ">=3.11"
+dependencies = [
+    "gitpython>=3.1.46",
+    "jinja2>=3.1.6",
+    "rich>=14.2.0",
+    "typer>=0.21.1",
+    "pyyaml>=6.0.1",
+]
+
+[project.scripts]
+viperx = "viperx.main:app"
+
+[build-system]
+requires = ["uv_build>=0.9.21,<0.10.0"]
+build-backend = "uv_build"
+

viperx-0.9.5/src/viperx/__init__.py

@@ -0,0 +1,2 @@
+def main() -> None:
+    print("Hello from propy!")

viperx-0.9.5/src/viperx/config_engine.py

@@ -0,0 +1,141 @@
+import yaml
+from pathlib import Path
+from rich.console import Console
+from rich.panel import Panel
+
+from viperx.core import ProjectGenerator
+from viperx.constants import DEFAULT_LICENSE, DEFAULT_BUILDER, TYPE_CLASSIC, FRAMEWORK_PYTORCH
+
+console = Console()
+
+class ConfigEngine:
+    """
+    Orchestrates project creation and updates based on a declarative YAML config.
+    Implements the 'Infrastructure as Code' pattern for ViperX.
+    """
+    
+    def __init__(self, config_path: Path, verbose: bool = False):
+        self.config_path = config_path
+        self.verbose = verbose
+        self.config = self._load_config()
+        self.root_path = Path.cwd()
+
+    def _load_config(self) -> dict:
+        """Load and validate the YAML configuration."""
+        if not self.config_path.exists():
+            console.print(f"[bold red]Error:[/bold red] Config file not found at {self.config_path}")
+            raise FileNotFoundError(f"Config file not found: {self.config_path}")
+            
+        with open(self.config_path, "r") as f:
+            try:
+                data = yaml.safe_load(f)
+            except yaml.YAMLError as e:
+                console.print(f"[bold red]Error:[/bold red] Invalid YAML format: {e}")
+                raise ValueError("Invalid YAML")
+                
+        # Basic Validation
+        if "project" not in data or "name" not in data["project"]:
+            console.print("[bold red]Error:[/bold red] Config must contain 'project.name'")
+            raise ValueError("Missing project.name")
+            
+        return data
+
+    def apply(self):
+        """Apply the configuration to the current directory."""
+        project_conf = self.config.get("project", {})
+        settings_conf = self.config.get("settings", {})
+        workspace_conf = self.config.get("workspace", {})
+        
+        project_name = project_conf.get("name")
+        target_dir = self.root_path / project_name
+        
+        # 1. Root Project Handling
+        # If we are NOT already in the project dir (checking name), we might need to create it
+        # Or if we are running in the root of where `viperx init` is called.
+        
+        # Heuristic: Are we already in a folder named 'project_name'?
+        if self.root_path.name == project_name:
+            # We are inside the project folder
+            if not (self.root_path / "pyproject.toml").exists():
+                 console.print(Panel(f"⚠️  [bold yellow]Current directory matches name but is not initialized. Hydrating:[/bold yellow] {project_name}", border_style="yellow"))
+                 gen = ProjectGenerator(
+                    name=project_name,
+                    description=project_conf.get("description", ""),
+                    type=settings_conf.get("type", TYPE_CLASSIC),
+                    author=project_conf.get("author", None),
+                    license=project_conf.get("license", DEFAULT_LICENSE),
+                    builder=project_conf.get("builder", DEFAULT_BUILDER),
+                    use_env=settings_conf.get("use_env", False),
+                    use_config=settings_conf.get("use_config", True),
+                    use_tests=settings_conf.get("use_tests", True),
+                    framework=settings_conf.get("framework", FRAMEWORK_PYTORCH),
+                    verbose=self.verbose
+                )
+                 # generate() expects parent dir, and will operate on parent/name (which is self.root_path)
+                 gen.generate(self.root_path.parent)
+            else:
+                console.print(Panel(f"♻️  [bold blue]Syncing Project:[/bold blue] {project_name}", border_style="blue"))
+            current_root = self.root_path
+        else:
+            # We are outside, check if it exists
+            if target_dir.exists() and (target_dir / "pyproject.toml").exists():
+                console.print(Panel(f"♻️  [bold blue]Updating Existing Project:[/bold blue] {project_name}", border_style="blue"))
+                current_root = target_dir
+            else:
+                if target_dir.exists():
+                     console.print(Panel(f"⚠️  [bold yellow]Directory exists but not initialized. Hydrating:[/bold yellow] {project_name}", border_style="yellow"))
+                else:
+                     console.print(Panel(f"🚀 [bold green]Creating New Project:[/bold green] {project_name}", border_style="green"))
+                
+                # Create Root (or Hydrate)
+                gen = ProjectGenerator(
+                    name=project_name,
+                    description=project_conf.get("description", ""),
+                    type=settings_conf.get("type", TYPE_CLASSIC),
+                    author=project_conf.get("author", None),
+                    license=project_conf.get("license", DEFAULT_LICENSE),
+                    builder=project_conf.get("builder", DEFAULT_BUILDER),
+                    use_env=settings_conf.get("use_env", False),
+                    use_config=settings_conf.get("use_config", True),
+                    use_tests=settings_conf.get("use_tests", True),
+                    framework=settings_conf.get("framework", FRAMEWORK_PYTORCH),
+                    verbose=self.verbose
+                )
+                gen.generate(self.root_path)
+                current_root = target_dir
+        
+        # 2. Copy Config to Root (Source of Truth)
+        # Only if we aren't reading the one already there
+        system_config_path = current_root / "viperx.yaml"
+        if self.config_path.absolute() != system_config_path.absolute():
+            import shutil
+            shutil.copy2(self.config_path, system_config_path)
+            console.print(f"[dim]Saved configuration to {system_config_path.name}[/dim]")
+
+        # 3. Handle Workspace Packages
+        packages = workspace_conf.get("packages", [])
+        if packages:
+            console.print(f"\n📦 [bold]Processing {len(packages)} workspace packages...[/bold]")
+            
+            for pkg in packages:
+                pkg_name = pkg.get("name")
+                pkg_path = current_root / "src" / pkg_name.replace("-", "_") # Approximate check
+                
+                # We instantiate a generator for this package
+                pkg_gen = ProjectGenerator(
+                    name=pkg_name,
+                    description=pkg.get("description", ""),
+                    type=pkg.get("type", TYPE_CLASSIC),
+                    author=project_conf.get("author", "Your Name"), # Inherit author
+                    use_env=pkg.get("use_env", settings_conf.get("use_env", False)),     # Inherit settings or default False
+                    use_config=pkg.get("use_config", settings_conf.get("use_config", True)), # Inherit or default True
+                    use_readme=pkg.get("use_readme", True),
+                    use_tests=pkg.get("use_tests", settings_conf.get("use_tests", True)),
+                    framework=pkg.get("framework", FRAMEWORK_PYTORCH),
+                    verbose=self.verbose
+                )
+                
+                # Check if package seems to exist (ProjectGenerator handles upgrade logic too)
+                pkg_gen.add_to_workspace(current_root)
+
+        console.print(Panel(f"✨ [bold green]Configuration Applied Successfully![/bold green]\nProject is up to date with {self.config_path.name}", border_style="green"))

viperx-0.9.5/src/viperx/constants.py

@@ -0,0 +1,35 @@
+from pathlib import Path
+
+# Project Defaults
+DEFAULT_VERSION = "0.1.0"
+DEFAULT_PYTHON_VERSION = "3.11"
+DEFAULT_LICENSE = "MIT"
+DEFAULT_BUILDER = "uv"
+
+# File Names
+CONFIG_FILENAME = "config.yaml"
+PYPROJECT_FILENAME = "pyproject.toml"
+PACKAGE_NAME = "viperx"
+README_FILENAME = "README.md"
+INIT_FILENAME = "__init__.py"
+MAIN_FILENAME = "main.py"
+
+# Directory Names
+SRC_DIR = "src"
+NOTEBOOKS_DIR = "notebooks"
+TESTS_DIR = "tests"
+
+# Templates
+TEMPLATE_DIR_NAME = "templates"
+TEMPLATES_DIR = Path(__file__).parent / TEMPLATE_DIR_NAME
+
+# Types
+TYPE_CLASSIC = "classic"
+TYPE_ML = "ml"
+TYPE_DL = "dl"
+PROJECT_TYPES = [TYPE_CLASSIC, TYPE_ML, TYPE_DL]
+
+# DL Frameworks
+FRAMEWORK_PYTORCH = "pytorch"
+FRAMEWORK_TENSORFLOW = "tensorflow"
+DL_FRAMEWORKS = [FRAMEWORK_PYTORCH, FRAMEWORK_TENSORFLOW]