fastgithub 0.0.1

A Python library to supercharge your GitHub organization with bots and webhooks.

FastGitHub

CI/CD
Meta
Package

---

About this project

FastGitHub provides a GitHub webhooks handler for FastAPI to automate your workflows.

FastGitHub also provides sets of automations (named recipes).

️️⚙️ Installation

Install the package from the PyPI registry.

pip install fastgithub

⚡ Usage

Example

from typing import Any
from fastapi import FastAPI
import uvicorn
from fastgithub.endpoint.webhook_router import webhook_router
from fastgithub.recipes.github import autocreate_pull_request
from fastgithub.webhook import GithubWebhookHandler

webhook_handler = GithubWebhookHandler(
    token="your-secret-token"
)  # by default os.environ["GITHUB_TOKEN"]


@webhook_handler.listen("push")
def hello(data: dict[str, Any]):
    print(f"Hello from: {data["repository"]}")


app = FastAPI()
router = webhook_router(handler=webhook_handler, path="/postreceive")
app.include_router(router)

if __name__ == "__main__":
    uvicorn.run(app)

You can also fill a list of functions for a specific event to the handler:

def hello(data: dict[str, Any]):
    print(f"Hello from: {data["repository"]}")


def bye(data: dict[str, Any]):
    print(f"Goodbye from: {data["repository"]}")


webhook_handler.listen("push", [hello, bye])

⛏️ Development

In order to install all development dependencies, run the following command:

uv sync

To ensure that you follow the development workflow, please setup the pre-commit hooks:

uv run pre-commit install

Acknowledgements

Initial ideas and designs are inspired by python-github-webhook and python-github-bot-api