PyGithub


NamePyGithub JSON
Version 2.8.1 PyPI version JSON
download
home_pageNone
SummaryUse the full Github API v3
upload_time2025-09-02 17:41:54
maintainerNone
docs_urlNone
authorNone
requires_python>=3.8
licenseNone
keywords github
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # PyGitHub

[![PyPI](https://img.shields.io/pypi/v/PyGithub.svg)](https://pypi.python.org/pypi/PyGithub)
![CI](https://github.com/PyGithub/PyGithub/workflows/CI/badge.svg)
[![readthedocs](https://img.shields.io/badge/docs-stable-brightgreen.svg?style=flat)](https://pygithub.readthedocs.io/en/stable/?badge=stable)
[![License](https://img.shields.io/badge/license-LGPL-blue.svg)](https://en.wikipedia.org/wiki/GNU_Lesser_General_Public_License)
[![Slack](https://img.shields.io/badge/Slack%20channel-%20%20-blue.svg)](https://join.slack.com/t/pygithub-project/shared_invite/zt-duj89xtx-uKFZtgAg209o6Vweqm8xeQ)
[![Open Source Helpers](https://www.codetriage.com/pygithub/pygithub/badges/users.svg)](https://www.codetriage.com/pygithub/pygithub)
[![codecov](https://codecov.io/gh/PyGithub/PyGithub/branch/master/graph/badge.svg)](https://codecov.io/gh/PyGithub/PyGithub)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](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/c1/74/e560bdeffea72ecb26cff27f0fad548bbff5ecc51d6a155311ea7f9e4c4c/pygithub-2.8.1.tar.gz",
    "platform": null,
    "description": "# PyGitHub\n\n[![PyPI](https://img.shields.io/pypi/v/PyGithub.svg)](https://pypi.python.org/pypi/PyGithub)\n![CI](https://github.com/PyGithub/PyGithub/workflows/CI/badge.svg)\n[![readthedocs](https://img.shields.io/badge/docs-stable-brightgreen.svg?style=flat)](https://pygithub.readthedocs.io/en/stable/?badge=stable)\n[![License](https://img.shields.io/badge/license-LGPL-blue.svg)](https://en.wikipedia.org/wiki/GNU_Lesser_General_Public_License)\n[![Slack](https://img.shields.io/badge/Slack%20channel-%20%20-blue.svg)](https://join.slack.com/t/pygithub-project/shared_invite/zt-duj89xtx-uKFZtgAg209o6Vweqm8xeQ)\n[![Open Source Helpers](https://www.codetriage.com/pygithub/pygithub/badges/users.svg)](https://www.codetriage.com/pygithub/pygithub)\n[![codecov](https://codecov.io/gh/PyGithub/PyGithub/branch/master/graph/badge.svg)](https://codecov.io/gh/PyGithub/PyGithub)\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](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.8.1",
    "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": null,
            "digests": {
                "blake2b_256": "07ba7049ce39f653f6140aac4beb53a5aaf08b4407b6a3019aae394c1c5244ff",
                "md5": "9490643231d8bc5cc26fe0836d50c4a3",
                "sha256": "23a0a5bca93baef082e03411bf0ce27204c32be8bfa7abc92fe4a3e132936df0"
            },
            "downloads": -1,
            "filename": "pygithub-2.8.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "9490643231d8bc5cc26fe0836d50c4a3",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 432709,
            "upload_time": "2025-09-02T17:41:52",
            "upload_time_iso_8601": "2025-09-02T17:41:52.947928Z",
            "url": "https://files.pythonhosted.org/packages/07/ba/7049ce39f653f6140aac4beb53a5aaf08b4407b6a3019aae394c1c5244ff/pygithub-2.8.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "c174e560bdeffea72ecb26cff27f0fad548bbff5ecc51d6a155311ea7f9e4c4c",
                "md5": "2bbc18e9a32b7977906d2f627d80796c",
                "sha256": "341b7c78521cb07324ff670afd1baa2bf5c286f8d9fd302c1798ba594a5400c9"
            },
            "downloads": -1,
            "filename": "pygithub-2.8.1.tar.gz",
            "has_sig": false,
            "md5_digest": "2bbc18e9a32b7977906d2f627d80796c",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 2246994,
            "upload_time": "2025-09-02T17:41:54",
            "upload_time_iso_8601": "2025-09-02T17:41:54.674292Z",
            "url": "https://files.pythonhosted.org/packages/c1/74/e560bdeffea72ecb26cff27f0fad548bbff5ecc51d6a155311ea7f9e4c4c/pygithub-2.8.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-09-02 17:41:54",
    "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"
}
        
Elapsed time: 4.59131s