Metadata-Version: 2.1
Name: octodir
Version: 1.1.0
Summary: Tool for downloading directories from Github repositories
Home-page: https://github.com/Jalkhov/octodir
Author: Pedro Torcatt
Author-email: pedrotorcattsoto@gmail.com
Project-URL: Bug Reports, https://github.com/Jalkhov/octodir/issues
Project-URL: Source, https://github.com/Jalkhov/octodir/
Keywords: github directory download
Classifier: Development Status :: 5 - Production/Stable
Classifier: Programming Language :: Python :: 3
Classifier: Natural Language :: English
Classifier: Environment :: Console
Classifier: License :: OSI Approved :: MIT License
Requires-Python: >=3.0
Description-Content-Type: text/markdown
License-File: LICENSE

<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>
