ryg/royalnet
ryg/royalnet
1
Fork 0
mirror of https://github.com/RYGhub/royalnet.git synced 2024-11-26 21:14:19 +00:00
Code Activity

Improve documentation of royalnet

Browse source
This commit is contained in:
Steffo 2022-05-02 05:21:42 +02:00
parent e8f7783337
commit 5ce523be1f
Signed by: steffo
GPG key ID: 6965406171929D01
1 changed files with 1 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
royalnet/__init__.py
View file

@ -1,15 +1,3 @@
"""
Royalnet is a collection of many Python modules useful to build chat-like applications.
The modules currently are:
- :mod:`.alchemist`, containing utility extensions to :mod:`sqlalchemy`;
- :mod:`.engineer`, containing a framework for building chat bots;
- :mod:`.lazy`, containing utilities to delay the evaluation of values until they are actually used;
- :mod:`.scrolls`, containing configuration utilities;
- :mod:`.sculptor`, containing common :mod:`pydantic` models for serialization and deserialization of data structures;
To prevent the library from breaking if optional dependencies are not installed, this module does not export any object; submodules should be directly imported instead.
All modules use exceptions based on :exc:`.exc.RoyalnetException`, and may subclass it to provide more detail on the errors.
Royalnet is a multiplatform chatbot library which allows to write bots only once for most chat platforms and at the same time maintain the versatility of using a platform-specific framework.
"""