diff --git a/docs/doctrees/audio.doctree b/docs/doctrees/audio.doctree
index e2b97294..9fdbd757 100644
Binary files a/docs/doctrees/audio.doctree and b/docs/doctrees/audio.doctree differ
diff --git a/docs/doctrees/bots.doctree b/docs/doctrees/bots.doctree
index 88d943c7..0d378121 100644
Binary files a/docs/doctrees/bots.doctree and b/docs/doctrees/bots.doctree differ
diff --git a/docs/doctrees/commands.doctree b/docs/doctrees/commands.doctree
index d16bba80..2d1f18ab 100644
Binary files a/docs/doctrees/commands.doctree and b/docs/doctrees/commands.doctree differ
diff --git a/docs/doctrees/database.doctree b/docs/doctrees/database.doctree
index e1b86d2d..0115b3f7 100644
Binary files a/docs/doctrees/database.doctree and b/docs/doctrees/database.doctree differ
diff --git a/docs/doctrees/environment.pickle b/docs/doctrees/environment.pickle
index c30e0fd3..273ab0b1 100644
Binary files a/docs/doctrees/environment.pickle and b/docs/doctrees/environment.pickle differ
diff --git a/docs/doctrees/error.doctree b/docs/doctrees/error.doctree
index 400a99aa..6acec1c8 100644
Binary files a/docs/doctrees/error.doctree and b/docs/doctrees/error.doctree differ
diff --git a/docs/doctrees/index.doctree b/docs/doctrees/index.doctree
index b1278f13..8304526d 100644
Binary files a/docs/doctrees/index.doctree and b/docs/doctrees/index.doctree differ
diff --git a/docs/doctrees/network.doctree b/docs/doctrees/network.doctree
index c3212919..0fe93ef3 100644
Binary files a/docs/doctrees/network.doctree and b/docs/doctrees/network.doctree differ
diff --git a/docs/doctrees/utils.doctree b/docs/doctrees/utils.doctree
index 8688165b..32402c58 100644
Binary files a/docs/doctrees/utils.doctree and b/docs/doctrees/utils.doctree differ
diff --git a/docs/doctrees/web.doctree b/docs/doctrees/web.doctree
index 5df16542..9f56e8a0 100644
Binary files a/docs/doctrees/web.doctree and b/docs/doctrees/web.doctree differ
diff --git a/docs/html/_static/basic.css b/docs/html/_static/basic.css
index c41d718e..53acd096 100644
--- a/docs/html/_static/basic.css
+++ b/docs/html/_static/basic.css
@@ -289,12 +289,6 @@ img.align-center, .figure.align-center, object.align-center {
margin-right: auto;
}
-img.align-default, .figure.align-default {
- display: block;
- margin-left: auto;
- margin-right: auto;
-}
-
.align-left {
text-align: left;
}
@@ -303,10 +297,6 @@ img.align-default, .figure.align-default {
text-align: center;
}
-.align-default {
- text-align: center;
-}
-
.align-right {
text-align: right;
}
@@ -378,11 +368,6 @@ table.align-center {
margin-right: auto;
}
-table.align-default {
- margin-left: auto;
- margin-right: auto;
-}
-
table caption span.caption-number {
font-style: italic;
}
diff --git a/docs/html/_static/searchtools.js b/docs/html/_static/searchtools.js
index 6031f991..bdc27065 100644
--- a/docs/html/_static/searchtools.js
+++ b/docs/html/_static/searchtools.js
@@ -319,13 +319,12 @@ var Search = {
for (var prefix in objects) {
for (var name in objects[prefix]) {
var fullname = (prefix ? prefix + '.' : '') + name;
- var fullnameLower = fullname.toLowerCase()
- if (fullnameLower.indexOf(object) > -1) {
+ if (fullname.toLowerCase().indexOf(object) > -1) {
var score = 0;
- var parts = fullnameLower.split('.');
+ var parts = fullname.split('.');
// check for different match types: exact matches of full name or
// "last name" (i.e. last dotted part)
- if (fullnameLower == object || parts[parts.length - 1] == object) {
+ if (fullname == object || parts[parts.length - 1] == object) {
score += Scorer.objNameMatch;
// matches in last name
} else if (parts[parts.length - 1].indexOf(object) > -1) {
diff --git a/docs/html/audio.html b/docs/html/audio.html
index fc119209..099bbf78 100644
--- a/docs/html/audio.html
+++ b/docs/html/audio.html
@@ -159,450 +159,6 @@
royalnet.audio
-Video and audio downloading related classes, mainly used for Discord voice bots.
-
-
-class royalnet.audio.PlayMode
-The base class for a PlayMode, such as royalnet.audio.Playlist
-
-
-__init__( )
-Create a new PlayMode and initialize the generator inside.
-
-
-
-
-_generate_generator( )
-Factory function for an async generator that changes the now_playing discord.audio.RoyalPCMAudio None
-
-Yields
-The royalnet.audio.RoyalPCMAudio
-
-
-
-
-
-add( item: royalnet.audio.royalpcmaudio.RoyalPCMAudio ) → None
-Add a new royalnet.audio.RoyalPCMAudio
-
-Parameters
-item – The item to add to the PlayMode.
-
-
-
-
-
-delete( ) → None
-Delete all royalnet.audio.RoyalPCMAudio
-
-
-
-
-async next( ) → Optional[royalnet.audio.royalpcmaudio.RoyalPCMAudio]
-Get the next royalnet.audio.RoyalPCMAudio
-
-Returns
-The next royalnet.audio.RoyalPCMAudio
-
-
-
-
-
-queue_preview( ) → List[royalnet.audio.royalpcmaudio.RoyalPCMAudio]
-Display all the videos in the PlayMode as a list, if possible.
-To be used with queue commands, for example.
-
-Raises
-NotImplementedError
-Returns
-A list of videos contained in the queue.
-
-
-
-
-
-videos_left( ) → Union[int, float]
-Return the number of videos left in the PlayMode.
-
-Returns
-Usually a int math.inf
-
-
-
-
-
-
-
-class royalnet.audio.Playlist( starting_list: List[royalnet.audio.royalpcmaudio.RoyalPCMAudio] = None )
-A video list. royalnet.audio.RoyalPCMAudio
-
-
-__init__( starting_list: List[royalnet.audio.royalpcmaudio.RoyalPCMAudio] = None )
-Create a new Playlist.
-
-Parameters
-starting_list – A list of items with which the Playlist will be created.
-
-
-
-
-
-_generate_generator( )
-Factory function for an async generator that changes the now_playing discord.audio.RoyalPCMAudio None
-
-Yields
-The royalnet.audio.RoyalPCMAudio
-
-
-
-
-
-add( item ) → None
-Add a new royalnet.audio.RoyalPCMAudio
-
-Parameters
-item – The item to add to the PlayMode.
-
-
-
-
-
-delete( ) → None
-Delete all royalnet.audio.RoyalPCMAudio
-
-
-
-
-queue_preview( ) → List[royalnet.audio.royalpcmaudio.RoyalPCMAudio]
-Display all the videos in the PlayMode as a list, if possible.
-To be used with queue commands, for example.
-
-Raises
-NotImplementedError
-Returns
-A list of videos contained in the queue.
-
-
-
-
-
-videos_left( ) → Union[int, float]
-Return the number of videos left in the PlayMode.
-
-Returns
-Usually a int math.inf
-
-
-
-
-
-
-
-class royalnet.audio.Pool( starting_pool: List[royalnet.audio.royalpcmaudio.RoyalPCMAudio] = None )
-A royalnet.audio.RoyalPCMAudio royalnet.audio.RoyalPCMAudio
-
-
-__init__( starting_pool: List[royalnet.audio.royalpcmaudio.RoyalPCMAudio] = None )
-Create a new Pool.
-
-Parameters
-starting_pool – A list of items the Pool will be created from.
-
-
-
-
-
-_generate_generator( )
-Factory function for an async generator that changes the now_playing discord.audio.RoyalPCMAudio None
-
-Yields
-The royalnet.audio.RoyalPCMAudio
-
-
-
-
-
-add( item ) → None
-Add a new royalnet.audio.RoyalPCMAudio
-
-Parameters
-item – The item to add to the PlayMode.
-
-
-
-
-
-delete( ) → None
-Delete all royalnet.audio.RoyalPCMAudio
-
-
-
-
-queue_preview( ) → List[royalnet.audio.royalpcmaudio.RoyalPCMAudio]
-Display all the videos in the PlayMode as a list, if possible.
-To be used with queue commands, for example.
-
-Raises
-NotImplementedError
-Returns
-A list of videos contained in the queue.
-
-
-
-
-
-videos_left( ) → Union[int, float]
-Return the number of videos left in the PlayMode.
-
-Returns
-Usually a int math.inf
-
-
-
-
-
-
-
-class royalnet.audio.YtdlFile( info: royalnet.audio.youtubedl.YtdlInfo , outtmpl='%(title)s-%(id)s.%(ext)s' , **ytdl_args )
-A wrapper around a youtube_dl downloaded file.
-
-
-_stop_download( )
-I have no clue of what this does, or why is it here. Possibly remove it?
-
-Raises
-InterruptDownload – …uhhh, always?
-
-
-
-
-
-static create_from_url( url , outtmpl='%(title)s-%(id)s.%(ext)s' , **ytdl_args ) → List[royalnet.audio.youtubedl.YtdlFile]
-Download the videos at the specified url.
-
-Parameters
-
-url – The url to download the videos from.
outtmpl – The filename that the downloaded videos are going to have. The name can be formatted according to the outtmpl documentation .
ytdl_args – Other arguments to be passed to the YoutubeDL object.
-Returns
-A list
-
-
-
-
-
-delete_video_file( )
-Delete the file located at self.video_filename
-
-
Note
-
No checks are done when deleting, so it may try to delete a non-existing file and raise an exception or do some other weird stuff with weird filenames.
-
-
-
-
-ytdl_args = {'logger': <Logger royalnet.audio.youtubedl (WARNING)>, 'no_warnings': True, 'noplaylist': True, 'quiet': True}
-
-
-
-
-
-
-class royalnet.audio.YtdlInfo( info: Dict[str, Any] )
-A wrapper around youtube_dl extracted info.
-
-
-__init__( info: Dict[str, Any] )
-Create a YtdlInfo from the dict returned by the youtube_dl.YoutubeDL.extract_info()
-
-
-
-
-
-static create_from_url( url , **ytdl_args ) → List[royalnet.audio.youtubedl.YtdlInfo]
-
-
-
-
-download( outtmpl='%(title)s-%(id)s.%(ext)s' , **ytdl_args ) → royalnet.audio.youtubedl.YtdlFile
-
-
-
-
-to_discord_embed( ) → discord.embeds.Embed
-
-
-
-
-
-
-class royalnet.audio.RoyalPCMFile( info: royalnet.audio.youtubedl.YtdlInfo , **ytdl_args )
-
-
-property audio_filename
-Returns:
-The name of the downloaded and PCM-converted audio file.
-
-
-
-
-static create_from_url( url: str , **ytdl_args ) → List[royalnet.audio.royalpcmfile.RoyalPCMFile]
-Download a file with youtube_dl and create a list of discord.audio.RoyalPCMFile
-
-Parameters
-
-
-Returns
-A list
-
-
-
-
-
-static create_from_ytsearch( search: str , amount: int = 1 , **ytdl_args ) → List[royalnet.audio.royalpcmfile.RoyalPCMFile]
-Search a string on YouTube and download the first amount discord.audio.RoyalPCMFile
-
-Parameters
-
-search – The string to search on YouTube.
amount – The number of videos to download.
ytdl_args – Extra arguments to be passed to YoutubeDL while downloading.
-Returns
-A list
-
-
-
-
-
-delete_audio_file( )
-Delete the PCM-converted audio file.
-
-
-
-
-ytdl_args = {'format': 'bestaudio'}
-
-
-
-
-property ytdl_filename
-
-Returns
-The name of the downloaded video file, as a str
-
-
-
Warning
-
It’s going to be deleted as soon as the royalnet.audio.RoyalPCMFile.__init__()
-
-
-
-
-
-
-class royalnet.audio.RoyalPCMAudio( rpf: royalnet.audio.royalpcmfile.RoyalPCMFile )
-A discord.AudioSource
-
-
-__init__( rpf: royalnet.audio.royalpcmfile.RoyalPCMFile )
-Create a discord.audio.RoyalPCMAudio royalnet.audio.RoyalPCMFile
-
-
-
-
-
-static create_from_url( url: str ) → List[royalnet.audio.royalpcmaudio.RoyalPCMAudio]
-Download a file with youtube_dl and create a list of RoyalPCMAudios.
-
-Parameters
-url – The url of the file to download.
-Returns
-A list
-
-
-
-
-
-static create_from_ytsearch( search: str , amount: int = 1 ) → List[royalnet.audio.royalpcmaudio.RoyalPCMAudio]
-Search a string on YouTube and download the first amount
-
-Parameters
-
-
-Returns
-A list
-
-
-
-
-
-delete( )
-Permanently delete the downloaded file.
-
-
-
-
-is_opus( )
-This audio file isn’t Opus-encoded, but PCM-encoded.
-
-Returns
-False
-
-
-
-
-
-read( )
-Reads 20ms worth of audio.
-If the audio is complete, then returning an empty bytes
-
-
-
-
diff --git a/docs/html/bots.html b/docs/html/bots.html
index 9c7d43b1..40a14279 100644
--- a/docs/html/bots.html
+++ b/docs/html/bots.html
@@ -159,194 +159,6 @@
royalnet.bots
-Various bot interfaces, and a generic class to create new ones.
-
-
-class royalnet.bots.TelegramBot( * , telegram_config: royalnet.bots.telegram.TelegramConfig , royalnet_config: Optional[royalnet.network.royalnetconfig.RoyalnetConfig] = None , database_config: Optional[royalnet.database.databaseconfig.DatabaseConfig] = None , command_prefix: str = '/' , commands: List[Type[royalnet.utils.command.Command]] = None , missing_command: Type[royalnet.utils.command.Command] = <class 'royalnet.commands.null.NullCommand'> , error_command: Type[royalnet.utils.command.Command] = <class 'royalnet.commands.null.NullCommand'> )
-A bot that connects to Telegram .
-
-
-_call_factory( ) → Type[royalnet.utils.call.Call]
-Create the TelegramCall class, representing a command call. It should inherit from royalnet.utils.Call
-
-Returns
-The created TelegramCall class.
-
-
-
-
-
-async _handle_update( update: telegram.update.Update )
-
-
-
-
-_init_client( )
-Create the telegram.Bot
-
-
-
-
-property botfather_command_string
-Generate a string to be pasted in the “Edit Commands” BotFather prompt.
-
-
-
-
-interface_name = 'telegram'
-
-
-
-
-async run( )
-A blocking coroutine that should make the bot start listening to commands and requests.
-
-
-
-
-
-
-class royalnet.bots.TelegramConfig( token: str )
-The specific configuration to be used for royalnet.database.TelegramBot
-
-
-
-
-class royalnet.bots.DiscordBot( * , discord_config: royalnet.bots.discord.DiscordConfig , royalnet_config: Optional[royalnet.network.royalnetconfig.RoyalnetConfig] = None , database_config: Optional[royalnet.database.databaseconfig.DatabaseConfig] = None , command_prefix: str = '!' , commands: List[Type[royalnet.utils.command.Command]] = None , missing_command: Type[royalnet.utils.command.Command] = <class 'royalnet.commands.null.NullCommand'> , error_command: Type[royalnet.utils.command.Command] = <class 'royalnet.commands.null.NullCommand'> )
-A bot that connects to Discord .
-
-
-_bot_factory( ) → Type[discord.client.Client]
-Create a custom DiscordClient class inheriting from discord.Client
-
-
-
-
-_call_factory( ) → Type[royalnet.utils.call.Call]
-Create the TelegramCall class, representing a command call. It should inherit from royalnet.utils.Call
-
-Returns
-The created TelegramCall class.
-
-
-
-
-
-_init_client( )
-Create an instance of the DiscordClient class created in royalnet.bots.DiscordBot._bot_factory()
-
-
-
-
-_init_voice( )
-Initialize the variables needed for the connection to voice chat.
-
-
-
-
-async add_to_music_data( audio_sources: List[royalnet.audio.royalpcmaudio.RoyalPCMAudio], guild: discord.guild.Guild )
-Add a file to the corresponding music_data object.
-
-
-
-
-async advance_music_data( guild: discord.guild.Guild )
-Try to play the next song, while it exists. Otherwise, just return.
-
-
-
-
-interface_name = 'discord'
-
-
-
-
-async run( )
-Login to Discord, then run the bot.
-
-
-
-
-async update_activity_with_source_title( )
-Change the bot’s presence (using discord.Client.change_presence()
-If multiple guilds are using the bot, the bot will always have an empty presence.
-
-
-
-
-
-
-class royalnet.bots.DiscordConfig( token: str )
-The specific configuration to be used for royalnet.bots.DiscordBot
-
-
-
-
-class royalnet.bots.GenericBot( * , royalnet_config: Optional[royalnet.network.royalnetconfig.RoyalnetConfig] = None , database_config: Optional[royalnet.database.databaseconfig.DatabaseConfig] = None , command_prefix: str , commands: List[Type[royalnet.utils.command.Command]] = None , missing_command: Type[royalnet.utils.command.Command] = <class 'royalnet.commands.null.NullCommand'> , error_command: Type[royalnet.utils.command.Command] = <class 'royalnet.commands.null.NullCommand'> , loop: asyncio.events.AbstractEventLoop = None )
-A generic bot class, to be used as base for the other more specific classes, such as royalnet.bots.TelegramBot and royalnet.bots.DiscordBot .
-
-
-_call_factory( ) → Type[royalnet.utils.call.Call]
-Create the TelegramCall class, representing a command call. It should inherit from royalnet.utils.Call
-
-Returns
-The created TelegramCall class.
-
-
-
-
-
-_init_commands( command_prefix: str, commands: List[Type[royalnet.utils.command.Command]], missing_command: Type[royalnet.utils.command.Command], error_command: Type[royalnet.utils.command.Command] ) → None
-Generate the commands network_handlers
-
-
-
-
-_init_database( commands: List[Type[royalnet.utils.command.Command]], database_config: royalnet.database.databaseconfig.DatabaseConfig )
-Create an royalnet.database.Alchemy master_table identity_table
-
-
-
-
-_init_royalnet( royalnet_config: royalnet.network.royalnetconfig.RoyalnetConfig )
-Create a royalnet.network.RoyalnetLink asyncio.Task
-
-
-
-
-async _network_handler( request_dict: dict ) → dict
-Handle a single dict royalnet.network.RoyalnetLink
-
-Returns
-Another dict royalnet.network.Response
-
-
-
-
-
-async call( command_name: str , channel , parameters: List[str] = None , **kwargs )
-Call the command with the specified name.
-If it doesn’t exist, call self.missing_command
-If an exception is raised during the execution of the command, call self.error_command
-
-
-
-
-interface_name = NotImplemented
-
-
-
-
-async run( )
-A blocking coroutine that should make the bot start listening to commands and requests.
-
-
-
-
diff --git a/docs/html/commands.html b/docs/html/commands.html
index e1fc928b..82159801 100644
--- a/docs/html/commands.html
+++ b/docs/html/commands.html
@@ -159,138 +159,6 @@
royalnet.commands
-Commands that can be used in bots.
-These probably won’t suit your needs, as they are tailored for the bots of the Royal Games gaming community, but they may be useful to develop new ones.
-
-
-class royalnet.commands.NullCommand
-
-
-
-
-class royalnet.commands.PingCommand
-
-
-
-
-class royalnet.commands.ShipCommand
-
-
-
-
-class royalnet.commands.SmecdsCommand
-
-
-
-
-class royalnet.commands.CiaoruoziCommand
-
-
-
-
-class royalnet.commands.ColorCommand
-
-
-
-
-class royalnet.commands.SyncCommand
-
-
-
-
-class royalnet.commands.DiarioCommand
-
-
-
-
-class royalnet.commands.RageCommand
-
-
-
-
-class royalnet.commands.DateparserCommand
-
-
-
-
-class royalnet.commands.AuthorCommand
-
-
-
-
-class royalnet.commands.ReminderCommand
-
-
-
-
-class royalnet.commands.KvactiveCommand
-
-
-
-
-class royalnet.commands.KvCommand
-
-
-
-
-class royalnet.commands.KvrollCommand
-
-
-
-
-class royalnet.commands.VideoinfoCommand
-
-
-
-
-class royalnet.commands.SummonCommand
-
-
-
-
-class royalnet.commands.PlayCommand
-
-
-
-
-class royalnet.commands.SkipCommand
-
-
-
-
-class royalnet.commands.PlaymodeCommand
-
-
-
-
-class royalnet.commands.VideochannelCommand
-
-
-
-
-class royalnet.commands.MissingCommand
-
-
-
-
-class royalnet.commands.CvCommand
-
-
-
-
-class royalnet.commands.PauseCommand
-
-
-
-
-class royalnet.commands.QueueCommand
-
-
-
-
-class royalnet.commands.RoyalnetprofileCommand
-
-
diff --git a/docs/html/database.html b/docs/html/database.html
index 018f9f8c..5698031e 100644
--- a/docs/html/database.html
+++ b/docs/html/database.html
@@ -85,7 +85,7 @@
royalnet.bots royalnet.commands royalnet.database
royalnet.network royalnet.database
-Relational database classes and methods.
-
-
-class royalnet.database.Alchemy( database_uri: str , tables: Set )
-A wrapper around SQLAlchemy declarative that allows to use multiple databases at once while maintaining a single table-class for both of them.
-
-
-__init__( database_uri: str , tables: Set )
-Create a new Alchemy object.
-
-Parameters
-
-
-
-
-
-
-
-_create_tables( tables: Set )
-
-
-
-
-session_acm( )
-Use Alchemy as a asyncronous context manager (to be used in async with statements).
-
-
-
-
-session_cm( )
-Use Alchemy as a context manager (to be used in with statements).
-
-
-
-
-
-
-royalnet.database.relationshiplinkchain( starting_class , ending_class ) → Optional[tuple]
-Find the path to follow to get from the starting table to the ending table.
-
-
-
-
-class royalnet.database.DatabaseConfig( database_uri: str , master_table: Type , identity_table: Type , identity_column_name: str )
-The configuration to be used for the royalnet.database.Alchemy component of royalnet.bots.GenericBot .
-
-
-
-
Tables
-
-
-class royalnet.database.tables.Royal
-
-
-avatar = Column(None, LargeBinary(), table=None)
-
-
-
-
-password = Column(None, LargeBinary(), table=None)
-
-
-
-
-role = Column(None, String(), table=None, nullable=False)
-
-
-
-
-uid = Column(None, Integer(), table=None, primary_key=True, nullable=False)
-
-
-
-
-username = Column(None, String(), table=None, nullable=False)
-
-
-
-
-
-
-class royalnet.database.tables.Telegram
-
-
-first_name = Column(None, String(), table=None)
-
-
-
-
-last_name = Column(None, String(), table=None)
-
-
-
-
-mention( ) → str
-
-
-
-
-royal = <RelationshipProperty at 0x7fafa024a8c8; no key>
-
-
-
-
-royal_id = Column(None, Integer(), ForeignKey('royals.uid'), table=None)
-
-
-
-
-tg_id = Column(None, BigInteger(), table=None, primary_key=True, nullable=False)
-
-
-
-
-username = Column(None, String(), table=None)
-
-
-
-
-
-
-class royalnet.database.tables.Diario
-
-
-context = Column(None, Text(), table=None)
-
-
-
-
-creator = <RelationshipProperty at 0x7fafa01e6448; no key>
-
-
-
-
-creator_id = Column(None, Integer(), ForeignKey('royals.uid'), table=None)
-
-
-
-
-diario_id = Column(None, Integer(), table=None, primary_key=True, nullable=False)
-
-
-
-
-media_url = Column(None, String(), table=None)
-
-
-
-
-quoted = Column(None, String(), table=None)
-
-
-
-
-quoted_account = <RelationshipProperty at 0x7fafa01e6648; no key>
-
-
-
-
-quoted_account_id = Column(None, Integer(), ForeignKey('royals.uid'), table=None)
-
-
-
-
-spoiler = Column(None, Boolean(), table=None, default=ColumnDefault(False))
-
-
-
-
-text = Column(None, Text(), table=None)
-
-
-
-
-timestamp = Column(None, DateTime(), table=None, nullable=False)
-
-
-
-
-
-
-class royalnet.database.tables.Alias
-
-
-alias = Column(None, String(), table=None, primary_key=True, nullable=False)
-
-
-
-
-royal = <RelationshipProperty at 0x7fafa01e6bc8; no key>
-
-
-
-
-royal_id = Column(None, Integer(), ForeignKey('royals.uid'), table=None)
-
-
-
-
-
-
-class royalnet.database.tables.ActiveKvGroup
-
-
-group = <RelationshipProperty at 0x7fafa024ad48; no key>
-
-
-
-
-group_name = Column(None, String(), ForeignKey('keygroups.group_name'), table=None, nullable=False)
-
-
-
-
-royal = <RelationshipProperty at 0x7fafa01e64c8; no key>
-
-
-
-
-royal_id = Column(None, Integer(), ForeignKey('royals.uid'), table=None, primary_key=True, nullable=False)
-
-
-
-
-
-
-class royalnet.database.tables.Keyvalue
-
-
-group = <RelationshipProperty at 0x7fafa024acc8; no key>
-
-
-
-
-group_name = Column(None, String(), ForeignKey('keygroups.group_name'), table=None, primary_key=True, nullable=False)
-
-
-
-
-key = Column(None, String(), table=None, primary_key=True, nullable=False)
-
-
-
-
-value = Column(None, String(), table=None, nullable=False)
-
-
-
-
-
-
-class royalnet.database.tables.Keygroup
-
-
-group_name = Column(None, String(), ForeignKey('keygroups.group_name'), table=None, primary_key=True, nullable=False)
-
-
-
-
-
-
-class royalnet.database.tables.Discord
-
-
-avatar_hash = Column(None, String(), table=None)
-
-
-
-
-discord_id = Column(None, BigInteger(), table=None, primary_key=True, nullable=False)
-
-
-
-
-discriminator = Column(None, String(), table=None)
-
-
-
-
-full_username( )
-
-
-
-
-royal = <RelationshipProperty at 0x7fafa024abc8; no key>
-
-
-
-
-royal_id = Column(None, Integer(), ForeignKey('royals.uid'), table=None)
-
-
-
-
-username = Column(None, String(), table=None)
-
-
-
-
-
-
-class royalnet.database.tables.WikiPage
-Wiki page properties.
-
-
Warning
-
Requires PostgreSQL!
-
-
-content = Column(None, Text(), table=None)
-
-
-
-
-css = Column(None, String(), table=None)
-
-
-
-
-format = Column(None, String(), table=None, nullable=False, default=ColumnDefault('markdown'))
-
-
-
-
-page_id = Column(None, UUID(as_uuid=True), table=None, primary_key=True, nullable=False)
-
-
-
-
-title = Column(None, String(), table=None, nullable=False)
-
-
-
-
-
-
-class royalnet.database.tables.WikiRevision
-A wiki page revision.
-
-
Warning
-
Requires PostgreSQL!
-
-
-author = <RelationshipProperty at 0x7fafa01e6b48; no key>
-
-
-
-
-author_id = Column(None, Integer(), ForeignKey('royals.uid'), table=None, nullable=False)
-
-
-
-
-diff = Column(None, Text(), table=None)
-
-
-
-
-page = <RelationshipProperty at 0x7fafa01e6448; no key>
-
-
-
-
-page_id = Column(None, UUID(as_uuid=True), ForeignKey('wikipages.page_id'), table=None, nullable=False)
-
-
-
-
-reason = Column(None, Text(), table=None)
-
-
-
-
-revision_id = Column(None, UUID(as_uuid=True), table=None, primary_key=True, nullable=False)
-
-
-
-
-timestamp = Column(None, DateTime(), table=None, nullable=False)
-
-
-
-
+
+
Tables
royalnet.error
-
-
-exception royalnet.error.CurrentlyDisabledError
-This feature is temporarely disabled and is not available right now.
-
-
-
-
-exception royalnet.error.ExternalError
-Something went wrong in a non-Royalnet component and the command execution cannot be completed.
-
-
-
-
-exception royalnet.error.FileTooBigError
-The file to be downloaded would be too big to store; therefore, it has been skipped.
-
-
-
-
-exception royalnet.error.InvalidConfigError
-The bot has not been configured correctly, therefore the command can not function.
-
-
-
-
-exception royalnet.error.InvalidInputError
-The command has received invalid input and cannot complete.
-
-
-
-
-exception royalnet.error.NoneFoundError
-The element that was being looked for was not found.
-
-
-
-
-exception royalnet.error.RoyalnetRequestError( error: ResponseError )
-An error was raised while handling the Royalnet request.
-This exception contains the royalnet.network.ResponseError
-
-
-
-
-exception royalnet.error.RoyalnetResponseError
-The royalnet.network.Response
-
-
-
-
-exception royalnet.error.TooManyFoundError
-Multiple elements matching the request were found, and only one was expected.
-
-
-
-
-exception royalnet.error.UnregisteredError
-The command required a registered user, and the user was not registered.
-
-
-
-
-exception royalnet.error.UnsupportedError
-The command is not supported for the specified interface.
-
-
diff --git a/docs/html/genindex.html b/docs/html/genindex.html
index d2a16137..fcc173cc 100644
--- a/docs/html/genindex.html
+++ b/docs/html/genindex.html
@@ -154,808 +154,8 @@
Index
-
_
- |
A
- |
B
- |
C
- |
D
- |
E
- |
F
- |
G
- |
I
- |
J
- |
K
- |
L
- |
M
- |
N
- |
O
- |
P
- |
Q
- |
R
- |
S
- |
T
- |
U
- |
V
- |
W
- |
Y _
-
-
-A
-
-
-B
-
-
-C
-
-
-D
-
-
-E
-
-
-F
-
-
-G
-
-
-I
-
-
-J
-
-
-K
-
-
-L
-
-
-M
-
-
-N
-
-
-O
-
-
-P
-
-
-Q
-
-
-R
-
-
-S
-
-
-T
-
-
-U
-
-
-V
-
-
-W
-
-
-Y
-
-
diff --git a/docs/html/index.html b/docs/html/index.html
index c74c4423..1ddaff1e 100644
--- a/docs/html/index.html
+++ b/docs/html/index.html
@@ -166,7 +166,7 @@
royalnet.database
royalnet.network
royalnet.web
royalnet.network
-Royalnet (websocket) related classes.
-
-
-class royalnet.network.RoyalnetLink( master_uri: str , secret: str , link_type: str , request_handler , * , loop: asyncio.events.AbstractEventLoop = None )
-
-
-async connect( )
-Connect to the royalnet.network.RoyalnetServer self.master_uri
-
-
-
-
-async identify( ) → None
-
-
-
-
-async receive( ) → royalnet.network.package.Package
-Recieve a Package royalnet.network.RoyalnetServer
-
-Raises
-royalnet.network.royalnetlink.ConnectionClosedError –
-
-
-
-
-
-async request( message , destination )
-
-
-
-
-async run( loops: numbers.Real = inf )
-Blockingly run the Link.
-
-
-
-
-async send( package: royalnet.network.package.Package )
-
-
-
-
-
-
-exception royalnet.network.NetworkError( error_data: dict , *args )
-
-
-
-
-exception royalnet.network.NotConnectedError
-The royalnet.network.RoyalnetLink royalnet.network.RoyalnetServer
-
-
-
-
-exception royalnet.network.NotIdentifiedError
-The royalnet.network.RoyalnetLink royalnet.network.RoyalnetServer
-
-
-
-
-class royalnet.network.Package( data: dict , * , source: str , destination: str , source_conv_id: Optional[str] = None , destination_conv_id: Optional[str] = None )
-A Royalnet package, the data type with which a royalnet.network.RoyalnetLink royalnet.network.RoyalnetServer
-
-
-__init__( data: dict , * , source: str , destination: str , source_conv_id: Optional[str] = None , destination_conv_id: Optional[str] = None )
-Create a Package.
-
-Parameters
-
-data – The data that should be sent. Usually a royalnet.network.Message
source – The nid
destination – The link_type nid NULL
source_conv_id – The conversation id of the node that created this package. Akin to the sequence number on IP packets.
destination_conv_id – The conversation id of the node that this Package is a reply to.
-
-
-
-
-
-static from_dict( d ) → royalnet.network.package.Package
-Create a Package from a dictionary.
-
-
-
-
-static from_json_bytes( b: bytes ) → royalnet.network.package.Package
-Create a Package from UTF8-encoded JSON bytes.
-
-
-
-
-static from_json_string( string: str ) → royalnet.network.package.Package
-Create a Package from a JSON string.
-
-
-
-
-reply( data ) → royalnet.network.package.Package
-Reply to this Package with another Package.
-
-Parameters
-data – The data that should be sent. Usually a royalnet.network.Message
-Returns
-The reply Package.
-
-
-
-
-
-to_dict( ) → dict
-Convert the Package into a dictionary.
-
-
-
-
-to_json_bytes( ) → bytes
-Convert the Package into UTF8-encoded JSON bytes.
-
-
-
-
-to_json_string( ) → str
-Convert the Package into a JSON string.
-
-
-
-
-
-
-class royalnet.network.RoyalnetServer( address: str , port: int , required_secret: str , * , loop: asyncio.events.AbstractEventLoop = None )
-
-
-find_client( * , nid: str = None , link_type: str = None ) → List[royalnet.network.royalnetserver.ConnectedClient]
-
-
-
-
-find_destination( package: royalnet.network.package.Package ) → List[royalnet.network.royalnetserver.ConnectedClient]
-Find a list of destinations for the package.
-
-Parameters
-package – The package to find the destination of.
-Returns
-A list ConnectedClients
-
-
-
-
-
-async listener( websocket: websockets.server.WebSocketServerProtocol , path )
-
-
-
-
-async route_package( package: royalnet.network.package.Package ) → None
-Executed every time a package is received and must be routed somewhere.
-
-
-
-
-async serve( )
-
-
-
-
-async start( )
-
-
-
-
-
-
-class royalnet.network.RoyalnetConfig( master_uri: str , master_secret: str )
-
-
-
-
-exception royalnet.network.ConnectionClosedError
-The royalnet.network.RoyalnetLink
-
-
-
-
-class royalnet.network.Request( handler: str , data: dict )
-A request sent from a royalnet.network.RoyalnetLink
-It contains the name of the requested handler, in addition to the data.
-
-
-static from_dict( d: dict )
-
-
-
-
-to_dict( )
-
-
-
-
-
-
-class royalnet.network.Response
-A base class to be inherited by all other response types.
-
-
-classmethod from_dict( d: dict ) → royalnet.network.response.Response
-Recreate the response from a received dict
-
-
-
-
-raise_on_error( )
-Raise an Exception
-
-
-
-
-to_dict( ) → dict
-Prepare the Response to be sent by converting it to a JSONable dict
-
-
-
-
-
-
-class royalnet.network.ResponseSuccess( data: Optional[dict] = None )
-A response to a successful royalnet.network.Request
-
-
-raise_on_error( )
-Raise an Exception
-
-
-
-
-
-
-class royalnet.network.ResponseError( name: str , description: str , extra_info: Optional[dict] = None )
-A response to a invalid royalnet.network.Request
-
-
-raise_on_error( )
-Raise an Exception
-
-
-
-
diff --git a/docs/html/objects.inv b/docs/html/objects.inv
index 47189e10..e45d8c52 100644
Binary files a/docs/html/objects.inv and b/docs/html/objects.inv differ
diff --git a/docs/html/py-modindex.html b/docs/html/py-modindex.html
deleted file mode 100644
index 2812267f..00000000
--- a/docs/html/py-modindex.html
+++ /dev/null
@@ -1,262 +0,0 @@
-
-
-
-
-
-
- Python Module Index — Royalnet documentation
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Royalnet
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Docs »Python Module Index
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Python Module Index
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
royalnet.utils
-Miscellaneous useful functions and classes.
-
-
-async royalnet.utils.asyncify( function: Callable , *args , **kwargs )
-Convert a function into a coroutine.
-
-
Warning
-
The coroutine cannot be cancelled, and any attempts to do so will result in unexpected outputs.
-
-
-
-
-class royalnet.utils.Call( channel, command: Type[royalnet.utils.command.Command], command_args: List[str] = None, loop: asyncio.events.AbstractEventLoop = None, **kwargs )
-A command call. An abstract class, sub-bots should create a new call class from this.
-
-
-interface_name
-The name of the interface that is calling the command. For example, telegram discord
-
-
-
-
-interface_obj
-The main object of the interface that is calling the command. For example, the royalnet.bots.TelegramBot
-
-
-
-
-interface_prefix
-The command prefix used by the interface. For example, / !
-
-
-
-
-alchemy
-The royalnet.database.Alchemy
-
-
-
-
-__init__( channel, command: Type[royalnet.utils.command.Command], command_args: List[str] = None, loop: asyncio.events.AbstractEventLoop = None, **kwargs )
-Create the call.
-
-Parameters
-
-channel – The channel object this call was sent in.
command – The command to be called.
command_args – The arguments to be passed to the command
kwargs – Additional optional keyword arguments that may be passed to the command, possibly specific to the bot.
-
-
-
-
-
-async _session_init( )
-If the command requires database access, create a royalnet.database.Alchemy
-
-
-
-
-alchemy = NotImplemented
-
-
-
-
-async get_author( error_if_none=False )
-Try to find the universal identifier of the user that sent the message.
-That probably means, the database row identifying the user.
-
-Parameters
-error_if_none – Raise a royalnet.error.UnregisteredError
-Raises
-royalnet.error.UnregisteredError
-
-
-
-
-
-interface_name = NotImplemented
-
-
-
-
-interface_obj = NotImplemented
-
-
-
-
-interface_prefix = NotImplemented
-
-
-
-
-async net_request( message , destination: str ) → dict
-Send data through a royalnet.network.RoyalnetLink royalnet.network.Reply
-
-Parameters
-
-message – The data to be sent. Must be pickle
destination – The destination of the request, either in UUID format or node name.
-
-
-
-
-
-async reply( text: str ) → None
-Send a text message to the channel where the call was made.
-
-Parameters
-text – The text to be sent, possibly formatted in the weird undescribed markup that I’m using.
-
-
-
-
-
-async run( )
-Execute the called command, and return the command result.
-
-
-
-
-async session_end( )
-Close the previously created royalnet.database.Alchemy
-
-
-
-
-
-
-class royalnet.utils.Command
-The base class from which all commands should inherit.
-
-
-command_name
-The name of the command. To have /example example
-
-
-
-
-command_description
-A small description of the command, to be displayed when the command is being autocompleted.
-
-
-
-
-command_syntax
-The syntax of the command, to be displayed when a royalnet.error.InvalidInputError (required_arg) [optional_arg]
-
-
-
-
-require_alchemy_tables
-A set of royalnet.database
-
-
-
-
-network_handlers
-A list of :py:class:`
-
-
-
-
-command_description = NotImplemented
-
-
-
-
-command_name = NotImplemented
-
-
-
-
-command_syntax = NotImplemented
-
-
-
-
-classmethod common( call: Call )
-
-
-
-
-classmethod network_handler_dict( )
-
-
-
-
-network_handlers = {}
-
-
-
-
-require_alchemy_tables = {}
-
-
-
-
-
-
-royalnet.utils.safeformat( string: str , **words ) → str
-str.format()
-
-Parameters
-
-
-Returns
-The formatted string.
-
-
-
-
-
-royalnet.utils.cdj( class_: Any ) → dict
-Return a dict of the class attributes without the __module__ __dict__ __weakref__ __doc__
-
-Parameters
-class_ – The object that you want to dict-ify.
-Returns
-The class dict.
-
-
-
Warning
-
You can’t dict-ify classes with __slots__
-
-
-
-
-async royalnet.utils.sleep_until( dt: datetime.datetime ) → None
-Block the call until the specified datetime.
-
-
Warning
-
Accurate only to seconds.
-
-
-
-
-royalnet.utils.plusformat( i: int ) → str
-Convert an int str +
-
-Parameters
-i – the int
-Returns
-The resulting str
-
-
-
-
-
-class royalnet.utils.CommandArgs
-An interface to access the arguments of a command with ease.
-
-
-__getitem__( item )
-Arguments can be accessed with an array notation, such as args[0]
-
-Raises
-royalnet.error.InvalidInputError
-
-
-
-
-
-joined( * , require_at_least=0 ) → str
-Get the arguments as a space-joined string.
-
-Parameters
-require_at_least – the minimum amount of arguments required, will raise royalnet.error.InvalidInputError
-Raises
-royalnet.error.InvalidInputError require_at_least
-Returns
-The space-joined string.
-
-
-
-
-
-match( pattern: Pattern ) → Sequence[AnyStr]
-Match the royalnet.utils.commandargs.joined()
-
-Parameters
-pattern – The regex pattern to be passed to re.match()
-Raises
-royalnet.error.InvalidInputError
-Returns
-The matched groups, as returned by re.Match.groups()
-
-
-
-
-
-optional( index: int , default=None )
-Get the argument at a specific index, but don’t raise an error if nothing is found, instead returning the default
-
-Parameters
-
-
-Returns
-Either the argument or the default None
-
-
-
-
-
-
-
-class royalnet.utils.NetworkHandler
-The NetworkHandler functions are called when a specific Message type is received.
-
-
-message_type = NotImplemented
-
-
-
-
-
-
-royalnet.utils.andformat( l: List[str], middle=', ', final=' and ' ) → str
-Convert a list str final middle
-
-Parameters
-
-
-Returns
-The resulting str
-
-
-
-
-
-royalnet.utils.plusformat( i: int ) → str
-Convert an int str +
-
-Parameters
-i – the int
-Returns
-The resulting str
-
-
-
-
-
-royalnet.utils.fileformat( string: str ) → str
-Ensure a string can be used as a filename by replacing all non-word characters with underscores.
-
-Parameters
-string – the input string.
-Returns
-A valid filename string.
-
-
-
-
-
-royalnet.utils.ytdldateformat( string: Optional[str], separator: str = '-' ) → str
-Convert the weird date string returned by youtube-dl YYYY-MM-DD
-
-Parameters
-
-string – the input string, in the YYYYMMDD
separator – the string to add between the years, the months and the days. Defaults to -
-Returns
-The resulting string, in the format YYYY-MM-DD
-
-
-
-
-
-royalnet.utils.numberemojiformat( l: List[str] ) → str
-
-
-
-
-royalnet.utils.telegram_escape( string: str ) → str
-Escape a string to be sent through Telegram, and format it using RoyalCode.
-
-
Warning
-
Currently escapes everything, even items in code blocks.
-
-
-
-
-royalnet.utils.discord_escape( string: str ) → str
-Escape a string to be sent through Discord, and format it using RoyalCode.
-
-
Warning
-
Currently escapes everything, even items in code blocks.
-
-
diff --git a/docs/html/web.html b/docs/html/web.html
index bc2fa1d2..c40a72ac 100644
--- a/docs/html/web.html
+++ b/docs/html/web.html
@@ -88,7 +88,7 @@
royalnet.utils royalnet.error royalnet.web
royalnet.web
-
-
-royalnet.web.create_app( config_obj: Type, blueprints: List[royalnet.web.royalprint.Royalprint] )
-Create a flask.Flask
-Gets the app.secret_key SECRET_KEY
-Also requires a DB_PATH config_obj
-
-
Warning
-
The code for this class was written at 1 AM, and I have no clue of how and why it works or even of if it really does work.
-Use with caution?
-
-Parameters
-
-
-Returns
-The created flask.Flask
-
-
-
-
-
-class royalnet.web.Royalprint( name , import_name , static_folder=None , static_url_path=None , template_folder=None , url_prefix=None , subdomain=None , url_defaults=None , root_path=None , required_tables: Optional[set] = None )
-An edited flask.Blueprint required_tables
-
-
-
-
Royalprints
-
Some Royalprints that can be used with the Royalnet Flask server.
+
+
Royalprints
