# Github-dlr
Download individual files and folders from GitHub recursively.
[](https://github.com/rocktimsaikia/github-dlr/actions/workflows/tests.yml)
[](https://github.com/user-attachments/assets/8927d4ef-f8e1-4699-b75b-b7e28291d509)
## Motivation
The project aims to save time and resources by allowing users to download only the specific folders and files they need from a GitHub repository, without the hassle of cloning the entire repo. It's designed for efficiency, making development and learning more streamlined.
## Install
Requires Python version 3.8 or higher.
```sh
pip install github-dlr
```
or using [pipx](https://pipx.pypa.io/)
```sh
pipx install github-dlr
```
## Usage
> [!NOTE]
> Using the tool is straightforward, copy the GitHub URL of the target repository folder and paste it after the command `github-dlr` or it's alias `gh-dlr`.
```sh
github-dlr <github_path>
# Basic Example
github-dlr https://github.com/makccr/wallpapers/blob/master/wallpapers/space
```
> [!NOTE]
> By default it will download the entire folder from GitHub and place in the current directory from where the command is being executed. If you want to specify a different output directory, you can do it via the `--output` or `-o` flag.
```sh
github-dlr --output wallpapers https://github.com/makccr/wallpapers/blob/master/wallpapers/space
```
\
Find all available options using `--help`
```sh
usage: github-dlr [-h] [-o] [-v] github_path
Download folders and files from Github.
positional arguments:
github_path Github directory full URL path
options:
-h, --help show this help message and exit
-o, --output Destination directory to download to
-v, --version show program version number and exit
Thanks for using github-dlr!
```
## LICENSE
[MIT](./LICENSE) License © [Rocktim Saikia](https://rocktimsaikia.dev) 2024
Raw data
{
"_id": null,
"home_page": "https://github.com/rocktimsaikia/github-dlr",
"name": "github-dlr",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": "download, github, directory, gitdown",
"author": "Rocktim Saikia",
"author_email": "rocktimthedev@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/a2/b3/27b11acb2aa73158f7b0c418cd380b06a41f62a2c92b33dcac0e9ea16ede/github_dlr-0.1.2.tar.gz",
"platform": null,
"description": "# Github-dlr\n\nDownload individual files and folders from GitHub recursively.\n\n[](https://github.com/rocktimsaikia/github-dlr/actions/workflows/tests.yml)\n\n[](https://github.com/user-attachments/assets/8927d4ef-f8e1-4699-b75b-b7e28291d509)\n\n## Motivation\n\nThe project aims to save time and resources by allowing users to download only the specific folders and files they need from a GitHub repository, without the hassle of cloning the entire repo. It's designed for efficiency, making development and learning more streamlined.\n\n## Install\n\nRequires Python version 3.8 or higher.\n\n```sh\npip install github-dlr\n```\n\nor using [pipx](https://pipx.pypa.io/)\n\n```sh\npipx install github-dlr\n```\n\n## Usage\n\n> [!NOTE]\n> Using the tool is straightforward, copy the GitHub URL of the target repository folder and paste it after the command `github-dlr` or it's alias `gh-dlr`.\n\n```sh\ngithub-dlr <github_path>\n\n# Basic Example\ngithub-dlr https://github.com/makccr/wallpapers/blob/master/wallpapers/space\n```\n\n> [!NOTE]\n> By default it will download the entire folder from GitHub and place in the current directory from where the command is being executed. If you want to specify a different output directory, you can do it via the `--output` or `-o` flag.\n\n```sh\ngithub-dlr --output wallpapers https://github.com/makccr/wallpapers/blob/master/wallpapers/space\n```\n\n\\\nFind all available options using `--help`\n\n```sh\nusage: github-dlr [-h] [-o] [-v] github_path\n\nDownload folders and files from Github.\n\npositional arguments:\n github_path Github directory full URL path\n\noptions:\n -h, --help show this help message and exit\n -o, --output Destination directory to download to\n -v, --version show program version number and exit\n\nThanks for using github-dlr!\n```\n\n## LICENSE\n\n[MIT](./LICENSE) License © [Rocktim Saikia](https://rocktimsaikia.dev) 2024\n",
"bugtrack_url": null,
"license": null,
"summary": "Download individual files and folders from Github",
"version": "0.1.2",
"project_urls": {
"Homepage": "https://github.com/rocktimsaikia/github-dlr"
},
"split_keywords": [
"download",
" github",
" directory",
" gitdown"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5bc885d04e9e295c51bed07279a952ad3fd55a0f48f4f84ecb5376f1e2e274bf",
"md5": "c1391d9360d9375b58df7ea2143685a3",
"sha256": "bafa789a36116cf8f109d97040469dddca5af6e5c18b204dbb29be545622d817"
},
"downloads": -1,
"filename": "github_dlr-0.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c1391d9360d9375b58df7ea2143685a3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 6359,
"upload_time": "2024-09-05T16:08:10",
"upload_time_iso_8601": "2024-09-05T16:08:10.735403Z",
"url": "https://files.pythonhosted.org/packages/5b/c8/85d04e9e295c51bed07279a952ad3fd55a0f48f4f84ecb5376f1e2e274bf/github_dlr-0.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a2b327b11acb2aa73158f7b0c418cd380b06a41f62a2c92b33dcac0e9ea16ede",
"md5": "958db5af262049b2d74a95e9b6782422",
"sha256": "fac37109281ee3669042cd9f64165c101c4882bf79ec4245bb2a2702d888851e"
},
"downloads": -1,
"filename": "github_dlr-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "958db5af262049b2d74a95e9b6782422",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 5214,
"upload_time": "2024-09-05T16:08:12",
"upload_time_iso_8601": "2024-09-05T16:08:12.188458Z",
"url": "https://files.pythonhosted.org/packages/a2/b3/27b11acb2aa73158f7b0c418cd380b06a41f62a2c92b33dcac0e9ea16ede/github_dlr-0.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-05 16:08:12",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "rocktimsaikia",
"github_project": "github-dlr",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "github-dlr"
}
JSON
