mirror of
https://github.com/status-im/PyGithub.git
synced 2026-09-01 11:21:16 +00:00
Steve Kowalik
c822dd1ce0
Due to the recent deprecation of setup.py test, we should move with the times, and switch to a non-deprecated test runner. Add configuration for pytest, and switch tox to using it. Remove AllTests, since it is no longer required to locate test classes, and rewrite tests/__main__.py as a pytest conftest plugin. Also drop the test function from manage.sh, tox does a much better job.
PyGitHub
PyGitHub is a Python library to access the GitHub API v3 and Github Enterprise API v3. This library enables you to manage GitHub resources such as repositories, user profiles, and organizations in your Python applications.
Install
$ pip install PyGithub
Simple Demo
from github import Github
# First create a Github instance:
# using username and password
g = Github("user", "password")
# or using an access token
g = Github("access_token")
# Github Enterprise with custom hostname
g = Github(base_url="https://{hostname}/api/v3", login_or_token="access_token")
# Then play with your Github objects:
for repo in g.get_user().get_repos():
print(repo.name)
Documentation
More information can be found on the PyGitHub documentation site.
Development
Contributing
Long-term discussion and bug reports are maintained via GitHub Issues. Code review is done via GitHub Pull Requests.
For more information read CONTRIBUTING.md.
Maintainership
We're actively seeking maintainers that will triage issues and pull requests and cut releases. If you work on a project that leverages PyGitHub and have a vested interest in keeping the code alive and well, send an email to someone in the MAINTAINERS file.