ryg/royalnet
ryg/royalnet
1
Fork 0
mirror of https://github.com/RYGhub/royalnet.git synced 2024-11-23 19:44:20 +00:00
Code Activity
Services network for the RYG community
693 commits 29 branches 13 tags 32 MiB
Rust 95.8%
Dockerfile 3.3%
PLpgSQL 0.9%
Find a file
Stefano Pigozzi 68ff79f301 publish: 5.6.1
2020-03-09 18:46:23 +01:00
docs Finally some good ****ing docs 2020-02-03 18:23:31 +01:00
docs_source Finally some good ****ing docs 2020-02-03 18:23:31 +01:00
pycharm_templates Done? 2020-02-11 23:03:14 +01:00
royalnet publish: 5.6.1 2020-03-09 18:46:23 +01:00
tests Start work on 5.1 2019-11-12 02:11:12 +01:00
.gitattributes Update docs 2020-01-30 19:33:15 +01:00
.gitignore Bump version 2020-01-16 02:27:56 +01:00
poetry.lock Start work on 5.5 2020-02-04 00:15:33 +01:00
publish.bat publish: 5.5 2020-02-11 23:05:45 +01:00
pyproject.toml publish: 5.6.1 2020-03-09 18:46:23 +01:00
README.md Finally some good ****ing docs 2020-02-03 18:23:31 +01:00
sample_config.toml Add experimental Matrix support 2019-12-22 19:25:28 +01:00

README.md

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