Simply downloads a folder from a github repo into current directory.

'initial commit'

huncholaneauthored 1 year ago

parent ab100a9commit 344a49186a2946384f167a54d2ff6b391fc69894Browse files

1 file changed, +67 -0

+67-0README.md

		@@ -0,0 +1,67 @@
	1	+# GitHub Folder Downloader
	2	+
	3	+## Overview
	4	+
	5	+`gh-downloader` is a command-line tool that allows you to download a specific folder or an entire repository from GitHub without cloning the full repository history.
	6	+
	7	+## Installation
	8	+
	9	+To install the tool, use the following command:
	10	+
	11	+```bash
	12	+pip install .
	13	+```
	14	+
	15	+Alternatively, you can install it directly from GitHub:
	16	+
	17	+```bash
	18	+pip install git+https://github.com/huncholane/gh-downloader.git
	19	+```
	20	+
	21	+To install the tool, use the following command:
	22	+
	23	+```bash
	24	+pip install .
	25	+```
	26	+
	27	+## Usage
	28	+
	29	+To download a folder or an entire repository, use:
	30	+
	31	+```bash
	32	+gh-downloader <GitHub_URL>
	33	+```
	34	+
	35	+### Examples
	36	+
	37	+#### Download an entire repository:
	38	+
	39	+```bash
	40	+gh-downloader https://github.com/user/repo
	41	+```
	42	+
	43	+#### Download a specific folder from a repository:
	44	+
	45	+```bash
	46	+gh-downloader https://github.com/user/repo/tree/main/folder_name
	47	+```
	48	+
	49	+## Features
	50	+
	51	+- Downloads only the required folder or the whole repository.
	52	+- Uses a temporary directory to clone before extracting.
	53	+- Removes the `.git` directory after cloning to keep it clean.
	54	+- Supports merging into an existing folder.
	55	+
	56	+## Dependencies
	57	+
	58	+- Python 3.x
	59	+- `requests`
	60	+
	61	+## Contributing
	62	+
	63	+Feel free to submit issues or pull requests to improve `gh-downloader`.
	64	+
	65	+## License
	66	+
	67	+This project is licensed under the MIT License.