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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for astrocyte_ingestion_github-0.8.0.tar.gz
Algorithm Hash digest
SHA256 3f665d2051ffa2708c875bbffc8eac5499d6032dd3f5d426fc71e64a6e0eb54d
MD5 059e7b5d0ec06af61c1cdd905dccb4cd
BLAKE2b-256 31c51d6f211ec8041a6ffb144e22145a30740a70b0f8c14401449e82b846433c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for astrocyte_ingestion_github-0.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a5f18be13c2bd7c81bfaeac0781e0258d0e9bd2c13041dc8361b053385af69c5
MD5 a06f5eafbb11ac3f48a7013ea0e9f2e8
BLAKE2b-256 89ae8bb1dfe90dd47b21c48d0179e7b7374e3a010ec2861d6ee431ae71d9953e

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