Metadata-Version: 2.1
Name: nonebot-adapter-rocketchat
Version: 0.1.0
Summary: RocketChat adapter for nonebot2
Keywords: bot,nonebot,Rocket.Chat
Author-email: IllTamer <mail@illtamer.com>
Requires-Python: >=3.8, <4.0
Classifier: Development Status :: 4 - Beta
Classifier: Framework :: Robot Framework
Classifier: Framework :: Robot Framework :: Library
Classifier: License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Project-URL: documentation, https://github.com/IUnlimit/nonebot-adapter-rocketchat/blob/main/README.md
Project-URL: homepage, https://github.com/IUnlimit
Project-URL: repository, https://github.com/IUnlimit/nonebot-adapter-rocketchat
Description-Content-Type: text/markdown

<p align="center"> 
  <img  src="./docs/images/logo.png" width="200" height="200" alt="nonebot-adapter-rocketchat" />
</p>

<h1 align="center">
  NoneBot-Adapter-RocketChat
</h1>

<p align="center">
  <img src="https://img.shields.io/github/v/release/IUnlimit/nonebot-adapter-rocketchat?label=version">
  <a alt="License" href="https://www.gnu.org/licenses/agpl-3.0.en.html"><image src="https://img.shields.io/badge/license-AGPLv3-4EB1BA.svg"></image></a>
</p>

## Usage

[How to create a RocketChat bot account](https://developer.rocket.chat/bots/creating-your-own-bot-from-scratch) 

> Notice: This project (as well as `rocketchat_API`) does not support 2FA authentication. Please make sure that the robot account has turned off 2FA authentication before starting !

```toml
# Bot username
RC_USERNAME="yourbot.name"
# Bot password
RC_PASSWORD="password"
# RocketChat server url
RC_SERVER_HTTP="http://localhost:3000"
RC_SERVER_WSS="ws://localhost:3000/websocket"
# Proxy server (Optional)
[RC_PROXIES]
http = "http://127.0.0.1:7890"
https = "https://127.0.0.1:7890"
```

## Support

- [x] stream-room-messages

## Thanks

- [rocket-python](https://github.com/Pipoline/rocket-python)
- [RealTime API](https://github.com/hynek-urban/rocketchat-async)
