Metadata-Version: 2.0
Name: gitpub
Version: 1.0
Summary: a module to interact with Github's API
Home-page: https://github.com/demfier/gitpub
Author: Gaurav Sahu
Author-email: sahu.gaurav719@googlemail.com
License: MIT
Keywords: github api development interact
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Requires-Dist: peppercorn

## Github library to interact with it's public API

Requirements:
<br>------------------
* [pytest](http://doc.pytest.org/en/latest/): Uses __pytest__ as the unit-testing framework. Install using <code>pip install pytest</code>.
* [requests](https://pypi.python.org/pypi/requests/2.11.1): Uses __requests__ for interacting with the various api urls.

How to use:
<br>--------------
* __Load Github Profile & Public Repo details of a user__: Loading a github profile just needs a _username_ to startwith. Here is a small demo with _username_ [__demfier__](https://github.com/Demfier).<br>

Type the following commands in python shell:

```python
import gitpub

username = 'demfier'
profile = gitpub.Profile()
profile.load_gh_profile(username)  # loads profile details of `username`
profile.get_public_repos()  # loads all the public repo details of `username`
```

* __Run Tests__: Just run the command<code>py.test -v</code> to see the test results.


