Skip to content
master
Go to file
Code

Files

Permalink
Failed to load latest commit information.

README.rst

github.py

GitHub contributors Documentation Status PyPI status information PyPI version information PyPI supported Python versions PyPI license information

An asynchronous Python wrapper for GitHub API, v4.

Features

  1. Easy to use, modern Pythonic API using async/await syntax.
  2. 100% coverage of the supported GitHub API.
  3. All user-facing objects and methods are documented here.

Installation

Python 3.5.2 or higher is required.

To install a final version of the wrapper do one of the following:

# Windows
py -3 -m pip install --upgrade github.py

# Linux / OS X
python3 -m pip install --upgrade github.py

To install the development version of the wrapper do one of the following:

# Windows
py -3 -m pip install --upgrade git+https://github.com/ShineyDev/github.py

# Linux / OS X
python3 -m pip install --upgrade git+https://github.com/ShineyDev/github.py

Examples

Fetch a repository's license:

import github
g = github.Client("token")
# you'll need a personal access token to use this library - you can get
# one from https://github.com/settings/tokens.

repo = await g.fetch_repository("ShineyDev", "github.py")
print(repo.license.name)

You can find more examples in the examples directory.

Attribution

Rapptz for EnumMeta - Copyright (c) 2015-2019 Rapptz

You can’t perform that action at this time.