getcodes 0.1.5

getcode (gc) — fetch code from GetSomeSleepBro/codes without cloning

Overview

• Simple, intuitive CLI to browse and fetch code from the GitHub repo online (no full clone).
• Defaults to latest version when multiple implementations (v1, v2, …) exist.
• Stdlib-only (urllib); optional GitHub token to avoid rate limits.

Install

• pip install getcodes
• Console scripts: getcode, gc, and g.

Config

• Env vars:
  • GETCODE_REPO (default: GetSomeSleepBro/codes)
  • GETCODE_BRANCH (default: main)
  • GITHUB_TOKEN (optional; increases rate limits)

Basic Use

• List subjects with versions:
  • g subjects or g subs
  • Example output: DSA (v1, v3) — subjects are discovered dynamically.
• Quick shorthand:
  • g dbms → list DBMS codes (defaults to latest version when multiple exist)
  • g dbms ddl → fetch best match for "ddl" in DBMS (copy/save based on default)
  • g DSA/v3/B6_BSTops.cpp → fetch by repo path
• List codes in a subject (latest version by default):
  • g list DSA
  • g list CNS --ext .py (only Python)
  • g list DBMS --all-versions --full-path
• Show summary info:
  • g info (totals and latest version per subject)
  • g info --subject DSA --all-versions
• Search filenames across subjects:
  • g search bst --ext .cpp
  • g search tcp --subject CNS
• Fetch by repo path:
  • g get DSA/v3/B6_BSTops.cpp --to ./codes
• Fetch by subject + pattern or exact name (simple):
  • gc get dbms ddl (best match in DBMS)
  • gc get cns sliding_window.py (exact name in CNS)
• Fetch by subject + name (chooses latest version if multiple):
  • g get -s DSA -n B6_BSTops.cpp --to ./codes
  • g get -s DSA -n B6_BSTops.cpp -v v2 (specific version)
• Fetch by subject + pattern (picks best match):
  • g dsa bst (shorthand; default action applies)
  • g get -s DSA -m bst --to ./codes
  • Copy instead of saving:
    • g dsa bst --copy (shorthand)
    • or g get -s DSA -m bst --copy
• Flatten save path (avoid nested folders):
  • g get DSA/v3/B6_BSTops.cpp --flatten

Bulk Download

• Entire repo: g all
• Single subject (all versions): g all DSA
• Single subject, specific version: g all DSA -v v3
• Custom destination: add --to ./downloads

Notes

• Version folders appear only when multiple implementations exist. The CLI shows only the latest by default (highest vN). Use --all-versions to see others.
• Listing recurses into nested folders (e.g., CNS/programs, DBMS/sql).
• If saving multiple files with --flatten and names collide, the CLI appends a suffix (e.g., -v3).
• Network errors or API rate limits print a friendly hint to set GITHUB_TOKEN.
• Automatic fallback: if the GitHub API is rate-limited/unavailable, the CLI downloads a temporary ZIP snapshot of the repo and serves listings/reads from it. The snapshot lives in a temp folder and is cleaned up automatically at process exit (including Ctrl+C).

Env Vars

• GETCODE_DEFAULT_ACTION = copy to copy by default.
• GITHUB_TOKEN to increase API limits.
• GETCODE_MODE = zip to force ZIP fallback (offline-friendly).
• GETCODE_DOWNLOAD_DIR default destination for bulk downloads (g all, g all <SUBJECT>).

Clipboard

• Copy text directly: add --copy (or -c) to gc get when fetching a single file.
• Make copy the default action instead of saving files:
  • export GETCODE_DEFAULT_ACTION=copy
• Clipboard uses built-in OS tools (macOS pbcopy, Windows clip) or stdlib tkinter when available.

Help

• g help shows quick examples and tips right in the terminal.

Windows

• PowerShell has a built-in gc alias for Get-Content. Use the g alias to avoid conflicts.