mirror of
https://github.com/status-im/PyGithub.git
synced 2026-09-01 03:11:09 +00:00
Steve Kowalik
babcbcd04f
Now that GitHub have moved their documentation from developer.github.com, we should update our links. I have also tried to update the call strings to their new format, but since it was done via regex, some of them may not match exactly.
61 lines
2.3 KiB
Markdown
61 lines
2.3 KiB
Markdown
# PyGitHub
|
|
|
|
[](https://pypi.python.org/pypi/PyGithub)
|
|
|
|
[](https://pygithub.readthedocs.io/en/latest/?badge=latest)
|
|
[](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
|
|
|
|
# First create a Github instance:
|
|
|
|
# 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.](https://pygithub.readthedocs.io/en/latest/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.
|