4 KiB
royalnet 
A framework for small Internet communities
About Royalnet
royalnet is a Python framework composed of many interconnected services that may be useful to small Internet communities (gaming clans, university groups, etc).
Serfs
Serfs are services that allow Royalnet to respond to chat commands on multiple chat platforms.
Commands using the Royalnet Serf API share their code between chat platforms: each serf will handle the specifics for their respective platform, preventing potential bugs due to code duplication!
Supported chat platforms
More can easily be added by creating a new serf!
Bard
The Bard module allows Royalnet services to safely download and convert video files through youtube-dl and ffmpeg.
It is mainly used to playback music on Discord Channels.
Alchemy
The Alchemy module allows all Royalnet services to use a PostgreSQL database with a SQLAlchemy interface.
This allows the usage of a shared and easy-to-use ORM: Alchemy handles for you everything, from the creation of new tables to isolating in transactions the calls made from a Serf command to the database.
Herald Network
All Royalnet services can communicate with each other through the Herald Network, a websockets-based system allowing Remote Procedure Calls ("events") between services.
For example, in response to a Telegram message, the Telegram Serf can contact the Discord Serf to ask it to connect to voice chat in Discord.
Connections between different hosts are possible too, even if they currently are unused by the Royalnet Launcher.
Constellation
The Constellation service is a Starlette-based webserver that can supply dynamic pages ("stars") while being connected to the other parts of Royalnet through the Herald.
APIs
The Constellation service also offers utilities for creating REST APIs as Python functions with dicts as inputs and outputs, leaving (de)serialization, transmission and eventually authentication to Royalnet.
Sentry
Royalnet can automatically report uncaught errors in all services to a Sentry-compatible server, while logging them in the console in development environments to facilitate debugging.
Packs
New Serf commands, Constellation stars, Herald events and Alchemy tables can be added to Royalnet through plugins called "Packs" that can be activated or deactivated on each single instance.
Config
Each pack can access only its individual section in the configuration file, preventing key conflicts (as long as the packs themselves don't share the same name).
Installing Royalnet
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
A work-in-progress documentation is available here.
Developing for Royalnet
To develop for 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
Help!
Need help in anything Royalnet-related? Open a issue on GitHub!