GitPub - Python library to interact with github's public API

Getting started!

Follow up these instructions if you want to see it in action up and running on your machine.

System Requirements:

pytest: Uses pytest as the unit-testing framework. Install using pip install pytest.
requests: Uses requests for interacting with the various api urls.

Few Final Steps:

Step 1: 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.

Step 2: Type the following commands in python shell:

import gitpub

username = 'demfier' # there goes your username, inside ' '
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`

Step 3: Run Tests : Just run the command py.test -v to see the test results. and you're done!!

Contribution

Want to contribute? Awesome, we always wanted a larger development base. Jump into contribution instructions for further instructions.

LICENSE

The MIT License (MIT) 2017 - Gaurav Sahu. Please have a look at the LICENSE.txt for more details.

utkarshkvs1 / GitPub