swarmauri_auth_idp_github 0.11.0.dev2

GitHub OAuth 2.0 / OAuth 2.1 identity provider implementations for Swarmauri

Swarmauri Auth IDP GitHub

GitHub OAuth 2.0 / 2.1 logins and installation token helpers packaged for Swarmauri deployments.

Features

• PKCE-enabled Authorization Code flows with HMAC-signed state payloads.
• Token exchange helpers that return normalized identity payloads for downstream services.
• Profile enrichment that fetches the authenticated user's primary verified email.
• Installation access tokens for GitHub Apps with automatic caching and retry-aware HTTP.
• ComponentBase-compatible models that register under swarmauri.auth_idp entry points.

Installation

pip

pip install swarmauri_auth_idp_github

uv (project)

uv add swarmauri_auth_idp_github

uv (environment)

uv pip install swarmauri_auth_idp_github

Usage

import asyncio
from pydantic import SecretBytes, SecretStr
from swarmauri_auth_idp_github import GitHubOAuth21Login

login = GitHubOAuth21Login(
    client_id="github-client-id",
    client_secret=SecretStr("github-client-secret"),
    redirect_uri="https://app.example.com/callback",
    state_secret=SecretBytes(b"replace-with-random-bytes"),
)

async def run_flow() -> None:
    auth = await login.auth_url()
    print(auth["url"])
    # Redirect the browser to `auth["url"]`, then capture the callback `code` and `state`.
    # Later, call `login.exchange_and_identity(code, state)` inside your callback handler.

asyncio.run(run_flow())

Workflow Summary

1. Call auth_url() and redirect the browser to the returned URL.
2. Persist the state and verify it during the callback handler.
3. Exchange the authorization code through exchange_and_identity() to obtain tokens and profile metadata.
4. Instantiate GitHubOAuth21AppClient to fetch GitHub App installation tokens when acting on behalf of repositories.

Entry Points

• swarmauri.auth_idp:GitHubOAuth20Login
• swarmauri.auth_idp:GitHubOAuth21Login
• swarmauri.auth_idp:GitHubOAuth20AppClient
• swarmauri.auth_idp:GitHubOAuth21AppClient

Contributing

To contribute to swarmauri-sdk, review the guidelines for contributing which cover development workflow, testing, and coding standards.