| Name | create-remote-repo JSON |
| Version |
1.0.0
JSON |
| download |
| home_page | None |
| 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. |
| upload_time | 2024-07-15 05:38:44 |
| maintainer | None |
| docs_url | None |
| author | Kim Chung |
| requires_python | >=3.7 |
| 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. |
| keywords |
github
automation
create
remote repository
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 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.
Raw data
{
"_id": null,
"home_page": null,
"name": "create-remote-repo",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "github, automation, create, remote repository",
"author": "Kim Chung",
"author_email": "Kim Chung <kchung0802@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/e4/2a/32a9a01dc69b896d7af9de7afe2e9ddc446b0ed28295cce83ab9399edf37/create-remote-repo-1.0.0.tar.gz",
"platform": null,
"description": "# GitHub Repo Automation Tool\n\nThis 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.\n\n## Features\n\n- Initialize a local Git repository.\n- Create a remote repository on GitHub.\n- Optionally add a `.gitignore` file.\n- Stage changes.\n- Commit changes.\n- Push the initial commit to the remote repository.\n\n## Requirements\n\n- Python 3.x\n- Git\n- GitHub account and authorization token\n\n## Installation\n\n## Usage\n```bash\npython create-remote-repo -rn <repo-name> -gu <github-username> -t <github-token> -d <working-directory> [-i <include-gitignore>] [-p <private>]\n```\n\n## Example\n```bash\npython create-remote-repo -rn my-new-repo -gu myusername -t mytoken -d /path/to/working/directory -i y -p y\n```\n\nThis command will:\n\n1. Initialize a Git repository in the specified local working directory.\n2. Create a remote repository named my-new-repo under the GitHub account myusername.\n3. Add a .gitignore file to the repository.\n4. Stage all changes.\n5. Commit the changes.\n6. Push the initial commit to the private remote repository.\n\n## CLI Arguments\n| Argument | Description | Required | Default Value |\n|------------------------------|--------------------------------------------------------------------------------------------------|----------|--------------------------|\n| `-rn`, `--repo-name` | The name of the remote repository you want to create. | Yes | None |\n| `-gu`, `--github-username` | The username of your GitHub account. | No | `global_github_username` |\n| `-t`, `--github-token` | Your GitHub authorization token. | No | `global_github_token` |\n| `-d`, `--working-directory` | The absolute path to the local working directory where the repository should be initialized. | Yes | None |\n| `-i`, `--include-gitignore` | Enter `y` if you want to add a `.gitignore` file to your repository, otherwise enter `n`. | No | `n` |\n| `-p`, `--private` | Enter `y` if you want to make the remote repository private, otherwise enter `n`. | No | `n` |\n\n## License\nThis 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.\n\n## Acknowledgements\nCreated and maintained by Kim Chung.\n",
"bugtrack_url": null,
"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. ",
"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.",
"version": "1.0.0",
"project_urls": {
"Repository": "https://github.com/Kimmm-c/automate-create-remote-repo"
},
"split_keywords": [
"github",
" automation",
" create",
" remote repository"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "dfde64cc4f74a8ad477d556ba1195664aa46b4294344d652764e367aa91539b0",
"md5": "86124b1b77756b58220cd28bdde7b3b3",
"sha256": "f94b75db58e19acafaa088fc949476704485ad2c3b1f73a5ad80e3f3c9c8eccf"
},
"downloads": -1,
"filename": "create_remote_repo-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "86124b1b77756b58220cd28bdde7b3b3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 9875,
"upload_time": "2024-07-15T05:38:42",
"upload_time_iso_8601": "2024-07-15T05:38:42.752015Z",
"url": "https://files.pythonhosted.org/packages/df/de/64cc4f74a8ad477d556ba1195664aa46b4294344d652764e367aa91539b0/create_remote_repo-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e42a32a9a01dc69b896d7af9de7afe2e9ddc446b0ed28295cce83ab9399edf37",
"md5": "e6e506ea8ee294b8e3004dd6281b6913",
"sha256": "a6e192030e1cf324a142f2896f1377faae96993376f0998142b6e823d55c3839"
},
"downloads": -1,
"filename": "create-remote-repo-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "e6e506ea8ee294b8e3004dd6281b6913",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 6969,
"upload_time": "2024-07-15T05:38:44",
"upload_time_iso_8601": "2024-07-15T05:38:44.242368Z",
"url": "https://files.pythonhosted.org/packages/e4/2a/32a9a01dc69b896d7af9de7afe2e9ddc446b0ed28295cce83ab9399edf37/create-remote-repo-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-15 05:38:44",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Kimmm-c",
"github_project": "automate-create-remote-repo",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "create-remote-repo"
}
