Skip to content

Latest commit

 

History

History
53 lines (44 loc) · 1.12 KB

README.md

File metadata and controls

53 lines (44 loc) · 1.12 KB

gitator

This is a python class with utilities createdd to interact with Git and GitHub APIs.

Utilization

Installation

pip install gitator

Execution

First, import the class:

from gitator import Gitator

Then create an object and use whatever method you need:

gitator = Gitator()
gitator.create_github_connection(github_token)

Development

Dependencies

Runtime

Tests

Test Strategy

This script uses the pytest framework in order to run unit tests.

Test Setup

In order to run tests, firt clone the repo and create a virtualenv:

git clone git@github.com:enkelbr/gitator.git
virtualenv -p python3 gitator
cd gitator
source bin/activate

Then install the deps. For example (on Enterprise Linux):

sudo yum install python pip
cd gitator
pip install -r requirements.txt

Test Execution

To run tests, just run pytest:

pytest