An advanced REST client for the GitHub API
Project description
github3api
An advanced REST client for the GitHub API. It is a subclass of rest3client tailored for the GitHub API with special optional directives for GET requests that can return all pages from an endpoint or return a generator that can be iterated over. By default all requests will be retried if ratelimit request limit is reached.
Installation
pip install github3api
Example Usage
>>> from github3api import GitHubAPI
GitHubAPI
instantiation
# instantiate using no-auth
>>> client = GitHubAPI()
# instantiate using a token
>>> client = GitHubAPI(bearer_token='****************')
GET
request
# GET request - return JSON response
>>> client.get('/rate_limit')['resources']['core']
{'limit': 60, 'remaining': 37, 'reset': 1588898701}
# GET request - return raw resonse
>>> client.get('/rate_limit', raw_response=True)
<Response [200]>
POST
request
>>> client.post('/user/repos', json={'name': 'test-repo1'})['full_name']
'soda480/test-repo1'
>>> client.post('/repos/soda480/test-repo1/labels', json={'name': 'label1', 'color': '#006b75'})['url']
'https://api.github.com/repos/soda480/test-repo1/labels/label1'
PATCH
request
>>> client.patch('/repos/soda480/test-repo1/labels/label1', json={'description': 'my label'})['url']
'https://api.github.com/repos/soda480/test-repo1/labels/label1'
DELETE
request
>>> client.delete('/repos/soda480/test-repo1')
GET all
directive - Get all pages from an endpoint and return list containing only matching attributes
for repo in client.get('/user/repos', _get='all', _attributes=['full_name']):
print(repo['full_name'])
GET page
directive - Yield a page from endpoint
for page in client.get('/user/repos', _get='page'):
for repo in page:
print(repo['full_name'])
total
- Get total number of resources at given endpoint
print(client.total('/user/repos'))
6218
Projects using github3api
-
edgexfoundry/sync-github-labels A script that synchronizes GitHub labels and milestones
-
edgexfoundry/prune-github-tags A script that prunes GitHub pre-release tags
-
edgexfoundry/create-github-release A script to facilitate creation of GitHub releases
-
soda480/prepbadge A script that creates multiple pull request workflows to update a target organization repos with badges
-
soda480/github-contributions A script to get contribution metrics for all members of a GitHub organization using the GitHub GraphQL API
Development
Ensure the latest version of Docker is installed on your development server. Fork and clone the repository.
Build the Docker image:
docker image build \
--target build-image \
--build-arg http_proxy \
--build-arg https_proxy \
-t \
github3api:latest .
Run the Docker container:
docker container run \
--rm \
-it \
-e http_proxy \
-e https_proxy \
-v $PWD:/github3api \
github3api:latest \
/bin/sh
Execute the build:
pyb -X
NOTE: commands above assume working behind a proxy, if not then the proxy arguments to both the docker build and run commands can be removed.
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
Built Distribution
Hashes for github3api-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9545ebcdf1f27b198f319799e243ab717686b0fad19ebcf9cad81e1e9eb96aae |
|
MD5 | 10af97a30364be1cd9a2fa73db222261 |
|
BLAKE2b-256 | b0c4dacdc7823e5f642ece8915336d5077ae484d34c35cb721f7237afbc92f92 |