Metadata-Version: 2.4
Name: pushikoo-getter-gh
Version: 0.1.2
Summary: GitHub getter adapter for Pushikoo.
Project-URL: Homepage, https://github.com/Pushikoo/pushikoo-getter-gh
Author: Pushikoo
License-File: LICENSE
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.10
Requires-Dist: loguru
Requires-Dist: pushikoo-interface>=0.2.0
Requires-Dist: python-dateutil
Requires-Dist: requests
Provides-Extra: dev
Requires-Dist: pytest; extra == 'dev'
Requires-Dist: python-dotenv; extra == 'dev'
Requires-Dist: ruff; extra == 'dev'
Description-Content-Type: text/markdown

<div align="center">

# pushikoo-getter-gh

GitHub getter adapter for Pushikoo. Monitors GitHub repository commits.

[![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)
[![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/Pushikoo/pushikoo-getter-gh/package.yml)](https://github.com/Pushikoo/pushikoo-getter-gh/actions)
[![Python](https://img.shields.io/pypi/pyversions/pushikoo-getter-gh)](https://pypi.org/project/pushikoo-getter-gh)
[![PyPI version](https://badge.fury.io/py/pushikoo-getter-gh.svg)](https://pypi.org/project/pushikoo-getter-gh)
[![License](https://img.shields.io/github/license/Pushikoo/pushikoo-getter-gh.svg)](https://pypi.org/project/pushikoo-getter-gh/)

</div>

## Configuration

### Adapter Config

| Field  | Type             | Default           | Description                                                   |
| ------ | ---------------- | ----------------- | ------------------------------------------------------------- |
| `auth` | `dict[str, str]` | `{"default": ""}` | GitHub API tokens. Key is the token name, value is the token. |

### Instance Config

| Field    | Type   | Default     | Description                                         |
| -------- | ------ | ----------- | --------------------------------------------------- |
| `repo`   | `str`  | Required    | Repository path, e.g. `Pushikoo/pushikoo-getter-gh` |
| `commit` | `bool` | `true`      | Enable commit monitoring                            |
| `auth`   | `str`  | `"default"` | Token name to use from adapter config               |
