PyGithub 2.2.0__tar.gz → 2.4.0__tar.gz

pygithub-2.4.0/.github/workflows/ci.yml

@@ -0,0 +1,69 @@
+name: CI
+on:
+  push:
+    branches:
+      - main
+      - release-v*
+  pull_request:
+  merge_group:
+
+jobs:
+
+  build:
+    uses: "./.github/workflows/_build-pkg.yml"
+    with:
+      artifact-name: package
+
+  test:
+    runs-on: ${{ matrix.os }}
+    name: test (Python ${{ matrix.python-version }} on ${{ matrix.os-label }})
+    strategy:
+      fail-fast: false
+      matrix:
+        # keep in sync with tox.ini [gh-actions] section
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
+        os: ["ubuntu-latest"]
+        os-label: ["Ubuntu"]
+        include:
+          - {python-version: "3.8", os: "windows-latest", os-label: "Windows"}
+          - {python-version: "3.8", os: "macos-latest", os-label: "macOS"}
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "${{ matrix.python-version }}"
+      - name: Install tox
+        run: |
+          python -m pip install --upgrade pip
+          pip install tox tox-gh-actions
+      - name: Run tests
+        run: tox
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v3
+
+  test_success:
+    # this aggregates success state of all jobs listed in `needs`
+    # this is the only required check to pass CI
+    name: "Test success"
+    if: always()
+    runs-on: ubuntu-latest
+    needs: [test]
+    steps:
+      - name: "Success"
+        if: needs.test.result == 'success'
+        run: true
+        shell: bash
+      - name: "Failure"
+        if: needs.test.result != 'success'
+        run: false
+        shell: bash
+
+  draft:
+    runs-on: ubuntu-latest
+    needs: test_success
+    if: github.ref == 'refs/heads/main'
+    steps:
+      - uses: release-drafter/release-drafter@v5
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

pygithub-2.4.0/.gitignore

@@ -0,0 +1,62 @@
+############################ Copyrights and license ############################
+#                                                                              #
+# Copyright 2012 Vincent Jacques <vincent@vincent-jacques.net>                 #
+# Copyright 2013 AKFish <akfish@gmail.com>                                     #
+# Copyright 2013 Vincent Jacques <vincent@vincent-jacques.net>                 #
+# Copyright 2014 Nic Dahlquist <nic@snapchat.com>                              #
+# Copyright 2014 Vincent Jacques <vincent@vincent-jacques.net>                 #
+# Copyright 2016 Peter Buckley <dx-pbuckley@users.noreply.github.com>          #
+# Copyright 2017 Chris McBride <thehighlander@users.noreply.github.com>        #
+# Copyright 2017 Colin Hoglund <colinhoglund@users.noreply.github.com>         #
+# Copyright 2018 Vinay Hegde <hegde.vi@husky.neu.edu>                          #
+# Copyright 2018 sfdye <tsfdye@gmail.com>                                      #
+# Copyright 2020 Steve Kowalik <steven@wedontsleep.org>                        #
+# Copyright 2020 Wan Liuyang <tsfdye@gmail.com>                                #
+# Copyright 2023 Enrico Minack <github@enrico.minack.dev>                      #
+# Copyright 2023 Sol Redfern <59831933+Tsuesun@users.noreply.github.com>       #
+# Copyright 2024 Aiden Grossman <agrossman154@yahoo.com>                       #
+# Copyright 2024 Enrico Minack <github@enrico.minack.dev>                      #
+# Copyright 2024 Jacky Lam <jacky.lam@r2studiohk.com>                          #
+#                                                                              #
+# This file is part of PyGithub.                                               #
+# http://pygithub.readthedocs.io/                                              #
+#                                                                              #
+# PyGithub is free software: you can redistribute it and/or modify it under    #
+# the terms of the GNU Lesser General Public License as published by the Free  #
+# Software Foundation, either version 3 of the License, or (at your option)    #
+# any later version.                                                           #
+#                                                                              #
+# PyGithub is distributed in the hope that it will be useful, but WITHOUT ANY  #
+# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS    #
+# FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more #
+# details.                                                                     #
+#                                                                              #
+# You should have received a copy of the GNU Lesser General Public License     #
+# along with PyGithub. If not, see <http://www.gnu.org/licenses/>.             #
+#                                                                              #
+################################################################################
+
+.DS_Store
+
+*.pyc
+.eggs/
+.python-version
+
+/GithubCredentials.py
+/scripts/TwitterCredentials.py
+/dist/
+/build/
+/MANIFEST
+/PyGithub.egg-info/
+/.coverage
+/coverage.xml
+/.idea
+/developer.github.com/
+/gh-pages/
+/doc/doctrees/
+.vscode*
+.venv
+venv
+.tox/
+.mypy_cache/
+*.swp

