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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for astrocyte_ingestion_github-0.15.1.tar.gz
Algorithm Hash digest
SHA256 47ddcaae3d4db305b4fe20dc614ea7cadddd24da8bd58b142ecfb6623a71127e
MD5 4dd446bfe4fb5701b012ff45b861ee32
BLAKE2b-256 4a77534c94cb9fb01d85be1cdcd2560b5db876ed0f4c9d22419dfea707554a33

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for astrocyte_ingestion_github-0.15.1-py3-none-any.whl
Algorithm Hash digest
SHA256 9828f23a2bbea37e842674ed84e4f76af08a409c75bd34ada2dd2e645aa69b07
MD5 e363db300f26569557c5ec0a2ced1166
BLAKE2b-256 99ecf6e35da940c2ba449b4087db29c3c976bdfac3587161dda4a60361fee447

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