repopy 0.3.0__tar.gz → 0.3.1__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: repopy
-Version: 0.3.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,9 +28,13 @@ 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)](#)
 
 ---
 
@@ -167,16 +171,20 @@ 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
 └── README.md
-
 ```
 
 ---

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

@@ -3,9 +3,13 @@
 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)](#)
 
 ---
 
@@ -142,16 +146,20 @@ 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
 └── README.md
-
 ```
 
 ---

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

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "repopy"
-version = "0.3.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.3.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"))

repopy-0.3.1/src/repopy/file_system.py

@@ -0,0 +1,200 @@
+"""
+Core Engine for the `repopy local` command. Houses the FileSystemEngine class
+that holds the methods required to manipulate directories, create virtural
+environments and create .gitignore and README.md templates.
+"""
+
+from __future__ import annotations
+
+import logging
+import shutil
+import subprocess
+import venv
+from pathlib import Path
+
+from repopy.os_detector import is_windows
+from repopy.templates import (
+    GITIGNORE_TEMPLATE,
+    generate_pyproject_toml,
+    generate_readme,
+)
+
+logger = logging.getLogger(__name__)
+
+
+class FileSystemEngine:
+    def __init__(self, project_path: Path):
+        self.project_path = project_path
+
+    def create_root_directory(self) -> bool:
+        """Creates new project directory with user-specified project name"""
+        try:
+            self.project_path.mkdir(parents=True, exist_ok=True)
+            return True
+
+        except OSError:
+            logger.error(f"❌ Failed to create directory at {self.project_path}")
+            return False
+
+    def create_theme_directories(self, theme: str, project_name: str):
+        """Maps and structures the child directory tree based on the project theme"""
+        if theme == "web_api":
+            sub_dirs = ["src/app", "src/app/routes", "src/app/models"]
+
+        elif theme == "cli_package":
+            sub_dirs = [f"src/{project_name}", "tests"]
+
+        elif theme == "data_science":
+            sub_dirs = ["data/raw", "data/processed", "notebooks", "src/pipeline"]
+
+        else:
+            return True
+
+        try:
+            for folder in sub_dirs:
+                target_folder_path = (self.project_path / folder).resolve()
+                target_folder_path.mkdir(parents=True, exist_ok=True)
+
+            return True
+
+        except OSError:
+            logger.error(f"❌ Failed to build nested structures for theme {theme}")
+            return False
+
+    def write_theme_configurations(self, theme: str, manifest: dict) -> bool:
+        """Deploys standard configuration templates (gitignore, requirements.txt or toml)"""
+        try:
+            gitignore_path = self.project_path / ".gitignore"
+            with open(gitignore_path, "w") as f:
+                f.write(GITIGNORE_TEMPLATE)
+
+            readme_content = generate_readme(manifest)
+            readme_path = self.project_path / "README.md"
+            with open(readme_path, "w") as f:
+                f.write(readme_content)
+
+            if theme == "minimal":
+                req_path = self.project_path / "requirements.txt"
+                with open(req_path, "w") as f:
+                    f.write("")
+
+            else:
+                toml_content = generate_pyproject_toml(manifest)
+                toml_path = self.project_path / "pyproject.toml"
+                with open(toml_path, "w") as f:
+                    f.write(toml_content)
+
+            return True
+
+        except OSError:
+            logger.error("❌ Failed to deploy structural file sheets")
+            return False
+
+    def create_virtual_environment(self) -> bool:
+        """Initializes a python virtual environment"""
+        venv_dir = self.project_path / ".venv"
+
+        try:
+            venv.create(venv_dir, with_pip=True)
+            return True
+
+        except Exception:
+            logger.exception(
+                f"❌ Failed to create virtual environment at {self.project_path}"
+            )
+            return False
+
+    def initialize_git(self) -> bool:
+        """Initializes git within the newly created project directory"""
+        try:
+            result = subprocess.run(
+                ["git", "init"],
+                cwd=self.project_path,
+                capture_output=True,
+                text=True,
+                check=False,
+            )
+            return result.returncode == 0
+        except OSError:
+            logger.error(f"❌ Unable to initialize git at {self.project_path}")
+            return False
+
+    def read_requirements(self) -> list[str]:
+        """Read repository dependencies if requirements.txt exists and displays them"""
+        req_path = self.project_path / "requirements.txt"
+        if not req_path.is_file():
+            return []
+
+        with open(req_path, "r") as f:
+            lines = [
+                cleaned_line
+                for line in f
+                if (cleaned_line := line.strip()) and not cleaned_line.startswith("#")
+            ]
+
+        return lines
+
+    def install_dependencies(self) -> bool:
+        """Install repository dependencies if requirements.txt is present"""
+        req_file = self.project_path / "requirements.txt"
+
+        if not req_file.exists():
+            return True
+
+        if is_windows():
+            pip_path = self.project_path / ".venv" / "Scripts" / "pip.exe"
+        else:
+            pip_path = self.project_path / ".venv" / "bin" / "pip"
+
+        try:
+            result = subprocess.run(
+                [str(pip_path), "install", "-r", str(req_file)],
+                capture_output=True,
+                text=True,
+                check=False,
+            )
+            return result.returncode == 0
+
+        except OSError:
+            logger.error(f"❌ Failed to install dependencies at {self.project_path}")
+            return False
+
+    def get_activation_guide(self) -> str:
+        if is_windows():
+            venv_activation = """
+    .\\.venv\\Scripts\\Activate.ps1 (if on Powershell)
+    .\\.venv\\Scripts\\activate.bat (if on cmd)\n
+"""
+        else:
+            venv_activation = """
+    source .venv/bin/activate\n
+"""
+
+        return f"""
+To activate the virtual environment and get started, enter the following:
+
+    cd {self.project_path}
+{venv_activation}
+"""
+
+    def cleanup(self) -> None:
+        """Removes any partially created project directories if a failure occurs"""
+        if self.project_path.exists():
+            try:
+                shutil.rmtree(self.project_path)
+                logger.info(
+                    f"☑️ Successfully cleaned up half-baked workspace at {self.project_path}"
+                )
+            except OSError:
+                logger.error(f"❌ Failed to clean up directory at {self.project_path}")
+
+    def build_workspace(self, theme: str, manifest: dict) -> bool:
+        """Orchestrate entire file-system creation sequence"""
+
+        return bool(
+            self.create_root_directory()
+            and self.initialize_git()
+            and self.create_theme_directories(theme, manifest["project_name"])
+            and self.write_theme_configurations(theme, manifest)
+            and self.create_virtual_environment()
+        )

