gitpub

a module to interact with Github's API


Keywords
github, api, development, interact, github-api, github-profile, pytest
License
MIT
Install
pip install gitpub==1.0

Documentation

[WIP] Python library to interact with github's public API

Requirements:
------------------

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

How to use:
--------------

  • 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.

Type the following commands in python shell:

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 commandpy.test -v to see the test results.

To Do:

  • Integrate Github's API v4
  • Use Github API's auth method for sending requests