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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for astrocyte_ingestion_github-0.12.2.tar.gz
Algorithm Hash digest
SHA256 06a245d2887326fa76cf61240391719dab51618136ecd9951958344e6aea9fa5
MD5 776227d21650fe83adf2548338a2f44c
BLAKE2b-256 2410391fa122013ed1ee80568865c4ed0d63c05cd18ca8e246df2f215c6bdd1a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for astrocyte_ingestion_github-0.12.2-py3-none-any.whl
Algorithm Hash digest
SHA256 be96413fd01ee0543a13de72cb70c61bbdae35507bbe168cf2889cbdb5567e6a
MD5 fe23d18e66c74e7b63c66cd30052e73a
BLAKE2b-256 8e35eedab1b99a9debe3241ca07a78992b8acb5f56d5519012fae5f86ed384f5

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