pppandas 0.1.0__py3-none-any.whl

ppandas/__init__.py

@@ -0,0 +1,3 @@
+"""ppandas: browse a configured GitHub repository from the terminal."""
+
+__version__ = "0.1.0"

ppandas/cli.py

@@ -0,0 +1,241 @@
+"""Command-line interface for browsing a GitHub repository."""
+from __future__ import annotations
+
+import argparse
+import json
+import os
+import sys
+import urllib.error
+import urllib.parse
+import urllib.request
+import zipfile
+from pathlib import Path
+from typing import Any
+
+DEFAULT_REPO = "PratikChavan05/LP3"
+API_BASE = "https://api.github.com"
+RAW_BASE = "https://raw.githubusercontent.com"
+
+
+def request_bytes(url: str) -> bytes:
+    """Fetch a URL with a descriptive user-agent."""
+    req = urllib.request.Request(
+        url,
+        headers={
+            "User-Agent": "ppandas-cli/0.1.0",
+            "Accept": "application/vnd.github+json",
+        },
+    )
+    try:
+        with urllib.request.urlopen(req, timeout=30) as response:
+            return response.read()
+    except urllib.error.HTTPError as exc:
+        if exc.code == 404:
+            raise RuntimeError(f"Not found: {url}") from exc
+        if exc.code == 403:
+            raise RuntimeError(
+                "GitHub rate limit or access restriction. Try again later, "
+                "or configure a GitHub token using PPANDAS_GITHUB_TOKEN."
+            ) from exc
+        raise RuntimeError(f"GitHub request failed (HTTP {exc.code}): {url}") from exc
+    except urllib.error.URLError as exc:
+        raise RuntimeError(f"Network error: {exc.reason}") from exc
+
+
+def headers_with_token() -> dict[str, str]:
+    token = os.environ.get("PPANDAS_GITHUB_TOKEN")
+    headers = {"User-Agent": "ppandas-cli/0.1.0", "Accept": "application/vnd.github+json"}
+    if token:
+        headers["Authorization"] = f"Bearer {token}"
+    return headers
+
+
+def github_json(url: str) -> Any:
+    req = urllib.request.Request(url, headers=headers_with_token())
+    try:
+        with urllib.request.urlopen(req, timeout=30) as response:
+            return json.loads(response.read().decode("utf-8"))
+    except urllib.error.HTTPError as exc:
+        if exc.code == 404:
+            raise RuntimeError(f"Repository, branch, or path not found: {url}") from exc
+        if exc.code == 403:
+            raise RuntimeError(
+                "GitHub API rate limit/access restriction. Set PPANDAS_GITHUB_TOKEN "
+                "to a GitHub token if needed."
+            ) from exc
+        raise RuntimeError(f"GitHub API request failed (HTTP {exc.code}): {url}") from exc
+    except urllib.error.URLError as exc:
+        raise RuntimeError(f"Network error: {exc.reason}") from exc
+
+
+def parse_repo(value: str) -> str:
+    value = value.strip().rstrip("/")
+    if value.startswith("https://github.com/"):
+        value = value[len("https://github.com/"):]
+    value = value.removesuffix(".git")
+    parts = value.split("/")
+    if len(parts) < 2 or not all(parts[:2]):
+        raise argparse.ArgumentTypeError(
+            "Repository must be OWNER/REPO or a GitHub repository URL."
+        )
+    return f"{parts[0]}/{parts[1]}"
+
+
+def get_tree(repo: str, branch: str) -> tuple[str, list[dict[str, Any]]]:
+    encoded_branch = urllib.parse.quote(branch, safe="")
+    data = github_json(f"{API_BASE}/repos/{repo}/git/trees/{encoded_branch}?recursive=1")
+    if data.get("truncated"):
+        print("Warning: GitHub returned a truncated file tree.", file=sys.stderr)
+    return data.get("sha", ""), data.get("tree", [])
+
+
+def cmd_list(args: argparse.Namespace) -> int:
+    repo = parse_repo(args.repo)
+    _, tree = get_tree(repo, args.branch)
+    entries = [item for item in tree if item.get("type") == "blob"]
+    for item in entries:
+        print(item["path"])
+    print(f"\n{len(entries)} files")
+    return 0
+
+
+def cmd_show(args: argparse.Namespace) -> int:
+    repo = parse_repo(args.repo)
+    path = args.path.lstrip("/")
+    _, tree = get_tree(repo, args.branch)
+    match = next(
+        (item for item in tree if item.get("type") == "blob" and item.get("path") == path),
+        None,
+    )
+    if not match:
+        raise RuntimeError(f"File not found in {repo}@{args.branch}: {path}")
+    if match.get("size", 0) > args.max_bytes:
+        raise RuntimeError(
+            f"File is {match['size']} bytes, exceeding the {args.max_bytes}-byte limit. "
+            "Use --max-bytes to increase the limit."
+        )
+    encoded_path = "/".join(urllib.parse.quote(part, safe="") for part in path.split("/"))
+    url = f"{RAW_BASE}/{repo}/{urllib.parse.quote(args.branch, safe='')}/{encoded_path}"
+    content = request_bytes(url)
+    try:
+        print(content.decode("utf-8"))
+    except UnicodeDecodeError as exc:
+        raise RuntimeError("This file is not UTF-8 text and cannot be displayed.") from exc
+    return 0
+
+
+def cmd_search(args: argparse.Namespace) -> int:
+    repo = parse_repo(args.repo)
+    _, tree = get_tree(repo, args.branch)
+    files = [
+        item for item in tree
+        if item.get("type") == "blob"
+        and (not args.extension or item["path"].lower().endswith(args.extension.lower()))
+        and item.get("size", 0) <= args.max_bytes
+    ]
+    needle = args.keyword.casefold()
+    found = 0
+    for item in files:
+        path = item["path"]
+        encoded_path = "/".join(urllib.parse.quote(part, safe="") for part in path.split("/"))
+        url = f"{RAW_BASE}/{repo}/{urllib.parse.quote(args.branch, safe='')}/{encoded_path}"
+        try:
+            text = request_bytes(url).decode("utf-8")
+        except (RuntimeError, UnicodeDecodeError):
+            continue
+        for line_number, line in enumerate(text.splitlines(), start=1):
+            if needle in line.casefold():
+                print(f"{path}:{line_number}: {line.strip()}")
+                found += 1
+                if found >= args.limit:
+                    print(f"Search result limit reached ({args.limit}).")
+                    return 0
+    if found == 0:
+        print("No matches found.")
+    else:
+        print(f"\n{found} match(es)")
+    return 0
+
+
+def cmd_download(args: argparse.Namespace) -> int:
+    repo = parse_repo(args.repo)
+    branch = args.branch
+    archive_url = f"https://github.com/{repo}/archive/refs/heads/{urllib.parse.quote(branch, safe='')}.zip"
+    archive = request_bytes(archive_url)
+    destination = Path(args.output).expanduser().resolve()
+    destination.mkdir(parents=True, exist_ok=True)
+    with zipfile.ZipFile(__import__("io").BytesIO(archive)) as zf:
+        # Extract into a single repository folder, rejecting unsafe paths.
+        root = destination.resolve()
+        for member in zf.infolist():
+            target = (destination / member.filename).resolve()
+            if target != root and root not in target.parents:
+                raise RuntimeError("Archive contains an unsafe path; refusing to extract.")
+        zf.extractall(destination)
+    print(f"Downloaded {repo}@{branch} to {destination}")
+    return 0
+
+
+def cmd_update(args: argparse.Namespace) -> int:
+    # For this CLI, update refreshes the repository by downloading its latest archive.
+    return cmd_download(args)
+
+
+def add_repo_options(parser: argparse.ArgumentParser) -> None:
+    parser.add_argument(
+        "--repo", default=DEFAULT_REPO,
+        help=f"GitHub repository as OWNER/REPO or URL (default: {DEFAULT_REPO})",
+    )
+    parser.add_argument("--branch", default="main", help="Branch or tag (default: main)")
+
+
+def build_parser() -> argparse.ArgumentParser:
+    parser = argparse.ArgumentParser(
+        prog="ppandas",
+        description="Browse and download the LP3 GitHub repository from your terminal.",
+    )
+    subparsers = parser.add_subparsers(dest="command", required=True)
+
+    list_parser = subparsers.add_parser("list", help="List repository files")
+    add_repo_options(list_parser)
+    list_parser.set_defaults(func=cmd_list)
+
+    show_parser = subparsers.add_parser("show", help="Print one file's source code")
+    show_parser.add_argument("path", help="Path relative to the repository root")
+    add_repo_options(show_parser)
+    show_parser.add_argument("--max-bytes", type=int, default=1_000_000)
+    show_parser.set_defaults(func=cmd_show)
+
+    search_parser = subparsers.add_parser("search", help="Search text across repository files")
+    search_parser.add_argument("keyword", help="Text to search for")
+    add_repo_options(search_parser)
+    search_parser.add_argument("--extension", help="Limit to an extension, e.g. .py or .cpp")
+    search_parser.add_argument("--max-bytes", type=int, default=500_000)
+    search_parser.add_argument("--limit", type=int, default=100)
+    search_parser.set_defaults(func=cmd_search)
+
+    download_parser = subparsers.add_parser("download", help="Download and extract repository ZIP")
+    add_repo_options(download_parser)
+    download_parser.add_argument("--output", default=".", help="Directory to extract into")
+    download_parser.set_defaults(func=cmd_download)
+
+    update_parser = subparsers.add_parser("update", help="Download the latest repository archive")
+    add_repo_options(update_parser)
+    update_parser.add_argument("--output", default=".", help="Directory to extract into")
+    update_parser.set_defaults(func=cmd_update)
+
+    return parser
+
+
+def main() -> int:
+    parser = build_parser()
+    args = parser.parse_args()
+    try:
+        return int(args.func(args))
+    except (RuntimeError, OSError, zipfile.BadZipFile) as exc:
+        print(f"ppandas: error: {exc}", file=sys.stderr)
+        return 1
+
+
+if __name__ == "__main__":
+    raise SystemExit(main())

