github-bot-api 0.5.2__tar.gz → 0.6.0__tar.gz

github_bot_api-0.6.0/PKG-INFO

@@ -0,0 +1,52 @@
+Metadata-Version: 2.1
+Name: github-bot-api
+Version: 0.6.0
+Summary: API for creating GitHub bots and webhooks in Python.
+License: MIT
+Author: Niklas Rosenstein
+Author-email: rosensteinniklas@gmail.com
+Requires-Python: >=3.8,<4.0
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+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
+Requires-Dist: PyGithub (>=1.58,<2.0)
+Requires-Dist: PyJWT (>=2.6.0,<3.0.0)
+Requires-Dist: cryptography (>=42.0.5,<43.0.0)
+Requires-Dist: flask
+Requires-Dist: requests (>=2.28.2,<3.0.0)
+Requires-Dist: urllib3 (>=1.26.15,<2.0.0)
+Project-URL: Bug Tracker, https://github.com/NiklasRosenstein/python-github-bot-api/issues
+Project-URL: Documentation, https://niklasrosenstein.github.io/python-github-bot-api/
+Project-URL: Repository, https://github.com/NiklasRosenstein/python-github-bot-api
+Description-Content-Type: text/markdown
+
+<p align="center"><img src="https://i.imgur.com/5SiDsz8.png"></p>
+<h1 align="center">python-github-bot-api</h1>
+<p align="center">
+<a href="https://pypi.org/project/github-bot-api"><img alt="PyPI - Python Version" src="https://img.shields.io/pypi/pyversions/github-bot-api"></a></p>
+
+  [PyGithub]: https://pypi.org/project/PyGithub/
+
+A thin Python library for creating GitHub bots and webhooks in Python with [PyGithub].
+
+```python
+from github import Github
+from github_bot_api import GithubApp
+from pathlib import Path
+
+app = GithubApp(
+    user_agent='my-bot/0.0.0',
+    app_id="67890",
+    private_key=Path("app-private.key").read_text(),
+)
+
+client: Github = app.installation_client(12345)
+```
+
+For more examples, check out the [documentation](https://niklasrosenstein.github.io/python-github-bot-api/).
+

github_bot_api-0.6.0/README.md

@@ -0,0 +1,24 @@
+<p align="center"><img src="https://i.imgur.com/5SiDsz8.png"></p>
+<h1 align="center">python-github-bot-api</h1>
+<p align="center">
+<a href="https://pypi.org/project/github-bot-api"><img alt="PyPI - Python Version" src="https://img.shields.io/pypi/pyversions/github-bot-api"></a></p>
+
+  [PyGithub]: https://pypi.org/project/PyGithub/
+
+A thin Python library for creating GitHub bots and webhooks in Python with [PyGithub].
+
+```python
+from github import Github
+from github_bot_api import GithubApp
+from pathlib import Path
+
+app = GithubApp(
+    user_agent='my-bot/0.0.0',
+    app_id="67890",
+    private_key=Path("app-private.key").read_text(),
+)
+
+client: Github = app.installation_client(12345)
+```
+
+For more examples, check out the [documentation](https://niklasrosenstein.github.io/python-github-bot-api/).

{github_bot_api-0.5.2 → github_bot_api-0.6.0}/pyproject.toml

@@ -4,11 +4,11 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "github-bot-api"
-version = "0.5.2"
+version = "0.6.0"
 description = "API for creating GitHub bots and webhooks in Python."
 authors = ["Niklas Rosenstein <rosensteinniklas@gmail.com>"]
 license = "MIT"
-readme = "readme.md"
+readme = "README.md"
 packages = [{ include = "github_bot_api", from = "src" }]
 classifiers = [
     "Intended Audience :: Developers",
@@ -24,14 +24,11 @@ keywords = []
 [tool.poetry.urls]
 "Bug Tracker" = "https://github.com/NiklasRosenstein/python-github-bot-api/issues"
 Documentation = "https://niklasrosenstein.github.io/python-github-bot-api/"
-Homepage = "https://github.com/NiklasRosenstein/python-github-bot-api"
 Repository = "https://github.com/NiklasRosenstein/python-github-bot-api"
 
 [tool.poetry.dependencies]
 python = "^3.8"
-"nr.functional" = "^0.2.0"
-cryptography = "^39.0.2"
-Deprecated = "^1.2.13"
+cryptography = "^42.0.5"
 flask = { version = "*", optional = true }
 PyGithub = { version = "^1.58", optional = true }
 PyJWT = "^2.6.0"
@@ -44,7 +41,6 @@ flake8 = "*"
 isort = "*"
 mypy = "*"
 pytest = "*"
-types-deprecated = "*"
 types-flask = "*"
 types-requests = "*"
 

github_bot_api-0.6.0/src/github_bot_api/__init__.py

@@ -0,0 +1,8 @@
+__author__ = "Niklas Rosenstein <nrosenstein@palantir.com>"
+__version__ = "0.6.0"
+
+from .app import GithubApp
+from .event import Event, accept_event
+from .webhook import Webhook
+
+__all__ = ["GithubApp", "Event", "accept_event", "Webhook"]

{github_bot_api-0.5.2 → github_bot_api-0.6.0}/src/github_bot_api/app.py

@@ -8,13 +8,12 @@ import sys
 import threading
 import typing as t
 
-import deprecated
 import requests
 import urllib3
-from nr.functional import coalesce
 
 from . import __version__
 from .token import InstallationTokenSupplier, JwtSupplier, TokenInfo
+from .utils.functions import coalesce
 
 T = t.TypeVar("T")
 logger = logging.getLogger(__name__)
@@ -66,38 +65,21 @@ class GithubClientSettings:
 class GithubApp:
     """
     Represents a GitHub application and all the required details.
-
-    # Example
-
-    ```py
-    import os
-    from github_bot_api import GithubApp
-
-    with open(os.environ['PRIVATE_KEY_FILE']) as fp:
-      private_key = fp.read()
-
-    app = GithubApp(
-      user_agent='my-bot/0.0.0',
-      app_id=int(os.environ['APP_ID']),
-      private_key=private_key)
-
-    print(app.app_client().get_app().owner)
-    ```
     """
 
     PUBLIC_GITHUB_V3_API_URL = "https://api.github.com"
 
-    #: User agent of the application. This will be respected in #get_user_agent().
     user_agent: str
+    """User agent of the application. This will be respected in #get_user_agent()."""
 
-    #: GitHub Application ID.
     app_id: int
+    """GitHub Application ID."""
 
-    #: RSA private key to sign the JWT with.
     private_key: str
+    """RSA private key to sign the JWT with."""
 
-    #: GitHub API base URL. Defaults to the public GitHub API.
     v3_api_url: str = PUBLIC_GITHUB_V3_API_URL
+    """GitHub API base URL. Defaults to the public GitHub API."""
 
     def __post_init__(self):
         self._jwt_supplier = JwtSupplier(self.app_id, self.private_key)
@@ -133,15 +115,6 @@ class GithubApp:
 
         return JwtSupplier(self.app_id, self.private_key)
 
-    @property
-    @deprecated.deprecated(reason="use GithubApp.app_client() instead", version="0.4.0")
-    def client(self) -> "github.Github":
-        """
-        Use #app_client() instead.
-        """
-
-        return self.app_client()
-
     def app_client(self, settings: t.Union[GithubClientSettings, t.Dict[str, t.Any], None] = None) -> "github.Github":
         """
         Returns a PyGithub client for your GitHub application.

{github_bot_api-0.5.2 → github_bot_api-0.6.0}/src/github_bot_api/event.py

@@ -21,22 +21,22 @@ class Event:
     Represents a GitHub webhook event.
     """
 
-    #: The name of the event. Could be `pull_request`, for example.
     name: str
+    """ The name of the event. Could be `pull_request`, for example."""
 
-    #: The delivery ID of the event.
     delivery_id: str
+    """The delivery ID of the event."""
 
-    #: The signature of the event. Will only be set if a Webhook-secret is configured on the
-    #: client side (e.g. in #Webhook.secret / if the *webhook_secret* parameter is passed to
-    #: #accept_event()).
     signature: t.Optional[str]
+    """The signature of the event. Will only be set if a Webhook-secret is configured on the
+    client side (e.g. in [`Webhook.secret`][github_bot_api.webhook.Webhook] / if the *webhook_secret* parameter is
+    passed to [`accept_event()`][github_bot_api.event.accept_event])."""
 
-    #: The user agent invoking the webhook.
     user_agent: str
+    """The user agent invoking the webhook."""
 
-    #: The event payload.
     payload: t.Dict[str, t.Any]
+    """The event payload."""
 
 
 def accept_event(
@@ -47,12 +47,12 @@ def accept_event(
     """
     Converts thee HTTP *headers* and the *raw_body* to an #Event object.
 
-    # Arguments
-    headers: The HTTP headers. Must have `X-Github-Event`, `X-Github-Delivery`, `User-Agent`, `Content-Type`.
-      May have `X-Hub-Signature` or `X-Hub-Signature-256`.
-    raw_body: The raw request body for the event. This is converted into a JSON payload.
-    webhook_secret: If specified, the `X-Hub-Signature` or `X-Hub-Signature-256` headers are used to verify
-      the signature of the payload. If not specified, the client does not validate the signature.
+    Args:
+        headers: The HTTP headers. Must have `X-Github-Event`, `X-Github-Delivery`, `User-Agent`, `Content-Type`.
+                 May have `X-Hub-Signature` or `X-Hub-Signature-256`.
+        raw_body: The raw request body for the event. This is converted into a JSON payload.
+        webhook_secret: If specified, the `X-Hub-Signature` or `X-Hub-Signature-256` headers are used to verify
+                        the signature of the payload. If not specified, the client does not validate the signature.
     """
 
     event_name = headers.get("X-GitHub-Event")
@@ -64,7 +64,7 @@ def accept_event(
 
     if not event_name or not delivery_id or not user_agent or not content_type:
         raise InvalidRequest("missing required headers")
-    if webhook_secret is not None and not (signature_1 or signature_256):
+    if webhook_secret is not None and not signature_1 and not signature_256:
         raise InvalidRequest("webhook secret is configured but no signature header was received")
 
     mime_type, parameters = get_mime_components(content_type)

{github_bot_api-0.5.2 → github_bot_api-0.6.0}/src/github_bot_api/signature.py

@@ -15,9 +15,9 @@ def compute_signature(payload: bytes, secret: bytes, algo: str = "sha256") -> st
     algo: The hash algorithm to use, must be `sha1` or `sha256`.
     """
 
-    if algo not in ("sha1", "sha256"):
-        raise ValueError(f"algo must be {{sha1, sha256}}, got {algo!r}")
-    return f"{algo}=" + hmac.new(secret, payload, algo).hexdigest()
+    if algo in {"sha1", "sha256"}:
+        return f"{algo}={hmac.new(secret, payload, algo).hexdigest()}"
+    raise ValueError(f"algo must be {{sha1, sha256}}, got {algo!r}")
 
 
 def check_signature(sig: str, payload: bytes, secret: bytes, algo: str = "sha256") -> None:

{github_bot_api-0.5.2 → github_bot_api-0.6.0}/src/github_bot_api/token.py

@@ -59,7 +59,7 @@ def create_jwt(app_id: int, expires_in: int, private_key: str) -> TokenInfo:
 
     now = int(time.time())
     exp = now + expires_in
-    payload = {"iss": int(app_id), "iat": now, "exp": exp}
+    payload = {"iss": app_id, "iat": now, "exp": exp}
     token = jwt.encode(payload, private_key, algorithm="RS256")
     return TokenInfo(exp, "Bearer", token)
 

github_bot_api-0.6.0/src/github_bot_api/utils/functions.py

@@ -0,0 +1,29 @@
+from typing import Optional, TypeVar, overload
+
+T = TypeVar("T")
+
+
+@overload
+def coalesce(value: Optional[T], fallback: T) -> T: ...
+
+
+@overload
+def coalesce(value: Optional[T], *values: Optional[T]) -> Optional[T]: ...
+
+
+@overload
+def coalesce(value: Optional[T], *values: Optional[T], fallback: T) -> T: ...
+
+
+def coalesce(value: Optional[T], *values: Optional[T], fallback: Optional[T] = None) -> Optional[T]:
+    """
+    Returns the first value that is not `None`. If a not-None fallback is specified, the function is guaranteed
+    to return a not-Non value.
+    """
+
+    if value is not None:
+        return value
+    value = next((x for x in values if x is not None), None)
+    if value is not None:
+        return value
+    return fallback

{github_bot_api-0.5.2 → github_bot_api-0.6.0}/src/github_bot_api/webhook.py

@@ -67,9 +67,6 @@ class Webhook:
                 matched = True
                 if handler.func(event):
                     return True
-        else:
-            logger.info(
-                f'Event %r (id: %r) goes {"unhandled" if matched else "unmatched"}.', event.name, event.delivery_id
-            )
+        logger.info(f'Event %r (id: %r) goes {"unhandled" if matched else "unmatched"}.', event.name, event.delivery_id)
 
         return matched

github_bot_api-0.5.2/LICENSE.txt

@@ -1,20 +0,0 @@
-The MIT License
-
-Copyright (c) 2021 Niklas Rosenstein
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-this software and associated documentation files (the "Software"), to deal in
-Software without restriction, including without limitation the rights to use,
-modify, merge, publish, distribute, sublicense, and/or sell copies of the
-and to permit persons to whom the Software is furnished to do so, subject to
-following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
-PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
-BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
-TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
-USE OR OTHER DEALINGS IN THE SOFTWARE.

github_bot_api-0.5.2/PKG-INFO

@@ -1,104 +0,0 @@
-Metadata-Version: 2.1
-Name: github-bot-api
-Version: 0.5.2
-Summary: API for creating GitHub bots and webhooks in Python.
-License: MIT
-Author: Niklas Rosenstein
-Author-email: rosensteinniklas@gmail.com
-Requires-Python: >=3.8,<4.0
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: MIT License
-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
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Requires-Dist: Deprecated (>=1.2.13,<2.0.0)
-Requires-Dist: PyGithub (>=1.58,<2.0)
-Requires-Dist: PyJWT (>=2.6.0,<3.0.0)
-Requires-Dist: cryptography (>=39.0.2,<40.0.0)
-Requires-Dist: flask
-Requires-Dist: nr.functional (>=0.2.0,<0.3.0)
-Requires-Dist: requests (>=2.28.2,<3.0.0)
-Requires-Dist: urllib3 (>=1.26.15,<2.0.0)
-Project-URL: Bug Tracker, https://github.com/NiklasRosenstein/python-github-bot-api/issues
-Project-URL: Documentation, https://niklasrosenstein.github.io/python-github-bot-api/
-Project-URL: Homepage, https://github.com/NiklasRosenstein/python-github-bot-api
-Project-URL: Repository, https://github.com/NiklasRosenstein/python-github-bot-api
-Description-Content-Type: text/markdown
-
-# github-bot-api
-
-API for creating GitHub bots and webhooks in Python.
-
-> Note: If you want to make use of `GithubApp.app_client()` or `GithubApp.installation_client()`, you
-> need to install `PyGithub>=1.58`.
-
-## Quickstart (Webhook)
-
-1. Create a new Smee channel on https://smee.io
-2. Install `smee-client` (e.g. `yarn global add smee-client`)
-3. Run `smee -u <SMEE_CHANNEL_URL> -P /event-handler -p 5000`
-4. Create a Python script with the below contents and run it
-
-```python
-from github_bot_api import Event, Webhook
-from github_bot_api.flask import create_flask_app
-
-def on_any_event(event: Event) -> bool:
-  print(event)
-  return True
-
-webhook = Webhook(secret=None)
-webhook.listen('*', on_any_event)
-
-import os; os.environ['FLASK_ENV'] = 'development'
-flask_app = create_flask_app(__name__, webhook)
-flask_app.run()
-```
-
-## Quickstart (Application)
-
-1. Create a GitHub App, including a private key
-2. Set the `APP_ID` and `PRIVATE_KEY_FILE` environment variables
-3. Run the following Python script
-
-```python
-import os
-from github_bot_api import GithubApp
-
-with open(os.environ['PRIVATE_KEY_FILE']) as fp:
-  private_key = fp.read()
-
-app = GithubApp(
-  user_agent='my-bot/0.0.0',
-  app_id=int(os.environ['APP_ID']),
-  private_key=private_key)
-
-print(app.app_client().get_app().owner)
-```
-
-## Combined Example
-
-```python
-# ...
-
-app = GithubApp(...)
-webhook = Webhook()
-
-@webhook.listen('pull_request')
-def on_pull_request(event: Event) -> bool:
-  client = app.installation_client(event.payload['installation']['id'])
-  repo = client.get_repo(event['repository']['full_name'])
-  pr = repo.get_pull(event['pull_request']['number'])
-  pr.create_issue_comment('Hello from my own bot!')
-  return True
-
-# ...
-```
-

github_bot_api-0.5.2/readme.md

@@ -1,69 +0,0 @@
-# github-bot-api
-
-API for creating GitHub bots and webhooks in Python.
-
-> Note: If you want to make use of `GithubApp.app_client()` or `GithubApp.installation_client()`, you
-> need to install `PyGithub>=1.58`.
-
-## Quickstart (Webhook)
-
-1. Create a new Smee channel on https://smee.io
-2. Install `smee-client` (e.g. `yarn global add smee-client`)
-3. Run `smee -u <SMEE_CHANNEL_URL> -P /event-handler -p 5000`
-4. Create a Python script with the below contents and run it
-
-```python
-from github_bot_api import Event, Webhook
-from github_bot_api.flask import create_flask_app
-
-def on_any_event(event: Event) -> bool:
-  print(event)
-  return True
-
-webhook = Webhook(secret=None)
-webhook.listen('*', on_any_event)
-
-import os; os.environ['FLASK_ENV'] = 'development'
-flask_app = create_flask_app(__name__, webhook)
-flask_app.run()
-```
-
-## Quickstart (Application)
-
-1. Create a GitHub App, including a private key
-2. Set the `APP_ID` and `PRIVATE_KEY_FILE` environment variables
-3. Run the following Python script
-
-```python
-import os
-from github_bot_api import GithubApp
-
-with open(os.environ['PRIVATE_KEY_FILE']) as fp:
-  private_key = fp.read()
-
-app = GithubApp(
-  user_agent='my-bot/0.0.0',
-  app_id=int(os.environ['APP_ID']),
-  private_key=private_key)
-
-print(app.app_client().get_app().owner)
-```
-
-## Combined Example
-
-```python
-# ...
-
-app = GithubApp(...)
-webhook = Webhook()
-
-@webhook.listen('pull_request')
-def on_pull_request(event: Event) -> bool:
-  client = app.installation_client(event.payload['installation']['id'])
-  repo = client.get_repo(event['repository']['full_name'])
-  pr = repo.get_pull(event['pull_request']['number'])
-  pr.create_issue_comment('Hello from my own bot!')
-  return True
-
-# ...
-```

github_bot_api-0.5.2/src/github_bot_api/__init__.py

@@ -1,8 +0,0 @@
-__author__ = "Niklas Rosenstein <nrosenstein@palantir.com>"
-__version__ = "0.5.2"
-
-from .app import GithubApp
-from .event import Event
-from .webhook import Webhook
-
-__all__ = ["GithubApp", "Event", "Webhook"]