Skip to main content

A python module for simple interaction with git via subprocess

Project description

# simplegit A python module for simple interaction with git via subprocess.

### How? ` # pip install simplegit ` (note: this doesn’t work via pip yet. Working on that.) `python from simplegit import Git git = Git() output_lines, returncode, error_lines = git.status() `

### Why? In personal projects, I always find myself writing scripts to automate parts of the development process. One example is checking out a gh-pages branch for a Github Pages website, pushing to gh-pages, then checking out master again - usually I have a script called push.py which automates this. If you’re conditionally ignoring files based on the branch, you have even more processing to do (including extra commits). It’s kind of clumsy to execute these git commands using python’s subprocess, so simplegit provides a nice wrapper.

### How does it work? The Git class form simplegit simply takes a call to it (for example Git().status(“-s”)), builds a subprocess command, executes it, and returns the relevant information. Any git command (e.g. status, commit, push, pull) is available, since the python object blindly proxies the function name to build the command (e.g. git.add(“-A”) -> git add -A). Some examples:

`python lines, rtncode, err_lines = git.status("-s") lines, rtncode, err_lines = git.commit("-m 'A fun message'") `

If you need to call a git command that would produce a python syntax error, like ls-files, you can use Git().call:

`python git.call("ls-files", "--others --exclude-standard") `

### Contributing Right now, this is just a one-off side project that I started. If you’d like to contribute or have ideas, pull requests are welcome!

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

simplegit-0.0.1.tar.gz (3.1 kB view details)

Uploaded Source

Built Distribution

simplegit-0.0.1-py2.py3-none-any.whl (4.6 kB view details)

Uploaded Python 2Python 3

File details

Details for the file simplegit-0.0.1.tar.gz.

File metadata

  • Download URL: simplegit-0.0.1.tar.gz
  • Upload date:
  • Size: 3.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for simplegit-0.0.1.tar.gz
Algorithm Hash digest
SHA256 49a1257bc7c0b60b66fb6399292c91b11dca16fcde202fa4b49ed1826936479e
MD5 b660ec979e792888da2bd09e40e650f9
BLAKE2b-256 a1e3caecf11eabed0a21883aab19ee25950988d330141f34a89bf82f1b77c57a

See more details on using hashes here.

File details

Details for the file simplegit-0.0.1-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for simplegit-0.0.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 194692972e98a84bb8d0ef023de9204fefe97461ffa84eb462d5ee39ce3d921a
MD5 c7a9e4947a565961a3d1a389a0a119cb
BLAKE2b-256 a3086a0d8c2cf15c4635cafcd1c9bd1351c251c6e0a9ddbff9db5d288ad1fd95

See more details on using hashes here.

Supported by

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