repopy 0.2.0__tar.gz → 0.3.1__tar.gz

{repopy-0.2.0/src/repopy.egg-info → repopy-0.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: repopy
-Version: 0.2.0
+Version: 0.3.1
 Summary: A modular CLI workspace initializer and cloning automation tool.
 Author-email: Janitha Manatunga <janithamanatunga@gmail.com>
 License: MIT
@@ -28,25 +28,29 @@ Dynamic: license-file
 A modular, cross-platform Python CLI workspace manager and developer tooling suite designed to automate reproducible local scaffolding, virtual environment creation, and remote repository synchronization.
 
 ![PyPI - Version](https://img.shields.io/pypi/v/repopy?color=orange)&nbsp;&nbsp;&nbsp;
+[![License: MIT](https://img.shields.io/pypi/l/repopy.svg)](https://opensource.org/license/mit)&nbsp;&nbsp;&nbsp;
+[![Python Versions](https://img.shields.io/pypi/pyversions/repopy.svg)](https://pypi.org)
+
 [![CI](https://github.com/manatunga/repopy/actions/workflows/tests.yml/badge.svg)](https://github.com/manatunga/repopy/actions/workflows/tests.yml)&nbsp;&nbsp;&nbsp;
-[![Python Versions](https://img.shields.io/pypi/pyversions/repopy.svg)](https://pypi.org)&nbsp;&nbsp;&nbsp;
-[![License: MIT](https://img.shields.io/pypi/l/repopy.svg)](https://opensource.org/license/mit)
+[![codecov](https://codecov.io/github/manatunga/repopy/graph/badge.svg?token=2JRECANC1G)](https://codecov.io/github/manatunga/repopy)&nbsp;&nbsp;&nbsp;
+[![type checked - mypy](https://img.shields.io/badge/type--checked-mypy-blue?logo=python)](https://mypy-lang.org)&nbsp;&nbsp;&nbsp;
+[![Ruff](https://custom-icon-badges.demolab.com/badge/Ruff-261230.svg?logo=ruff-logo)](#)
 
 ---
 
 ## 🌟 Key Features
 
-- **Lifecycle Project Scaffolding (`repopy init`)**: Replaces manual setup by provisioning clean directory structures, virtual environments, automated `.gitignore` presets, and standardized metadata configurations (`pyproject.toml` or `requirements.txt`).
+- **Lifecycle Project Scaffolding (`repopy init`)**: Provisions clean directory structures, dedicated virtual environments, automated `.gitignore` templates, and PEP 621 `pyproject.toml` or `requirements.txt` configs.
 
-- **Remote Cloning (`repopy clone`)**: Clones remote Git repositories into structured local footprints and auto-provisions dedicated virtual environments and dependencies.
+- **Smart Remote Cloning (`repopy clone`)**: Clones remote Git repositories, creates isolated `.venv` environments, previews declared dependencies, and installs them interactively or via flags.
 
 - **Upstream Linking (`repopy link`)**: Instantly connects an unlinked local workspace to a remote Git upstream, staging files, executing initial commits, and pushing to the default branch in one step.
 
-- **Architectural Themes**: Supports presets (`minimal`, `web_api`, `cli_package`, `data_science`) tailored to the specific packaging needs of the application.
+- **Architectural Themes**: Built-in layout presets (`minimal`, `web_api`, `cli_package`, `data_science`) tailored to modern packaging standards.
 
-- **Transactional Cleanups**: Employs defensive rollback mechanisms (`shutil.rmtree`) to purge incomplete workspaces if initialization fails midway.
+- **Transactional Cleanups**: Employs defensive rollback mechanisms (`shutil.rmtree`) to safely purge half-baked directories if setup fails midway.
 
-- **Automated Test Suite & CI**: Fully covered by local `pytest` test suites and verified via continuous integration on GitHub Actions.
+- **Isolated & Tested**: Fully decoupled architecture backed by comprehensive unit and mock test suites.
 
 ---
 
@@ -55,11 +59,11 @@ A modular, cross-platform Python CLI workspace manager and developer tooling sui
 `repopy` is organized into single-responsibility layers:
 - **Presentation & Routing (`cli.py`, `prompts.py`, `__main__.py`)**: Evaluates native terminal arguments via `argparse`, orchestrates interactive prompt flows, and handles OS interrupts gracefully.
 
-- **Supervision (`orchestrators.py`)**: Broker layer executing lifecycle validation checks, branch sequencing, and command handoffs.
+- **Supervision (`orchestrators.py`)**: Broker layer executing lifecycle validation checks, branch sequencing, rollback triggers and command handoffs.
 
-- **Low-Level Engines (`file_system.py`, `git_engine.py`)**: Decoupled engines handling transactional directory allocations, venv isolation, and direct subprocess execution.
+- **Low-Level Engines (`file_system.py`, `git_engine.py`)**: Decoupled engines handling transactional directory allocations, venv isolation, dependency installation and direct subprocess execution.
 
-- **Validation & Translation (`validators.py`, `dependencies.py`, `os_detector.py`)**: Sanitizes paths, ensures semantic regex compliance, verifies system binaries (such as `git`), and resolves cross-platform paths.
+- **Validation & Translation (`validators.py`, `dependencies.py`, `os_detector.py`)**: Sanitizes names and paths, validates Git URLs, verifies host binaries (`python`, `git`), and resolves cross-platform paths.
 
 ---
 
@@ -100,15 +104,25 @@ repopy init my-cli -t cli_package --link <git-url>
 - `minimal`: Bare directory setup with `requirements.txt`.
 - `web_api`: Layered service layout prepared for modern frameworks.
 - `cli_package`: Modular structure configured with PEP 621 compliant `pyproject.toml`.
-- `data_science`: Notebooks, data folders, and pipeline layouts.
-<br>
+- `data_science`: Notebooks, data directories (raw, processed), and pipeline layout.
+
 <br>
 
 ### 2. Clone a Remote Project (`repopy clone`)
-Fetch a remote repository and immediately auto-provision an isolated `.venv`:
+Fetch a remote repository, provision a virtual environment, and manage dependencies:
 
 ```bash
-repopy clone <git-url> -n [custom-project-name]
+# Interactive mode (previews requirements.txt and prompts for installation)
+repopy clone <git-url>
+
+# Custom directory name
+repopy clone <git-url> -n custom-folder-name
+
+# Auto-install dependencies without prompting
+repopy clone <git-url> -i
+
+# Fetch and provision environment only (skip dependency installation)
+repopy clone <git-url> --no-install
 ```
 
 <br>
@@ -117,7 +131,11 @@ repopy clone <git-url> -n [custom-project-name]
 Run inside an existing workspace to push tracking history to an upstream origin:
 
 ```bash
-repopy link <git-url> -m ["custom-initial-commit-message"]
+# Link with default initial commit message
+repopy link <git-url>
+
+# Link with custom commit message
+repopy link <git-url> -m "feat: initial project structure"
 ```
 
 ---
@@ -130,8 +148,6 @@ Run the test suite using `pytest`:
 pytest -v
 ```
 
-All contributions and pull requests are validated through our GitHub Actions workflow matrix (`.github/workflows/tests.yml`), running integration and validation tests across supported Python versions.
-
 ---
 
 ## 🗂️ Project Structure
@@ -155,7 +171,16 @@ repopy/
 │       ├── templates.py         # Static asset definitions & manifests
 │       └── validators.py        # Input sanitation & regex filters
 ├── tests/
+|   ├── __init__.py
+│   ├── test_cli.py              # CLI argument parser & flag exclusivity tests
+│   ├── test_dependencies.py     # Binary detection & absence verification tests
+│   ├── test_file_system.py      # Workspace scaffolding & requirements parsing tests
+│   ├── test_git_engine.py       # Subprocess Git mocking & exit code tests
+│   ├── test_main.py             # CLI dispatching & interrupt lifecycle tests
+│   ├── test_orchestrators.py    # Pipeline logic, prompts, and rollback tests
+│   ├── test_os_detector.py      # Cross-platform path resolution tests
 │   ├── test_prompts.py          # Input loop & default manifest tests
+│   ├── test_templates.py        # PEP 621 generator & asset template tests
 │   └── test_validators.py       # Path and schema validation tests
 ├── pyproject.toml               # PEP 621 packaging configuration
 ├── LICENSE                      # MIT License
@@ -167,10 +192,3 @@ repopy/
 ## 📄 License
 
 Distributed under the MIT License. See `LICENSE` for details.
-
----
-
-## Key Review Notes
-
-* Verify the GitHub Actions workflow file path (`.github/workflows/tests.yml`) matches your actual workflow file name so the build badge renders correctly.
-* In the `repopy init` theme section, verify that the theme descriptions match what you have mapped out in `templates.py`.

{repopy-0.2.0 → repopy-0.3.1}/README.md

@@ -3,25 +3,29 @@
 A modular, cross-platform Python CLI workspace manager and developer tooling suite designed to automate reproducible local scaffolding, virtual environment creation, and remote repository synchronization.
 
 ![PyPI - Version](https://img.shields.io/pypi/v/repopy?color=orange)   
+[![License: MIT](https://img.shields.io/pypi/l/repopy.svg)](https://opensource.org/license/mit)   
+[![Python Versions](https://img.shields.io/pypi/pyversions/repopy.svg)](https://pypi.org)
+
 [![CI](https://github.com/manatunga/repopy/actions/workflows/tests.yml/badge.svg)](https://github.com/manatunga/repopy/actions/workflows/tests.yml)   
-[![Python Versions](https://img.shields.io/pypi/pyversions/repopy.svg)](https://pypi.org)   
-[![License: MIT](https://img.shields.io/pypi/l/repopy.svg)](https://opensource.org/license/mit)
+[![codecov](https://codecov.io/github/manatunga/repopy/graph/badge.svg?token=2JRECANC1G)](https://codecov.io/github/manatunga/repopy)   
+[![type checked - mypy](https://img.shields.io/badge/type--checked-mypy-blue?logo=python)](https://mypy-lang.org)   
+[![Ruff](https://custom-icon-badges.demolab.com/badge/Ruff-261230.svg?logo=ruff-logo)](#)
 
 ---
 
 ## 🌟 Key Features
 
-- **Lifecycle Project Scaffolding (`repopy init`)**: Replaces manual setup by provisioning clean directory structures, virtual environments, automated `.gitignore` presets, and standardized metadata configurations (`pyproject.toml` or `requirements.txt`).
+- **Lifecycle Project Scaffolding (`repopy init`)**: Provisions clean directory structures, dedicated virtual environments, automated `.gitignore` templates, and PEP 621 `pyproject.toml` or `requirements.txt` configs.
 
-- **Remote Cloning (`repopy clone`)**: Clones remote Git repositories into structured local footprints and auto-provisions dedicated virtual environments and dependencies.
+- **Smart Remote Cloning (`repopy clone`)**: Clones remote Git repositories, creates isolated `.venv` environments, previews declared dependencies, and installs them interactively or via flags.
 
 - **Upstream Linking (`repopy link`)**: Instantly connects an unlinked local workspace to a remote Git upstream, staging files, executing initial commits, and pushing to the default branch in one step.
 
-- **Architectural Themes**: Supports presets (`minimal`, `web_api`, `cli_package`, `data_science`) tailored to the specific packaging needs of the application.
+- **Architectural Themes**: Built-in layout presets (`minimal`, `web_api`, `cli_package`, `data_science`) tailored to modern packaging standards.
 
-- **Transactional Cleanups**: Employs defensive rollback mechanisms (`shutil.rmtree`) to purge incomplete workspaces if initialization fails midway.
+- **Transactional Cleanups**: Employs defensive rollback mechanisms (`shutil.rmtree`) to safely purge half-baked directories if setup fails midway.
 
-- **Automated Test Suite & CI**: Fully covered by local `pytest` test suites and verified via continuous integration on GitHub Actions.
+- **Isolated & Tested**: Fully decoupled architecture backed by comprehensive unit and mock test suites.
 
 ---
 
@@ -30,11 +34,11 @@ A modular, cross-platform Python CLI workspace manager and developer tooling sui
 `repopy` is organized into single-responsibility layers:
 - **Presentation & Routing (`cli.py`, `prompts.py`, `__main__.py`)**: Evaluates native terminal arguments via `argparse`, orchestrates interactive prompt flows, and handles OS interrupts gracefully.
 
-- **Supervision (`orchestrators.py`)**: Broker layer executing lifecycle validation checks, branch sequencing, and command handoffs.
+- **Supervision (`orchestrators.py`)**: Broker layer executing lifecycle validation checks, branch sequencing, rollback triggers and command handoffs.
 
-- **Low-Level Engines (`file_system.py`, `git_engine.py`)**: Decoupled engines handling transactional directory allocations, venv isolation, and direct subprocess execution.
+- **Low-Level Engines (`file_system.py`, `git_engine.py`)**: Decoupled engines handling transactional directory allocations, venv isolation, dependency installation and direct subprocess execution.
 
-- **Validation & Translation (`validators.py`, `dependencies.py`, `os_detector.py`)**: Sanitizes paths, ensures semantic regex compliance, verifies system binaries (such as `git`), and resolves cross-platform paths.
+- **Validation & Translation (`validators.py`, `dependencies.py`, `os_detector.py`)**: Sanitizes names and paths, validates Git URLs, verifies host binaries (`python`, `git`), and resolves cross-platform paths.
 
 ---
 
@@ -75,15 +79,25 @@ repopy init my-cli -t cli_package --link <git-url>
 - `minimal`: Bare directory setup with `requirements.txt`.
 - `web_api`: Layered service layout prepared for modern frameworks.
 - `cli_package`: Modular structure configured with PEP 621 compliant `pyproject.toml`.
-- `data_science`: Notebooks, data folders, and pipeline layouts.
-<br>
+- `data_science`: Notebooks, data directories (raw, processed), and pipeline layout.
+
 <br>
 
 ### 2. Clone a Remote Project (`repopy clone`)
-Fetch a remote repository and immediately auto-provision an isolated `.venv`:
+Fetch a remote repository, provision a virtual environment, and manage dependencies:
 
 ```bash
-repopy clone <git-url> -n [custom-project-name]
+# Interactive mode (previews requirements.txt and prompts for installation)
+repopy clone <git-url>
+
+# Custom directory name
+repopy clone <git-url> -n custom-folder-name
+
+# Auto-install dependencies without prompting
+repopy clone <git-url> -i
+
+# Fetch and provision environment only (skip dependency installation)
+repopy clone <git-url> --no-install
 ```
 
 <br>
@@ -92,7 +106,11 @@ repopy clone <git-url> -n [custom-project-name]
 Run inside an existing workspace to push tracking history to an upstream origin:
 
 ```bash
-repopy link <git-url> -m ["custom-initial-commit-message"]
+# Link with default initial commit message
+repopy link <git-url>
+
+# Link with custom commit message
+repopy link <git-url> -m "feat: initial project structure"
 ```
 
 ---
@@ -105,8 +123,6 @@ Run the test suite using `pytest`:
 pytest -v
 ```
 
-All contributions and pull requests are validated through our GitHub Actions workflow matrix (`.github/workflows/tests.yml`), running integration and validation tests across supported Python versions.
-
 ---
 
 ## 🗂️ Project Structure
@@ -130,7 +146,16 @@ repopy/
 │       ├── templates.py         # Static asset definitions & manifests
 │       └── validators.py        # Input sanitation & regex filters
 ├── tests/
+|   ├── __init__.py
+│   ├── test_cli.py              # CLI argument parser & flag exclusivity tests
+│   ├── test_dependencies.py     # Binary detection & absence verification tests
+│   ├── test_file_system.py      # Workspace scaffolding & requirements parsing tests
+│   ├── test_git_engine.py       # Subprocess Git mocking & exit code tests
+│   ├── test_main.py             # CLI dispatching & interrupt lifecycle tests
+│   ├── test_orchestrators.py    # Pipeline logic, prompts, and rollback tests
+│   ├── test_os_detector.py      # Cross-platform path resolution tests
 │   ├── test_prompts.py          # Input loop & default manifest tests
+│   ├── test_templates.py        # PEP 621 generator & asset template tests
 │   └── test_validators.py       # Path and schema validation tests
 ├── pyproject.toml               # PEP 621 packaging configuration
 ├── LICENSE                      # MIT License
@@ -142,10 +167,3 @@ repopy/
 ## 📄 License
 
 Distributed under the MIT License. See `LICENSE` for details.
-
----
-
-## Key Review Notes
-
-* Verify the GitHub Actions workflow file path (`.github/workflows/tests.yml`) matches your actual workflow file name so the build badge renders correctly.
-* In the `repopy init` theme section, verify that the theme descriptions match what you have mapped out in `templates.py`.

{repopy-0.2.0 → repopy-0.3.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "repopy"
-version = "0.2.0"
+version = "0.3.1"
 description = "A modular CLI workspace initializer and cloning automation tool."
 readme = "README.md"
 requires-python = ">=3.8"
@@ -35,3 +35,12 @@ Repository = "https://github.com/manatunga/repopy"
 
 [project.scripts]
 repopy = "repopy.__main__:main"
+
+[tool.coverage.report]
+exclude_lines = [
+    "pragma: no cover",
+    "if __name__ == .__main__.:",
+]
+
+[tool.setuptools.package-data]
+repopy = ["py.typed"]

repopy-0.3.1/src/repopy/__main__.py

@@ -0,0 +1,50 @@
+"""
+Main entrypoint of repopy. Brings together the argument parser and
+the orchestrators together under a main function.
+"""
+
+import sys
+
+from repopy.cli import parse_arguments
+from repopy.orchestrators import CloneInitializer, LinkInitializer, LocalInitializer
+from repopy.prompts import capture_project_manifests
+
+
+def main() -> None:
+    try:
+        args = parse_arguments()
+
+        if args.command == "init":
+            print("⌛ Working on it...\n")
+            manifest = capture_project_manifests(args)
+            local_initializer = LocalInitializer(manifest)
+            success = local_initializer.run()
+
+            if success and args.link:
+                print("⌛ Initiating automated repository link shortcut...")
+                link_initializer = LinkInitializer(args.link, args.message)
+                link_initializer.run()
+
+        elif args.command == "clone":
+            print("⌛ Working on it...\n")
+            clone_initializer = CloneInitializer(
+                args.repo_url, args.name, args.install, args.no_install
+            )
+            clone_initializer.run()
+
+        elif args.command == "link":
+            print("⌛ Working on it...\n")
+            link_initializer = LinkInitializer(args.repo_url, args.message)
+            link_initializer.run()
+
+        else:
+            print("Usage: repopy [init | clone | link] --help")
+            print("⚠️ Error: Please specify a subcommand")
+
+    except KeyboardInterrupt:
+        print("\n ✖️ Workspace operation cancelled by user.")
+        sys.exit(1)
+
+
+if __name__ == "__main__":
+    main()

repopy-0.3.1/src/repopy/cli.py

@@ -0,0 +1,115 @@
+"""
+Parser layer. Imports Python's built-in argparse module
+to identify user intent and any extra information passed.
+"""
+
+import argparse
+
+
+def parse_arguments() -> argparse.Namespace:
+    parser = argparse.ArgumentParser(
+        description="repopy: A modular project scaffolder and workflow manager for Python."
+    )
+
+    subparsers = parser.add_subparsers(dest="command", required=True)
+
+    # ---------------------------------------------------------------------------------
+    # `repopy init` subcommand
+    # ---------------------------------------------------------------------------------
+
+    init_parser = subparsers.add_parser(
+        "init",
+        help="Initializes a standardized Python development workspace in a new directory",
+    )
+
+    # Optional argument to add a project_name
+    init_parser.add_argument(
+        "project_name", nargs="?", help="Name of the target project folder to create"
+    )
+
+    # Project theme shortcut flag (-t / --theme)
+    init_parser.add_argument(
+        "-t",
+        "--theme",
+        choices=["minimal", "web_api", "cli_package", "data_science"],
+        help="Pre-select an architectural theme layout",
+    )
+
+    # Skip flag (-s / --skip) to bypass input prompts completely
+    init_parser.add_argument(
+        "-s",
+        "--skip",
+        action="store_true",
+        help="Skip interactive loops and generate workspace using default values",
+    )
+
+    # Link flag (-l / --link) to pass an existing remote URL during creation
+    init_parser.add_argument(
+        "-l",
+        "--link",
+        metavar="GIT_URL",
+        help="Automatically link and push the new local repo to this remote Git URL",
+    )
+
+    # Custom commit message shortcut allowed directly during init orchestration
+    init_parser.add_argument(
+        "-m",
+        "--message",
+        help="Custom commit message to use for the initial repository push",
+    )
+
+    # ---------------------------------------------------------------------------------
+    # `repopy clone` subcommand
+    # ---------------------------------------------------------------------------------
+
+    clone_parser = subparsers.add_parser(
+        "clone", help="Clones a remote Git repository to the local machine"
+    )
+
+    # Positional argument to add remote Git URL
+    clone_parser.add_argument(
+        "repo_url", help="Repository URL from Github to clone locally"
+    )
+
+    # Name flag (-n / --name) to pass an optional name for the to-be-cloned repository
+    clone_parser.add_argument("-n", "--name", help="Name of the project folder")
+
+    # Mutually exclusive commands regarding installing dependencies:
+    # install flag (-i / --install) for installing dependencies, bypassing prompt
+    # download-only flag (-d / --download-only) for only fetching dependencies without installing, bypassing prompt
+    deps_group = clone_parser.add_mutually_exclusive_group()
+    deps_group.add_argument(
+        "-i",
+        "--install",
+        action="store_true",
+        help="Automatically install dependencies without confirmation",
+    )
+
+    deps_group.add_argument(
+        "--no-install",
+        action="store_true",
+        help="Skip dependency installation completely (fetch-only safe mode)",
+    )
+
+    # ---------------------------------------------------------------------------------
+    # `repopy link` subcommand
+    # ---------------------------------------------------------------------------------
+
+    link_parser = subparsers.add_parser(
+        "link",
+        help="Stage, commit and link current local repository to a remote Git URL",
+    )
+
+    # Positional argument to add a dedicated existing remote Git URL for the local repository
+    link_parser.add_argument(
+        "repo_url",
+        help="Target remote Git repository URL (e.g., git@github.com:user/repo.git)",
+    )
+
+    link_parser.add_argument(
+        "-m",
+        "--message",
+        help="Custom commit message to use instead of the default repopy message",
+    )
+
+    return parser.parse_args()

{repopy-0.2.0 → repopy-0.3.1}/src/repopy/dependencies.py

@@ -1,13 +1,14 @@
-'''
+"""
 Layer for Dependency-checking. Contains functions to check whether
 expected dependencies (such as python and git) are installed.
-'''
+"""
 
 import shutil
 
+
 def has_python() -> bool:
-    return bool(shutil.which('python') or shutil.which('python3'))
+    return bool(shutil.which("python") or shutil.which("python3"))
 
 
 def has_git() -> bool:
-    return bool(shutil.which('git'))
+    return bool(shutil.which("git"))