pppandas-0.1.0.dist-info/METADATA

@@ -0,0 +1,51 @@
+Metadata-Version: 2.4
+Name: pppandas
+Version: 0.1.0
+Summary: A terminal tool to browse and download the PratikChavan05/LP3 GitHub repository
+Author: PratikChavan05
+License: MIT
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# ppandas
+
+`ppandas` is a terminal CLI for listing, viewing, searching, and downloading the public
+GitHub repository `PratikChavan05/LP3`.
+
+## Install locally
+
+```bash
+python3 -m venv .venv
+source .venv/bin/activate
+python -m pip install --upgrade pip
+python -m pip install .
+ppandas --help
+```
+
+## Commands
+
+```bash
+ppandas list
+ppandas show path/to/file.cpp
+ppandas search "binary search"
+ppandas search "main" --extension .cpp
+ppandas download --output ./downloads
+ppandas update --output ./downloads
+```
+
+Override the repository or branch:
+
+```bash
+ppandas list --repo OWNER/REPO --branch main
+```
+
+`show` and `search` fetch files from GitHub when used, so an internet connection is required.
+The default repository is public. For higher GitHub API rate limits, set
+`PPANDAS_GITHUB_TOKEN` to a GitHub token in your shell. Do not commit a token to source control.
+
+## Publish to PyPI
+
+Check package-name availability and complete the PyPI account setup first. Then build and
+upload a release using the official Python packaging instructions.

