Skip to main content

GitHub Issues API poll IngestSource adapter for Astrocyte

Project description

astrocyte-ingestion-github

Poll driver for Astrocyte sources: — ingests GitHub repository issues (not pull requests) via the REST API.

Install

pip install astrocyte-ingestion-github
# or
pip install 'astrocyte[poll]'

Config (astrocyte.yaml)

sources:
  gh_issues:
    type: poll
    driver: github
    path: octocat/Hello-World          # owner/repo
    interval_seconds: 120              # >= 60 (GitHub API rate limits)
    target_bank: engineering
    auth:
      token: ${GITHUB_TOKEN}           # classic PAT or fine-grained token (issues read)
    extraction_profile: builtin_text   # optional
# Optional: GitHub Enterprise Server API root
#    url: https://github.example.com/api/v3

The adapter sets Authorization: Bearer … and uses since (max updated_at from the last response) to limit traffic. Each issue is retained as text [GitHub #N] title plus body; metadata includes github.issue_id, number, html_url, updated_at, author.

Principal for bank resolution: sources.*.principal if set; otherwise github:<author_login> from the issue.

Entry point

Registers as github under astrocyte.ingest_poll_drivers (same discovery pattern as stream drivers).

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

astrocyte_ingestion_github-0.12.3.tar.gz (14.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

astrocyte_ingestion_github-0.12.3-py3-none-any.whl (5.4 kB view details)

Uploaded Python 3

File details

Details for the file astrocyte_ingestion_github-0.12.3.tar.gz.

File metadata

File hashes

Hashes for astrocyte_ingestion_github-0.12.3.tar.gz
Algorithm Hash digest
SHA256 945b2a5ba88f7f8c47bca384ecd5783ae3f56cfd4e9f10ae8dfd7d6e5d87d8d1
MD5 95b870c48bd62180fdae7b91ec4c980f
BLAKE2b-256 142e82d02bcda8b52f42d9b24f58646a250c8a77dc71e8d3ced6c9d96cfc4558

See more details on using hashes here.

File details

Details for the file astrocyte_ingestion_github-0.12.3-py3-none-any.whl.

File metadata

File hashes

Hashes for astrocyte_ingestion_github-0.12.3-py3-none-any.whl
Algorithm Hash digest
SHA256 397c21d133bdec3edd05e18c4ab7711ca7825e37d8dc0a61693f0bc4e1f58110
MD5 3bd206319a45cdab628f6ab0a5b33c6c
BLAKE2b-256 9f12cbc017a21f194bd1f47f4095ec90edbdf1d7ee204077bf6981da8289c9a4

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page