Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/toshi-pono/aiotraq

Async ready API Client and bot library for traQ written in Python
https://github.com/toshi-pono/aiotraq

traq traq-bot

Last synced: 2 months ago
JSON representation

Async ready API Client and bot library for traQ written in Python

Host: GitHub
URL: https://github.com/toshi-pono/aiotraq
Owner: toshi-pono
License: mit
Created: 2024-05-10T10:01:34.000Z (8 months ago)
Default Branch: main
Last Pushed: 2024-09-21T10:21:35.000Z (4 months ago)
Last Synced: 2024-09-25T22:11:40.235Z (3 months ago)
Topics: traq, traq-bot
Language: Python
Homepage: https://toshi-pono.github.io/aiotraq/
Size: 1.99 MB
Stars: 6
Watchers: 2
Forks: 1
Open Issues: 6
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # AiotraQ

async ready API wrapper and bot library for [traQ](https://github.com/traPtitech/traQ) written in Python.

[![PyPI - Version](https://img.shields.io/pypi/v/aiotraq?label=aiotraq)](https://pypi.org/project/aiotraq/)

[![PyPI - Version](https://img.shields.io/pypi/v/aiotraq-bot?label=aiotraq-bot)](https://pypi.org/project/aiotraq-bot/)

[![PyPI - Version](https://img.shields.io/pypi/v/aiotraq-message?label=aiotraq-message)](https://pypi.org/project/aiotraq-message/)

[![CI](https://github.com/toshi-pono/aiotraq/actions/workflows/ci.yml/badge.svg)](https://github.com/toshi-pono/aiotraq/actions/workflows/ci.yml)

[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/toshi-pono/aiotraq/blob/main/LICENSE)

![teaser](docs/static/img/aiotraq.png)

## Installation

```bash

pip install aiotraq

pip install aiotraq-bot

pip install aiotraq-message

```

## Projects

詳細は各リンク先を参照してください。

| Name                                                                            | Description                              | Version                                                                                                                             |

| ------------------------------------------------------------------------------- | ---------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |

| [AiotraQ](https://github.com/toshi-pono/aiotraq/tree/main/libs/aiotraq)         | 非同期リクエスト対応の traQ API ラッパー | [![PyPI - Version](https://img.shields.io/pypi/v/aiotraq?label=aiotraq)](https://pypi.org/project/aiotraq/)                         |

| [AiotraQ-Bot](https://github.com/toshi-pono/aiotraq/tree/main/libs/bot)         | FastAPI を使った traQ Bot ライブラリ     | [![PyPI - Version](https://img.shields.io/pypi/v/aiotraq-bot?label=aiotraq-bot)](https://pypi.org/project/aiotraq-bot/)             |

| [AiotraQ-Message](https://github.com/toshi-pono/aiotraq/tree/main/libs/message) | traQ Bot のメッセージ送信ライブラリ      | [![PyPI - Version](https://img.shields.io/pypi/v/aiotraq-message?label=aiotraq-message)](https://pypi.org/project/aiotraq-message/) |

![overview](docs/docs/overview.svg)

ドキュメントは [こちら](https://toshi-pono.github.io/aiotraq/docs/intro/)

## Development

### aiotraq

API Client の更新: monorepo のプロジェクトルートで以下を実行してください

```bash

poetry install

make api_update

```

> [!WARNING]

> `post_webhook` についてはライブラリ未対応のため動的に生成できず、手動で追加しています

## publish

> [!WARNING]

> work in progress: githubactions でいい感じにしたい

1. monorepo の pyproject.toml に記載されているバージョンを更新して、`$ make write-version`でまとめて更新します

2. github actions の workflow を実行して、pypi に publish します

## License

This project is licensed under the terms of the MIT license.