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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for astrocyte_ingestion_github-0.13.1.tar.gz
Algorithm Hash digest
SHA256 56e169e8f85fc4890f4286b15332e097f93fdc33628c3b8936573ed65b445fb9
MD5 45c5b7c3ba0035194a99af8cd8cdd0d1
BLAKE2b-256 435146e25e45048203ee57e336ad5da01fde7d57323ac170b3e192a8751820ff

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for astrocyte_ingestion_github-0.13.1-py3-none-any.whl
Algorithm Hash digest
SHA256 bc12d95c797bf5111db5d4d94e0413f895c0e6e892a3dbf91ab2beba97285814
MD5 ff120fa9b5e461840b5f361cf71b70bc
BLAKE2b-256 63ed85c4189d88c5e6441f2f66fc000224141c85ae33bf51f0599e17d41688ba

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