octodir

Name	octodir JSON
Version	1.1.0 JSON
	download
home_page	https://github.com/Jalkhov/octodir
Summary	Tool for downloading directories from Github repositories
upload_time	2023-05-10 22:31:15
maintainer
docs_url	None
author	Pedro Torcatt
requires_python	>=3.0
license
keywords	github directory download
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            <div align="center">
    <img src="https://raw.githubusercontent.com/Jalkhov/octodir/main/logo.png">
</div>

Tool for downloading directories from Github repositories.

ALERT: Not authenticated requests have limits, fixing for add API Key support.

# Installation
  ```
  $ pip install octodir
  ```

# Use

## From the console

```
$ octodir
```

**You will be asked for the following data:**

* **Full folder url:** Direct url to the target folder
  * **Example:** `https://github.com/Jalkhov/octodir/tree/stable/octodir`
* **Output folder**: Absolute path of the output directory
  * You can enter a dot to download in the current working directory
* **API key**: Personal Github Token for prevent requests limit

## In code

```python
from octodir import Octodir

target = 'https://github.com/Jalkhov/Octodir/tree/stable/octodir'
folder = '.' # Current working directory
api_key = '<PERSONAL_GITHUB_TOKEN>'

Octo = Octodir(target, folder, api_key=api_key)
Octo.dowload_folder()
```

# Support me <3

<a href="https://www.buymeacoffee.com/Jalkhov" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png" alt="Buy Me A Coffee" style="height: 41px !important;width: 174px !important;box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;-webkit-box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;" ></a>

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/Jalkhov/octodir",
    "name": "octodir",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.0",
    "maintainer_email": "",
    "keywords": "github directory download",
    "author": "Pedro Torcatt",
    "author_email": "pedrotorcattsoto@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/df/d5/5f5e3cf6b901610a8020f7189d65e73f6c0af77042f3c314a71e7c632a4a/octodir-1.1.0.tar.gz",
    "platform": null,
    "description": "<div align=\"center\">\r\n    <img src=\"https://raw.githubusercontent.com/Jalkhov/octodir/main/logo.png\">\r\n</div>\r\n\r\nTool for downloading directories from Github repositories.\r\n\r\nALERT: Not authenticated requests have limits, fixing for add API Key support.\r\n\r\n# Installation\r\n  ```\r\n  $ pip install octodir\r\n  ```\r\n\r\n# Use\r\n\r\n## From the console\r\n\r\n```\r\n$ octodir\r\n```\r\n\r\n**You will be asked for the following data:**\r\n\r\n* **Full folder url:** Direct url to the target folder\r\n  * **Example:** `https://github.com/Jalkhov/octodir/tree/stable/octodir`\r\n* **Output folder**: Absolute path of the output directory\r\n  * You can enter a dot to download in the current working directory\r\n* **API key**: Personal Github Token for prevent requests limit\r\n\r\n## In code\r\n\r\n```python\r\nfrom octodir import Octodir\r\n\r\ntarget = 'https://github.com/Jalkhov/Octodir/tree/stable/octodir'\r\nfolder = '.' # Current working directory\r\napi_key = '<PERSONAL_GITHUB_TOKEN>'\r\n\r\nOcto = Octodir(target, folder, api_key=api_key)\r\nOcto.dowload_folder()\r\n```\r\n\r\n# Support me <3\r\n\r\n<a href=\"https://www.buymeacoffee.com/Jalkhov\" target=\"_blank\"><img src=\"https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png\" alt=\"Buy Me A Coffee\" style=\"height: 41px !important;width: 174px !important;box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;-webkit-box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;\" ></a>\r\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "Tool for downloading directories from Github repositories",
    "version": "1.1.0",
    "project_urls": {
        "Bug Reports": "https://github.com/Jalkhov/octodir/issues",
        "Homepage": "https://github.com/Jalkhov/octodir",
        "Source": "https://github.com/Jalkhov/octodir/"
    },
    "split_keywords": [
        "github",
        "directory",
        "download"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "dfd55f5e3cf6b901610a8020f7189d65e73f6c0af77042f3c314a71e7c632a4a",
                "md5": "4c6e3f0936edbc3b588a8ce6aff4d90d",
                "sha256": "579e24388a30245dace930a2f0e73dd1bd46e33cb2329a3ee939cce5f63ea2b2"
            },
            "downloads": -1,
            "filename": "octodir-1.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "4c6e3f0936edbc3b588a8ce6aff4d90d",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.0",
            "size": 4830,
            "upload_time": "2023-05-10T22:31:15",
            "upload_time_iso_8601": "2023-05-10T22:31:15.121979Z",
            "url": "https://files.pythonhosted.org/packages/df/d5/5f5e3cf6b901610a8020f7189d65e73f6c0af77042f3c314a71e7c632a4a/octodir-1.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-05-10 22:31:15",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Jalkhov",
    "github_project": "octodir",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "requirements": [],
    "lcname": "octodir"
}