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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for astrocyte_ingestion_github-0.12.1.tar.gz
Algorithm Hash digest
SHA256 e0ddb2c6b0a78b0ad904839247dd82e31e8112ac4785f2846f333a2896131acc
MD5 63ef10571846cfa2494e579ca2ffd4c1
BLAKE2b-256 cd2ca87e7705175b39765a600399342a458e28037ae76dbaa3a61b9439a92254

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for astrocyte_ingestion_github-0.12.1-py3-none-any.whl
Algorithm Hash digest
SHA256 9fbf4f4b39392d1cc84bc2aab4d433450a10e3d54b7daf5f8f38e6117b6cce7a
MD5 ec6359cab1a7984d1d4a53a6ede0beef
BLAKE2b-256 3bafee45336bb50053593c6347d8144a2dff56233d39b7ce722d0edc195753f8

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