dz-devkit-cli 0.1.0__py3-none-any.whl

devkit/__init__.py

@@ -0,0 +1,8 @@
+# Copyright (c) 2026 Oussama Boudinar <lionweb01@gmail.com>
+# SPDX-License-Identifier: MIT
+"""DevKit — a modern CLI toolkit for developers."""
+
+__version__ = "0.1.0"
+__author__ = "Oussama Boudinar"
+__email__ = "lionweb01@gmail.com"
+__license__ = "MIT"

devkit/cli.py

@@ -0,0 +1,23 @@
+# Copyright (c) 2026 Oussama Boudinar <lionweb01@gmail.com>
+# SPDX-License-Identifier: MIT
+"""Entry point for the DevKit CLI."""
+
+import click
+
+from devkit.commands import git_stats, organize, scaffold
+
+
+@click.group()
+@click.version_option(package_name="devkit-cli")
+def main() -> None:
+    """DevKit — a modern CLI toolkit for developers."""
+    pass
+
+
+main.add_command(organize.organize)
+main.add_command(scaffold.scaffold)
+main.add_command(git_stats.git_stats)
+
+
+if __name__ == "__main__":
+    main()

devkit/commands/__init__.py

@@ -0,0 +1,3 @@
+# Copyright (c) 2026 Oussama Boudinar <lionweb01@gmail.com>
+# SPDX-License-Identifier: MIT
+"""DevKit subcommands."""

devkit/commands/git_stats.py

@@ -0,0 +1,50 @@
+# Copyright (c) 2026 Oussama Boudinar <lionweb01@gmail.com>
+# SPDX-License-Identifier: MIT
+"""Show quick statistics for a git repository."""
+
+import subprocess
+from pathlib import Path
+
+import click
+from rich.console import Console
+from rich.table import Table
+
+console = Console()
+
+
+def _git(path: Path, *args: str) -> str:
+    return subprocess.check_output(
+        ["git", "-C", str(path), *args], text=True
+    ).strip()
+
+
+@click.command()
+@click.argument(
+    "path",
+    type=click.Path(exists=True, file_okay=False, path_type=Path),
+    default=".",
+)
+def git_stats(path: Path) -> None:
+    """Show git statistics for the repository in PATH."""
+    if not (path / ".git").exists():
+        console.print(f"[red]✗[/] No git repository found in {path}")
+        raise SystemExit(1)
+
+    try:
+        branch = _git(path, "rev-parse", "--abbrev-ref", "HEAD")
+        commits = _git(path, "rev-list", "--count", "HEAD")
+        last_commit = _git(path, "log", "-1", "--pretty=%s")
+        author = _git(path, "log", "-1", "--pretty=%an")
+    except subprocess.CalledProcessError:
+        console.print("[red]✗[/] Failed to read git history.")
+        raise SystemExit(1)
+
+    table = Table(title=f"Git Stats — {path.resolve().name}")
+    table.add_column("Metric", style="cyan", no_wrap=True)
+    table.add_column("Value", style="green")
+    table.add_row("Branch", branch)
+    table.add_row("Total commits", commits)
+    table.add_row("Last commit", last_commit)
+    table.add_row("Last author", author)
+
+    console.print(table)

devkit/commands/organize.py

