PyGithub 1.58.2__tar.gz → 1.59.0__tar.gz

PyGithub-1.59.0/.github/workflows/ci.yml

@@ -0,0 +1,35 @@
+name: CI
+on:
+  push:
+    branches: master
+  pull_request:
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    name: test (Python ${{ matrix.python-version }})
+    strategy:
+      matrix:
+        # keey it sync with tox.ini [gh-actions] section
+        python-version: ["3.7", "3.8", "3.9", "3.10", "3.11", "3.12-dev"]
+    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
+  draft:
+    runs-on: ubuntu-latest
+    needs: test
+    if: github.ref == 'refs/heads/master'
+    steps:
+      - uses: release-drafter/release-drafter@v5
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

PyGithub-1.59.0/.github/workflows/lint.yml

@@ -0,0 +1,44 @@
+name: Lint
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+jobs:
+  mypy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.x"
+      - run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements-types.txt
+      - uses: liskin/gh-problem-matcher-wrap@v2
+        with:
+          action: add
+          linters: mypy
+      - run: mypy --show-column-numbers github tests
+
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: "3.x"
+      - uses: pre-commit/action@v3.0.0
+
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: "3.8"
+
+      - run: pip install -r requirements.txt
+      - run: pip install -e .
+      - run: sphinx-build doc build

PyGithub-1.59.0/.github/workflows/pypi-release.yml

@@ -0,0 +1,25 @@
+name: Publish to PyPI
+on:
+  push:
+    tags:
+      - "*"
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: '3.x'
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install setuptools wheel twine
+      - name: Build and publish
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+        run: |
+          python setup.py sdist bdist_wheel
+          twine upload dist/*

PyGithub-1.59.0/CONTRIBUTING.md

@@ -0,0 +1,125 @@
+# 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 and uses isort to sort imports.
+
+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 test-requirements.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. 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.txt
+sphinx-build doc build
+```
+
+If you use tox:
+
+```bash
+tox -edocs
+```

PyGithub-1.59.0/MAINTAINERS

@@ -0,0 +1,8 @@
+Adam Dangoor <adamdangoor@gmail.com> (@adamtheturtle)
+Jimmy Zelinskie <jimmyzelinskie@gmail.com> (@jzelinskie)
+Nhomar Hernández <nhomar@gmail.com> (@nhomar)
+Vincent Jacques <vincent@vincent-jacques.net> (@jacquev6)
+Wan Liuyang <t@sfdye.com> (@sfdye)
+Steve Kowalik <steven@wedontsleep.org> (@s-t-e-v-e-n-k)
+Enrico Minack <github@Enrico.Minack.dev> (@EnricoMi)
+Jonathan Leitschuh <Jonathan.Leiitschuh@gmail.com> (@JLLeitschuh)

PyGithub-1.59.0/PKG-INFO

@@ -0,0 +1,59 @@
+Metadata-Version: 2.1
+Name: PyGithub
+Version: 1.59.0
+Summary: Use the full Github API v3
+Home-page: https://github.com/pygithub/pygithub
+Author: Vincent Jacques
+Author-email: vincent@vincent-jacques.net
+Project-URL: Documentation, http://pygithub.readthedocs.io/en/stable/
+Project-URL: Source, https://github.com/pygithub/pygithub
+Project-URL: Tracker, https://github.com/pygithub/pygithub/issues
+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.7
+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: Topic :: Software Development
+Requires-Python: >=3.7
+Provides-Extra: integrations
+License-File: COPYING
+License-File: COPYING.LESSER
+
+(Very short) Tutorial
+=====================
+
+First create a Github instance::
+
+    from github import Github
+
+    # Authentication is defined via github.Auth
+    from github import Auth
+
+    # using an access token
+    auth = Auth.Token("access_token")
+
+    # Public Web Github
+    g = Github(auth=auth)
+
+    # Github Enterprise with custom hostname
+    g = Github(auth=auth, base_url="https://{hostname}/api/v3")
+
+Then play with your Github objects::
+
+    for repo in g.get_user().get_repos():
+        print(repo.name)
+        repo.edit(has_wiki=False)
+        # to see all the available attributes and methods
+        print(dir(repo))
+
+Reference documentation
+=======================
+
+See http://pygithub.readthedocs.io/en/stable/

PyGithub-1.59.0/PyGithub.egg-info/PKG-INFO

@@ -0,0 +1,59 @@
+Metadata-Version: 2.1
+Name: PyGithub
+Version: 1.59.0
+Summary: Use the full Github API v3
+Home-page: https://github.com/pygithub/pygithub
+Author: Vincent Jacques
+Author-email: vincent@vincent-jacques.net
+Project-URL: Documentation, http://pygithub.readthedocs.io/en/stable/
+Project-URL: Source, https://github.com/pygithub/pygithub
+Project-URL: Tracker, https://github.com/pygithub/pygithub/issues
+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.7
+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: Topic :: Software Development
+Requires-Python: >=3.7
+Provides-Extra: integrations
+License-File: COPYING
+License-File: COPYING.LESSER
+
+(Very short) Tutorial
+=====================
+
+First create a Github instance::
+
+    from github import Github
+
+    # Authentication is defined via github.Auth
+    from github import Auth
+
+    # using an access token
+    auth = Auth.Token("access_token")
+
+    # Public Web Github
+    g = Github(auth=auth)
+
+    # Github Enterprise with custom hostname
+    g = Github(auth=auth, base_url="https://{hostname}/api/v3")
+
+Then play with your Github objects::
+
+    for repo in g.get_user().get_repos():
+        print(repo.name)
+        repo.edit(has_wiki=False)
+        # to see all the available attributes and methods
+        print(dir(repo))
+
+Reference documentation
+=======================
+
+See http://pygithub.readthedocs.io/en/stable/