PyGithub 2.4.0__tar.gz → 2.6.0__tar.gz

pygithub-2.6.0/.github/release.yml

@@ -0,0 +1,19 @@
+changelog:
+  exclude:
+    labels: []
+    authors: []
+  categories:
+    - title: Breaking Changes
+      labels: ['breaking']
+    - title: New Features
+      labels: ['feature']
+    - title: Improvement
+      labels: ['improvement']
+    - title: Bug Fixes
+      labels: ['bugfix']
+    - title: Dependencies
+      labels: ['dependencies']
+    - title: Maintenance
+      labels: ['ci', 'documentation', 'maintenance']
+    - title: Others
+      labels: ['*']

pygithub-2.6.0/.github/workflows/_build-pkg.yml

@@ -0,0 +1,32 @@
+name: Build package
+
+on:
+  workflow_call:
+    inputs:
+      artifact-name:
+        description: "Name of an artifact"
+        type: "string"
+        required: false
+        default: "package"
+
+jobs:
+  build-pkg:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.x'
+
+      - name: Install dependencies
+        run: pip install -U build twine
+      - name: Build 📦 package
+        run: python -m build
+      - name: Check 📦 package
+        run: twine check dist/*
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: ${{ inputs.artifact-name }}
+          path: dist

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

@@ -0,0 +1,76 @@
+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 Test Results
+        if: always()
+        uses: actions/upload-artifact@v4
+        with:
+          name: Test Results (Python ${{ matrix.python-version }} on ${{ matrix.os-label }})
+          path: pytest.xml
+      - 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
+
+  event_file:
+    name: "Event File"
+    runs-on: ubuntu-latest
+    steps:
+      - name: Upload
+        uses: actions/upload-artifact@v4
+        with:
+          name: Event File
+          path: ${{ github.event_path }}

pygithub-2.6.0/.github/workflows/lint.yml

@@ -0,0 +1,58 @@
+name: Lint
+on:
+  push:
+    branches:
+      - main
+      - release-v*
+  pull_request:
+  merge_group:
+
+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 -e .
+          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"
+      # FIXME: pin pre-commit<4 pending PyCQA/docformatter#287
+      - name: install pre-commit
+        run: python -m pip install 'pre-commit<4'
+      - name: show environment
+        run: python -m pip freeze --local
+      - uses: actions/cache@v4
+        with:
+          path: ~/.cache/pre-commit
+          key: pre-commit-${{ hashFiles('.pre-commit-config.yaml') }}
+      - name: run pre-commit
+        run: pre-commit run --show-diff-on-failure --color=always --all-files
+
+  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/docs.txt
+      - run: pip install -e .
+      - run: sphinx-build doc build

pygithub-2.6.0/.github/workflows/pypi-release.yml

@@ -0,0 +1,29 @@
+name: Publish to PyPI
+on:
+  push:
+    tags: ["*"]  # this will run full workflow including publish to PyPI
+  workflow_dispatch:
+
+jobs:
+  build:
+    uses: "./.github/workflows/_build-pkg.yml"
+    with:
+      artifact-name: package
+
+  publish:
+    needs: [build]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: package
+          path: dist
+      - name: Install twine
+        run: pip install -U "twine>=6.1.0" "packaging>=24.2"
+      - name: Publish 📦 to PyPI
+        # only run this for tags
+        if: startsWith(github.event.ref, 'refs/tags/')
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+        run: twine upload dist/*

pygithub-2.6.0/.github/workflows/test-results.yml

@@ -0,0 +1,33 @@
+name: Test Results
+
+on:
+  workflow_run:
+    workflows: ["CI"]
+    types:
+      - completed
+permissions: {}
+
+jobs:
+  test-results:
+    name: Test Results
+    if: github.event.workflow_run.conclusion != 'skipped'
+    runs-on: ubuntu-latest
+    permissions:
+      checks: write
+      pull-requests: write
+
+    steps:
+      - name: Download and Extract Artifacts
+        uses: dawidd6/action-download-artifact@e7466d1a7587ed14867642c2ca74b5bcc1e19a2d
+        with:
+          run_id: ${{ github.event.workflow_run.id }}
+          path: artifacts
+
+      - name: Publish Test Results
+        id: test-results
+        uses: EnricoMi/publish-unit-test-result-action@v2
+        with:
+          commit: ${{ github.event.workflow_run.head_sha }}
+          event_file: artifacts/Event File/event.json
+          event_name: ${{ github.event.workflow_run.event }}
+          files: "artifacts/**/*.xml"

pygithub-2.6.0/.github/workflows/top-issues.yaml

@@ -0,0 +1,23 @@
+name: Top issues
+on:
+  schedule:
+    - cron: '0 0 */1 * *'
+  workflow_dispatch:
+
+jobs:
+  ShowAndLabelTopIssues:
+    name: Display and label top issues
+    runs-on: ubuntu-latest
+    if: github.repository == 'PyGithub/PyGithub'
+    steps:
+      - name: Run top issues action
+        uses: rickstaa/top-issues-action@7e8dda5d5ae3087670f9094b9724a9a091fc3ba1  # v1.3.101
+        env:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          label: true
+          dashboard: true
+          dashboard_show_total_reactions: true
+          top_issues: true
+          top_pull_requests: true
+          top_list_size: 10

pygithub-2.6.0/PKG-INFO

@@ -0,0 +1,103 @@
+Metadata-Version: 2.2
+Name: PyGithub
+Version: 2.6.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.6.0/PyGithub.egg-info/PKG-INFO

@@ -0,0 +1,103 @@
+Metadata-Version: 2.2
+Name: PyGithub
+Version: 2.6.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.