pppandas-0.1.0.dist-info/RECORD

@@ -0,0 +1,8 @@
+ppandas/__init__.py,sha256=MT07VHlxgjA1iutLdAHzBIUNWIDPsRhS1N1xdwd9O8g,95
+ppandas/cli.py,sha256=kQ6mthdmgaeFObIBXpuAtcfhC3FRahBGvxjR2lHRiGI,9334
+pppandas-0.1.0.dist-info/licenses/LICENSE,sha256=IAMcIK9VEEi6Ay3oIgiuaQdTVCpIbLG0kOQu0ZRKv64,812
+pppandas-0.1.0.dist-info/METADATA,sha256=QBukhkYy4yHCG7f-Q6RN6aWOYnmkS7yOBqqAc7AO6AU,1330
+pppandas-0.1.0.dist-info/WHEEL,sha256=mOdXR9C3wMVov7cSY8PY-XCzo3SmmWCHvGQr5csJoao,91
+pppandas-0.1.0.dist-info/entry_points.txt,sha256=uSh1-ssG4mzu8PsDDIrc_QEByGLPMORqkxqxrogSDaE,45
+pppandas-0.1.0.dist-info/top_level.txt,sha256=5CXoUq_TlC3Fp44175sX7zfKcI6sozJapj2nNT75Vf0,8
+pppandas-0.1.0.dist-info/RECORD,,

pppandas-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
+

pppandas-0.1.0.dist-info/entry_points.txt

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

pppandas-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,17 @@
+MIT License
+
+Copyright (c) 2026 PratikChavan05
+
+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.

pppandas-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+ppandas