| Name | PyGithub JSON |
| Version |
2.4.0
JSON |
| download |
| home_page | None |
| Summary | Use the full Github API v3 |
| upload_time | 2024-08-26 06:49:44 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | None |
| keywords |
github
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 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]: https://github.com/PyGithub/PyGithub/blob/main/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.
Raw data
{
"_id": null,
"home_page": null,
"name": "PyGithub",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "github",
"author": null,
"author_email": "Vincent Jacques <vincent@vincent-jacques.net>",
"download_url": "https://files.pythonhosted.org/packages/f1/a0/1e8b8ca88df9857836f5bf8e3ee15dfb810d19814ef700b12f99ce11f691/pygithub-2.4.0.tar.gz",
"platform": null,
"description": "# PyGitHub\n\n[](https://pypi.python.org/pypi/PyGithub)\n\n[](https://pygithub.readthedocs.io/en/stable/?badge=stable)\n[](https://en.wikipedia.org/wiki/GNU_Lesser_General_Public_License)\n[](https://join.slack.com/t/pygithub-project/shared_invite/zt-duj89xtx-uKFZtgAg209o6Vweqm8xeQ)\n[](https://www.codetriage.com/pygithub/pygithub)\n[](https://codecov.io/gh/PyGithub/PyGithub)\n[](https://github.com/psf/black)\n\nPyGitHub is a Python library to access the [GitHub REST API].\nThis library enables you to manage [GitHub] resources such as repositories, user profiles, and organizations in your Python applications.\n\n[GitHub REST API]: https://docs.github.com/en/rest\n[GitHub]: https://github.com\n\n## Install\n\n```bash\npip install PyGithub\n```\n\n## Simple Demo\n\n```python\nfrom github import Github\n\n# Authentication is defined via github.Auth\nfrom github import Auth\n\n# using an access token\nauth = Auth.Token(\"access_token\")\n\n# First create a Github instance:\n\n# Public Web Github\ng = Github(auth=auth)\n\n# Github Enterprise with custom hostname\ng = Github(base_url=\"https://{hostname}/api/v3\", auth=auth)\n\n# Then play with your Github objects:\nfor repo in g.get_user().get_repos():\n print(repo.name)\n\n# To close connections after use\ng.close()\n```\n\n## Documentation\n\nMore information can be found on the [PyGitHub documentation site.](https://pygithub.readthedocs.io/en/stable/introduction.html)\n\n## Development\n\n### Contributing\n\nLong-term discussion and bug reports are maintained via GitHub Issues.\nCode review is done via GitHub Pull Requests.\n\nFor more information read [CONTRIBUTING.md].\n\n[CONTRIBUTING.md]: https://github.com/PyGithub/PyGithub/blob/main/CONTRIBUTING.md\n\n### Maintainership\n\nWe're actively seeking maintainers that will triage issues and pull requests and cut releases.\nIf 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.\n",
"bugtrack_url": null,
"license": null,
"summary": "Use the full Github API v3",
"version": "2.4.0",
"project_urls": {
"Documentation": "https://pygithub.readthedocs.io/en/stable/",
"Source": "https://github.com/pygithub/pygithub",
"Tracker": "https://github.com/pygithub/pygithub/issues"
},
"split_keywords": [
"github"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0af3e185613c411757c0c18b904ea2db173f2872397eddf444a3fe8cdde47077",
"md5": "987045aeee4d9949661bc92ca6080166",
"sha256": "81935aa4bdc939fba98fee1cb47422c09157c56a27966476ff92775602b9ee24"
},
"downloads": -1,
"filename": "PyGithub-2.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "987045aeee4d9949661bc92ca6080166",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 362599,
"upload_time": "2024-08-26T06:49:42",
"upload_time_iso_8601": "2024-08-26T06:49:42.351974Z",
"url": "https://files.pythonhosted.org/packages/0a/f3/e185613c411757c0c18b904ea2db173f2872397eddf444a3fe8cdde47077/PyGithub-2.4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f1a01e8b8ca88df9857836f5bf8e3ee15dfb810d19814ef700b12f99ce11f691",
"md5": "9ad4bdf757df7f69a0905a1aa5e2aab3",
"sha256": "6601e22627e87bac192f1e2e39c6e6f69a43152cfb8f307cee575879320b3051"
},
"downloads": -1,
"filename": "pygithub-2.4.0.tar.gz",
"has_sig": false,
"md5_digest": "9ad4bdf757df7f69a0905a1aa5e2aab3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 3476673,
"upload_time": "2024-08-26T06:49:44",
"upload_time_iso_8601": "2024-08-26T06:49:44.029907Z",
"url": "https://files.pythonhosted.org/packages/f1/a0/1e8b8ca88df9857836f5bf8e3ee15dfb810d19814ef700b12f99ce11f691/pygithub-2.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-26 06:49:44",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pygithub",
"github_project": "pygithub",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "pygithub"
}
