Skip to main content

CLI to browse and fetch code snippets from GetSomeSleepBro/codes via GitHub API

Project description

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:
    • g subjects
  • Quick shorthand:
    • g dbms → list DBMS codes
    • 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

Notes

  • Version folders appear only when multiple implementations exist. The CLI shows only the latest by default; 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).

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

getcodes-0.1.3.tar.gz (18.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

getcodes-0.1.3-py3-none-any.whl (16.5 kB view details)

Uploaded Python 3

File details

Details for the file getcodes-0.1.3.tar.gz.

File metadata

  • Download URL: getcodes-0.1.3.tar.gz
  • Upload date:
  • Size: 18.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.6

File hashes

Hashes for getcodes-0.1.3.tar.gz
Algorithm Hash digest
SHA256 c74079c4c001cd11ee1baf938328bd36fd91fd6cb38568aed589a0e65fcdfd75
MD5 a30c656367db2950bcabd962c888f87c
BLAKE2b-256 df90f750530c6cbe3524ac3e31a5aa43b37d90bf36f360e84af266b2af4e3268

See more details on using hashes here.

File details

Details for the file getcodes-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: getcodes-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 16.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.6

File hashes

Hashes for getcodes-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 0ccbceb34d617559070302e2189336f946d7c07fbaa7146fa29aab34b6234ab7
MD5 bacd415e92302cf843fff2a5b9ab5443
BLAKE2b-256 469ccbdc3b2a65777c8ff9d6af3e0299af884a32d5e4e4bb49fa313480a2a00d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page