A plugin-based Matrix bot system.
Project description
# maubot
A plugin-based [Matrix](https://matrix.org) bot system written in Python.
Management API spec: [maubot.xyz/spec](https://maubot.xyz/spec)
### [Wiki](https://github.com/maubot/maubot/wiki)
## Discussion
Matrix room: [#maubot:maunium.net](https://matrix.to/#/#maubot:maunium.net)
### Development setup
0. Clone the repo (`git clone https://github.com/maubot/maubot.git`)
1. (Optional) Create a virtualenv (`virtualenv -p python3.6 .venv` and `source .venv/bin/activate`)
2. Install dependencies (`pip install -r requirements.txt`)
3. Compile the frontend
0. Install [Node.js](https://nodejs.org/en/) and Yarn (`npm install --global yarn`)
1. `cd maubot/management/frontend`
2. `yarn`
3. `yarn build`
4. Copy `example-config.yaml` to `config.yaml` and fill it in
5. Start with `python -m maubot`
6. Browse to the management interface
## Plugins
* [jesaribot](https://github.com/maubot/jesaribot) - A simple bot that replies with an image when you say "jesari".
* [sed](https://github.com/maubot/sed) - A bot to do sed-like replacements.
* [factorial](https://github.com/maubot/factorial) - A bot to calculate unexpected factorials.
* [media](https://github.com/maubot/media) - A bot that replies with the MXC URI of images you send it.
* [dice](https://github.com/maubot/dice) - A combined dice rolling and calculator bot.
* [karma](https://github.com/maubot/karma) - A user karma tracker bot.
* [xkcd](https://github.com/maubot/xkcd) - A bot to view xkcd comics.
* [echo](https://github.com/maubot/echo) - A bot that echoes pings and other stuff.
* [rss](https://github.com/maubot/rss) - A bot that posts RSS feed updates to Matrix.
### Upcoming
* dictionary - A bot to get the dictionary definitions of words.
* poll - A simple poll bot.
* reminder - A bot to ping you about something after a certain amount of time.
* github - A GitHub client and webhook receiver bot.
* wolfram - A Wolfram Alpha bot
* gitlab - A GitLab client and webhook receiver bot.
A plugin-based [Matrix](https://matrix.org) bot system written in Python.
Management API spec: [maubot.xyz/spec](https://maubot.xyz/spec)
### [Wiki](https://github.com/maubot/maubot/wiki)
## Discussion
Matrix room: [#maubot:maunium.net](https://matrix.to/#/#maubot:maunium.net)
### Development setup
0. Clone the repo (`git clone https://github.com/maubot/maubot.git`)
1. (Optional) Create a virtualenv (`virtualenv -p python3.6 .venv` and `source .venv/bin/activate`)
2. Install dependencies (`pip install -r requirements.txt`)
3. Compile the frontend
0. Install [Node.js](https://nodejs.org/en/) and Yarn (`npm install --global yarn`)
1. `cd maubot/management/frontend`
2. `yarn`
3. `yarn build`
4. Copy `example-config.yaml` to `config.yaml` and fill it in
5. Start with `python -m maubot`
6. Browse to the management interface
## Plugins
* [jesaribot](https://github.com/maubot/jesaribot) - A simple bot that replies with an image when you say "jesari".
* [sed](https://github.com/maubot/sed) - A bot to do sed-like replacements.
* [factorial](https://github.com/maubot/factorial) - A bot to calculate unexpected factorials.
* [media](https://github.com/maubot/media) - A bot that replies with the MXC URI of images you send it.
* [dice](https://github.com/maubot/dice) - A combined dice rolling and calculator bot.
* [karma](https://github.com/maubot/karma) - A user karma tracker bot.
* [xkcd](https://github.com/maubot/xkcd) - A bot to view xkcd comics.
* [echo](https://github.com/maubot/echo) - A bot that echoes pings and other stuff.
* [rss](https://github.com/maubot/rss) - A bot that posts RSS feed updates to Matrix.
### Upcoming
* dictionary - A bot to get the dictionary definitions of words.
* poll - A simple poll bot.
* reminder - A bot to ping you about something after a certain amount of time.
* github - A GitHub client and webhook receiver bot.
* wolfram - A Wolfram Alpha bot
* gitlab - A GitLab client and webhook receiver bot.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
maubot-0.1.0.dev9.tar.gz
(932.9 kB
view hashes)
Built Distribution
maubot-0.1.0.dev9-py3-none-any.whl
(953.5 kB
view hashes)
Close
Hashes for maubot-0.1.0.dev9-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a5eed081ac0ab77ffc4ab181bb1f906d7479b8c54ddf791d7a146d4c90780d55 |
|
MD5 | 656c826e756bad8de238b0f2d6f98009 |
|
BLAKE2b-256 | 2262c5d7d5a31c45aa8908108972a0d66478fb7e57a0085fdb1dd56702a4fc76 |