Skip to main content

Run git terminal commands from python scripts

Project description

Pygit

Installation:


pip install Pygitcli

Here is an example code to perform various git commands:-

"""
===============
Pygitcli
===============
This example shows how to use the Pygitcli module. We will demonstrate how 
to perform various git commands.
First, some imports.
"""
from Pygitcli.git import Git

###############################################################################
# Now let's initialize the Git class 
# We need to provide the path to the target directory

git = Git(r'D:\test_directory')

###############################################################################
# Next we will initialize an empty git directory in the target directory

repo_info = ['https://github.com/test_user/test_repo.git', 'master']
git.init_repo(repo_info)

###############################################################################
# Next, we'll perform various git commands

git.add('test_file.txt')
git.commit('test_file.txt')
git.pull(repo_info)
git.push(repo_info)

###############################################################################
# There are some utility functions in the Git class as well

git.create_readme() # creates a README.md in the target directory

# Set remote URL, branch
git.set_remote(url='https://github.com/test_user/test_repo.git')
git.set_branch(branch='master', new=True) # If the branch already exists set new to False

# Get remote repository information (URL, branch)
url = git.get_remote()
branch = git.get_branch()


Change Log

0.0.1 (13/12/2020)

  • First Release

0.0.4 (13/12/2020)

  • Changed Documentation

0.0.6 (30/05/2021)

  • Code cleanup
  • Bug Fixes
  • More git commands!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Pygitcli-0.0.6.tar.gz (4.5 kB view details)

Uploaded Source

File details

Details for the file Pygitcli-0.0.6.tar.gz.

File metadata

  • Download URL: Pygitcli-0.0.6.tar.gz
  • Upload date:
  • Size: 4.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.3.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.9.2

File hashes

Hashes for Pygitcli-0.0.6.tar.gz
Algorithm Hash digest
SHA256 910e39ee01f893fc826eeddaf7ae88d24f23ccef7426fd054695cc1058e7c4b6
MD5 03600f0e38d3e7e1fc2c378d57a99785
BLAKE2b-256 d4233ef10c170368d7897f96a10beb6864a74485bf66479b74de9d3e7f48386b

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page