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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for astrocyte_ingestion_github-0.8.1.tar.gz
Algorithm Hash digest
SHA256 db8c743c9cecdee8a00d4c9b9e411898c7d72fe40ed8b9cddde6cbb7fadb8af9
MD5 715c7391359f58c4a1e6af9554f586b4
BLAKE2b-256 b54381e55cf6a30b92ba42c808841be15dbe9475e245c52c6f91b39513a1a141

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for astrocyte_ingestion_github-0.8.1-py3-none-any.whl
Algorithm Hash digest
SHA256 cb5e71097de967636175af2bf8ac2b6de98153a1ff4813be7d843d3224d5f7bb
MD5 4d0b5547d8cea89259d392e34da0618c
BLAKE2b-256 2f92df170177402cba0e37462911f04a7595dee4451e0fdad1b4d1e3e34c6346

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