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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for astrocyte_ingestion_github-0.12.0.tar.gz
Algorithm Hash digest
SHA256 ebf05ddff06024a1de50b40bbd6210771b43a3d5236c1d288a80803743957be3
MD5 19e12d4721df2849607013b584573746
BLAKE2b-256 05057192eb88e8dfd892e445e39e5cea2901395df5bbba4d1a9d88543398aeba

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for astrocyte_ingestion_github-0.12.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2284267221c2092cc491963e32c73ca5b788f300811e9253defacc936856b4f0
MD5 1fda123efe0e3ccdd49eb94b9caf8a71
BLAKE2b-256 b8036e43896511c310c5af48afd1e1f8a24eae39f2dde153d7d35af46ab46a2b

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