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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for astrocyte_ingestion_github-0.14.0.tar.gz
Algorithm Hash digest
SHA256 fc7b52f1e98b038229de4f7046a14c88cca05de75a55cbbdd7738adfbc626b1d
MD5 d506a5839c172d8188e3f87c32a8d9ad
BLAKE2b-256 0db059292d67dc9ecf846b1a181628639560534de1b59f86e1bcaad73fc3c892

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for astrocyte_ingestion_github-0.14.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c26b7a963847cc8a76e56e87fb66b0d92cc6c0adcd6c1552cb361079a8b58536
MD5 e50c7fda9a1824cf7d8738348a0c9f56
BLAKE2b-256 61516d73bf7fd3917fbc4a32a52c25959497715782e1851b6573bf529a7adbc2

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