Skip to main content

A Python CLI tool for downloading files, directories, or entire repositories from GitHub, supporting recursive downloads for folders and the option to save files as a ZIP archive.

Project description

GitDownloader

GitDownloader-Logo

GitDownloader is a Python CLI tool for downloading files, directories, or entire repositories from GitHub, supporting recursive downloads for folders and the option to save files as a ZIP archive.

Features

  • Download individual files, directories, or entire repositories from GitHub.
  • Recursively fetch files from a directory in a repository.
  • Option to save files as individual files or compress them into a ZIP archive.
  • Simple and user-friendly CLI interface.

Installation

Ensure you have Python 3.7 or later installed. Then, install GitDownloader using pip:

pip install GitDownloader

Alternatively, clone the repository and install it directly:

git clone https://github.com/PtPrashantTripathi/GitDownloader.git
cd GitDownloader
pip install .

Usage

Command Line Interface (CLI)

Use the GitDownloader command to download GitHub files or directories:

GitDownloader <GitHub URL>

Examples

  1. Download a single file:

    GitDownloader https://github.com/user/repo/blob/main/path/to/file.txt
    
  2. Download an entire directory:

    GitDownloader https://github.com/user/repo/tree/main/path/to/directory
    
  3. Download the whole repository:

    GitDownloader https://github.com/user/repo
    
  4. Save files as a ZIP archive:

    Add -z to zip the downloaded files.

    GitDownloader https://github.com/user/repo/tree/main/path/to/directory -z
    

License

This project is licensed under the MIT License.

Contribution

Contributions are welcome! Please fork the repository, create a feature branch, and submit a pull request.

Contact

Disclaimer

This tool interacts with GitHub's APIs and is subject to GitHub's rate limits and terms of service.


Made with ❤️ in Bharat

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

gitdownloader-1.0.19.tar.gz (4.8 kB view details)

Uploaded Source

Built Distribution

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

GitDownloader-1.0.19-py3-none-any.whl (5.6 kB view details)

Uploaded Python 3

File details

Details for the file gitdownloader-1.0.19.tar.gz.

File metadata

  • Download URL: gitdownloader-1.0.19.tar.gz
  • Upload date:
  • Size: 4.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for gitdownloader-1.0.19.tar.gz
Algorithm Hash digest
SHA256 d9303c11fae1fb5e05c84a40a8284b51d66f01b6a8098a441a460761c9108526
MD5 455901a4750af65e3de7e6652c766113
BLAKE2b-256 5a180d21e65074365cc010718e30c617545872ba2b7bed7839255e9c73e3abc2

See more details on using hashes here.

File details

Details for the file GitDownloader-1.0.19-py3-none-any.whl.

File metadata

  • Download URL: GitDownloader-1.0.19-py3-none-any.whl
  • Upload date:
  • Size: 5.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for GitDownloader-1.0.19-py3-none-any.whl
Algorithm Hash digest
SHA256 651f869a14f809f28320ef40f27aaf5d6dba3c3994b22a0fa56e77c89b0d5d3e
MD5 a9ecca1fd61db26294bc9d00beec7ca8
BLAKE2b-256 45300a38d127df6a73577841faea515b59efff04597747782443239eb49e07f8

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