@@ -0,0 +1,52 @@
+# Copyright (c) 2026 Oussama Boudinar <lionweb01@gmail.com>
+# SPDX-License-Identifier: MIT
+"""Organize files in a directory into category folders."""
+
+import shutil
+from pathlib import Path
+
+import click
+from rich.console import Console
+
+console = Console()
+
+CATEGORIES: dict[str, list[str]] = {
+    "Images": [".jpg", ".jpeg", ".png", ".gif", ".svg", ".webp", ".bmp"],
+    "Documents": [".pdf", ".doc", ".docx", ".txt", ".md", ".odt", ".xlsx", ".pptx"],
+    "Videos": [".mp4", ".mkv", ".avi", ".mov", ".webm"],
+    "Audio": [".mp3", ".wav", ".flac", ".ogg", ".m4a"],
+    "Archives": [".zip", ".rar", ".7z", ".tar", ".gz"],
+    "Code": [".py", ".js", ".ts", ".html", ".css", ".json", ".yml", ".yaml", ".sh"],
+}
+
+
+@click.command()
+@click.argument("path", type=click.Path(exists=True, file_okay=False, path_type=Path))
+@click.option("--dry-run", is_flag=True, help="Preview changes without moving files.")
+def organize(path: Path, dry_run: bool) -> None:
+    """Organize files in PATH into category folders."""
+    console.print(f"[bold cyan]Organizing:[/] {path}")
+    if dry_run:
+        console.print("[yellow]Dry-run mode — no files will be moved.[/]")
+
+    moved = 0
+    for file in sorted(path.iterdir()):
+        if not file.is_file():
+            continue
+
+        category = next(
+            (cat for cat, exts in CATEGORIES.items() if file.suffix.lower() in exts),
+            "Other",
+        )
+        target_dir = path / category
+
+        if dry_run:
+            console.print(f"  [dim]→[/] {file.name}  →  {category}/")
+        else:
+            target_dir.mkdir(exist_ok=True)
+            shutil.move(str(file), str(target_dir / file.name))
+
+        moved += 1
+
+    verb = "Would move" if dry_run else "Moved"
+    console.print(f"[green]✓[/] {verb} {moved} file(s).")

devkit/commands/scaffold.py

@@ -0,0 +1,64 @@
+# Copyright (c) 2026 Oussama Boudinar <lionweb01@gmail.com>
+# SPDX-License-Identifier: MIT
+"""Scaffold new projects from built-in templates."""
+
+from pathlib import Path
+
+import click
+from rich.console import Console
+
+console = Console()
+
+TEMPLATES: dict[str, dict[str, str]] = {
+    "web": {
+        "index.html": (
+            "<!DOCTYPE html>\n<html lang=\"en\">\n<head>\n"
+            "  <meta charset=\"UTF-8\" />\n"
+            "  <meta name=\"viewport\" content=\"width=device-width, initial-scale=1.0\" />\n"
+            "  <title>New Project</title>\n"
+            "  <link rel=\"stylesheet\" href=\"style.css\" />\n"
+            "</head>\n<body>\n  <h1>Hello, world!</h1>\n"
+            "  <script src=\"script.js\"></script>\n</body>\n</html>\n"
+        ),
+        "style.css": "body {\n  font-family: system-ui, sans-serif;\n  margin: 2rem;\n}\n",
+        "script.js": "console.log('Ready.');\n",
+    },
+    "python-cli": {
+        "main.py": (
+            "import click\n\n\n"
+            "@click.command()\n"
+            "def main() -> None:\n"
+            '    """My CLI tool."""\n'
+            "    click.echo('Hello!')\n\n\n"
+            'if __name__ == "__main__":\n'
+            "    main()\n"
+        ),
+        "requirements.txt": "click>=8.1.0\n",
+    },
+}
+
+
+@click.command()
+@click.argument("name")
+@click.option(
+    "--type",
+    "template",
+    type=click.Choice(TEMPLATES.keys()),
+    default="web",
+    show_default=True,
+)
+def scaffold(name: str, template: str) -> None:
+    """Create a new project NAME from a template."""
+    target = Path(name)
+    if target.exists():
+        console.print(f"[red]✗[/] Directory '{name}' already exists.")
+        raise SystemExit(1)
+
+    files = TEMPLATES[template]
+    for filename, content in files.items():
+        file_path = target / filename
+        file_path.parent.mkdir(parents=True, exist_ok=True)
+        file_path.write_text(content)
+
+    console.print(f"[green]✓[/] Created '{name}' ({template}) — {len(files)} file(s).")
+    console.print(f"[dim]  cd {name}[/]")

