Metadata-Version: 2.1
Name: create-remote-repo
Version: 1.0.0
Summary: This command line tool automates the process of initializing a local Git repository, creating a remote GitHub repository via the GitHub API, optionally adding a .gitignore file, staging changes, committing, and performing the initial push to the remote repository.
Home-page: 
Author: Kim Chung
Author-email: Kim Chung <kchung0802@gmail.com>
License: MIT License
        
        Copyright (c) 2024-present, Kim Chung
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Repository, https://github.com/Kimmm-c/automate-create-remote-repo
Keywords: github,automation,create,remote repository
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: MacOS
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE

# GitHub Repo Automation Tool

This command line tool automates the process of initializing a local Git repository, creating a remote GitHub repository via the GitHub API, optionally adding a `.gitignore` file, staging changes, committing, and performing the initial push to the remote repository.

## Features

- Initialize a local Git repository.
- Create a remote repository on GitHub.
- Optionally add a `.gitignore` file.
- Stage changes.
- Commit changes.
- Push the initial commit to the remote repository.

## Requirements

- Python 3.x
- Git
- GitHub account and authorization token

## Installation

## Usage
```bash
python create-remote-repo -rn <repo-name> -gu <github-username> -t <github-token> -d <working-directory> [-i <include-gitignore>] [-p <private>]
```

## Example
```bash
python create-remote-repo -rn my-new-repo -gu myusername -t mytoken -d /path/to/working/directory -i y -p y
```

This command will:

1. Initialize a Git repository in the specified local working directory.
2. Create a remote repository named my-new-repo under the GitHub account myusername.
3. Add a .gitignore file to the repository.
4. Stage all changes.
5. Commit the changes.
6. Push the initial commit to the private remote repository.

## CLI Arguments
| Argument                     | Description                                                                                      | Required | Default Value            |
|------------------------------|--------------------------------------------------------------------------------------------------|----------|--------------------------|
| `-rn`, `--repo-name`         | The name of the remote repository you want to create.                                            | Yes      | None                     |
| `-gu`, `--github-username`   | The username of your GitHub account.                                                             | No       | `global_github_username` |
| `-t`, `--github-token`       | Your GitHub authorization token.                                                                 | No       | `global_github_token`    |
| `-d`, `--working-directory`  | The absolute path to the local working directory where the repository should be initialized.     | Yes      | None                     |
| `-i`, `--include-gitignore`  | Enter `y` if you want to add a `.gitignore` file to your repository, otherwise enter `n`.        | No       | `n`                      |
| `-p`, `--private`            | Enter `y` if you want to make the remote repository private, otherwise enter `n`.                | No       | `n`                      |

## License
This project is licensed under the MIT License. See the [LICENSE](https://github.com/Kimmm-c/automate-create-remote-repo/blob/9c1d5213b39def985fc7cbfb1c4f15a2e7b74b57/LICENSE) file for details.

## Acknowledgements
Created and maintained by Kim Chung.
