- \n
- Python3<\/li>\n
- pip<\/li>\n
- venv<\/li>\n
- Github account<\/li>\n
- Github access token<\/li>\n
- requests~=2.23.0<\/li>\n
- python-dotenv~=0.13.0<\/li>\n<\/ul>\n
Objectives<\/h2>\n
- \n
- Create a repository in GitHub<\/li>\n
- Push local changes to the master branch<\/li>\n
- Stay home and stay safe<\/li>\n<\/ol>\n
Project folder and file structure<\/h2>\n
.\r\n\u251c\u2500\u2500 github\r\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 __init__.py\r\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 run.py\r\n\u2502\u00a0\u00a0 \u2514\u2500\u2500 services.py\r\n\u251c\u2500\u2500 README.md\r\n\u251c\u2500\u2500 requirements.txt\r\n\u251c\u2500\u2500 settings.py\r\n\u251c\u2500\u2500 shell_scripts\r\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 github_push.sh\r\n\u2514\u2500\u2500 utils\r\n\u251c\u2500\u2500 helpers.py\r\n\u2514\u2500\u2500 __init__.py\r\n\u2514\u2500\u2500.env\r\n\r\n<\/pre>\n
Adding Shell Scripts<\/h2>\n
Now to add remote origin we need to add the below code in shell_scripts\/github_push.sh.<\/strong><\/p>\n
#! \/bin\/bash\r\n\r\nset -e\r\n\r\n# shellcheck disable=SC2164\r\ncd\r\ncd \"$1\"\r\ngit remote add origin \"$2\"\r\ngit push origin master<\/pre>\n
<\/p>\n
Config .env file<\/h2>\n
Now we need to add some credentials in our .env <\/strong>file.<\/p>\n
GITHUB_ACCESS_TOKEN={Your github access token}\r\nGITHUB_USERNAME={Your github username}<\/pre>\nTo get GitHub access token visit here<\/a>.<\/p>\n
Config settings.py<\/h2>\n
Now let’s add some constants to use in our projects inside the settings.py<\/strong> file.<\/p>\n
import os\r\nfrom dotenv import load_dotenv\r\n\r\n\r\nload_dotenv()\r\n\r\nGITHUB_ACCESS_TOKEN = os.getenv(\"GITHUB_ACCESS_TOKEN\")\r\nGITHUB_USERNAME = os.getenv(\"GITHUB_USERNAME\")<\/pre>\n
<\/p>\n
Helper methods<\/h2>\n
Now, let’s create some helper method to get a shell script from a directory and building a remote origin URL. To do that we will write those methods in utils\/helpers.py <\/strong>file.<\/p>\n
import os\r\nfrom settings import GITHUB_USERNAME\r\n\r\n\r\ndef get_shell_script(file_name: str) -> dict:\r\n \"\"\"\r\n Get shell script from shell_scripts folder\r\n :param file_name:\r\n :return:\r\n \"\"\"\r\n try:\r\n # Get the root directory\r\n root_dir = os.path.dirname(\r\n os.path.realpath(__file__)).rsplit(os.sep, 1)[0]\r\n # Get the shell script, which will create the venv\r\n shell_script = os.path.join(root_dir, \"shell_scripts\", file_name)\r\n\r\n return dict(success=True, script=shell_script)\r\n except Exception as e:\r\n\r\n return dict(success=False, message=str(e))\r\n\r\n\r\ndef github_repo_remote_origin(repo_name: str) -> str:\r\n \"\"\"\r\n\r\n :param repo_name:\r\n :return:\r\n \"\"\"\r\n return \"git@github.com:\"+GITHUB_USERNAME+'\/'+repo_name+'.git'\r\n\r\n<\/pre>\n
Developing a service for Github Automation<\/h2>\n
Let’s build a separate service for all the actions. But first, import all the necessary things.<\/p>\n
import subprocess\r\nimport requests\r\nfrom settings import GITHUB_ACCESS_TOKEN, GITHUB_USERNAME\r\nfrom utils.helpers import get_shell_script<\/pre>\n
Now let’s create a class with its properties.<\/p>\n
class GithubService:\r\n \"\"\"\r\n Github service\r\n \"\"\"\r\n\r\n __github_push_shell_script: str = \"github_push.sh\"\r\n __repo_creation_end_point: str = \"https:\/\/api.github.com\/user\/repos\"\r\n __headers = {\r\n 'Authorization': 'token ' + GITHUB_ACCESS_TOKEN\r\n }<\/pre>\nLet’s write an __init__\u00a0 method with two arguments, one is repo_name and another is git_directory.<\/p>\n
def __init__(self, repo_name, git_directory):\r\n \"\"\"\r\n\r\n :param repo_name:\r\n :param git_directory:\r\n \"\"\"\r\n self.repo_name = repo_name\r\n self.git_directory = git_directory<\/pre>\n
Now let’s write a method to get remote origin.<\/p>\n
def __github_repo_remote_origin(self):\r\n \"\"\"\r\n \r\n :return:\r\n \"\"\"\r\n return \"git@github.com:\"+GITHUB_USERNAME+'\/'+self.repo_name+'.git'<\/pre>\n
We need a method to create a Github repository. To do that we will need the help of python request. We will make a post request in __repo_creation_end_point with a repo name and it will create a repository in Github for us. Check out the PI documentation I have added below and you will find something like that in the repository section.<\/p>\n
![\"\"](\"https:\/\/toptechytips.com\/wp-content\/uploads\/2020\/06\/Screenshot-from-2020-06-17-22-01-04-300x300.png\")
<\/p>\ndef create_repo(self) -> dict:\r\n \"\"\"\r\n\r\n :return:\r\n \"\"\"\r\n try:\r\n with requests.Session() as s:\r\n s.headers.update(self.__headers)\r\n resp = s.post(self.__repo_creation_end_point, json={\r\n \"name\": self.repo_name\r\n })\r\n print(resp.content.decode())\r\n\r\n return dict(success=True,\r\n message=\"Github repository has been created\")\r\n except Exception as e:\r\n\r\n return dict(success=False, message=str(e))<\/pre>\nNow we need to push our changes in Github right? To do that we need to add remote origin and push changes there. We will get our shell script first. Then we will run it in a subprocess.<\/p>\n
def git_add_remote_origin_and_push_master(self):\r\n \"\"\"\r\n Will add remote origin and push changes to github repo\r\n :return:\r\n \"\"\"\r\n try:\r\n shell_script = get_shell_script(self.__github_push_shell_script)\r\n if not shell_script[\"success\"]:\r\n return dict(success=False, message=\"Shell script not found\")\r\n # execute and get the output of the shell script\r\n output = subprocess.check_output([\r\n shell_script[\"script\"],\r\n str(self.git_directory),\r\n str(self.__github_repo_remote_origin()),\r\n ])\r\n print(output.decode())\r\n\r\n return dict(success=True, message=\"Git push successfull\")\r\n except Exception as e:\r\n\r\n print(e)\r\n return dict(success=False, message=\"Git push failed\",\r\n error_message=str(e))<\/pre>\n
To run the whole process we need to write the below code in the github\/run.py\u00a0<\/strong>file.<\/p>\n
from github.services import GithubService\r\n\r\n\r\ndef create_repo_and_push_local_changes(repo_name: str, git_directory: str) -> \\\r\n dict:\r\n github_service = GithubService(repo_name, git_directory)\r\n repository_api_response = github_service.create_repo()\r\n if not repository_api_response[\"success\"]:\r\n return repository_api_response\r\n push_response = github_service.git_add_remote_origin_and_push_master()\r\n if not push_response[\"success\"]:\r\n return push_response\r\n\r\n return dict(success=True, message=dict(\r\n repository_api_response=repository_api_response[\"message\"],\r\n push_response=push_response[\"message\"],\r\n ))<\/pre>\n
If you check your Github you will find your repository there. One thing you have noticed that We have run shell scripts in the subprocess. The subprocess module allows you to spawn new processes, connect to their input\/output\/error pipes, and obtain their return codes. This module intends to replace several older modules and functions. In Linux, a subprocess is a child process, i.e. a process that has been launched by its parent to which it is a subprocess. An interactive shell is a command-line interpreter reading your input line by line and prompting you when a command is done.<\/p>\n
Well, let me tell you about this tool. I have developed a tool to automate python projects. It will create a project in venv and do all the git and Github stuffs for me. I have shown you examples of Github API using python. We will discover more about the tool in the future. Till then write a tool for automating Github. You can do many actions with Github APIs. I have gave you all the thing you will need to know.<\/p>\n
Happy coding!<\/p>\n
<\/p>\n
Original tool Github repository: https:\/\/github.com\/zim0101\/jervis_the_bot\u00a0<\/a><\/p>\n
Python subprocess module: https:\/\/docs.python.org\/3\/library\/subprocess.html<\/a><\/p>\n