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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for astrocyte_ingestion_github-0.11.0.tar.gz
Algorithm Hash digest
SHA256 8c2f0983c0f1f0efc70bb2d86fc175131437861bd76dbc4e79b517e78041433d
MD5 91f5d358e8c1257b03970e152f454ace
BLAKE2b-256 9edb65abd4b489c8ec6819b287331325a52ec86a82e743332ca0969cd8503add

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for astrocyte_ingestion_github-0.11.0-py3-none-any.whl
Algorithm Hash digest
SHA256 20482b8074e8314b9368646a026827f2ba3a6851a3a2fa27ae876227df6b9ae8
MD5 0006ce7b12206dd6e23586a54aa9e1bf
BLAKE2b-256 118344060ea89a92026f2caacf53c0225dd0365dc22f5ef807b4de8def80c0ae

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