Metadata-Version: 2.4
Name: github-bulk-clone
Version: 0.0.2
Summary: A script that script that helps get a backup of all your github projects.
Project-URL: Homepage, https://github.com/awesome-open-source-projects/github-bulk-clone
Project-URL: Issues, https://github.com/awesome-open-source-projects/github-bulk-clone/issues
Author-email: yolowex <yolowex@gmail.com>
License-Expression: MPL-2.0
License-File: LICENSE
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.9
Requires-Dist: requests>=2.32.0
Description-Content-Type: text/markdown

## README for GitHub Bulk Clone

### Overview

**github-bulk-clone** is a Python package that allows you to efficiently clone all repositories from a specified GitHub user, including private ones if you have access.

### Installation

Install via pip:

```bash
pip install github-bulk-clone
```

### Usage

#### Command-line

Run the following command in your terminal:

```bash
python -m github_bulk_clone <username> <clone_directory> [-t <token>]
```

- `<username>`: GitHub username.
- `<clone_directory>`: Local directory for cloning.
- `-t <token>`: Optional GitHub personal access token.

#### Python Script

Import and use the functions directly:

```python
from github_bulk_clone import clone_all_repos_of

clone_all_repos_of('USER_NAME', 'YOUR_TOKEN', './my_repos')
```

### Functions

- **`get_all_repo_names(api_token, username)`**: Fetches repository URLs.
- **`store_repo_names_to_file(repo_list, path)`**: Saves repository URLs to a file.
- **`clone_from_list(repos, clone_directory)`**: Clones repositories from a list.
- **`clone_all_repos_of(username, api_token, clone_directory)`**: Main function to clone repositories.

### License

This project is licensed under the MIT License.

### Contributing

Feel free to contribute via pull requests or by opening issues on GitHub.