viperx 0.9.14__py3-none-any.whl

viperx/utils.py

@@ -0,0 +1,47 @@
+import re
+import shutil
+import subprocess
+from rich.console import Console
+
+console = Console()
+
+def check_uv_installed() -> bool:
+    """Check if 'uv' is installed and accessible."""
+    return shutil.which("uv") is not None
+
+def sanitize_project_name(name: str) -> str:
+    """
+    Sanitize the project name to be a valid Python package name.
+    Replaces hyphens with underscores and removes invalid characters.
+    """
+    # Replace - with _
+    name = name.replace("-", "_")
+    # Remove any characters that aren't alphanumerics or underscores
+    name = re.sub(r"[^a-zA-Z0-9_]", "", name)
+    # Ensure it starts with a letter or underscore
+    if not re.match(r"^[a-zA-Z_]", name):
+        name = f"_{name}"
+    return name.lower()
+
+def validate_project_name(ctx, param, value):
+    """
+    Typer callback to validate project name.
+    """
+    if not re.match(r"^[a-zA-Z0-9_-]+$", value):
+        from typer import BadParameter
+        raise BadParameter("Project name must contain only letters, numbers, underscores, and hyphens.")
+    return value
+
+def get_author_from_git() -> tuple[str, str]:
+    """
+    Attempt to get author name and email from git config.
+    Returns (name, email) or defaults.
+    """
+    try:
+        import git
+        config = git.GitConfigParser(git.GitConfigParser.get_global_config(), read_only=True)
+        name = config.get("user", "name", fallback="Your Name")
+        email = config.get("user", "email", fallback="your.email@example.com")
+        return name, email
+    except Exception:
+        return "Your Name", "your.email@example.com"

viperx-0.9.14.dist-info/METADATA

@@ -0,0 +1,236 @@
+Metadata-Version: 2.3
+Name: viperx
+Version: 0.9.14
+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 get                   # 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 get
+```
+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.14.dist-info/RECORD

@@ -0,0 +1,22 @@
+viperx/__init__.py,sha256=mRrD-SK9PtwBhqgLzJrvefdViNsXCyBGknzFNsIou1I,51
+viperx/config_engine.py,sha256=Fzb5F3rE7BqcnpAdu6QhN28tfQNTuBHI04YuR1B7cHM,7340
+viperx/constants.py,sha256=BMogG1-ik67YeheQdCgjsdS5FNFYiLfdro6utCWwczY,784
+viperx/core.py,sha256=dOLLPxBohYN6A5i1BnT5gx35x6x5n40yYYGm6yEZKHM,18733
+viperx/licenses.py,sha256=TPsG1aqNAjtOsvuD6i3SiC5rUK9f3DslPHQkKiV7vxs,12482
+viperx/main.py,sha256=B8Z6bjESFKFvL80NJcfPGgYycxQP3NwLhKtJDtaj1Zc,9856
+viperx/templates/Base.ipynb.j2,sha256=rlGCw7jIds3RiXFrG8D8oAjzXzzj1cayKjBI91k-1kA,3140
+viperx/templates/Base_General.ipynb.j2,sha256=f5ZUu65khtvBeCofs3Lvzccn5Krl0nRGu0dv7SzLvzg,2716
+viperx/templates/Base_Kaggle.ipynb.j2,sha256=gPkmFt4cA5UzhRU_gLZ1UzSjEa7Mgel001Eqiw94-fc,2698
+viperx/templates/README.md.j2,sha256=TJNUwTcKnjALrP0MOSs8UBx8zNhI8erRHrc2-8nuMgQ,3445
+viperx/templates/__init__.py.j2,sha256=uq8IYd0SGYX2-cpGb9q5197eYs-ode-g5y2NCGWU5YM,196
+viperx/templates/config.py.j2,sha256=sU6bwiA0eW7g0d9Y_rhxSd-6LcMUyYiZKBhcF_OJcxM,1409
+viperx/templates/config.yaml.j2,sha256=IYvjQUioZ9lyzVHVDgwrdjgM6s4pUnCFXwtnydoKe2k,485
+viperx/templates/data_loader.py.j2,sha256=hehewwvBAYJM-acKn6_T4cU5EvUPX7wHAurAQ3z3ET4,3696
+viperx/templates/main.py.j2,sha256=caGN54Hck_EcwT3Aqju52CBuGujSnzU2Hehw8mowzjI,277
+viperx/templates/pyproject.toml.j2,sha256=RnJm7BinT-p646BiC2gxOTBuIX0nmRM7BUqt0n981io,1434
+viperx/templates/viperx_config.yaml.j2,sha256=dZ5GtiGRWT_FOsMeF1YUjqL5wHO0y0i38gqU-lwrVSQ,1379
+viperx/utils.py,sha256=2kiQLDHsPcCELEKeQYbIkSL8e3HhW4pRzw1pUth6hYA,1583
+viperx-0.9.14.dist-info/WHEEL,sha256=RRVLqVugUmFOqBedBFAmA4bsgFcROUBiSUKlERi0Hcg,79
+viperx-0.9.14.dist-info/entry_points.txt,sha256=Is38BrTuf6unQCLgDE990Rjd9HyGldBSw4Uzy_nMePY,44
+viperx-0.9.14.dist-info/METADATA,sha256=OC8UDqEikK2-pU1RKt02YGRbKtsLvg0p-7OFGzvzXKA,6782
+viperx-0.9.14.dist-info/RECORD,,

viperx-0.9.14.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: uv 0.9.21
+Root-Is-Purelib: true
+Tag: py3-none-any

viperx-0.9.14.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+viperx = viperx.main:app
+