mirror of
https://github.com/status-im/PyGithub.git
synced 2026-08-31 19:01:15 +00:00
70 lines
2.4 KiB
Markdown
70 lines
2.4 KiB
Markdown
# PyGitHub
|
|
|
|
[](https://pypi.python.org/pypi/PyGithub)
|
|
|
|
[](https://pygithub.readthedocs.io/en/stable/?badge=stable)
|
|
[](https://en.wikipedia.org/wiki/GNU_Lesser_General_Public_License)
|
|
[](https://join.slack.com/t/pygithub-project/shared_invite/zt-duj89xtx-uKFZtgAg209o6Vweqm8xeQ)
|
|
[](https://www.codetriage.com/pygithub/pygithub)
|
|
[](https://codecov.io/gh/PyGithub/PyGithub)
|
|
[](https://github.com/psf/black)
|
|
|
|
PyGitHub is a Python library to access the [GitHub REST API].
|
|
This library enables you to manage [GitHub] resources such as repositories, user profiles, and organizations in your Python applications.
|
|
|
|
[GitHub REST API]: https://docs.github.com/en/rest
|
|
[GitHub]: https://github.com
|
|
|
|
## Install
|
|
|
|
```bash
|
|
pip install PyGithub
|
|
```
|
|
|
|
## Simple Demo
|
|
|
|
```python
|
|
from github import Github
|
|
|
|
# Authentication is defined via github.Auth
|
|
from github import Auth
|
|
|
|
# using an access token
|
|
auth = Auth.Token("access_token")
|
|
|
|
# First create a Github instance:
|
|
|
|
# Public Web Github
|
|
g = Github(auth=auth)
|
|
|
|
# Github Enterprise with custom hostname
|
|
g = Github(base_url="https://{hostname}/api/v3", auth=auth)
|
|
|
|
# Then play with your Github objects:
|
|
for repo in g.get_user().get_repos():
|
|
print(repo.name)
|
|
|
|
# To close connections after use
|
|
g.close()
|
|
```
|
|
|
|
## Documentation
|
|
|
|
More information can be found on the [PyGitHub documentation site.](https://pygithub.readthedocs.io/en/stable/introduction.html)
|
|
|
|
## 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].
|
|
|
|
[CONTRIBUTING.md]: /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.
|