Installation
+Requirements:
+-
+
- Git Bash installed on your computer. +
- GitHub personal access token. (Go to your GitHub profile -> Settings -> Developer settings -> Personal Access Tokens -> Create new token with all the repository permissions) +
Note: This script is written exclusively for Git Bash on Windows. You will have to modify it for other shells.
+-
+
-
+
Fork and clone the repository locally.
+
+ -
+
Create a
+github_secrets.pyfile in the./scriptsfolder and define the following variables inside it:
+GITHUB_API_TOKEN = "Your GitHub personal access token" +USERNAME = "Your GitHub username"
+ -
+
Add the project path to the PATH variable (Recommended):
+
+$ export PATH=$PATH":"$(pwd)"/scripts"To permanently add the scripts path to the PATH variable, run the below command in the project's root directory. (This file is located in your home directory)
+
+$ echo 'export PATH=$PATH''":'"$(pwd)"'/scripts''"' >> ~/.bash_profile
+ -
+
OR
+Run the following commands in the project folder to add the scripts to your bin directory:
+
+$ cp -r /scripts/* /usr/bin/
+
How to Use
+
+ create_repo -h
+
+ Sample usage:
+
+ create_repo <PATH_NAME> <REPO_NAME>
+
+ <PATH_NAME> is the path where you want to create the local repository and <REPO_NAME> is the name for your repo
+Example:
+
+ create_repo . test-repo
+
+ License
+
+
+ MIT License
+
+ 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.
+
+
+
+- Steps to join the project channel on
+
+