repopy-0.3.1/src/repopy/git_engine.py

@@ -0,0 +1,91 @@
+"""
+Core Engine for the `repopy clone` command. Houses the GitEngine class that
+holds the methods required to cone a GitHub repository and install
+dependencies.
+"""
+
+from __future__ import annotations
+
+import logging
+import subprocess
+from pathlib import Path
+
+logger = logging.getLogger(__name__)
+
+
+class GitEngine:
+    def __init__(self, repo_url: str, dir_name: str | None):
+        self.repo_url = repo_url
+
+        cleaned_url = repo_url.removesuffix(".git")
+        final_name = dir_name if dir_name else Path(cleaned_url).name
+
+        self.project_path = Path(final_name)
+
+    def clone_repository(self) -> bool:
+        """Clone GitHub repository using the given url to the given directory name"""
+        try:
+            result = subprocess.run(
+                ["git", "clone", self.repo_url, str(self.project_path)],
+                text=True,
+                check=False,
+            )
+            return result.returncode == 0
+
+        except OSError:
+            logger.error(f"❌ Failed to clone repository at {self.project_path}")
+            return False
+
+
+class GitLinkEngine:
+    def __init__(self, repo_url: str, message: str):
+        self.repo_url = repo_url
+        self.message = message
+
+    def link_and_push(self) -> bool:
+        """Runs the sequence of Git terminal execution blocks to link the repo"""
+        try:
+            stage_result = subprocess.run(
+                ["git", "add", "."], capture_output=True, text=True, check=False
+            )
+            if stage_result.returncode != 0:
+                return False
+
+            commit_result = subprocess.run(
+                ["git", "commit", "-m", self.message],
+                capture_output=True,
+                text=True,
+                check=False,
+            )
+            if (
+                commit_result.returncode != 0
+                and "nothing to commit" not in commit_result.stdout
+            ):
+                return False
+
+            branch_result = subprocess.run(
+                ["git", "branch", "-M", "main"],
+                capture_output=True,
+                text=True,
+                check=False,
+            )
+            if branch_result.returncode != 0:
+                return False
+
+            remote_result = subprocess.run(
+                ["git", "remote", "add", "origin", self.repo_url],
+                capture_output=True,
+                text=True,
+                check=False,
+            )
+            if remote_result.returncode != 0:
+                return False
+
+            push_result = subprocess.run(
+                ["git", "push", "-u", "origin", "main"], text=True, check=False
+            )
+            return push_result.returncode == 0
+
+        except OSError:
+            logger.error("❌ Failed to execute Git linking operations")
+            return False