Metadata-Version: 2.1
Name: kilroy-face-reddit
Version: 0.1.1
Summary: kilroy face for Reddit 🤖
Home-page: https://github.com/kilroybot/kilroy-face-reddit
Author: kilroy
Author-email: kilroymail@pm.me
Requires-Python: >=3.10,<3.11
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Requires-Dist: asyncpraw (>=7.6,<8.0)
Requires-Dist: detoxify (>=0.5,<0.6)
Requires-Dist: httpx (>=0.23,<0.24)
Requires-Dist: kilroy-face-server-py-sdk (>=0.9,<0.10)
Requires-Dist: numpy (>=1.23,<2.0)
Requires-Dist: omegaconf (>=2.2,<3.0)
Requires-Dist: platformdirs (>=2.5,<3.0)
Requires-Dist: pydantic[dotenv] (>=1.10,<2.0)
Requires-Dist: typer[all] (>=0.6,<0.7)
Project-URL: Documentation, https://kilroybot.github.io/kilroy-face-reddit
Project-URL: Repository, https://github.com/kilroybot/kilroy-face-reddit
Description-Content-Type: text/markdown

<h1 align="center">kilroy-face-reddit</h1>

<div align="center">

kilroy face for Reddit 🤖

[![Lint](https://github.com/kilroybot/kilroy-face-reddit/actions/workflows/lint.yaml/badge.svg)](https://github.com/kilroybot/kilroy-face-reddit/actions/workflows/lint.yaml)
[![Multiplatform tests](https://github.com/kilroybot/kilroy-face-reddit/actions/workflows/test-multiplatform.yaml/badge.svg)](https://github.com/kilroybot/kilroy-face-reddit/actions/workflows/test-multiplatform.yaml)
[![Docker tests](https://github.com/kilroybot/kilroy-face-reddit/actions/workflows/test-docker.yaml/badge.svg)](https://github.com/kilroybot/kilroy-face-reddit/actions/workflows/test-docker.yaml)
[![Docs](https://github.com/kilroybot/kilroy-face-reddit/actions/workflows/docs.yaml/badge.svg)](https://github.com/kilroybot/kilroy-face-reddit/actions/workflows/docs.yaml)

</div>

---

## Installing

Using `pip`:

```sh
pip install kilroy-face-reddit
```

## Usage

To run the face server, install the package and run the following command:

```sh
kilroy-face-reddit
```

This will start the face server on port 10002 by default.
Then you can communicate with the server, for example by using
[this package](https://github.com/kilroybot/kilroy-face-client-py-sdk).

