Skip to main content

The Git magician for Python

Project description

# gity
[![Build Status](https://travis-ci.org/Mnw2212/gity.svg?branch=master)](https://travis-ci.org/Mnw2212/gity)

```
_ _
__ _(_) |_ _ _
/ _` | | __| | | |
| (_| | | |_| |_| |
\__, |_|\__|\__, |
|___/ |___/

```
The git magician for python. gity makes using git commands in python, a piece of cake.

Most existing Python modules for for interacting with git repositories are extremely verbose and cumbersome.

Python doesnt have a builtin module and with the existing ones it requires tremendous amount of documentation digging to get hold of the simplest functions.

Things shouldn't be this way. Not in Python.

![](http://i.imgur.com/Qn2jHxx.gif)

## Features

- Written in uncomplicated Python
- Easy to [install](https://github.com/mnw2212/gity#installation)
- Works on Linux and Mac

## Current Support
- git init
- git clone
- git status
- git add
- git commit
- git push
- git pull
- git checkout

## Installation


### Option 1: [Pip](https://pypi.python.org/pypi/gity)

```bash
$ pip install gity
```

### Option 2: From source

```bash
$ git clone --recursive git@github.com:mnw2212/gity.git
$ cd gity/
$ python setup.py install
```

## Usage
```python
from gity import gity

obj = gity()
obj.git_add(deletion=True)
message = "inital commit"
obj.git_commit(message)
```

## Contributing

#### Bug Reports & Feature Requests

Please use the [issue tracker](https://github.com/mnw2212/gity/issues) to report any bugs or file feature requests.

#### Developing

PRs are welcome. To begin developing, follow this:

```bash
# make virtual env
$ git clone --recursive git@github.com:Mnw2212/gity.git
$ cd gity/
$ python gity/gity.py
```

Project details


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