a module to interact with Github's API
Project description
## 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.
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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
gitpub-1.0.tar.gz
(4.3 kB
view hashes)
Built Distribution
gitpub-1.0-py2-none-any.whl
(6.8 kB
view hashes)