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.13.0.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.13.0-py3-none-any.whl (5.4 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for astrocyte_ingestion_github-0.13.0.tar.gz
Algorithm Hash digest
SHA256 8cf78233b94acb1aac818080be6efed31049e0718c82fe19a6947189176ecba3
MD5 b8c59311ca4219e0a6d27463bb0f707a
BLAKE2b-256 de2033c4bb48518778e3610a9ebf04fd3bb20e1a759169045ca08198e871f851

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for astrocyte_ingestion_github-0.13.0-py3-none-any.whl
Algorithm Hash digest
SHA256 fd89fb7bb1276540ccc1c4babe01a349943264106901363d7b794d227f89a1bd
MD5 61f930723469bcc365bcf5c3bc20e8bd
BLAKE2b-256 fa7c657c99448afeb1c3627db0a50c0c66897890a139d0763a5c748e13cde06d

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