dz_devkit_cli-0.1.0.dist-info/METADATA

@@ -0,0 +1,342 @@
+Metadata-Version: 2.4
+Name: dz-devkit-cli
+Version: 0.1.0
+Summary: A modern CLI toolkit for developers: organize files, scaffold projects, inspect git repos.
+Author-email: Oussama Boudinar <lionweb01@gmail.com>
+Maintainer-email: Oussama Boudinar <lionweb01@gmail.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/dzopensource-lab/devkit-cli
+Project-URL: Repository, https://github.com/dzopensource-lab/devkit-cli
+Project-URL: Issues, https://github.com/dzopensource-lab/devkit-cli/issues
+Keywords: cli,developer-tools,productivity,python
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: click>=8.1.0
+Requires-Dist: rich>=13.0.0
+Dynamic: license-file
+
+markdown
+
+# 🛠️ DevKit CLI
+
+**A modern CLI toolkit for developers — organize files, scaffold projects, and inspect git repositories. All in one command.**
+
+[![Tests](https://github.com/dzopensource-lab/devkit-cli/actions/workflows/test.yml/badge.svg)](https://github.com/dzopensource-lab/devkit-cli/actions/workflows/test.yml)
+[![Python](https://img.shields.io/badge/Python-3.9%2B-3776AB?style=flat&logo=python&logoColor=white)](https://www.python.org/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
+
+> Stop wasting time on repetitive tasks. `devkit` handles the boring stuff so you can focus on writing code.
+
+---
+
+## 🎬 Quick Start (60 seconds)
+
+```bash
+# 1. Clone and install
+git clone https://github.com/dzopensource-lab/devkit-cli.git
+cd devkit-cli
+pip install -e .
+
+# 2. Try it immediately
+devkit organize ~/Downloads --dry-run
+devkit scaffold my-new-project --type web
+devkit git-stats
+
+That's it. You're ready to go. 🚀
+📖 What is DevKit?
+
+devkit is a command-line toolkit that solves three daily problems every developer faces:
+Problem	Solution	Command
+🗂️ "My Downloads folder is a mess"	Auto-sort files into categories	devkit organize
+🧱 "I waste 10 minutes setting up every new project"	Generate project structure instantly	devkit scaffold
+📊 "I forget my repo's commit count and current branch"	See git stats in one command	devkit git-stats
+✨ Features
+
+    📂 Smart file organizer — Sorts files into Images/, Documents/, Code/, Audio/, Videos/, Archives/ automatically
+
+    🧱 Project scaffolder — Creates ready-to-use templates for web and python-cli projects
+
+    📊 Git inspector — Quick overview: branch, commit count, last author, last commit message
+
+    🎨 Beautiful terminal output — Colors, tables, and clear feedback powered by rich
+
+    🛡️ Safe by default — --dry-run mode lets you preview changes before executing
+
+    🧪 Tested — Fully covered by pytest and GitHub Actions CI
+
+    ⚡ Fast — No dependencies beyond click and rich
+
+🚀 Installation
+Option 1: Install from source (recommended for now)
+bash
+
+git clone https://github.com/dzopensource-lab/devkit-cli.git
+cd devkit-cli
+pip install -e .
+
+Option 2: Install from PyPI (coming soon)
+bash
+
+pip install devkit-cli
+
+Verify installation
+bash
+
+devkit --version
+# devkit-cli, version 0.1.0
+
+devkit --help
+# Usage: devkit [OPTIONS] COMMAND [ARGS]...
+
+📚 Commands Reference
+📂 devkit organize — Sort files into folders
+
+Syntax:
+bash
+
+devkit organize <PATH> [--dry-run]
+
+What it does:
+Scans the folder <PATH> and moves files into categorized subfolders based on their extension.
+
+Categories:
+Folder	Extensions
+Images/	.jpg, .jpeg, .png, .gif, .svg, .webp, .bmp
+Documents/	.pdf, .doc, .docx, .txt, .md, .odt, .xlsx, .pptx
+Videos/	.mp4, .mkv, .avi, .mov, .webm
+Audio/	.mp3, .wav, .flac, .ogg, .m4a
+Archives/	.zip, .rar, .7z, .tar, .gz
+Code/	.py, .js, .ts, .html, .css, .json, .yml, .yaml, .sh
+Other/	Everything else
+
+Example:
+
+Before:
+text
+
+Downloads/
+├── photo.jpg
+├── report.pdf
+├── song.mp3
+├── project.zip
+└── script.py
+
+Run:
+bash
+
+devkit organize ~/Downloads
+
+After:
+text
+
+Downloads/
+├── Images/
+│   └── photo.jpg
+├── Documents/
+│   └── report.pdf
+├── Audio/
+│   └── song.mp3
+├── Archives/
+│   └── project.zip
+└── Code/
+    └── script.py
+
+Safe preview:
+bash
+
+devkit organize ~/Downloads --dry-run
+
+Shows what would happen without moving anything. Always use this first!
+🧱 devkit scaffold — Create a new project
+
+Syntax:
+bash
+
+devkit scaffold <NAME> [--type web|python-cli]
+
+What it does:
+Creates a new folder <NAME> with a ready-to-use starter template.
+
+Available templates:
+Template 1: web (default)
+
+Creates:
+
+    index.html — Starter HTML5 page
+
+    style.css — Basic styles
+
+    script.js — Starter JS file
+
+bash
+
+devkit scaffold my-website
+
+Output:
+text
+
+my-website/
+├── index.html
+├── style.css
+└── script.js
+
+Template 2: python-cli
+
+Creates:
+
+    main.py — CLI starter using click
+
+    requirements.txt — Dependencies
+
+bash
+
+devkit scaffold my-tool --type python-cli
+
+Output:
+text
+
+my-tool/
+├── main.py
+└── requirements.txt
+
+📊 devkit git-stats — Inspect a git repository
+
+Syntax:
+bash
+
+devkit git-stats [PATH]
+
+What it does:
+Displays key statistics about a git repository in a formatted table.
+
+Example:
+bash
+
+devkit git-stats
+
+Output:
+text
+
+        Git Stats — devkit-cli
+┏━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
+┃ Metric        ┃ Value                        ┃
+┡━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
+│ Branch        │ main                         │
+│ Total commits │ 5                            │
+│ Last commit   │ feat: add clean command      │
+│ Last author   │ Oussama Boudinar             │
+└───────────────┴──────────────────────────────┘
+
+On another repo:
+bash
+
+devkit git-stats /path/to/any/repo
+
+💡 Use Cases
+Use Case 1: Monthly Downloads cleanup
+bash
+
+devkit organize ~/Downloads
+
+Use Case 2: Start a new web project instantly
+bash
+
+devkit scaffold my-landing-page
+cd my-landing-page
+# Open in browser, start coding!
+
+Use Case 3: Quick repo status before a standup meeting
+bash
+
+devkit git-stats
+
+🗂️ Project Structure
+text
+
+devkit-cli/
+├── devkit/
+│   ├── __init__.py           # Package metadata
+│   ├── cli.py                # Main entry point (Click group)
+│   └── commands/
+│       ├── organize.py       # File organizer command
+│       ├── scaffold.py       # Project scaffolder command
+│       └── git_stats.py      # Git stats command
+├── tests/
+│   └── test_cli.py           # Basic tests
+├── .github/
+│   └── workflows/
+│       └── test.yml          # CI pipeline
+├── docs/
+│   ├── quickstart.md         # 60-second guide
+│   ├── commands.md           # Full command reference
+│   └── examples.md           # Real-world examples
+├── pyproject.toml            # Package config
+├── README.md                 # This file
+├── CONTRIBUTING.md           # How to contribute
+├── CHANGELOG.md              # Version history
+└── LICENSE                   # MIT License
+
+🛡️ Safety Notes
+⚠️ Warning	Reason
+Always run --dry-run first on organize	To preview before moving files
+Don't organize system folders (C:\Windows, Program Files)	May require permissions and break the system
+Backup important folders before organizing	Though safe, always be careful
+🤝 Contributing
+
+See CONTRIBUTING.md for guidelines.
+
+Quick version:
+
+    Fork the repo
+
+    Create a branch: git checkout -b feature/my-feature
+
+    Make changes + add tests
+
+    Push and open a Pull Request
+
+🧪 Testing
+bash
+
+pytest
+pytest -v
+
+🗺️ Roadmap
+
+    ☑
+
+    organize — Sort files into categories
+    ☑
+
+    scaffold — Create project templates
+    ☑
+
+    git-stats — Show repository statistics
+    ☑
+
+    GitHub Actions CI
+    ☑
+
+    clean command — Remove node_modules, __pycache__, .venv
+    ☑
+
+    organize --recursive — Support subfolders
+    ☑
+
+    Custom categories from devkit.toml
+    ☑
+
+    More scaffold templates (react, fastapi, vue)
+    ☑
+
+    Publish to PyPI
+
+📄 License
+
+MIT © 2026 Oussama Boudinar lionweb01@gmail.com — dzopensource-lab
+⭐ Show your support
+
+If devkit helped you, please give it a ⭐ on GitHub — it means a lot!

dz_devkit_cli-0.1.0.dist-info/RECORD

@@ -0,0 +1,12 @@
+devkit/__init__.py,sha256=Z3I1hx3ykVY3PSjE3KhcQwMPBBcvCPX6SJveY89atCQ,260
+devkit/cli.py,sha256=iIr8TVjnLr0Zbo5bUx7c_lvU_bfj0mUt9C4Dl0_eNDI,528
+devkit/commands/__init__.py,sha256=Ya6dNnnWAWnD8CXIResD2gMHLFvnAUVBTQC2J93iMS8,118
+devkit/commands/git_stats.py,sha256=sZRfXhZCLiKGjO7Ax2Ohmw66ZkSbScHHC0ljucinnHY,1588
+devkit/commands/organize.py,sha256=rEu-ashLAlIKV9EjBFmcbuznNnEIZlQAK8nYxFkCH7o,1840
+devkit/commands/scaffold.py,sha256=sJnlK6iuixqdCYMcR6Tpqd1_ZgbUSiqzURxqS_Tu0aA,2112
+dz_devkit_cli-0.1.0.dist-info/licenses/LICENSE,sha256=iobIM_H-i8CbCtcWlsvlKWvf78zL2eNmU8PR0gV5hL8,1112
+dz_devkit_cli-0.1.0.dist-info/METADATA,sha256=YwGu2EUrqisXpMHqL94FsG-msFiYILbcmfXKOG-jPqw,8946
+dz_devkit_cli-0.1.0.dist-info/WHEEL,sha256=mOdXR9C3wMVov7cSY8PY-XCzo3SmmWCHvGQr5csJoao,91
+dz_devkit_cli-0.1.0.dist-info/entry_points.txt,sha256=cp9XH93n8MQocJk2pIMbetXCda8C5_ZaDI375co9FyU,43
+dz_devkit_cli-0.1.0.dist-info/top_level.txt,sha256=5-7qWb-lawQBFJmCyx9FZJkWasklwAPxD0_0PaRkBlY,7
+dz_devkit_cli-0.1.0.dist-info/RECORD,,

dz_devkit_cli-0.1.0.dist-info/WHEEL

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

dz_devkit_cli-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+devkit = devkit.cli:main

dz_devkit_cli-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Oussama Boudinar lionweb01@gmail.com
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

dz_devkit_cli-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+devkit