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.15.0.tar.gz (38.9 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.15.0-py3-none-any.whl (5.4 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for astrocyte_ingestion_github-0.15.0.tar.gz
Algorithm Hash digest
SHA256 456517178df318e2e3a40e14d0e8d2d135126b7e43d1bfd680036a824b37d350
MD5 00add0a661ef2727e38ecf2a48fb32e1
BLAKE2b-256 086e244e91ce6fd53710b4e61ecbf7423dab9bbfadd36a31a0d517ce33c00a0b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for astrocyte_ingestion_github-0.15.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d4ce8fb594dec3963e8ae10602b673483c965d5fd5d3265980238a4379b0181b
MD5 ba04a700626e7a14e92a0f98df8614bb
BLAKE2b-256 ee84f9b902d99e990c859648f483976ff1c82e10cb1ba40a1804e930d578e032

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