ryg/royalnet
ryg/royalnet
1
Fork 0
mirror of https://github.com/RYGhub/royalnet.git synced 2024-11-23 11:34:18 +00:00
Code Activity
royalnet/README.md

1.4 KiB
Raw Blame History

royalnet PyPI

A multipurpose bot framework and webserver

About

royalnet is a Python framework that allows you to create interconnected modular chat bots accessible through multiple interfaces (such as Telegram or Discord), and also modular websites that can be connected with the bots.

Supported bot platforms ("serfs")

Installing

To install royalnet, run:

pip install royalnet

To install a specific module, run:

pip install royalnet[MODULENAME]

To install all royalnet modules, run:

pip install royalnet[telegram,discord,matrix,alchemy_easy,bard,constellation,sentry,herald,coloredlogs]

Documentation

royalnet's documentation is available here.

Developing royalnet

To develop royalnet, you need to have Poetry installed on your PC.

After you've installed Poetry, clone the git repo with the command:

git clone https://github.com/Steffo99/royalnet

Then enter the new directory:

cd royalnet

And finally install all dependencies and the package:

poetry install -E telegram -E discord -E matrix -E alchemy_easy -E bard -E constellation -E sentry -E herald -E coloredlogs