Skip to main content

# githon

[![Current version at PyPI](https://img.shields.io/pypi/v/githon.svg)](https://pypi.python.org/pypi/githon) ![Supported Python Versions](https://img.shields.io/pypi/pyversions/githon.svg) ![Software status](https://img.shields.io/pypi/status/githon.svg) [![PyPI](https://img.shields.io/pypi/l/githon.svg)]() [![GitHub issues](https://img.shields.io/github/issues/marcosvbras/githon.svg)]() [![GitHub forks](https://img.shields.io/github/forks/marcosvbras/githon.svg?style=social&label=Fork)]() [![GitHub stars](https://img.shields.io/github/stars/marcosvbras/githon.svg?style=social&label=Stars)]() [![Donate](https://img.shields.io/gratipay/marcosvbras.svg?style=social&label=Donate)](https://www.gratipay.com/marcosvbras)

Githon is a python library that provides a GitHub REST API v3 Data Scraping.

With this library you can: - Request user data through username or user ID - Control request errors easily - Use Application tokens or Personal User tokens to request data - Reduce spending on your requisition limit

## Installation Run the command:

` pip install githon `

## How to use Import the GithubApi class and create an object. Optionally pass an access token to constructor.

` >>> from githon import GithubApi >>> gh = GithubApi('YOUR_ACCESS_TOKEN') `

> NOTE: With access_token, your rate limit will be 5000 requests per hour. If you don’t provide an access_token, your number of requests will be limited to 60 requests per hour, according with GitHub REST API v3 docs. See more in https://developer.github.com/v3/#rate-limitingUse.

Sample code:

` >>> gh.user_by_username('marcosvbras') { 'blog': 'https://about.me/marcosvbras', 'followers': 7, 'following': 28, ...} `

## Methods - `user_by_username`: Request user based in Github login. - `user_by_id`: Request user based in Github User ID. - `user_emails`: Retrieve a list of emails from a given access_token. Requires the user access token. - `followers_by_id`: Request the user followers based in Github login. - `followers_by_username`: Request the user followers based in Github ID. - `following_by_id`: Request the user following based in Github ID. - `following_by_username`: Request the user following based in Github login. - `gists_by_id`: Request the user gists based in Github ID. - `gists_by_username`: Request the user gists based in Github login. - `repositories_by_id`: Request the user repositories based in Github ID. - `repositories_by_username`: Request the user repositories based in Github login. - `search_users`: Search users with a Github query. - `get_request_limit`: Request the API Rate Limit to your token.

Metadata

Release files for githon 0.7.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for githon 0.7.0
File Size Uploaded
githon-0.7.0.tar.gz 6.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for githon 0.7.0
File Interpreter ABI Platform
githon-0.7.0-py3-none-any.whl Python 3 none any Details

Total release size: 17.4 kB

Release files / githon-0.7.0.tar.gz

Download URL githon-0.7.0.tar.gz
Size 6.8 kB
Tags Source
SHA-256 checksum
How to use checksums
3007e274fce6e4cee2bab478c55f2f5413a21b9677f6e862410e3f9f74146783
BLAKE2b-256 checksum
How to use checksums
6498ff6ae2ccf161230b28e99e39e433f2fc2acd0524fb4f177e75e8368d5c0e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release files / githon-0.7.0-py3-none-any.whl

Download URL githon-0.7.0-py3-none-any.whl
Size 10.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
2df4b72e695439ebcdafe6e8e847b23e438294e05fdc333e2d5b69b7bd51c639
BLAKE2b-256 checksum
How to use checksums
fc15cb7e61fd8eacfd265baa0037453512e94b8f73a38a597334cd0ec1088908
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

This release

0.7.0 This release

2 release files

0.6.0

2 release files

0.5.7

2 release files

0.5.6

2 release files

0.5.5

2 release files

0.5.4

2 release files

0.5.3

2 release files

0.5.2

2 release files

0.5.1

2 release files

0.5.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page