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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for astrocyte_ingestion_github-0.10.0.tar.gz
Algorithm Hash digest
SHA256 142e9a58abc6790b4571b69480ca687d79fe0f45f30c67bb5cc17b582a300c68
MD5 d8b44e811201960242d6e7a0e8038491
BLAKE2b-256 2739b9152d9996967bae7e543eba6150907d077008626c0308e550a1a7eaf39c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for astrocyte_ingestion_github-0.10.0-py3-none-any.whl
Algorithm Hash digest
SHA256 bbc6e22a42250cfdc2919a8984566bb7a2e99cb8735eaba6cdf6216dc2e86ca2
MD5 ab7ae937d781ef883e6a680c7d198738
BLAKE2b-256 7e181cc1e1c6471d08603f3f1e6e54d76c08c0bcfeaafbe9179b1b86e5a408f2

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