Skip to content

heisenberg-2505/GitPub

Repository files navigation

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

PRs Welcome

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.

Contributing

Want to contribute? Awesome, have a look at contribution instructions.

LICENSE

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

About

Module to interact with Github's public API

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages