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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for astrocyte_ingestion_github-0.14.2.tar.gz
Algorithm Hash digest
SHA256 852c9bc2b0220599595956d5b515b26c3de3fa9f9740de7ab0641e0b1f09c96e
MD5 e3b26a69a9591897ba30b28a3771ae3e
BLAKE2b-256 c1cac11ba1dcb4c73fb2c843dac21a27a53ffe814f62e469017db1362693a1da

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for astrocyte_ingestion_github-0.14.2-py3-none-any.whl
Algorithm Hash digest
SHA256 9819cbeb81f8af8574f4a2457ad3e344728ffefa21c37f5192eb4f5a6f65285b
MD5 d3a5b1b67dc16e074c3d98e5d0bd8145
BLAKE2b-256 60538cf2355d330ab1a5c9e760b0a08759cb3973bc83e20e31cbfbeeaf83d031

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