pygithub-2.4.0/.pre-commit-config.yaml

@@ -0,0 +1,47 @@
+default_language_version:
+  python: python3
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+      - id: check-symlinks
+      - id: destroyed-symlinks
+      - id: mixed-line-ending
+        args:
+          - "--fix=lf"
+
+  - repo: https://github.com/asottile/pyupgrade
+    rev: v3.15.0
+    hooks:
+      - id: pyupgrade
+        args: ["--py38-plus"]
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.1.7
+    hooks:
+      - id: ruff
+        args:
+          - "--fix"
+          - "--fixable=ALL"
+          - "--exit-non-zero-on-fix"
+
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.2.6
+    hooks:
+      - id: codespell
+        additional_dependencies: [tomli]
+
+  - repo: https://github.com/PyCQA/docformatter
+    rev: v1.7.5
+    hooks:
+      - id: docformatter
+        additional_dependencies: [tomli]
+        args: ["--in-place"]
+
+  - repo: https://github.com/psf/black
+    rev: 23.12.0
+    hooks:
+      - id: black

pygithub-2.4.0/CONTRIBUTING.md

@@ -0,0 +1,136 @@
+# Contributing
+
+## Issues
+
+A good issue includes a [short, self contained, correct example](http://sscce.org/) of the problem, something like:
+
+```python
+assert github.Github().get_user("jacquev6").name == "Vincent Jacques"
+```
+
+It is even better if you provide the debug logs associated with your issue.
+Enable them with `github.enable_console_debug_logging` and copy them in the body of the issue.
+**Warning:** you may want to remove some private information (authentication information is removed, but there may be private stuff in the messages)
+
+If for any reason you are not able to do that, open your issue anyway and a maintainer will see what is needed to solve your problem.
+
+## Pull Requests
+
+Pull Requests should clearly describe two things:
+
+1. The problem they attempt to solve
+2. How the author went about solving the problem
+
+Ideally, changes should be made in logical commits and tests added to improve the project's coverage of the GitHub API.
+
+## Coding style
+
+PyGithub adopts the black coding style.
+
+To manually format the code:
+```bash
+tox -e lint
+```
+
+## Pre-commit plugin
+
+To forget about coding style and let [pre-commit](https://pre-commit.com/#installation) fix your flake8/isort/black issue.
+
+```
+pre-commit install
+```
+
+That's it!
+
+## Adding missing attributes for a GithubObject
+
+```bash
+$ python scripts/add_attribute.py [class_name] [attribute_name] [attribute_type]
+
+# For example, if you want to add a `url` attribute of string type to the Commit class
+# Note: adding multiple attributes you have to run the script multiple times
+
+$ python scripts/add_attribute.py Commit url string
+```
+
+## Deprecation warning
+
+Before removing attributes/methods, consider adding deprecation warnings instead. The [Deprecated](https://github.com/tantale/deprecated) packages provides a handy decorator to add deprecation warnings with an optional reason.
+
+```python
+from deprecated import deprecated
+
+@property
+@deprecated
+def rate(self):
+   pass
+
+@deprecated(reason="Deprecated in favor of the new branch protection")
+def get_protected_branch(self):
+   pass
+```
+
+## Automated tests
+
+First you need to install the test dependencies:
+```bash
+pip install -r requirements/test.txt
+```
+
+Then you can run the tests through `pytest`.
+Run a specific test with `pytest tests/tests_filename.py` or `pytest tests/tests_filename.py -k testMethod` or `pytest -k TestClass.testMethod`.
+
+If you add a new test, for example `Issue139.testCompletion`, you have to run `pytest -k Issue139.testCompletion --record` to create the `tests/ReplayData/*.txt` files needed for your new test.
+Check them and commit them as well.
+You will need a `GithubCredentials.py` file at the root of the project with the following contents:
+
+```python
+login = "my_login"
+password = "my_password"                # Can be left empty if not used
+oauth_token = "my_token"                # Can be left empty if not used
+jwt = "my_json_web_token"               # Can be left empty if not used
+app_id = "my_app_id"                    # Can be left empty if not used
+app_private_key = "my_app_private_key"  # Can be left empty if not used
+```
+
+If you use 2 factor authentication on your Github account, tests that require a login/password authentication will fail.
+You can use `pytest Issue139.testCompletion --record --auth_with_token` to use the `oauth_token` field specified in `GithubCredentials.py` when recording a unit test interaction. Note that the `password = ""` (empty string is ok) must still be present in `GithubCredentials.py` to run the tests even when the `--auth_with_token` arg is used.
+
+Also note that if you record your test data with `--auth_with_token` then you also need to be in token authentication mode when running the test. You can do this by setting `tokenAuthMode` to be true like so:
+
+```python
+    def setUp(self):
+        self.tokenAuthMode = True
+        super().setUp()
+        ...
+```
+
+A simple alternative is to replace `token private_token_removed` with `Basic login_and_password_removed` in all your newly generated ReplayData files.
+
+Similarly, you can use `pytest Issue139.testCompletion --record --auth_with_jwt` to use the `jwt` field specified in `GithubCredentials.py` to access endpoints that require JWT.
+
+To run manual tests with external scripts that use the PyGithub package, you can install your development version with:
+
+```bash
+pip install --editable path/to/project
+```
+
+You may also want to investigate `tox` to run tests:
+
+```bash
+pip install tox
+tox -epy310
+```
+
+## Build documentation locally
+
+```bash
+pip install -r requirements/docs.txt
+sphinx-build doc build
+```
+
+If you use tox:
+
+```bash
+tox -edocs
+```

pygithub-2.4.0/PKG-INFO

@@ -0,0 +1,103 @@
+Metadata-Version: 2.1
+Name: PyGithub
+Version: 2.4.0
+Summary: Use the full Github API v3
+Author-email: Vincent Jacques <vincent@vincent-jacques.net>
+Project-URL: Documentation, https://pygithub.readthedocs.io/en/stable/
+Project-URL: Source, https://github.com/pygithub/pygithub
+Project-URL: Tracker, https://github.com/pygithub/pygithub/issues
+Keywords: github
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Web Environment
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: GNU Library or Lesser General Public License (LGPL)
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: COPYING
+License-File: COPYING.LESSER
+Requires-Dist: pynacl>=1.4.0
+Requires-Dist: requests>=2.14.0
+Requires-Dist: pyjwt[crypto]>=2.4.0
+Requires-Dist: typing-extensions>=4.0.0
+Requires-Dist: urllib3>=1.26.0
+Requires-Dist: Deprecated
+Provides-Extra: integrations
+
+# 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.

pygithub-2.4.0/PyGithub.egg-info/PKG-INFO

@@ -0,0 +1,103 @@
+Metadata-Version: 2.1
+Name: PyGithub
+Version: 2.4.0
+Summary: Use the full Github API v3
+Author-email: Vincent Jacques <vincent@vincent-jacques.net>
+Project-URL: Documentation, https://pygithub.readthedocs.io/en/stable/
+Project-URL: Source, https://github.com/pygithub/pygithub
+Project-URL: Tracker, https://github.com/pygithub/pygithub/issues
+Keywords: github
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Web Environment
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: GNU Library or Lesser General Public License (LGPL)
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: COPYING
+License-File: COPYING.LESSER
+Requires-Dist: pynacl>=1.4.0
+Requires-Dist: requests>=2.14.0
+Requires-Dist: pyjwt[crypto]>=2.4.0
+Requires-Dist: typing-extensions>=4.0.0
+Requires-Dist: urllib3>=1.26.0
+Requires-Dist: Deprecated
+Provides-Extra: integrations
+
+# 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.