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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for astrocyte_ingestion_github-0.9.1.tar.gz
Algorithm Hash digest
SHA256 464835e474926a9de7dce0a81c2e144b6d01ff7a22eeff633fb17dbd63e9d008
MD5 c7c026e21ed9c83d770edbc8bfffe223
BLAKE2b-256 792a42896895c9c108448dc7d5a49fe64ab852af1d7fa10ef1f4f0447cb579bb

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for astrocyte_ingestion_github-0.9.1-py3-none-any.whl
Algorithm Hash digest
SHA256 cf0c196d7a5ea600c4dfc5fae7551db75667d55555b510d87a826aa9f1dd0e77
MD5 2423459dfe7cea1b9f899cd4598d0102
BLAKE2b-256 b05230afc041abfd61e22bae124551e7bdc49b245398c6b1b53fceb4c17cc034

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