Skip to content

README.md

Latest commit

 

History

History
34 lines (23 loc) · 1.05 KB

README.md

File metadata and controls

34 lines (23 loc) · 1.05 KB

RepoSiphon

A high-performance, concurrent CLI tool for surgically downloading subdirectories from GitHub repositories.

⚡ The Problem

GitHub does not provide a native way to download a single folder. Users are forced to git clone entire repositories, wasting bandwidth and storage.

RepoSiphon treats the GitHub API as a file system, recursively reconstructing target directories in memory and utilizing a concurrent worker pool to stream files to disk.

🛠️ Installation

  1. Clone the repository:

    git clone https://github.com/Henry8r8w/RepoSiphon.git
cd RepoSiphon

  2. Install in editable mode (Recommended): This allows you to run the tool from anywhere while developing.

    pip install -e .

💻 Usage

Run the tool as a python module.

Basic Download

Download a specific folder (e.g., RateMyProf Scrape/selenium) from a repository.

# Syntax: python -m src.siphon.cli <OWNER>/<REPO> <PATH>
python -m src.siphon.cli Henry8r8w/Notebooks "RateMyProf Scrape/selenium"