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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for astrocyte_ingestion_github-0.14.1.tar.gz
Algorithm Hash digest
SHA256 9ed4473aa70d11c2f9b096e7d5df1f9f3b51089bf007410f96a4c2f1e1c12fe8
MD5 381e215e0e1f07b24b7717379d894835
BLAKE2b-256 b7a11b1f727a22fa49780c87a55ba9cf1030290a4e283475c01ca19cd9aa150e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for astrocyte_ingestion_github-0.14.1-py3-none-any.whl
Algorithm Hash digest
SHA256 7da163c906274d5fdebe1ae1ab89723e4cbd54c2a07291471cecf844ec7f8c4a
MD5 efd878bd63f7b4ab94a62e8a303d4d2b
BLAKE2b-256 f528c8f84130c9f63f5b22291fc6ce1999dce8faa4662b8023c311ad3bab3f7f

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