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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for astrocyte_ingestion_github-0.9.0.tar.gz
Algorithm Hash digest
SHA256 c2499b5aa47e470d80d5d1073bb8349f3f844ae4db13c519da344ed69e19243d
MD5 9d005707abf5c866d445ae1acdf2bd75
BLAKE2b-256 fbbb9fc788e8ab278bde60cd67a0df1e13526152e0af7e5f36579c5b2d4e127a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for astrocyte_ingestion_github-0.9.0-py3-none-any.whl
Algorithm Hash digest
SHA256 93d9c6d04860f1e6314b99559d94ff3776556d952524c8432f9278361884839e
MD5 43e2bc1bc6e4dd5daf026ee3ab3b0a7c
BLAKE2b-256 c7c3a829e95c5fde393d3b48bb5b7a42c323b236ace74afe6993c2057ed2de67

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