diff --git a/docs/Makefile b/docs/Makefile deleted file mode 100644 index d0c3cbf1..00000000 --- a/docs/Makefile +++ /dev/null @@ -1,20 +0,0 @@ -# Minimal makefile for Sphinx documentation -# - -# You can set these variables from the command line, and also -# from the environment for the first two. -SPHINXOPTS ?= -SPHINXBUILD ?= sphinx-build -SOURCEDIR = source -BUILDDIR = build - -# Put it first so that "make" without argument is like "make help". -help: - @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) - -.PHONY: help Makefile - -# Catch-all target: route all unknown targets to Sphinx using the new -# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). -%: Makefile - @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/docs/build/doctrees/contributing.doctree b/docs/build/doctrees/contributing.doctree deleted file mode 100644 index 58fdc6e1..00000000 Binary files a/docs/build/doctrees/contributing.doctree and /dev/null differ diff --git a/docs/build/doctrees/cpl_cli.add.doctree b/docs/build/doctrees/cpl_cli.add.doctree deleted file mode 100644 index 677db691..00000000 Binary files a/docs/build/doctrees/cpl_cli.add.doctree and /dev/null differ diff --git a/docs/build/doctrees/cpl_cli.build.doctree b/docs/build/doctrees/cpl_cli.build.doctree deleted file mode 100644 index b72fe0e5..00000000 Binary files a/docs/build/doctrees/cpl_cli.build.doctree and /dev/null differ diff --git a/docs/build/doctrees/cpl_cli.doctree b/docs/build/doctrees/cpl_cli.doctree deleted file mode 100644 index 8f2f01b6..00000000 Binary files a/docs/build/doctrees/cpl_cli.doctree and /dev/null differ diff --git a/docs/build/doctrees/cpl_cli.generate.doctree b/docs/build/doctrees/cpl_cli.generate.doctree deleted file mode 100644 index de66f9d7..00000000 Binary files a/docs/build/doctrees/cpl_cli.generate.doctree and /dev/null differ diff --git a/docs/build/doctrees/cpl_cli.help.doctree b/docs/build/doctrees/cpl_cli.help.doctree deleted file mode 100644 index 00cf443d..00000000 Binary files a/docs/build/doctrees/cpl_cli.help.doctree and /dev/null differ diff --git a/docs/build/doctrees/cpl_cli.install.doctree b/docs/build/doctrees/cpl_cli.install.doctree deleted file mode 100644 index 0ddb941f..00000000 Binary files a/docs/build/doctrees/cpl_cli.install.doctree and /dev/null differ diff --git a/docs/build/doctrees/cpl_cli.new.doctree b/docs/build/doctrees/cpl_cli.new.doctree deleted file mode 100644 index 237c9329..00000000 Binary files a/docs/build/doctrees/cpl_cli.new.doctree and /dev/null differ diff --git a/docs/build/doctrees/cpl_cli.overview.doctree b/docs/build/doctrees/cpl_cli.overview.doctree deleted file mode 100644 index 8873d1bb..00000000 Binary files a/docs/build/doctrees/cpl_cli.overview.doctree and /dev/null differ diff --git a/docs/build/doctrees/cpl_cli.publish.doctree b/docs/build/doctrees/cpl_cli.publish.doctree deleted file mode 100644 index c514bcf0..00000000 Binary files a/docs/build/doctrees/cpl_cli.publish.doctree and /dev/null differ diff --git a/docs/build/doctrees/cpl_cli.remove.doctree b/docs/build/doctrees/cpl_cli.remove.doctree deleted file mode 100644 index 63999e9b..00000000 Binary files a/docs/build/doctrees/cpl_cli.remove.doctree and /dev/null differ diff --git a/docs/build/doctrees/cpl_cli.run.doctree b/docs/build/doctrees/cpl_cli.run.doctree deleted file mode 100644 index 0afb0ef2..00000000 Binary files a/docs/build/doctrees/cpl_cli.run.doctree and /dev/null differ diff --git a/docs/build/doctrees/cpl_cli.start.doctree b/docs/build/doctrees/cpl_cli.start.doctree deleted file mode 100644 index ecd13f5e..00000000 Binary files a/docs/build/doctrees/cpl_cli.start.doctree and /dev/null differ diff --git a/docs/build/doctrees/cpl_cli.uninstall.doctree b/docs/build/doctrees/cpl_cli.uninstall.doctree deleted file mode 100644 index 8d2993f2..00000000 Binary files a/docs/build/doctrees/cpl_cli.uninstall.doctree and /dev/null differ diff --git a/docs/build/doctrees/cpl_cli.update.doctree b/docs/build/doctrees/cpl_cli.update.doctree deleted file mode 100644 index c0d18ad5..00000000 Binary files a/docs/build/doctrees/cpl_cli.update.doctree and /dev/null differ diff --git a/docs/build/doctrees/cpl_cli.version.doctree b/docs/build/doctrees/cpl_cli.version.doctree deleted file mode 100644 index 19603701..00000000 Binary files a/docs/build/doctrees/cpl_cli.version.doctree and /dev/null differ diff --git a/docs/build/doctrees/cpl_core.application.doctree b/docs/build/doctrees/cpl_core.application.doctree deleted file mode 100644 index cebd5d1f..00000000 Binary files a/docs/build/doctrees/cpl_core.application.doctree and /dev/null differ diff --git a/docs/build/doctrees/cpl_core.configuration.doctree b/docs/build/doctrees/cpl_core.configuration.doctree deleted file mode 100644 index f90a41dc..00000000 Binary files a/docs/build/doctrees/cpl_core.configuration.doctree and /dev/null differ diff --git a/docs/build/doctrees/cpl_core.console.doctree b/docs/build/doctrees/cpl_core.console.doctree deleted file mode 100644 index a17248ee..00000000 Binary files a/docs/build/doctrees/cpl_core.console.doctree and /dev/null differ diff --git a/docs/build/doctrees/cpl_core.database.connection.doctree b/docs/build/doctrees/cpl_core.database.connection.doctree deleted file mode 100644 index 3697c32f..00000000 Binary files a/docs/build/doctrees/cpl_core.database.connection.doctree and /dev/null differ diff --git a/docs/build/doctrees/cpl_core.database.context.doctree b/docs/build/doctrees/cpl_core.database.context.doctree deleted file mode 100644 index ef2d78de..00000000 Binary files a/docs/build/doctrees/cpl_core.database.context.doctree and /dev/null differ diff --git a/docs/build/doctrees/cpl_core.database.doctree b/docs/build/doctrees/cpl_core.database.doctree deleted file mode 100644 index ccb3634c..00000000 Binary files a/docs/build/doctrees/cpl_core.database.doctree and /dev/null differ diff --git a/docs/build/doctrees/cpl_core.dependency_injection.doctree b/docs/build/doctrees/cpl_core.dependency_injection.doctree deleted file mode 100644 index 1b693000..00000000 Binary files a/docs/build/doctrees/cpl_core.dependency_injection.doctree and /dev/null differ diff --git a/docs/build/doctrees/cpl_core.doctree b/docs/build/doctrees/cpl_core.doctree deleted file mode 100644 index e721552f..00000000 Binary files a/docs/build/doctrees/cpl_core.doctree and /dev/null differ diff --git a/docs/build/doctrees/cpl_core.environment.doctree b/docs/build/doctrees/cpl_core.environment.doctree deleted file mode 100644 index 81defb9c..00000000 Binary files a/docs/build/doctrees/cpl_core.environment.doctree and /dev/null differ diff --git a/docs/build/doctrees/cpl_core.logging.doctree b/docs/build/doctrees/cpl_core.logging.doctree deleted file mode 100644 index ca0ef9af..00000000 Binary files a/docs/build/doctrees/cpl_core.logging.doctree and /dev/null differ diff --git a/docs/build/doctrees/cpl_core.mailing.doctree b/docs/build/doctrees/cpl_core.mailing.doctree deleted file mode 100644 index cde47964..00000000 Binary files a/docs/build/doctrees/cpl_core.mailing.doctree and /dev/null differ diff --git a/docs/build/doctrees/cpl_core.pipes.doctree b/docs/build/doctrees/cpl_core.pipes.doctree deleted file mode 100644 index cd820dcf..00000000 Binary files a/docs/build/doctrees/cpl_core.pipes.doctree and /dev/null differ diff --git a/docs/build/doctrees/cpl_core.time.doctree b/docs/build/doctrees/cpl_core.time.doctree deleted file mode 100644 index ddf2391d..00000000 Binary files a/docs/build/doctrees/cpl_core.time.doctree and /dev/null differ diff --git a/docs/build/doctrees/cpl_core.utils.doctree b/docs/build/doctrees/cpl_core.utils.doctree deleted file mode 100644 index e1c28d01..00000000 Binary files a/docs/build/doctrees/cpl_core.utils.doctree and /dev/null differ diff --git a/docs/build/doctrees/cpl_discord.application.doctree b/docs/build/doctrees/cpl_discord.application.doctree deleted file mode 100644 index 488022aa..00000000 Binary files a/docs/build/doctrees/cpl_discord.application.doctree and /dev/null differ diff --git a/docs/build/doctrees/cpl_discord.command.doctree b/docs/build/doctrees/cpl_discord.command.doctree deleted file mode 100644 index 94d71e52..00000000 Binary files a/docs/build/doctrees/cpl_discord.command.doctree and /dev/null differ diff --git a/docs/build/doctrees/cpl_discord.configuration.doctree b/docs/build/doctrees/cpl_discord.configuration.doctree deleted file mode 100644 index 15b55403..00000000 Binary files a/docs/build/doctrees/cpl_discord.configuration.doctree and /dev/null differ diff --git a/docs/build/doctrees/cpl_discord.container.doctree b/docs/build/doctrees/cpl_discord.container.doctree deleted file mode 100644 index 716d7284..00000000 Binary files a/docs/build/doctrees/cpl_discord.container.doctree and /dev/null differ diff --git a/docs/build/doctrees/cpl_discord.doctree b/docs/build/doctrees/cpl_discord.doctree deleted file mode 100644 index d2a1c8a5..00000000 Binary files a/docs/build/doctrees/cpl_discord.doctree and /dev/null differ diff --git a/docs/build/doctrees/cpl_discord.events.doctree b/docs/build/doctrees/cpl_discord.events.doctree deleted file mode 100644 index 88a4068f..00000000 Binary files a/docs/build/doctrees/cpl_discord.events.doctree and /dev/null differ diff --git a/docs/build/doctrees/cpl_discord.helper.doctree b/docs/build/doctrees/cpl_discord.helper.doctree deleted file mode 100644 index bd00488f..00000000 Binary files a/docs/build/doctrees/cpl_discord.helper.doctree and /dev/null differ diff --git a/docs/build/doctrees/cpl_discord.service.doctree b/docs/build/doctrees/cpl_discord.service.doctree deleted file mode 100644 index fcd92d55..00000000 Binary files a/docs/build/doctrees/cpl_discord.service.doctree and /dev/null differ diff --git a/docs/build/doctrees/cpl_query.base.doctree b/docs/build/doctrees/cpl_query.base.doctree deleted file mode 100644 index 90dd2a37..00000000 Binary files a/docs/build/doctrees/cpl_query.base.doctree and /dev/null differ diff --git a/docs/build/doctrees/cpl_query.doctree b/docs/build/doctrees/cpl_query.doctree deleted file mode 100644 index 7d7a2dfa..00000000 Binary files a/docs/build/doctrees/cpl_query.doctree and /dev/null differ diff --git a/docs/build/doctrees/cpl_query.enumerable.doctree b/docs/build/doctrees/cpl_query.enumerable.doctree deleted file mode 100644 index 9b712444..00000000 Binary files a/docs/build/doctrees/cpl_query.enumerable.doctree and /dev/null differ diff --git a/docs/build/doctrees/cpl_query.extension.doctree b/docs/build/doctrees/cpl_query.extension.doctree deleted file mode 100644 index b2074628..00000000 Binary files a/docs/build/doctrees/cpl_query.extension.doctree and /dev/null differ diff --git a/docs/build/doctrees/cpl_query.iterable.doctree b/docs/build/doctrees/cpl_query.iterable.doctree deleted file mode 100644 index 6797451d..00000000 Binary files a/docs/build/doctrees/cpl_query.iterable.doctree and /dev/null differ diff --git a/docs/build/doctrees/cpl_translation.doctree b/docs/build/doctrees/cpl_translation.doctree deleted file mode 100644 index 2acb2b7e..00000000 Binary files a/docs/build/doctrees/cpl_translation.doctree and /dev/null differ diff --git a/docs/build/doctrees/deprecated.doctree b/docs/build/doctrees/deprecated.doctree deleted file mode 100644 index a9fd206a..00000000 Binary files a/docs/build/doctrees/deprecated.doctree and /dev/null differ diff --git a/docs/build/doctrees/environment.pickle b/docs/build/doctrees/environment.pickle deleted file mode 100644 index 7badde67..00000000 Binary files a/docs/build/doctrees/environment.pickle and /dev/null differ diff --git a/docs/build/doctrees/getting_started.doctree b/docs/build/doctrees/getting_started.doctree deleted file mode 100644 index 6d3d3b88..00000000 Binary files a/docs/build/doctrees/getting_started.doctree and /dev/null differ diff --git a/docs/build/doctrees/index.doctree b/docs/build/doctrees/index.doctree deleted file mode 100644 index 90284558..00000000 Binary files a/docs/build/doctrees/index.doctree and /dev/null differ diff --git a/docs/build/doctrees/introduction.doctree b/docs/build/doctrees/introduction.doctree deleted file mode 100644 index ae560060..00000000 Binary files a/docs/build/doctrees/introduction.doctree and /dev/null differ diff --git a/docs/build/doctrees/modules.doctree b/docs/build/doctrees/modules.doctree deleted file mode 100644 index b572691b..00000000 Binary files a/docs/build/doctrees/modules.doctree and /dev/null differ diff --git a/docs/build/doctrees/quickstart.doctree b/docs/build/doctrees/quickstart.doctree deleted file mode 100644 index 36838565..00000000 Binary files a/docs/build/doctrees/quickstart.doctree and /dev/null differ diff --git a/docs/build/doctrees/setup.doctree b/docs/build/doctrees/setup.doctree deleted file mode 100644 index b04a5e7b..00000000 Binary files a/docs/build/doctrees/setup.doctree and /dev/null differ diff --git a/docs/build/doctrees/tutorials.appsettings.doctree b/docs/build/doctrees/tutorials.appsettings.doctree deleted file mode 100644 index e58c0b98..00000000 Binary files a/docs/build/doctrees/tutorials.appsettings.doctree and /dev/null differ diff --git a/docs/build/doctrees/tutorials.console-arguments.doctree b/docs/build/doctrees/tutorials.console-arguments.doctree deleted file mode 100644 index f9338a08..00000000 Binary files a/docs/build/doctrees/tutorials.console-arguments.doctree and /dev/null differ diff --git a/docs/build/doctrees/tutorials.console.doctree b/docs/build/doctrees/tutorials.console.doctree deleted file mode 100644 index a3f00a54..00000000 Binary files a/docs/build/doctrees/tutorials.console.doctree and /dev/null differ diff --git a/docs/build/doctrees/tutorials.create-startup.doctree b/docs/build/doctrees/tutorials.create-startup.doctree deleted file mode 100644 index effd2199..00000000 Binary files a/docs/build/doctrees/tutorials.create-startup.doctree and /dev/null differ diff --git a/docs/build/doctrees/tutorials.doctree b/docs/build/doctrees/tutorials.doctree deleted file mode 100644 index a6fa6ac2..00000000 Binary files a/docs/build/doctrees/tutorials.doctree and /dev/null differ diff --git a/docs/build/doctrees/tutorials.extend-application.doctree b/docs/build/doctrees/tutorials.extend-application.doctree deleted file mode 100644 index 410b23ef..00000000 Binary files a/docs/build/doctrees/tutorials.extend-application.doctree and /dev/null differ diff --git a/docs/build/doctrees/tutorials.extend-startup.doctree b/docs/build/doctrees/tutorials.extend-startup.doctree deleted file mode 100644 index c00d64e9..00000000 Binary files a/docs/build/doctrees/tutorials.extend-startup.doctree and /dev/null differ diff --git a/docs/build/doctrees/tutorials.logging.doctree b/docs/build/doctrees/tutorials.logging.doctree deleted file mode 100644 index ff5b4111..00000000 Binary files a/docs/build/doctrees/tutorials.logging.doctree and /dev/null differ diff --git a/docs/build/doctrees/tutorials.mail.doctree b/docs/build/doctrees/tutorials.mail.doctree deleted file mode 100644 index abe08273..00000000 Binary files a/docs/build/doctrees/tutorials.mail.doctree and /dev/null differ diff --git a/docs/build/doctrees/tutorials.templating.doctree b/docs/build/doctrees/tutorials.templating.doctree deleted file mode 100644 index f924bfc0..00000000 Binary files a/docs/build/doctrees/tutorials.templating.doctree and /dev/null differ diff --git a/docs/build/html/.buildinfo b/docs/build/html/.buildinfo deleted file mode 100644 index 03a5ac29..00000000 --- a/docs/build/html/.buildinfo +++ /dev/null @@ -1,4 +0,0 @@ -# Sphinx build info version 1 -# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: 7161cd79d6fb56140ef1c390e01dab1c -tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/docs/build/html/_images/ide-emulate.png b/docs/build/html/_images/ide-emulate.png deleted file mode 100644 index 3c6f5a6b..00000000 Binary files a/docs/build/html/_images/ide-emulate.png and /dev/null differ diff --git a/docs/build/html/_images/ide-src.png b/docs/build/html/_images/ide-src.png deleted file mode 100644 index f778cd46..00000000 Binary files a/docs/build/html/_images/ide-src.png and /dev/null differ diff --git a/docs/build/html/_images/ide.png b/docs/build/html/_images/ide.png deleted file mode 100644 index 18370cd8..00000000 Binary files a/docs/build/html/_images/ide.png and /dev/null differ diff --git a/docs/build/html/_sources/contributing.md.txt b/docs/build/html/_sources/contributing.md.txt deleted file mode 100644 index 249c41d6..00000000 --- a/docs/build/html/_sources/contributing.md.txt +++ /dev/null @@ -1,111 +0,0 @@ -# Contributing to CPL - -We would love for you to contribute to CPL and help make it even better than it is today! As a contributor, here are the guidelines we would like you to follow: - -- [Issuses and Bugs](#found-a-bug) -- [Feature Request](#feature-request) -- [Submission Guidelines](#submission-guidelines) -- [Coding Rules](#coding-rules) -- [License](#license) - -## Found a Bug? - -If you find a bug in the source code, you can help us by [submitting an issue](#submitting-an-issue) to our [Gitea Repository][gitea-repo]. Even better, you can [submit a Pull Request](#submitting-a-pull-request) with a fix. - -## Feature Request - -You can request a new feature by submitting an issue to our [Gitea Repository][gitea-repo]. If you would like to implement a new feature, please consider the size of the change in order to determine the right steps to proceed: - -For a Major Feature, first open an issue and outline your proposal so that it can be discussed. This process allows us to better coordinate our efforts, prevent duplication of work, and help you to craft the change so that it is successfully accepted into the project. - -Note: Adding a new topic to the documentation, or significantly re-writing a topic, counts as a major feature. - -Small Features can be crafted and directly submitted as a [Pull Request](#submit-pr). - -## Submission Guidelines - -### Submitting an Issue - -Before you submit an issue, please search the issue tracker, maybe an issue for your problem already exists and the discussion might inform you of workarounds readily available. - -We want to fix all the issues as soon as possible, but before fixing a bug we need to reproduce and confirm it. In order to reproduce bugs, we require that you provide a minimal reproduction. Having a minimal reproducible scenario gives us a wealth of important information without going back and forth to you with additional questions. - -A minimal reproduction allows us to quickly confirm a bug (or point out a coding problem) as well as confirm that we are fixing the right problem. - -We require a minimal reproduction to save maintainers' time and ultimately be able to fix more bugs. Often, developers find coding problems themselves while preparing a minimal reproduction. We understand that sometimes it might be hard to extract essential bits of code from a larger codebase but we really need to isolate the problem before we can fix it. - -Unfortunately, we are not able to investigate / fix bugs without a minimal reproduction, so if we don't hear back from you, we are going to close an issue that doesn't have enough info to be reproduced. - -### Submitting a Pull Request - -Before you submit your Pull Request (PR) consider the following guidelines: - -1. Search the [repository][gitea-repo] for an open or closed PR that relates to your submission. You don't want to duplicate existing efforts. - -2. Be sure that an issue describes the problem you're fixing, or documents the design for the feature you'd like to add. Discussing the design upfront helps to ensure that we're ready to accept your work. - -3. Fork the sh-edraft.de/cpl repo. - -4. In your forked repository, make your changes in a new git branch: - - ```sh - git checkout -b my-fix-branch master - ``` - -5. Create your patch, including appropriate test cases. - - - -6. Commit your changes. - - ```sh - git commit --all - ``` - - Note: the optional commit ```-a``` command line option will automatically "add" and "rm" edited files. - -7. Push your branch to the [repository][gitea-repo]: - - ```sh - git push origin my-fix-branch - ``` - -8. In Gitea, send a pull request to cpl:master - -### Reviewing a Pull Request - -The sh-edraft.de team reserves the right not to accept pull requests from community members who haven't been good citizens of the community. Such behavior includes not following the CPL [coding rules](#coding-rules) and applies within or outside of CPL managed channels. - -#### Addressing review feedback - -If we ask for changes via code reviews then: - -1. Make the required updates to the code. - -2. Create a fixup commit and push to your repository (this will update your Pull Request): - - ```sh - git commit --all --fixup HEAD - git push - ``` - -That's it! Thank you for your contribution! - -## Coding Rules - -To ensure consistency throughout the source code, keep these rules in mind as you are working: - -- All features or bug fixes must be tested by one or more unit-tests. - -- All public API methods must be documented. - -- We follow [PEP 8 -- Style Guide for Python Code](https://www.python.org/dev/peps/pep-0008/). - -## License - -By contributing, you agree that your contributions will be licensed under its MIT License. -See [LICENSE](https://git.sh-edraft.de/sh-edraft.de/cpl/src/branch/master/LICENSE) - - -[gitea-repo]: https://git.sh-edraft.de/sh-edraft.de/sh_cpl/ -[coding-rules]: / diff --git a/docs/build/html/_sources/cpl_cli.add.md.txt b/docs/build/html/_sources/cpl_cli.add.md.txt deleted file mode 100644 index 119359fa..00000000 --- a/docs/build/html/_sources/cpl_cli.add.md.txt +++ /dev/null @@ -1,32 +0,0 @@ -# cpl add - -## Contents - -- [Description](#description) -- [Arguments](#arguments) -- [Flags](#flags) - -Removes a project from workspace. - -cpl **add** *<source-project>* *<target-project>*
-cpl **a** *<source-project>* *<target-project>*
-cpl **A** *<source-project>* *<target-project>* - -## Description - -Adds a project reference to given project. - -If you call the command in a CPL workspace, you can use the project names. Otherwise the paths of the projects must be specified. - -## Arguments - -| Argument | Description | Value type | -|------------------------|:----------------------------------------------------------:|:----------:| -| `````` | Name of the project to which the reference has to be added | ```str``` | -| `````` | Name of the project to be referenced | ```str``` | - -## Flags - -| Argument | Description | -|------------------|:------------------------------------------:| -| ```--simulate``` | Specifies whether the command is simulated | \ No newline at end of file diff --git a/docs/build/html/_sources/cpl_cli.build.md.txt b/docs/build/html/_sources/cpl_cli.build.md.txt deleted file mode 100644 index 8fdf31b8..00000000 --- a/docs/build/html/_sources/cpl_cli.build.md.txt +++ /dev/null @@ -1,26 +0,0 @@ -# cpl build - -## Contents - -- [Description](#description) - - -Copies an python app into an output directory named build/ at the given output path. Must be executed within a CPL workspace or project directory - -cpl **build**
-cpl **b**
-cpl **B** - -## Description - -The command can be used to build a project of type "console" or "library". - -The build command copies all included source files to the output directory. You can run the source files in the output directory directly. - -The command is used to prepare the source files for the publish command or to copy them to an target for execution. - - diff --git a/docs/build/html/_sources/cpl_cli.generate.md.txt b/docs/build/html/_sources/cpl_cli.generate.md.txt deleted file mode 100644 index 6dc285a0..00000000 --- a/docs/build/html/_sources/cpl_cli.generate.md.txt +++ /dev/null @@ -1,43 +0,0 @@ -# cpl generate - -## Contents - -- [Description](#description) -- [Arguments](#arguments) -- [Schematics](#schematics) - -Generate a file based on schematic. - -cpl **generate** *<schematic>* *<name>*
-cpl **g** *<schematic>* *<name>*
-cpl **G** *<schematic>* *<name>* - -## Description - -Generates files based on a schematic. - -You can define custom schematics by creating templates in a ```.cpl``` folder. - -## Arguments - -| Argument | Description | Value type | -|-------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------:|:-------------:| -| `````` | The schematic to generate. | ```str``` | -| `````` | The name of the generated file. | ```str``` | -| ```--base``` | First element of path will be used as base-path not 'src'. For example: 'cpl g c test/Test' will be created at ```src/test/``` with --base it would be ```test/``` | ```str``` | - -## Schematics - -| Schematic | Description | Arguments | -|-----------------|:--------------------------------------:|:------------:| -| ```abc``` | Abstract base class | `````` | -| ```class``` | Class | `````` | -| ```enum``` | Enum class | `````` | -| ```pipe``` | Pipe class | `````` | -| ```service``` | Service class | `````` | -| ```settings``` | [Configmodel](cpl_core.configuration) | `````` | -| ```test``` | Test class | `````` | -| ```thread``` | Thread class | `````` | -| ```validator``` | Validator class | `````` | -| ```command``` | Discord bot command class | `````` | -| ```event``` | Discord bot event class | `````` | diff --git a/docs/build/html/_sources/cpl_cli.help.md.txt b/docs/build/html/_sources/cpl_cli.help.md.txt deleted file mode 100644 index 533c108c..00000000 --- a/docs/build/html/_sources/cpl_cli.help.md.txt +++ /dev/null @@ -1,22 +0,0 @@ -# cpl help - -## Contents - -- [Description](#description) -- [Arguments](#arguments) - -Lists available command and their short descriptions. - -cpl **help** *<command>*
-cpl **h** *<command>*
-cpl **H** *<command>* - -## Description - -Lists available command and their short descriptions. - -## Arguments - -| Argument | Description | Value type | -| ----------------- |:-----------------------------:|:-------------:| -| `````` | Shows a help message for this command in the console. | ```str``` | diff --git a/docs/build/html/_sources/cpl_cli.install.md.txt b/docs/build/html/_sources/cpl_cli.install.md.txt deleted file mode 100644 index 29a293cf..00000000 --- a/docs/build/html/_sources/cpl_cli.install.md.txt +++ /dev/null @@ -1,31 +0,0 @@ -# cpl install - -## Contents - -- [Description](#description) -- [Arguments](#arguments) - -Installs given package via pip - -cpl **install** *<package>*
-cpl **i** *<package>*
-cpl **I** *<package>* - -## Description - -Install given package to project via pip. -Without given package it will install the depedencies of the CPL project your in. - -## Arguments - -| Argument | Description | Value type | -|-----------------|:----------------------:|:----------:| -| `````` | The package to install | ```str``` | - -## Flags - -| Argument | Description | -|------------------|:----------------------------------------------------:| -| ```--dev``` | Specifies whether the command is in development mode | -| ```--virtual``` | Specifies whether the command is virtual mode | -| ```--simulate``` | Specifies whether the command is simulated | diff --git a/docs/build/html/_sources/cpl_cli.new.md.txt b/docs/build/html/_sources/cpl_cli.new.md.txt deleted file mode 100644 index 1301c1ad..00000000 --- a/docs/build/html/_sources/cpl_cli.new.md.txt +++ /dev/null @@ -1,45 +0,0 @@ -# cpl new - -## Contents - -- [Description](#description) -- [Arguments](#arguments) -- [Project types](#project-types) - -Generates a workspace and initial project or add a project to workspace. - -cpl **new** *<type>* *<name>*
-cpl **n** *<type>* *<name>*
-cpl **N** *<type>* *<name>* - -## Description - -Generates a workspace and initial project or add a project to workspace. - -You can define custom project types by creating templates in a ```.cpl``` folder. - -If the command is running in a CPL workspace, it will add the new project to the workspace. - -| Argument | Description | Value type | -|--------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------:|:----------:| -| `````` | The type of the project, see [types](#project-types) | ```str``` | -| `````` | The name of the project | ```str``` | -| ```--base``` | First element of path will be used as base-path not 'src'. For example: 'cpl g c test/Test' will be created at ```src/test/``` with --base it would be ```test/``` | ```str``` | - -## Project types - -| Project type | Description | -|---------------|:----------------------------:| -| ```console``` | A simple console application | -| ```library``` | A package | - -## Flags - -| Argument | Description | -|---------------------------|:-------------------------------------------:| -| ```--async``` | Specifies whether async is used | -| ```--application-base``` | Specifies whether application base is used | -| ```--startup``` | Specifies whether startup is used | -| ```--service-providing``` | Specifies whether service-providing is used | -| ```--nothing``` | Specifies whether nothing is used | -| ```--venv``` | Specifies whether venv is used | diff --git a/docs/build/html/_sources/cpl_cli.overview.md.txt b/docs/build/html/_sources/cpl_cli.overview.md.txt deleted file mode 100644 index 1116b4ba..00000000 --- a/docs/build/html/_sources/cpl_cli.overview.md.txt +++ /dev/null @@ -1,53 +0,0 @@ -# CLI Overview and Command Reference - -## Table of Contents - -1. [Install CPL](setup#install-the-package) -2. [Install CPL CLI](setup#install-the-cli) -3. [Basic workflow](#basic-workflow) -4. [CLI command-language syntax](#cli-command-language-syntax) -5. [Command overview](#command-overview) - -## Basic workflow - -To create, build, and serve a new, basic CPL project on a development server, go to the parent directory of your new workspace use the following commands: - -```sh -cpl new console my-first-project -cd my-first-project -cpl start -``` - -In the terminal you will the output of the app. - -## CLI command-language syntax - -```cpl``` commandNameOrAlias requiredArg ```[optionalsArgs]``` - -- Most commands, and some options, have aliases. Aliases are shown in the syntax statement for each command. -- Arguments are not prefixed. - -### Relative paths - -Options that specify files can be given as absolute paths, or as paths relative to the current working directory, which is generally either the workspace or project root. - -### Schematics - -The cpl generate command takes as an argument the artifact to be generated. In addition to any general options, each artifact defines its own options in a schematic. Schematic options are supplied to the command in the same format as immediate command options. - -## Command overview - -| Command | Alias | Description | -| ----------------------------- |:-------------:|:----------------:| -| [add](cpl_cli.add) | a or a | Adds a project reference to given project. -| [build](cpl_cli.build) | b or B | Prepares files for publish into an output directory named dist/ at the given output path. Must be executed from within a workspace directory. -| [generate](cpl_cli.generate) | g or G | Generate a new file. -| [help](cpl_cli.help) | h or H | Lists available command and their short descriptions. -| [install](cpl_cli.install) | i or I | With argument installs packages to project, without argument installs project dependencies. -| [new](cpl_cli.new) | n or N | Creates new CPL project. -| [publish](cpl_cli.publish) | p or P | Prepares files for publish into an output directory named dist/ at the given output path and executes ```setup.py```. Must be executed from within a library workspace directory. -| [remove](cpl_cli.remove) | r or R | Removes a project from workspace. -| [start](cpl_cli.start) | s or S | Starts CPL project, restarting on file changes. -| [uninstall](cpl_cli.uninstall) | ui or UI | Uninstalls packages from project. -| [update](cpl_cli.update) | u or U | Update CPL and project dependencies. -| [version](cpl_cli.version) | v or V | Outputs CPL CLI version. diff --git a/docs/build/html/_sources/cpl_cli.publish.md.txt b/docs/build/html/_sources/cpl_cli.publish.md.txt deleted file mode 100644 index ead7aebb..00000000 --- a/docs/build/html/_sources/cpl_cli.publish.md.txt +++ /dev/null @@ -1,27 +0,0 @@ -# cpl publish - -## Contents - -- [Description](#description) - - -Prepares files for publish into an output directory named dist/ at the given output path and executes ```setup.py```. - -cpl **publish**
-cpl **p**
-cpl **P** - -## Description - -The command can be used to publish a project of type "console" or "library". - -The publish command builds the source files and then creates an ```setup.py``` with data from ```cpl_core.json```. -The command executes the ```setup.py``` and removes all source files with the ```setup.py``` from the 'publish/' directory. - -Generated files of ```setup.py``` are in the 'publish/setup/' directory. - - \ No newline at end of file diff --git a/docs/build/html/_sources/cpl_cli.remove.md.txt b/docs/build/html/_sources/cpl_cli.remove.md.txt deleted file mode 100644 index a4a9fbf2..00000000 --- a/docs/build/html/_sources/cpl_cli.remove.md.txt +++ /dev/null @@ -1,30 +0,0 @@ -# cpl remove - -## Contents - -- [Description](#description) -- [Arguments](#arguments) - -Removes a project from workspace. - -cpl **remove** *<project>*
-cpl **r** *<project>*
-cpl **R** *<project>* - -## Description - -Removes a project reference and the files from workspace. - -If you call the command in a CPL workspace, you can use the project names. Otherwise the paths of the projects must be specified. - -## Arguments - -| Argument | Description | Value type | -|-----------------|:---------------------------------:|:----------:| -| `````` | The name of the project to delete | ```str``` | - -## Flags - -| Argument | Description | -|------------------|:----------------------------------------------------:| -| ```--simulate``` | Specifies whether the command is simulated | diff --git a/docs/build/html/_sources/cpl_cli.rst.txt b/docs/build/html/_sources/cpl_cli.rst.txt deleted file mode 100644 index e0ca1832..00000000 --- a/docs/build/html/_sources/cpl_cli.rst.txt +++ /dev/null @@ -1,20 +0,0 @@ -CLI reference -============= - -.. toctree:: - :maxdepth: 4 - - cpl_cli.overview - cpl_cli.add - cpl_cli.build - cpl_cli.generate - cpl_cli.help - cpl_cli.install - cpl_cli.new - cpl_cli.publish - cpl_cli.remove - cpl_cli.run - cpl_cli.start - cpl_cli.uninstall - cpl_cli.update - cpl_cli.version \ No newline at end of file diff --git a/docs/build/html/_sources/cpl_cli.run.md.txt b/docs/build/html/_sources/cpl_cli.run.md.txt deleted file mode 100644 index 5782a7a4..00000000 --- a/docs/build/html/_sources/cpl_cli.run.md.txt +++ /dev/null @@ -1,12 +0,0 @@ -# cpl run - -Starts your application once. - -cpl **run**
-cpl **r**
-cpl **R** - -| Argument | Description | Value type | -|-----------------|:----------------------------------------------------------------------------------------------------:|:----------:| -| `````` | Optional parameter to specify which project to start, if not set default project will be started. | ```str``` | -| ```--dev``` | To run the project from source and not from dist after build. | ```str``` | \ No newline at end of file diff --git a/docs/build/html/_sources/cpl_cli.start.md.txt b/docs/build/html/_sources/cpl_cli.start.md.txt deleted file mode 100644 index 961feef1..00000000 --- a/docs/build/html/_sources/cpl_cli.start.md.txt +++ /dev/null @@ -1,11 +0,0 @@ -# cpl start - -Starts your application, restarting on file changes. - -cpl **start**
-cpl **s**
-cpl **S** - -| Argument | Description | Value type | -|-----------------|:----------------------------------------------------------------------------------------------------:|:----------:| -| ```--dev``` | To run the project from source and not from dist after build. | ```str``` | \ No newline at end of file diff --git a/docs/build/html/_sources/cpl_cli.uninstall.md.txt b/docs/build/html/_sources/cpl_cli.uninstall.md.txt deleted file mode 100644 index a87c1320..00000000 --- a/docs/build/html/_sources/cpl_cli.uninstall.md.txt +++ /dev/null @@ -1,30 +0,0 @@ -# cpl uninstall - -## Contents - -- [Description](#description) -- [Arguments](#arguments) - -Uninstalls given package via pip - -cpl **uninstall** *<package>*
-cpl **ui** *<package>*
-cpl **UI** *<package>* - -## Description - -Uninstall given package from project via pip. - -## Arguments - -| Argument | Description | Value type | -|-----------------|:------------------------:|:----------:| -| `````` | The package to uninstall | ```str``` | - -## Flags - -| Argument | Description | -|------------------|:----------------------------------------------------:| -| ```--dev``` | Specifies whether the command is in development mode | -| ```--virtual``` | Specifies whether the command is virtual mode | -| ```--simulate``` | Specifies whether the command is simulated | diff --git a/docs/build/html/_sources/cpl_cli.update.md.txt b/docs/build/html/_sources/cpl_cli.update.md.txt deleted file mode 100644 index 0bbcb72a..00000000 --- a/docs/build/html/_sources/cpl_cli.update.md.txt +++ /dev/null @@ -1,13 +0,0 @@ -# cpl update - -Updates the CPL and project dependencies. - -cpl **update**
-cpl **u**
-cpl **U** - -## Flags - -| Argument | Description | -|------------------|:----------------------------------------------------:| -| ```--simulate``` | Specifies whether the command is simulated | diff --git a/docs/build/html/_sources/cpl_cli.version.md.txt b/docs/build/html/_sources/cpl_cli.version.md.txt deleted file mode 100644 index 4c8fcbe4..00000000 --- a/docs/build/html/_sources/cpl_cli.version.md.txt +++ /dev/null @@ -1,7 +0,0 @@ -# cpl version - -Lists the version of CPL, CPL CLI and all installed packages from pip. - -cpl **version**
-cpl **v**
-cpl **V** diff --git a/docs/build/html/_sources/cpl_core.application.rst.txt b/docs/build/html/_sources/cpl_core.application.rst.txt deleted file mode 100644 index bcdcbc20..00000000 --- a/docs/build/html/_sources/cpl_core.application.rst.txt +++ /dev/null @@ -1,61 +0,0 @@ -cpl\_core.application package -============================= - -Submodules ----------- - -cpl\_core.application.application\_abc module ---------------------------------------------- - -.. automodule:: cpl_core.application.application_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.application.application\_builder module -------------------------------------------------- - -.. automodule:: cpl_core.application.application_builder - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.application.application\_builder\_abc module ------------------------------------------------------- - -.. automodule:: cpl_core.application.application_builder_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.application.application\_extension\_abc module --------------------------------------------------------- - -.. automodule:: cpl_core.application.application_extension_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.application.startup\_abc module ------------------------------------------ - -.. automodule:: cpl_core.application.startup_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.application.startup\_extension\_abc module ----------------------------------------------------- - -.. automodule:: cpl_core.application.startup_extension_abc - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: cpl_core.application - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/build/html/_sources/cpl_core.configuration.rst.txt b/docs/build/html/_sources/cpl_core.configuration.rst.txt deleted file mode 100644 index 708c4ea6..00000000 --- a/docs/build/html/_sources/cpl_core.configuration.rst.txt +++ /dev/null @@ -1,109 +0,0 @@ -cpl\_core.configuration package -=============================== - -Submodules ----------- - -cpl\_core.configuration.argument\_abc module --------------------------------------------- - -.. automodule:: cpl_core.configuration.argument_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.configuration.argument\_builder module ------------------------------------------------- - -.. automodule:: cpl_core.configuration.argument_builder - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.configuration.argument\_executable\_abc module --------------------------------------------------------- - -.. automodule:: cpl_core.configuration.argument_executable_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.configuration.argument\_type\_enum module ---------------------------------------------------- - -.. automodule:: cpl_core.configuration.argument_type_enum - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.configuration.configuration module --------------------------------------------- - -.. automodule:: cpl_core.configuration.configuration - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.configuration.configuration\_abc module -------------------------------------------------- - -.. automodule:: cpl_core.configuration.configuration_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.configuration.configuration\_model\_abc module --------------------------------------------------------- - -.. automodule:: cpl_core.configuration.configuration_model_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.configuration.configuration\_variable\_name\_enum module ------------------------------------------------------------------- - -.. automodule:: cpl_core.configuration.configuration_variable_name_enum - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.configuration.executable\_argument module ---------------------------------------------------- - -.. automodule:: cpl_core.configuration.executable_argument - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.configuration.flag\_argument module ---------------------------------------------- - -.. automodule:: cpl_core.configuration.flag_argument - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.configuration.validator\_abc module ---------------------------------------------- - -.. automodule:: cpl_core.configuration.validator_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.configuration.variable\_argument module -------------------------------------------------- - -.. automodule:: cpl_core.configuration.variable_argument - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: cpl_core.configuration - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/build/html/_sources/cpl_core.console.rst.txt b/docs/build/html/_sources/cpl_core.console.rst.txt deleted file mode 100644 index b14cc8c8..00000000 --- a/docs/build/html/_sources/cpl_core.console.rst.txt +++ /dev/null @@ -1,53 +0,0 @@ -cpl\_core.console package -========================= - -Submodules ----------- - -cpl\_core.console.background\_color\_enum module ------------------------------------------------- - -.. automodule:: cpl_core.console.background_color_enum - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.console.console module --------------------------------- - -.. automodule:: cpl_core.console.console - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.console.console\_call module --------------------------------------- - -.. automodule:: cpl_core.console.console_call - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.console.foreground\_color\_enum module ------------------------------------------------- - -.. automodule:: cpl_core.console.foreground_color_enum - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.console.spinner\_thread module ----------------------------------------- - -.. automodule:: cpl_core.console.spinner_thread - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: cpl_core.console - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/build/html/_sources/cpl_core.database.connection.rst.txt b/docs/build/html/_sources/cpl_core.database.connection.rst.txt deleted file mode 100644 index 86ec3966..00000000 --- a/docs/build/html/_sources/cpl_core.database.connection.rst.txt +++ /dev/null @@ -1,29 +0,0 @@ -cpl\_core.database.connection package -===================================== - -Submodules ----------- - -cpl\_core.database.connection.database\_connection module ---------------------------------------------------------- - -.. automodule:: cpl_core.database.connection.database_connection - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.database.connection.database\_connection\_abc module --------------------------------------------------------------- - -.. automodule:: cpl_core.database.connection.database_connection_abc - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: cpl_core.database.connection - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/build/html/_sources/cpl_core.database.context.rst.txt b/docs/build/html/_sources/cpl_core.database.context.rst.txt deleted file mode 100644 index a17353d7..00000000 --- a/docs/build/html/_sources/cpl_core.database.context.rst.txt +++ /dev/null @@ -1,29 +0,0 @@ -cpl\_core.database.context package -================================== - -Submodules ----------- - -cpl\_core.database.context.database\_context module ---------------------------------------------------- - -.. automodule:: cpl_core.database.context.database_context - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.database.context.database\_context\_abc module --------------------------------------------------------- - -.. automodule:: cpl_core.database.context.database_context_abc - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: cpl_core.database.context - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/build/html/_sources/cpl_core.database.rst.txt b/docs/build/html/_sources/cpl_core.database.rst.txt deleted file mode 100644 index c5fbcffb..00000000 --- a/docs/build/html/_sources/cpl_core.database.rst.txt +++ /dev/null @@ -1,46 +0,0 @@ -cpl\_core.database package -========================== - -Subpackages ------------ - -.. toctree:: - :maxdepth: 4 - - cpl_core.database.connection - cpl_core.database.context - -Submodules ----------- - -cpl\_core.database.database\_settings module --------------------------------------------- - -.. automodule:: cpl_core.database.database_settings - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.database.database\_settings\_name\_enum module --------------------------------------------------------- - -.. automodule:: cpl_core.database.database_settings_name_enum - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.database.table\_abc module ------------------------------------- - -.. automodule:: cpl_core.database.table_abc - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: cpl_core.database - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/build/html/_sources/cpl_core.dependency_injection.rst.txt b/docs/build/html/_sources/cpl_core.dependency_injection.rst.txt deleted file mode 100644 index 4e951d6e..00000000 --- a/docs/build/html/_sources/cpl_core.dependency_injection.rst.txt +++ /dev/null @@ -1,85 +0,0 @@ -cpl\_core.dependency\_injection package -======================================= - -Submodules ----------- - -cpl\_core.dependency\_injection.scope module --------------------------------------------- - -.. automodule:: cpl_core.dependency_injection.scope - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.dependency\_injection.scope\_abc module -------------------------------------------------- - -.. automodule:: cpl_core.dependency_injection.scope_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.dependency\_injection.scope\_builder module ------------------------------------------------------ - -.. automodule:: cpl_core.dependency_injection.scope_builder - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.dependency\_injection.service\_collection module ----------------------------------------------------------- - -.. automodule:: cpl_core.dependency_injection.service_collection - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.dependency\_injection.service\_collection\_abc module ---------------------------------------------------------------- - -.. automodule:: cpl_core.dependency_injection.service_collection_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.dependency\_injection.service\_descriptor module ----------------------------------------------------------- - -.. automodule:: cpl_core.dependency_injection.service_descriptor - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.dependency\_injection.service\_lifetime\_enum module --------------------------------------------------------------- - -.. automodule:: cpl_core.dependency_injection.service_lifetime_enum - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.dependency\_injection.service\_provider module --------------------------------------------------------- - -.. automodule:: cpl_core.dependency_injection.service_provider - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.dependency\_injection.service\_provider\_abc module -------------------------------------------------------------- - -.. automodule:: cpl_core.dependency_injection.service_provider_abc - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: cpl_core.dependency_injection - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/build/html/_sources/cpl_core.environment.rst.txt b/docs/build/html/_sources/cpl_core.environment.rst.txt deleted file mode 100644 index 84eaedde..00000000 --- a/docs/build/html/_sources/cpl_core.environment.rst.txt +++ /dev/null @@ -1,37 +0,0 @@ -cpl\_core.environment package -============================= - -Submodules ----------- - -cpl\_core.environment.application\_environment module ------------------------------------------------------ - -.. automodule:: cpl_core.environment.application_environment - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.environment.application\_environment\_abc module ----------------------------------------------------------- - -.. automodule:: cpl_core.environment.application_environment_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.environment.environment\_name\_enum module ----------------------------------------------------- - -.. automodule:: cpl_core.environment.environment_name_enum - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: cpl_core.environment - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/build/html/_sources/cpl_core.logging.rst.txt b/docs/build/html/_sources/cpl_core.logging.rst.txt deleted file mode 100644 index 6f36754d..00000000 --- a/docs/build/html/_sources/cpl_core.logging.rst.txt +++ /dev/null @@ -1,53 +0,0 @@ -cpl\_core.logging package -========================= - -Submodules ----------- - -cpl\_core.logging.logger\_abc module ------------------------------------- - -.. automodule:: cpl_core.logging.logger_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.logging.logger\_service module ----------------------------------------- - -.. automodule:: cpl_core.logging.logger_service - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.logging.logging\_level\_enum module ---------------------------------------------- - -.. automodule:: cpl_core.logging.logging_level_enum - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.logging.logging\_settings module ------------------------------------------- - -.. automodule:: cpl_core.logging.logging_settings - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.logging.logging\_settings\_name\_enum module ------------------------------------------------------- - -.. automodule:: cpl_core.logging.logging_settings_name_enum - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: cpl_core.logging - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/build/html/_sources/cpl_core.mailing.rst.txt b/docs/build/html/_sources/cpl_core.mailing.rst.txt deleted file mode 100644 index 323e167c..00000000 --- a/docs/build/html/_sources/cpl_core.mailing.rst.txt +++ /dev/null @@ -1,53 +0,0 @@ -cpl\_core.mailing package -========================= - -Submodules ----------- - -cpl\_core.mailing.email module ------------------------------- - -.. automodule:: cpl_core.mailing.email - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.mailing.email\_client\_abc module -------------------------------------------- - -.. automodule:: cpl_core.mailing.email_client_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.mailing.email\_client\_service module ------------------------------------------------ - -.. automodule:: cpl_core.mailing.email_client_service - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.mailing.email\_client\_settings module ------------------------------------------------- - -.. automodule:: cpl_core.mailing.email_client_settings - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.mailing.email\_client\_settings\_name\_enum module ------------------------------------------------------------- - -.. automodule:: cpl_core.mailing.email_client_settings_name_enum - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: cpl_core.mailing - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/build/html/_sources/cpl_core.pipes.rst.txt b/docs/build/html/_sources/cpl_core.pipes.rst.txt deleted file mode 100644 index cc061b15..00000000 --- a/docs/build/html/_sources/cpl_core.pipes.rst.txt +++ /dev/null @@ -1,77 +0,0 @@ -cpl\_core.pipes package -======================= - -Submodules ----------- - -cpl\_core.pipes.bool\_pipe module ---------------------------------- - -.. automodule:: cpl_core.pipes.bool_pipe - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.pipes.first\_char\_to\_lower\_pipe module ---------------------------------------------------- - -.. automodule:: cpl_core.pipes.first_char_to_lower_pipe - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.pipes.first\_to\_upper\_pipe module ---------------------------------------------- - -.. automodule:: cpl_core.pipes.first_to_upper_pipe - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.pipes.ip\_address\_pipe module ----------------------------------------- - -.. automodule:: cpl_core.pipes.ip_address_pipe - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.pipes.pipe\_abc module --------------------------------- - -.. automodule:: cpl_core.pipes.pipe_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.pipes.to\_camel\_case\_pipe module --------------------------------------------- - -.. automodule:: cpl_core.pipes.to_camel_case_pipe - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.pipes.to\_snake\_case\_pipe module --------------------------------------------- - -.. automodule:: cpl_core.pipes.to_snake_case_pipe - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.pipes.version\_pipe module ------------------------------------- - -.. automodule:: cpl_core.pipes.version_pipe - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: cpl_core.pipes - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/build/html/_sources/cpl_core.rst.txt b/docs/build/html/_sources/cpl_core.rst.txt deleted file mode 100644 index f238136a..00000000 --- a/docs/build/html/_sources/cpl_core.rst.txt +++ /dev/null @@ -1,18 +0,0 @@ -API reference -============= - -.. toctree:: - :maxdepth: 4 - - cpl_core.application - cpl_core.configuration - cpl_core.console - cpl_core.database - cpl_core.dependency_injection - cpl_core.environment - cpl_core.logging - cpl_core.mailing - cpl_core.pipes - cpl_core.time - cpl_core.utils - diff --git a/docs/build/html/_sources/cpl_core.time.rst.txt b/docs/build/html/_sources/cpl_core.time.rst.txt deleted file mode 100644 index 4ecce6ec..00000000 --- a/docs/build/html/_sources/cpl_core.time.rst.txt +++ /dev/null @@ -1,29 +0,0 @@ -cpl\_core.time package -====================== - -Submodules ----------- - -cpl\_core.time.time\_format\_settings module --------------------------------------------- - -.. automodule:: cpl_core.time.time_format_settings - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.time.time\_format\_settings\_names\_enum module ---------------------------------------------------------- - -.. automodule:: cpl_core.time.time_format_settings_names_enum - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: cpl_core.time - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/build/html/_sources/cpl_core.utils.rst.txt b/docs/build/html/_sources/cpl_core.utils.rst.txt deleted file mode 100644 index 6318a1de..00000000 --- a/docs/build/html/_sources/cpl_core.utils.rst.txt +++ /dev/null @@ -1,37 +0,0 @@ -cpl\_core.utils package -======================= - -Submodules ----------- - -cpl\_core.utils.credential\_manager module ------------------------------------------- - -.. automodule:: cpl_core.utils.credential_manager - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.utils.pip module --------------------------- - -.. automodule:: cpl_core.utils.pip - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.utils.string module ------------------------------ - -.. automodule:: cpl_core.utils.string - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: cpl_core.utils - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/build/html/_sources/cpl_discord.application.rst.txt b/docs/build/html/_sources/cpl_discord.application.rst.txt deleted file mode 100644 index 3ce2c948..00000000 --- a/docs/build/html/_sources/cpl_discord.application.rst.txt +++ /dev/null @@ -1,21 +0,0 @@ -cpl\_discord.application package -================================ - -Submodules ----------- - -cpl\_discord.application.discord\_bot\_application\_abc module --------------------------------------------------------------- - -.. automodule:: cpl_discord.application.discord_bot_application_abc - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: cpl_discord.application - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/build/html/_sources/cpl_discord.command.rst.txt b/docs/build/html/_sources/cpl_discord.command.rst.txt deleted file mode 100644 index ca0bb5a5..00000000 --- a/docs/build/html/_sources/cpl_discord.command.rst.txt +++ /dev/null @@ -1,29 +0,0 @@ -cpl\_discord.command package -============================ - -Submodules ----------- - -cpl\_discord.command.discord\_command\_abc module -------------------------------------------------- - -.. automodule:: cpl_discord.command.discord_command_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.command.discord\_commands\_meta module ---------------------------------------------------- - -.. automodule:: cpl_discord.command.discord_commands_meta - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: cpl_discord.command - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/build/html/_sources/cpl_discord.configuration.rst.txt b/docs/build/html/_sources/cpl_discord.configuration.rst.txt deleted file mode 100644 index 47cda9ed..00000000 --- a/docs/build/html/_sources/cpl_discord.configuration.rst.txt +++ /dev/null @@ -1,21 +0,0 @@ -cpl\_discord.configuration package -================================== - -Submodules ----------- - -cpl\_discord.configuration.discord\_bot\_settings module --------------------------------------------------------- - -.. automodule:: cpl_discord.configuration.discord_bot_settings - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: cpl_discord.configuration - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/build/html/_sources/cpl_discord.container.rst.txt b/docs/build/html/_sources/cpl_discord.container.rst.txt deleted file mode 100644 index 44b70a52..00000000 --- a/docs/build/html/_sources/cpl_discord.container.rst.txt +++ /dev/null @@ -1,77 +0,0 @@ -cpl\_discord.container package -============================== - -Submodules ----------- - -cpl\_discord.container.category\_channel module ------------------------------------------------ - -.. automodule:: cpl_discord.container.category_channel - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.container.container module ---------------------------------------- - -.. automodule:: cpl_discord.container.container - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.container.guild module ------------------------------------ - -.. automodule:: cpl_discord.container.guild - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.container.member module ------------------------------------- - -.. automodule:: cpl_discord.container.member - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.container.role module ----------------------------------- - -.. automodule:: cpl_discord.container.role - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.container.text\_channel module -------------------------------------------- - -.. automodule:: cpl_discord.container.text_channel - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.container.thread module ------------------------------------- - -.. automodule:: cpl_discord.container.thread - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.container.voice\_channel module --------------------------------------------- - -.. automodule:: cpl_discord.container.voice_channel - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: cpl_discord.container - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/build/html/_sources/cpl_discord.events.rst.txt b/docs/build/html/_sources/cpl_discord.events.rst.txt deleted file mode 100644 index 290111c1..00000000 --- a/docs/build/html/_sources/cpl_discord.events.rst.txt +++ /dev/null @@ -1,421 +0,0 @@ -cpl\_discord.events package -=========================== - -Submodules ----------- - -cpl\_discord.events.on\_bulk\_message\_delete\_abc module ---------------------------------------------------------- - -.. automodule:: cpl_discord.events.on_bulk_message_delete_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_command\_abc module -------------------------------------------- - -.. automodule:: cpl_discord.events.on_command_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_command\_completion\_abc module -------------------------------------------------------- - -.. automodule:: cpl_discord.events.on_command_completion_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_command\_error\_abc module --------------------------------------------------- - -.. automodule:: cpl_discord.events.on_command_error_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_connect\_abc module -------------------------------------------- - -.. automodule:: cpl_discord.events.on_connect_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_disconnect\_abc module ----------------------------------------------- - -.. automodule:: cpl_discord.events.on_disconnect_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_error\_abc module ------------------------------------------ - -.. automodule:: cpl_discord.events.on_error_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_group\_join\_abc module ------------------------------------------------ - -.. automodule:: cpl_discord.events.on_group_join_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_group\_remove\_abc module -------------------------------------------------- - -.. automodule:: cpl_discord.events.on_group_remove_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_guild\_available\_abc module ----------------------------------------------------- - -.. automodule:: cpl_discord.events.on_guild_available_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_guild\_channel\_create\_abc module ----------------------------------------------------------- - -.. automodule:: cpl_discord.events.on_guild_channel_create_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_guild\_channel\_delete\_abc module ----------------------------------------------------------- - -.. automodule:: cpl_discord.events.on_guild_channel_delete_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_guild\_channel\_pins\_update\_abc module ----------------------------------------------------------------- - -.. automodule:: cpl_discord.events.on_guild_channel_pins_update_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_guild\_channel\_update\_abc module ----------------------------------------------------------- - -.. automodule:: cpl_discord.events.on_guild_channel_update_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_guild\_emojis\_update\_abc module ---------------------------------------------------------- - -.. automodule:: cpl_discord.events.on_guild_emojis_update_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_guild\_integrations\_update\_abc module ---------------------------------------------------------------- - -.. automodule:: cpl_discord.events.on_guild_integrations_update_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_guild\_join\_abc module ------------------------------------------------ - -.. automodule:: cpl_discord.events.on_guild_join_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_guild\_remove\_abc module -------------------------------------------------- - -.. automodule:: cpl_discord.events.on_guild_remove_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_guild\_role\_create\_abc module -------------------------------------------------------- - -.. automodule:: cpl_discord.events.on_guild_role_create_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_guild\_role\_delete\_abc module -------------------------------------------------------- - -.. automodule:: cpl_discord.events.on_guild_role_delete_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_guild\_role\_update\_abc module -------------------------------------------------------- - -.. automodule:: cpl_discord.events.on_guild_role_update_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_guild\_unavailable\_abc module ------------------------------------------------------- - -.. automodule:: cpl_discord.events.on_guild_unavailable_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_guild\_update\_abc module -------------------------------------------------- - -.. automodule:: cpl_discord.events.on_guild_update_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_invite\_create\_abc module --------------------------------------------------- - -.. automodule:: cpl_discord.events.on_invite_create_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_invite\_delete\_abc module --------------------------------------------------- - -.. automodule:: cpl_discord.events.on_invite_delete_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_member\_ban\_abc module ------------------------------------------------ - -.. automodule:: cpl_discord.events.on_member_ban_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_member\_join\_abc module ------------------------------------------------- - -.. automodule:: cpl_discord.events.on_member_join_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_member\_remove\_abc module --------------------------------------------------- - -.. automodule:: cpl_discord.events.on_member_remove_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_member\_unban\_abc module -------------------------------------------------- - -.. automodule:: cpl_discord.events.on_member_unban_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_member\_update\_abc module --------------------------------------------------- - -.. automodule:: cpl_discord.events.on_member_update_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_message\_abc module -------------------------------------------- - -.. automodule:: cpl_discord.events.on_message_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_message\_delete\_abc module ---------------------------------------------------- - -.. automodule:: cpl_discord.events.on_message_delete_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_message\_edit\_abc module -------------------------------------------------- - -.. automodule:: cpl_discord.events.on_message_edit_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_private\_channel\_create\_abc module ------------------------------------------------------------- - -.. automodule:: cpl_discord.events.on_private_channel_create_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_private\_channel\_delete\_abc module ------------------------------------------------------------- - -.. automodule:: cpl_discord.events.on_private_channel_delete_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_private\_channel\_pins\_update\_abc module ------------------------------------------------------------------- - -.. automodule:: cpl_discord.events.on_private_channel_pins_update_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_private\_channel\_update\_abc module ------------------------------------------------------------- - -.. automodule:: cpl_discord.events.on_private_channel_update_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_raw\_reaction\_add\_abc module ------------------------------------------------------- - -.. automodule:: cpl_discord.events.on_raw_reaction_add_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_raw\_reaction\_clear\_abc module --------------------------------------------------------- - -.. automodule:: cpl_discord.events.on_raw_reaction_clear_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_raw\_reaction\_clear\_emoji\_abc module ---------------------------------------------------------------- - -.. automodule:: cpl_discord.events.on_raw_reaction_clear_emoji_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_raw\_reaction\_remove\_abc module ---------------------------------------------------------- - -.. automodule:: cpl_discord.events.on_raw_reaction_remove_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_reaction\_add\_abc module -------------------------------------------------- - -.. automodule:: cpl_discord.events.on_reaction_add_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_reaction\_clear\_abc module ---------------------------------------------------- - -.. automodule:: cpl_discord.events.on_reaction_clear_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_reaction\_clear\_emoji\_abc module ----------------------------------------------------------- - -.. automodule:: cpl_discord.events.on_reaction_clear_emoji_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_reaction\_remove\_abc module ----------------------------------------------------- - -.. automodule:: cpl_discord.events.on_reaction_remove_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_ready\_abc module ------------------------------------------ - -.. automodule:: cpl_discord.events.on_ready_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_resume\_abc module ------------------------------------------- - -.. automodule:: cpl_discord.events.on_resume_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_typing\_abc module ------------------------------------------- - -.. automodule:: cpl_discord.events.on_typing_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_user\_update\_abc module ------------------------------------------------- - -.. automodule:: cpl_discord.events.on_user_update_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_voice\_state\_update\_abc module --------------------------------------------------------- - -.. automodule:: cpl_discord.events.on_voice_state_update_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_webhooks\_update\_abc module ----------------------------------------------------- - -.. automodule:: cpl_discord.events.on_webhooks_update_abc - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: cpl_discord.events - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/build/html/_sources/cpl_discord.helper.rst.txt b/docs/build/html/_sources/cpl_discord.helper.rst.txt deleted file mode 100644 index fab914ae..00000000 --- a/docs/build/html/_sources/cpl_discord.helper.rst.txt +++ /dev/null @@ -1,21 +0,0 @@ -cpl\_discord.helper package -=========================== - -Submodules ----------- - -cpl\_discord.helper.to\_containers\_converter module ----------------------------------------------------- - -.. automodule:: cpl_discord.helper.to_containers_converter - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: cpl_discord.helper - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/build/html/_sources/cpl_discord.rst.txt b/docs/build/html/_sources/cpl_discord.rst.txt deleted file mode 100644 index 94735451..00000000 --- a/docs/build/html/_sources/cpl_discord.rst.txt +++ /dev/null @@ -1,21 +0,0 @@ -Discord Reference -==================== - -.. toctree:: - :maxdepth: 4 - - cpl_discord.application - cpl_discord.command - cpl_discord.configuration - cpl_discord.container - cpl_discord.events - cpl_discord.helper - cpl_discord.service - -cpl\_discord.discord\_event\_types\_enum module ------------------------------------------------ - -.. automodule:: cpl_discord.discord_event_types_enum - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/build/html/_sources/cpl_discord.service.rst.txt b/docs/build/html/_sources/cpl_discord.service.rst.txt deleted file mode 100644 index 13527b5b..00000000 --- a/docs/build/html/_sources/cpl_discord.service.rst.txt +++ /dev/null @@ -1,69 +0,0 @@ -cpl\_discord.service package -============================ - -Submodules ----------- - -cpl\_discord.service.command\_error\_handler\_service module ------------------------------------------------------------- - -.. automodule:: cpl_discord.service.command_error_handler_service - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.service.discord\_bot\_service module -------------------------------------------------- - -.. automodule:: cpl_discord.service.discord_bot_service - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.service.discord\_bot\_service\_abc module ------------------------------------------------------- - -.. automodule:: cpl_discord.service.discord_bot_service_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.service.discord\_collection module ------------------------------------------------ - -.. automodule:: cpl_discord.service.discord_collection - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.service.discord\_collection\_abc module ----------------------------------------------------- - -.. automodule:: cpl_discord.service.discord_collection_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.service.discord\_service module --------------------------------------------- - -.. automodule:: cpl_discord.service.discord_service - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.service.discord\_service\_abc module -------------------------------------------------- - -.. automodule:: cpl_discord.service.discord_service_abc - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: cpl_discord.service - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/build/html/_sources/cpl_query.base.rst.txt b/docs/build/html/_sources/cpl_query.base.rst.txt deleted file mode 100644 index 34fc9962..00000000 --- a/docs/build/html/_sources/cpl_query.base.rst.txt +++ /dev/null @@ -1,53 +0,0 @@ -cpl\_query.base package -======================= - -Submodules ----------- - -cpl\_query.base.default\_lambda module --------------------------------------- - -.. automodule:: cpl_query.base.default_lambda - :members: - :undoc-members: - :show-inheritance: - -cpl\_query.base.ordered\_queryable module ------------------------------------------ - -.. automodule:: cpl_query.base.ordered_queryable - :members: - :undoc-members: - :show-inheritance: - -cpl\_query.base.ordered\_queryable\_abc module ----------------------------------------------- - -.. automodule:: cpl_query.base.ordered_queryable_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_query.base.queryable\_abc module -------------------------------------- - -.. automodule:: cpl_query.base.queryable_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_query.base.sequence module -------------------------------- - -.. automodule:: cpl_query.base.sequence - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: cpl_query.base - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/build/html/_sources/cpl_query.enumerable.rst.txt b/docs/build/html/_sources/cpl_query.enumerable.rst.txt deleted file mode 100644 index 6c4d6a18..00000000 --- a/docs/build/html/_sources/cpl_query.enumerable.rst.txt +++ /dev/null @@ -1,29 +0,0 @@ -cpl\_query.enumerable package -============================= - -Submodules ----------- - -cpl\_query.enumerable.enumerable module ---------------------------------------- - -.. automodule:: cpl_query.enumerable.enumerable - :members: - :undoc-members: - :show-inheritance: - -cpl\_query.enumerable.enumerable\_abc module --------------------------------------------- - -.. automodule:: cpl_query.enumerable.enumerable_abc - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: cpl_query.enumerable - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/build/html/_sources/cpl_query.extension.rst.txt b/docs/build/html/_sources/cpl_query.extension.rst.txt deleted file mode 100644 index 4579c6e1..00000000 --- a/docs/build/html/_sources/cpl_query.extension.rst.txt +++ /dev/null @@ -1,21 +0,0 @@ -cpl\_query.extension package -============================ - -Submodules ----------- - -cpl\_query.extension.list module --------------------------------- - -.. automodule:: cpl_query.extension.list - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: cpl_query.extension - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/build/html/_sources/cpl_query.iterable.rst.txt b/docs/build/html/_sources/cpl_query.iterable.rst.txt deleted file mode 100644 index 07ea0c19..00000000 --- a/docs/build/html/_sources/cpl_query.iterable.rst.txt +++ /dev/null @@ -1,29 +0,0 @@ -cpl\_query.iterable package -=========================== - -Submodules ----------- - -cpl\_query.iterable.iterable module ------------------------------------ - -.. automodule:: cpl_query.iterable.iterable - :members: - :undoc-members: - :show-inheritance: - -cpl\_query.iterable.iterable\_abc module ----------------------------------------- - -.. automodule:: cpl_query.iterable.iterable_abc - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: cpl_query.iterable - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/build/html/_sources/cpl_query.rst.txt b/docs/build/html/_sources/cpl_query.rst.txt deleted file mode 100644 index 5812cc73..00000000 --- a/docs/build/html/_sources/cpl_query.rst.txt +++ /dev/null @@ -1,10 +0,0 @@ -Query reference -=============== - -.. toctree:: - :maxdepth: 4 - - cpl_query.base - cpl_query.enumerable - cpl_query.extension - cpl_query.iterable diff --git a/docs/build/html/_sources/cpl_translation.rst.txt b/docs/build/html/_sources/cpl_translation.rst.txt deleted file mode 100644 index 365356e8..00000000 --- a/docs/build/html/_sources/cpl_translation.rst.txt +++ /dev/null @@ -1,34 +0,0 @@ -Translation reference -======================== - -cpl\_translation.translate\_pipe ---------------------------------------- - -.. automodule:: cpl_translation.translate_pipe - :members: - :undoc-members: - :show-inheritance: - -cpl\_translation.translation\_service --------------------------------------------- - -.. automodule:: cpl_translation.translation_service - :members: - :undoc-members: - :show-inheritance: - -cpl\_translation.translation\_service\_abc -------------------------------------------------- - -.. automodule:: cpl_translation.translation_service_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_translation.translation\_settings ---------------------------------------------- - -.. automodule:: cpl_translation.translation_settings - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/build/html/_sources/deprecated.md.txt b/docs/build/html/_sources/deprecated.md.txt deleted file mode 100644 index b73a77ab..00000000 --- a/docs/build/html/_sources/deprecated.md.txt +++ /dev/null @@ -1,69 +0,0 @@ -# Deprecated - -## Table of Contents - -1. [ConfigurationModelABC.from_dict](#ConfigurationModelABC-from_dict-method) - -## ConfigurationModelABC from_dict method - -We now process the configuration models directly in the configuration by recursive parameter parsing. - -The JSONProcessor now goes through the JSON and the arguments of the __init__ and links the attributes by name from the -JSON and the name of the keyword argument. -Now, based on the type, either simply assigns the value. With a ``dict`` the processor is called recursively and so the -JSON is processed further. This way nested ConfigurationModels can be processed. - -For this the code must be adapted as follows: - -From this: - -```sh -class VersionSettings(ConfigurationModelABC): - - def __init__(self): - ConfigurationModelABC.__init__(self) - - self.major: Optional[str] = "0" - self.minor: Optional[str] = "0" - self.micro: Optional[str] = "0" - - def from_dict(self, settings: dict): - self.major = settings["Major"] - self.minor = settings["Minor"] - micro = settings["Micro"] - if micro != '': - self.micro = micro -``` - -To this: - -```sh -class VersionSettings(ConfigurationModelABC): - def __init__(self, major: str = None, minor: str = None, micro: str = None): - ConfigurationModelABC.__init__(self) - - self.major: Optional[str] = major - self.minor: Optional[str] = minor - self.micro: Optional[str] = micro if micro != "" else None -``` - -This makes the [from_dict](#from_dict) function obsolete. - -A few rules must be observed: - -- Only simple types can be processed -
- Wrong: ```dict[str, str]``` -
- Correct: ```dict``` -
-
- Incorrect: ```list[str]``` -
- Correct: ```list``` - -- The arguments must be optional, i.e. created as kwargs -
- Incorrect: ```def __init__(self, x: int, y: int)``` -
- Correct: ```def __init__(self, x: int = None, y: int = None)``` \ No newline at end of file diff --git a/docs/build/html/_sources/getting_started.rst.txt b/docs/build/html/_sources/getting_started.rst.txt deleted file mode 100644 index 22dc00e9..00000000 --- a/docs/build/html/_sources/getting_started.rst.txt +++ /dev/null @@ -1,10 +0,0 @@ -Getting started -=============== - -.. toctree:: - :maxdepth: 4 - - quickstart - setup - tutorials - diff --git a/docs/build/html/_sources/index.rst.txt b/docs/build/html/_sources/index.rst.txt deleted file mode 100644 index 9b6e6056..00000000 --- a/docs/build/html/_sources/index.rst.txt +++ /dev/null @@ -1,95 +0,0 @@ -.. Common Python Library documentation master file, created by - sphinx-quickstart on Wed Apr 14 10:25:36 2021. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -Introduction to the CPL Docs -============================ - -The Common Python Library (CPL) is a package for python and a development platform meant to help you create simple and efficient server and desktop applications. - -This CPL docs help you learn, understand and use the package. From your first application to complex apps for enterprises. - - -Features --------- -- cpl-core - - Expandable - - Application base - - Standardized application classes - - Application object builder - - Application extension classes - - Startup classes - - Startup extension classes - - Configuration - - Configure via object mapped JSON - - Console argument handling - - Console class for in and output - - Banner - - Spinner - - Options (menu) - - Table - - Write - - Write_at - - Write_line - - Write_line_at - - Dependency injection - - Service lifetimes: singleton, scoped and transient - - Providing of application environment - - Environment (development, staging, testing, production) - - Appname - - Customer - - Hostname - - Runtime directory - - Working directory - - Logging - - Standardized logger - - Log-level (FATAL, ERROR, WARN, INFO, DEBUG & TRACE) - - Mail handling - - Send mails - - Pipe classes - - Convert input - - Utils - - Credential manager - - Encryption via BASE64 - - PIP wrapper class based on subprocess - - Run pip commands - - String converter to different variants - - to_lower_case - - to_camel_case - - ... -- cpl-cli - - Expandle - - Code generation - - Package managing - - Build & Publishing -- cpl-discord - - Utils for discord.py - - Connector between cpl-core and discord.py - - Prepared services for dependency injection -- cpl-query - - Python list extensions - - Functions for sorting and filtering - - Like linq from C# but in python xD -- cpl-translate - - Generic translations - - Prepared translation service and translate pipe - - Get translation from JSON files key dot.key notation - -Manuals ---------- - -These pages go into great detail about everything the Library can do. - -.. toctree:: - :maxdepth: 1 - - introduction - getting_started - contributing - deprecated - cpl_cli - cpl_core - cpl_discord - cpl_query - cpl_translation diff --git a/docs/build/html/_sources/introduction.md.txt b/docs/build/html/_sources/introduction.md.txt deleted file mode 100644 index 33d31430..00000000 --- a/docs/build/html/_sources/introduction.md.txt +++ /dev/null @@ -1,60 +0,0 @@ -# Introduction to the CPL Docs - -The Common Python Library (CPL) is a package for python and a development platform meant to help you create simple and efficient server and desktop applications. - -This CPL docs help you learn, understand and use the package. From your first application to complex apps for enterprises. - -## Feature overview - -- Expandle -- Application base - - Standardized application classes - - Application object builder - - Application extension classes - - Startup classes - - Startup extension classes -- Configuration - - Configure via object mapped JSON - - Console argument handling -- Console class for in and output - - Banner - - Spinner - - Options (menu) - - Table - - Write - - Write_at - - Write_line - - Write_line_at -- Dependency injection - - Service lifetimes: singleton, scoped and transient -- Providing of application environment - - Environment (development, staging, testing, production) - - Appname - - Customer - - Hostname - - Runtime directory - - Working directory -- Logging - - Standardized logger - - Log-level (FATAL, ERROR, WARN, INFO, DEBUG & TRACE) -- Mail handling - - Send mails -- Pipe classes - - Convert input -- Utils - - Credential manager - - Encryption via BASE64 - - PIP wrapper class based on subprocess - - Run pip commands - - String converter to different variants - - to_lower_case - - to_camel_case - - ... - -## Explore - -- [Getting started](quickstart) -- [Setup](setup) -- [API Reference](cpl_core) -- [CLI Reference](cpl_cli.overview) -- [Query Reference](cpl_query) diff --git a/docs/build/html/_sources/modules.rst.txt b/docs/build/html/_sources/modules.rst.txt deleted file mode 100644 index 49bd8182..00000000 --- a/docs/build/html/_sources/modules.rst.txt +++ /dev/null @@ -1,11 +0,0 @@ -Packages -======== - -.. toctree:: - :maxdepth: 4 - - cpl_cli - cpl_core - cpl_discord - cpl_query - cpl_translation diff --git a/docs/build/html/_sources/quickstart.md.txt b/docs/build/html/_sources/quickstart.md.txt deleted file mode 100644 index ef5b6693..00000000 --- a/docs/build/html/_sources/quickstart.md.txt +++ /dev/null @@ -1,210 +0,0 @@ -# Getting started with CPL - -Welcome to CPL! - -This tutorial introduces you to the essentials of the CPL package by walking through building an console based app. - -## Table of Contents - -1. [Prerequisites](#prerequisites) -2. [Create the project](#create-the-project) -3. [Create a menu](#create-a-menu) -4. [What's next](#whats-next) - -## Prerequisites - -To get most out of this tutorial you should already have a basic understanding of the following. - -- [Python][python] - -Also you need to have the following installed. - -- [Python][python] -- [Pip][pip-url] -- [CPL](setup) -- [CPL-CLI](setup) - -## Create the project - -To create the sample project to the following: - -1. Open a terminal -2. Run - - ```sh - cpl new console sample-project - ``` - -3. We don't want to use Application base or Dependency injection: - - ```sh - Do you want to use application base? (y/n) n - - Do you want to use service providing? (y/n) n - ``` - - The ouput should look like this: - - ```sh - Creating sample-project/LICENSE done - Creating sample-project/README.md done - Creating sample-project/src/tests/__init__.py done - Creating sample-project/appsettings.json done - Creating sample-project/src/sample-project/__init__.py done - Creating sample-project/src/sample-projectmain.py done - ``` - -4. Open the project with an IDE like VS Code or PyCharm - - ![IDE](images/ide.png) - -5. Set the 'src' directory as source folder - - ![IDE set src folder](images/ide-src.png) - -6. Run the application - - You should see an output like: - - ```sh - Hello World - ``` - -7. In PyCharm you have to enable ```Emulate terminal in output console```! - - ![IDE emulate console](images/ide-emulate.png) - -## Create a menu - -1. Open the 'sample-project/main.py' - -2. Change 'Hello World' to 'Password generator:' in line 5 - -3. Add ```Console.select``` as follows: - - ```py - from cpl_core.console import Console - - - def main(): - Console.write_line('Password generator:') - options = [ - 'Only lower case', - 'Only upper case', - 'Lower and upper case' - 'Exit' - ] - option = Console.select('>', 'Select option: ', options) - - - if __name__ == '__main__': - main() - - ``` - -4. Get Id of the selected option: - - ```py - index = options.index(option) - ``` - -5. Create the generate function as follows: - - ```py - def generate_password(letters: str, length: int) -> str: - return ''.join(random.choice(letters) for i in range(length)) - ``` - - Add imports: - - ```py - import random - import string - ``` - -6. Get length of the password: - - ```py - length = int(Console.read('Length: ')) - ``` - -7. Validate the selected option: - - ```py - index = options.index(option) - letters = '' - - if index == 0: - letters = string.ascii_lowercase - elif index == 1: - letters = string.ascii_uppercase - elif index == 2: - letters = string.ascii_letters - elif index == len(options) - 1: - exit() - ``` - -8. Print the generated password: - - ```py - Console.write_line('Password: ', generate_password(letters, length)) - ``` - -9. The full 'sample-project/main.py': - - ```py - import random - import string - - from cpl_core.console import Console - - - def generate_password(letters: str, length: int) -> str: - return ''.join(random.choice(letters) for i in range(length)) - - - def main(): - Console.write_line('Password generator:') - options = [ - 'Only lower case', - 'Only upper case', - 'Lower and upper case', - 'Exit' - ] - option = Console.select('>', 'Select option: ', options) - - length = int(Console.read('Length: ')) - - index = options.index(option) - letters = '' - if index == 0: - letters = string.ascii_lowercase - elif index == 1: - letters = string.ascii_uppercase - elif index == 2: - letters = string.ascii_letters - elif index == len(options) - 1: - exit() - - Console.write_line('Password: ', generate_password(letters, length)) - - - if __name__ == '__main__': - main() - - ``` - -## What's next - -In this section, you've created an application that uses user input to generate a password. - -To continue exploring CPL and developing applications: - -- [Application base](cpl_core.application) -- [Dependency injection](cpl_core.dependency_injection) -- [Console](cpl_core.console) - - -[pip-url]: https://pip.sh-edraft.de -[python]: https://www.python.org/ -[pip]: https://pypi.org/project/pip/ diff --git a/docs/build/html/_sources/setup.md.txt b/docs/build/html/_sources/setup.md.txt deleted file mode 100644 index 1a953c69..00000000 --- a/docs/build/html/_sources/setup.md.txt +++ /dev/null @@ -1,113 +0,0 @@ -# Setting up the local environment and workspace - -## Table of Contents - -1. [Prerequisites](#prerequisites) -2. [Install the package](#install-the-package) -3. [Install the CLI](#install-the-cli) -3. [Install the query](#install-the-query) -4. [Create a initial application](#create-initial-console-app) -5. [Create a initial library](#create-initial-library) -6. [Start the application](#start-the-app) -7. [What's next](#whats-next) - -## Prerequisites - -To get most out of this tutorial you should already have a basic understanding of the following. - -- [Python][python] - -Also you need to have the following installed. - -- [Python][python] -- [Pip][pip-url] - -## Install the package - -To install the package, open a terminal window and run the following command: - -```sh -pip install cpl-core --extra-index-url https://pip.sh-edraft.de -``` - -## Install the CLI - -You use the CPL CLI to create projects, generate application and library code. You also use the CLI to build and publish your python packages. - -To install the CLI, open a terminal window and run the following command: - -```sh -pip install cpl-cli --extra-index-url https://pip.sh-edraft.de -``` - -## Install the query - -To install the package, open a terminal window and run the following command: - -```sh -pip install cpl-query --extra-index-url https://pip.sh-edraft.de -``` - -## Create initial console app - -You develop apps and packages in the context of an CPL project which is defined in an cpl_core.json. - -1. Run the CLI command ```cpl new console``` and provide the name my-app, as shown here: - - ```sh - cpl new console my-app - ``` - -2. The cpl new command prompts you for information about features to include in the initial app. Decline the defaults by enter 'n' and press the Enter key. - -The CLI create a new workspace and a simple 'Hello World' app, ready to run. - -## Create initial library - -You develop apps and packages in the context of an CPL project which is defined in an cpl_core.json. - -1. Run the CLI command ```cpl new library``` and provide the name my-lib, as shown here: - - ```sh - cpl new library my-lib - ``` - -2. The cpl new command prompts you for information about features to include in the initial library. Decline the defaults by enter 'n' and press the Enter key. - -The CLI create a new workspace and a simple 'Hello World' library with CLI, ready to run. - -## Start the app - -The CLI includes a live development server, so that you can run your app locally. - -1. Open a terminal window - -2. To navigate to your project workspace, run the following command: - - ```sh - cd /path/to/project/name - ``` - -3. To run the app run: - - ```sh - cpl start - ``` - -The ```cpl start``` command launches the server, watches your source files, and restarts the app as you make chnages to thoses source files. - -If your installation and setup was successful, you should see a output similar to the following: - -```sh -Hello World -``` - -## What's next - -- To learn more about the CPL CLI, see the [CLI Overview](cpl_cli.overview) -- Fore more informations about the Pyhton files generated by ```cpl new```, see [New Command](cpl_cli.new) - - -[pip-url]: https://pip.sh-edraft.de -[python]: https://www.python.org/ -[pip]: https://pypi.org/project/pip/ diff --git a/docs/build/html/_sources/tutorials.appsettings.md.txt b/docs/build/html/_sources/tutorials.appsettings.md.txt deleted file mode 100644 index 4eabffa2..00000000 --- a/docs/build/html/_sources/tutorials.appsettings.md.txt +++ /dev/null @@ -1,3 +0,0 @@ -# Using appsettings.json - -## Coming soon \ No newline at end of file diff --git a/docs/build/html/_sources/tutorials.console-arguments.md.txt b/docs/build/html/_sources/tutorials.console-arguments.md.txt deleted file mode 100644 index 0a3b5a42..00000000 --- a/docs/build/html/_sources/tutorials.console-arguments.md.txt +++ /dev/null @@ -1,3 +0,0 @@ -# Handle console arguments - -## Coming soon \ No newline at end of file diff --git a/docs/build/html/_sources/tutorials.console.md.txt b/docs/build/html/_sources/tutorials.console.md.txt deleted file mode 100644 index fcbaaba1..00000000 --- a/docs/build/html/_sources/tutorials.console.md.txt +++ /dev/null @@ -1,3 +0,0 @@ -# Use cpl_core.console.Console - -## Coming soon \ No newline at end of file diff --git a/docs/build/html/_sources/tutorials.create-startup.md.txt b/docs/build/html/_sources/tutorials.create-startup.md.txt deleted file mode 100644 index 028d072c..00000000 --- a/docs/build/html/_sources/tutorials.create-startup.md.txt +++ /dev/null @@ -1,3 +0,0 @@ -# Create startup class - -## Coming soon \ No newline at end of file diff --git a/docs/build/html/_sources/tutorials.extend-application.md.txt b/docs/build/html/_sources/tutorials.extend-application.md.txt deleted file mode 100644 index 1eec6e9e..00000000 --- a/docs/build/html/_sources/tutorials.extend-application.md.txt +++ /dev/null @@ -1,3 +0,0 @@ -# Extend application - -## Coming soon \ No newline at end of file diff --git a/docs/build/html/_sources/tutorials.extend-startup.md.txt b/docs/build/html/_sources/tutorials.extend-startup.md.txt deleted file mode 100644 index 98b90da4..00000000 --- a/docs/build/html/_sources/tutorials.extend-startup.md.txt +++ /dev/null @@ -1,3 +0,0 @@ -# Extend startup - -## Coming soon \ No newline at end of file diff --git a/docs/build/html/_sources/tutorials.logging.md.txt b/docs/build/html/_sources/tutorials.logging.md.txt deleted file mode 100644 index 660fbfe1..00000000 --- a/docs/build/html/_sources/tutorials.logging.md.txt +++ /dev/null @@ -1,3 +0,0 @@ -# Use builtin logger - -## Coming soon \ No newline at end of file diff --git a/docs/build/html/_sources/tutorials.mail.md.txt b/docs/build/html/_sources/tutorials.mail.md.txt deleted file mode 100644 index 7b6c9150..00000000 --- a/docs/build/html/_sources/tutorials.mail.md.txt +++ /dev/null @@ -1,3 +0,0 @@ -# Send mails - -## Coming soon \ No newline at end of file diff --git a/docs/build/html/_sources/tutorials.rst.txt b/docs/build/html/_sources/tutorials.rst.txt deleted file mode 100644 index b8fd6668..00000000 --- a/docs/build/html/_sources/tutorials.rst.txt +++ /dev/null @@ -1,15 +0,0 @@ -Tutorials -============= - -.. toctree:: - :maxdepth: 4 - - tutorials.extend-application - tutorials.create-startup - tutorials.extend-startup - tutorials.appsettings - tutorials.console-arguments - tutorials.console - tutorials.logging - tutorials.mail - tutorials.templating \ No newline at end of file diff --git a/docs/build/html/_sources/tutorials.templating.md.txt b/docs/build/html/_sources/tutorials.templating.md.txt deleted file mode 100644 index 4530b17c..00000000 --- a/docs/build/html/_sources/tutorials.templating.md.txt +++ /dev/null @@ -1,181 +0,0 @@ -# Using cpl g & cpl n templating - -## Contents - -- [Prerequisites](#prerequisites) -- [Generate schematics](#cpl-generate-scmatics) -- [Project types](#cpl-new-project-types) - -## Prerequisites - -Create a folder called ```.cpl``` - -## cpl generate schematics - -Create a file which begins with ```schematic_your_schematic.py```. -A schematic template is detected by starting with ```schematic_``` and endswith ```.py```. - -You should replace ```your_schematic``` with an appropriate name of your schematic. For example, we will choose ```Enum```. -Attention: It is important that you do not overwrite templates by creating a file or class with the same name. - -In the template create a class with the name of your schematic. For example: - -```python -from cpl_cli.abc.generate_schematic_abc import GenerateSchematicABC - - -class Enum(GenerateSchematicABC): - - def __init__(self, *args: str): - GenerateSchematicABC.__init__(self, *args) - - def get_code(self) -> str: - import textwrap - code = textwrap.dedent("""\ - from enum import Enum - - - class $Name(Enum): - - atr = 0 - """) - return self.build_code_str(code, Name=self._class_name) - - @classmethod - def register(cls): - GenerateSchematicABC.register( - cls, - 'enum', - ['e', 'E'] - ) - -``` - -You can test it by calling ```cpl g --help``` your schematic should be listed as available. - -## cpl new project types - -The project templating is a little more complex and is therefore divided into several files. -First of all, for information, it is very important not to overwrite any existing files or classes! - -Template structure explained by the example of the internal type ```console```: - -``` -- project_console.py -- project_file_license.py -- project_file_appsettings.py -- project_file.py -- project_file_readme.py -- project_file_code_main.py -- project_file_code_startup.py -- project_file_code_application.py -``` - -Here the template ```project_console.py``` defines how a console project has to look like when it is generated. Here is the code to illustrate this: - -```python -from cpl_cli.abc.project_type_abc import ProjectTypeABC -from cpl_cli.configuration import WorkspaceSettings -from cpl_core.utils import String - - -class Console(ProjectTypeABC): - - def __init__( - self, - base_path: str, - project_name: str, - workspace: WorkspaceSettings, - use_application_api: bool, - use_startup: bool, - use_service_providing: bool, - use_async: bool, - project_file_data: dict, - ): - from project_file import ProjectFile - from project_file_appsettings import ProjectFileAppsettings - from project_file_code_application import ProjectFileApplication - from project_file_code_main import ProjectFileMain - from project_file_code_startup import ProjectFileStartup - from project_file_readme import ProjectFileReadme - from project_file_license import ProjectFileLicense - from schematic_init import Init - - ProjectTypeABC.__init__(self, base_path, project_name, workspace, use_application_api, use_startup, use_service_providing, use_async, project_file_data) - - project_path = f'{base_path}{String.convert_to_snake_case(project_name.split("/")[-1])}/' - - self.add_template(ProjectFile(project_name.split('/')[-1], project_path, project_file_data)) - if workspace is None: - self.add_template(ProjectFileLicense('')) - self.add_template(ProjectFileReadme('')) - self.add_template(Init('', 'init', f'{base_path}tests/')) - - self.add_template(Init('', 'init', project_path)) - self.add_template(ProjectFileAppsettings(project_path)) - - if use_application_api: - self.add_template(ProjectFileApplication(project_path, use_application_api, use_startup, use_service_providing, use_async)) - - if use_startup: - self.add_template(ProjectFileStartup(project_path, use_application_api, use_startup, use_service_providing, use_async)) - - self.add_template(ProjectFileMain(project_name.split('/')[-1], project_path, use_application_api, use_startup, use_service_providing, use_async)) -``` - -The class must be named exactly as the project type should be named. It is also checked on the initial letter of the class as alias. -Now create a class for normal files which inherits from ```FileTemplateABC``` and a class for code files which inherits from ```CodeFileTemplateABC```. - -For example: - -project_file_code_startup.py: -```python -from cpl_cli.abc.code_file_template_abc import CodeFileTemplateABC - - -class ProjectFileStartup(CodeFileTemplateABC): - - def __init__(self, path: str, use_application_api: bool, use_startup: bool, use_service_providing: bool, use_async: bool): - CodeFileTemplateABC.__init__(self, 'startup', path, '', use_application_api, use_startup, use_service_providing, use_async) - - def get_code(self) -> str: - import textwrap - - return textwrap.dedent("""\ - from cpl_core.application import StartupABC - from cpl_core.configuration import ConfigurationABC - from cpl_core.dependency_injection import ServiceProviderABC, ServiceCollectionABC - from cpl_core.environment import ApplicationEnvironment - - - class Startup(StartupABC): - - def __init__(self): - StartupABC.__init__(self) - - def configure_configuration(self, configuration: ConfigurationABC, environment: ApplicationEnvironment) -> ConfigurationABC: - return configuration - - def configure_services(self, services: ServiceCollectionABC, environment: ApplicationEnvironment) -> ServiceProviderABC: - return services.build_service_provider() - """) -``` - -project_file.py: - -```python -import json - -from cpl_cli.abc.file_template_abc import FileTemplateABC - - -class ProjectFile(FileTemplateABC): - - def __init__(self, name: str, path: str, code: dict): - FileTemplateABC.__init__(self, '', path, '{}') - self._name = f'{name}.json' - self._code = code - - def get_code(self) -> str: - return json.dumps(self._code, indent=2) -``` diff --git a/docs/build/html/_static/_sphinx_javascript_frameworks_compat.js b/docs/build/html/_static/_sphinx_javascript_frameworks_compat.js deleted file mode 100644 index 81415803..00000000 --- a/docs/build/html/_static/_sphinx_javascript_frameworks_compat.js +++ /dev/null @@ -1,123 +0,0 @@ -/* Compatability shim for jQuery and underscores.js. - * - * Copyright Sphinx contributors - * Released under the two clause BSD licence - */ - -/** - * small helper function to urldecode strings - * - * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL - */ -jQuery.urldecode = function(x) { - if (!x) { - return x - } - return decodeURIComponent(x.replace(/\+/g, ' ')); -}; - -/** - * small helper function to urlencode strings - */ -jQuery.urlencode = encodeURIComponent; - -/** - * This function returns the parsed url parameters of the - * current request. Multiple values per key are supported, - * it will always return arrays of strings for the value parts. - */ -jQuery.getQueryParameters = function(s) { - if (typeof s === 'undefined') - s = document.location.search; - var parts = s.substr(s.indexOf('?') + 1).split('&'); - var result = {}; - for (var i = 0; i < parts.length; i++) { - var tmp = parts[i].split('=', 2); - var key = jQuery.urldecode(tmp[0]); - var value = jQuery.urldecode(tmp[1]); - if (key in result) - result[key].push(value); - else - result[key] = [value]; - } - return result; -}; - -/** - * highlight a given string on a jquery object by wrapping it in - * span elements with the given class name. - */ -jQuery.fn.highlightText = function(text, className) { - function highlight(node, addItems) { - if (node.nodeType === 3) { - var val = node.nodeValue; - var pos = val.toLowerCase().indexOf(text); - if (pos >= 0 && - !jQuery(node.parentNode).hasClass(className) && - !jQuery(node.parentNode).hasClass("nohighlight")) { - var span; - var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg"); - if (isInSVG) { - span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); - } else { - span = document.createElement("span"); - span.className = className; - } - span.appendChild(document.createTextNode(val.substr(pos, text.length))); - node.parentNode.insertBefore(span, node.parentNode.insertBefore( - document.createTextNode(val.substr(pos + text.length)), - node.nextSibling)); - node.nodeValue = val.substr(0, pos); - if (isInSVG) { - var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect"); - var bbox = node.parentElement.getBBox(); - rect.x.baseVal.value = bbox.x; - rect.y.baseVal.value = bbox.y; - rect.width.baseVal.value = bbox.width; - rect.height.baseVal.value = bbox.height; - rect.setAttribute('class', className); - addItems.push({ - "parent": node.parentNode, - "target": rect}); - } - } - } - else if (!jQuery(node).is("button, select, textarea")) { - jQuery.each(node.childNodes, function() { - highlight(this, addItems); - }); - } - } - var addItems = []; - var result = this.each(function() { - highlight(this, addItems); - }); - for (var i = 0; i < addItems.length; ++i) { - jQuery(addItems[i].parent).before(addItems[i].target); - } - return result; -}; - -/* - * backward compatibility for jQuery.browser - * This will be supported until firefox bug is fixed. - */ -if (!jQuery.browser) { - jQuery.uaMatch = function(ua) { - ua = ua.toLowerCase(); - - var match = /(chrome)[ \/]([\w.]+)/.exec(ua) || - /(webkit)[ \/]([\w.]+)/.exec(ua) || - /(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) || - /(msie) ([\w.]+)/.exec(ua) || - ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) || - []; - - return { - browser: match[ 1 ] || "", - version: match[ 2 ] || "0" - }; - }; - jQuery.browser = {}; - jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true; -} diff --git a/docs/build/html/_static/basic.css b/docs/build/html/_static/basic.css deleted file mode 100644 index 7577acb1..00000000 --- a/docs/build/html/_static/basic.css +++ /dev/null @@ -1,903 +0,0 @@ -/* - * basic.css - * ~~~~~~~~~ - * - * Sphinx stylesheet -- basic theme. - * - * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. - * :license: BSD, see LICENSE for details. - * - */ - -/* -- main layout ----------------------------------------------------------- */ - -div.clearer { - clear: both; -} - -div.section::after { - display: block; - content: ''; - clear: left; -} - -/* -- relbar ---------------------------------------------------------------- */ - -div.related { - width: 100%; - font-size: 90%; -} - -div.related h3 { - display: none; -} - -div.related ul { - margin: 0; - padding: 0 0 0 10px; - list-style: none; -} - -div.related li { - display: inline; -} - -div.related li.right { - float: right; - margin-right: 5px; -} - -/* -- sidebar --------------------------------------------------------------- */ - -div.sphinxsidebarwrapper { - padding: 10px 5px 0 10px; -} - -div.sphinxsidebar { - float: left; - width: 230px; - margin-left: -100%; - font-size: 90%; - word-wrap: break-word; - overflow-wrap : break-word; -} - -div.sphinxsidebar ul { - list-style: none; -} - -div.sphinxsidebar ul ul, -div.sphinxsidebar ul.want-points { - margin-left: 20px; - list-style: square; -} - -div.sphinxsidebar ul ul { - margin-top: 0; - margin-bottom: 0; -} - -div.sphinxsidebar form { - margin-top: 10px; -} - -div.sphinxsidebar input { - border: 1px solid #98dbcc; - font-family: sans-serif; - font-size: 1em; -} - -div.sphinxsidebar #searchbox form.search { - overflow: hidden; -} - -div.sphinxsidebar #searchbox input[type="text"] { - float: left; - width: 80%; - padding: 0.25em; - box-sizing: border-box; -} - -div.sphinxsidebar #searchbox input[type="submit"] { - float: left; - width: 20%; - border-left: none; - padding: 0.25em; - box-sizing: border-box; -} - - -img { - border: 0; - max-width: 100%; -} - -/* -- search page ----------------------------------------------------------- */ - -ul.search { - margin: 10px 0 0 20px; - padding: 0; -} - -ul.search li { - padding: 5px 0 5px 20px; - background-image: url(file.png); - background-repeat: no-repeat; - background-position: 0 7px; -} - -ul.search li a { - font-weight: bold; -} - -ul.search li p.context { - color: #888; - margin: 2px 0 0 30px; - text-align: left; -} - -ul.keywordmatches li.goodmatch a { - font-weight: bold; -} - -/* -- index page ------------------------------------------------------------ */ - -table.contentstable { - width: 90%; - margin-left: auto; - margin-right: auto; -} - -table.contentstable p.biglink { - line-height: 150%; -} - -a.biglink { - font-size: 1.3em; -} - -span.linkdescr { - font-style: italic; - padding-top: 5px; - font-size: 90%; -} - -/* -- general index --------------------------------------------------------- */ - -table.indextable { - width: 100%; -} - -table.indextable td { - text-align: left; - vertical-align: top; -} - -table.indextable ul { - margin-top: 0; - margin-bottom: 0; - list-style-type: none; -} - -table.indextable > tbody > tr > td > ul { - padding-left: 0em; -} - -table.indextable tr.pcap { - height: 10px; -} - -table.indextable tr.cap { - margin-top: 10px; - background-color: #f2f2f2; -} - -img.toggler { - margin-right: 3px; - margin-top: 3px; - cursor: pointer; -} - -div.modindex-jumpbox { - border-top: 1px solid #ddd; - border-bottom: 1px solid #ddd; - margin: 1em 0 1em 0; - padding: 0.4em; -} - -div.genindex-jumpbox { - border-top: 1px solid #ddd; - border-bottom: 1px solid #ddd; - margin: 1em 0 1em 0; - padding: 0.4em; -} - -/* -- domain module index --------------------------------------------------- */ - -table.modindextable td { - padding: 2px; - border-collapse: collapse; -} - -/* -- general body styles --------------------------------------------------- */ - -div.body { - min-width: 360px; - max-width: 800px; -} - -div.body p, div.body dd, div.body li, div.body blockquote { - -moz-hyphens: auto; - -ms-hyphens: auto; - -webkit-hyphens: auto; - hyphens: auto; -} - -a.headerlink { - visibility: hidden; -} - -h1:hover > a.headerlink, -h2:hover > a.headerlink, -h3:hover > a.headerlink, -h4:hover > a.headerlink, -h5:hover > a.headerlink, -h6:hover > a.headerlink, -dt:hover > a.headerlink, -caption:hover > a.headerlink, -p.caption:hover > a.headerlink, -div.code-block-caption:hover > a.headerlink { - visibility: visible; -} - -div.body p.caption { - text-align: inherit; -} - -div.body td { - text-align: left; -} - -.first { - margin-top: 0 !important; -} - -p.rubric { - margin-top: 30px; - font-weight: bold; -} - -img.align-left, figure.align-left, .figure.align-left, object.align-left { - clear: left; - float: left; - margin-right: 1em; -} - -img.align-right, figure.align-right, .figure.align-right, object.align-right { - clear: right; - float: right; - margin-left: 1em; -} - -img.align-center, figure.align-center, .figure.align-center, object.align-center { - display: block; - margin-left: auto; - margin-right: auto; -} - -img.align-default, figure.align-default, .figure.align-default { - display: block; - margin-left: auto; - margin-right: auto; -} - -.align-left { - text-align: left; -} - -.align-center { - text-align: center; -} - -.align-default { - text-align: center; -} - -.align-right { - text-align: right; -} - -/* -- sidebars -------------------------------------------------------------- */ - -div.sidebar, -aside.sidebar { - margin: 0 0 0.5em 1em; - border: 1px solid #ddb; - padding: 7px; - background-color: #ffe; - width: 40%; - float: right; - clear: right; - overflow-x: auto; -} - -p.sidebar-title { - font-weight: bold; -} - -nav.contents, -aside.topic, -div.admonition, div.topic, blockquote { - clear: left; -} - -/* -- topics ---------------------------------------------------------------- */ - -nav.contents, -aside.topic, -div.topic { - border: 1px solid #ccc; - padding: 7px; - margin: 10px 0 10px 0; -} - -p.topic-title { - font-size: 1.1em; - font-weight: bold; - margin-top: 10px; -} - -/* -- admonitions ----------------------------------------------------------- */ - -div.admonition { - margin-top: 10px; - margin-bottom: 10px; - padding: 7px; -} - -div.admonition dt { - font-weight: bold; -} - -p.admonition-title { - margin: 0px 10px 5px 0px; - font-weight: bold; -} - -div.body p.centered { - text-align: center; - margin-top: 25px; -} - -/* -- content of sidebars/topics/admonitions -------------------------------- */ - -div.sidebar > :last-child, -aside.sidebar > :last-child, -nav.contents > :last-child, -aside.topic > :last-child, -div.topic > :last-child, -div.admonition > :last-child { - margin-bottom: 0; -} - -div.sidebar::after, -aside.sidebar::after, -nav.contents::after, -aside.topic::after, -div.topic::after, -div.admonition::after, -blockquote::after { - display: block; - content: ''; - clear: both; -} - -/* -- tables ---------------------------------------------------------------- */ - -table.docutils { - margin-top: 10px; - margin-bottom: 10px; - border: 0; - border-collapse: collapse; -} - -table.align-center { - margin-left: auto; - margin-right: auto; -} - -table.align-default { - margin-left: auto; - margin-right: auto; -} - -table caption span.caption-number { - font-style: italic; -} - -table caption span.caption-text { -} - -table.docutils td, table.docutils th { - padding: 1px 8px 1px 5px; - border-top: 0; - border-left: 0; - border-right: 0; - border-bottom: 1px solid #aaa; -} - -th { - text-align: left; - padding-right: 5px; -} - -table.citation { - border-left: solid 1px gray; - margin-left: 1px; -} - -table.citation td { - border-bottom: none; -} - -th > :first-child, -td > :first-child { - margin-top: 0px; -} - -th > :last-child, -td > :last-child { - margin-bottom: 0px; -} - -/* -- figures --------------------------------------------------------------- */ - -div.figure, figure { - margin: 0.5em; - padding: 0.5em; -} - -div.figure p.caption, figcaption { - padding: 0.3em; -} - -div.figure p.caption span.caption-number, -figcaption span.caption-number { - font-style: italic; -} - -div.figure p.caption span.caption-text, -figcaption span.caption-text { -} - -/* -- field list styles ----------------------------------------------------- */ - -table.field-list td, table.field-list th { - border: 0 !important; -} - -.field-list ul { - margin: 0; - padding-left: 1em; -} - -.field-list p { - margin: 0; -} - -.field-name { - -moz-hyphens: manual; - -ms-hyphens: manual; - -webkit-hyphens: manual; - hyphens: manual; -} - -/* -- hlist styles ---------------------------------------------------------- */ - -table.hlist { - margin: 1em 0; -} - -table.hlist td { - vertical-align: top; -} - -/* -- object description styles --------------------------------------------- */ - -.sig { - font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace; -} - -.sig-name, code.descname { - background-color: transparent; - font-weight: bold; -} - -.sig-name { - font-size: 1.1em; -} - -code.descname { - font-size: 1.2em; -} - -.sig-prename, code.descclassname { - background-color: transparent; -} - -.optional { - font-size: 1.3em; -} - -.sig-paren { - font-size: larger; -} - -.sig-param.n { - font-style: italic; -} - -/* C++ specific styling */ - -.sig-inline.c-texpr, -.sig-inline.cpp-texpr { - font-family: unset; -} - -.sig.c .k, .sig.c .kt, -.sig.cpp .k, .sig.cpp .kt { - color: #0033B3; -} - -.sig.c .m, -.sig.cpp .m { - color: #1750EB; -} - -.sig.c .s, .sig.c .sc, -.sig.cpp .s, .sig.cpp .sc { - color: #067D17; -} - - -/* -- other body styles ----------------------------------------------------- */ - -ol.arabic { - list-style: decimal; -} - -ol.loweralpha { - list-style: lower-alpha; -} - -ol.upperalpha { - list-style: upper-alpha; -} - -ol.lowerroman { - list-style: lower-roman; -} - -ol.upperroman { - list-style: upper-roman; -} - -:not(li) > ol > li:first-child > :first-child, -:not(li) > ul > li:first-child > :first-child { - margin-top: 0px; -} - -:not(li) > ol > li:last-child > :last-child, -:not(li) > ul > li:last-child > :last-child { - margin-bottom: 0px; -} - -ol.simple ol p, -ol.simple ul p, -ul.simple ol p, -ul.simple ul p { - margin-top: 0; -} - -ol.simple > li:not(:first-child) > p, -ul.simple > li:not(:first-child) > p { - margin-top: 0; -} - -ol.simple p, -ul.simple p { - margin-bottom: 0; -} - -aside.footnote > span, -div.citation > span { - float: left; -} -aside.footnote > span:last-of-type, -div.citation > span:last-of-type { - padding-right: 0.5em; -} -aside.footnote > p { - margin-left: 2em; -} -div.citation > p { - margin-left: 4em; -} -aside.footnote > p:last-of-type, -div.citation > p:last-of-type { - margin-bottom: 0em; -} -aside.footnote > p:last-of-type:after, -div.citation > p:last-of-type:after { - content: ""; - clear: both; -} - -dl.field-list { - display: grid; - grid-template-columns: fit-content(30%) auto; -} - -dl.field-list > dt { - font-weight: bold; - word-break: break-word; - padding-left: 0.5em; - padding-right: 5px; -} - -dl.field-list > dd { - padding-left: 0.5em; - margin-top: 0em; - margin-left: 0em; - margin-bottom: 0em; -} - -dl { - margin-bottom: 15px; -} - -dd > :first-child { - margin-top: 0px; -} - -dd ul, dd table { - margin-bottom: 10px; -} - -dd { - margin-top: 3px; - margin-bottom: 10px; - margin-left: 30px; -} - -dl > dd:last-child, -dl > dd:last-child > :last-child { - margin-bottom: 0; -} - -dt:target, span.highlighted { - background-color: #fbe54e; -} - -rect.highlighted { - fill: #fbe54e; -} - -dl.glossary dt { - font-weight: bold; - font-size: 1.1em; -} - -.versionmodified { - font-style: italic; -} - -.system-message { - background-color: #fda; - padding: 5px; - border: 3px solid red; -} - -.footnote:target { - background-color: #ffa; -} - -.line-block { - display: block; - margin-top: 1em; - margin-bottom: 1em; -} - -.line-block .line-block { - margin-top: 0; - margin-bottom: 0; - margin-left: 1.5em; -} - -.guilabel, .menuselection { - font-family: sans-serif; -} - -.accelerator { - text-decoration: underline; -} - -.classifier { - font-style: oblique; -} - -.classifier:before { - font-style: normal; - margin: 0 0.5em; - content: ":"; - display: inline-block; -} - -abbr, acronym { - border-bottom: dotted 1px; - cursor: help; -} - -/* -- code displays --------------------------------------------------------- */ - -pre { - overflow: auto; - overflow-y: hidden; /* fixes display issues on Chrome browsers */ -} - -pre, div[class*="highlight-"] { - clear: both; -} - -span.pre { - -moz-hyphens: none; - -ms-hyphens: none; - -webkit-hyphens: none; - hyphens: none; - white-space: nowrap; -} - -div[class*="highlight-"] { - margin: 1em 0; -} - -td.linenos pre { - border: 0; - background-color: transparent; - color: #aaa; -} - -table.highlighttable { - display: block; -} - -table.highlighttable tbody { - display: block; -} - -table.highlighttable tr { - display: flex; -} - -table.highlighttable td { - margin: 0; - padding: 0; -} - -table.highlighttable td.linenos { - padding-right: 0.5em; -} - -table.highlighttable td.code { - flex: 1; - overflow: hidden; -} - -.highlight .hll { - display: block; -} - -div.highlight pre, -table.highlighttable pre { - margin: 0; -} - -div.code-block-caption + div { - margin-top: 0; -} - -div.code-block-caption { - margin-top: 1em; - padding: 2px 5px; - font-size: small; -} - -div.code-block-caption code { - background-color: transparent; -} - -table.highlighttable td.linenos, -span.linenos, -div.highlight span.gp { /* gp: Generic.Prompt */ - user-select: none; - -webkit-user-select: text; /* Safari fallback only */ - -webkit-user-select: none; /* Chrome/Safari */ - -moz-user-select: none; /* Firefox */ - -ms-user-select: none; /* IE10+ */ -} - -div.code-block-caption span.caption-number { - padding: 0.1em 0.3em; - font-style: italic; -} - -div.code-block-caption span.caption-text { -} - -div.literal-block-wrapper { - margin: 1em 0; -} - -code.xref, a code { - background-color: transparent; - font-weight: bold; -} - -h1 code, h2 code, h3 code, h4 code, h5 code, h6 code { - background-color: transparent; -} - -.viewcode-link { - float: right; -} - -.viewcode-back { - float: right; - font-family: sans-serif; -} - -div.viewcode-block:target { - margin: -1px -10px; - padding: 0 10px; -} - -/* -- math display ---------------------------------------------------------- */ - -img.math { - vertical-align: middle; -} - -div.body div.math p { - text-align: center; -} - -span.eqno { - float: right; -} - -span.eqno a.headerlink { - position: absolute; - z-index: 1; -} - -div.math:hover a.headerlink { - visibility: visible; -} - -/* -- printout stylesheet --------------------------------------------------- */ - -@media print { - div.document, - div.documentwrapper, - div.bodywrapper { - margin: 0 !important; - width: 100%; - } - - div.sphinxsidebar, - div.related, - div.footer, - #top-link { - display: none; - } -} \ No newline at end of file diff --git a/docs/build/html/_static/css/badge_only.css b/docs/build/html/_static/css/badge_only.css deleted file mode 100644 index c718cee4..00000000 --- a/docs/build/html/_static/css/badge_only.css +++ /dev/null @@ -1 +0,0 @@ -.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}@font-face{font-family:FontAwesome;font-style:normal;font-weight:400;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#FontAwesome) format("svg")}.fa:before{font-family:FontAwesome;font-style:normal;font-weight:400;line-height:1}.fa:before,a .fa{text-decoration:inherit}.fa:before,a .fa,li .fa{display:inline-block}li .fa-large:before{width:1.875em}ul.fas{list-style-type:none;margin-left:2em;text-indent:-.8em}ul.fas li .fa{width:.8em}ul.fas li .fa-large:before{vertical-align:baseline}.fa-book:before,.icon-book:before{content:"\f02d"}.fa-caret-down:before,.icon-caret-down:before{content:"\f0d7"}.fa-caret-up:before,.icon-caret-up:before{content:"\f0d8"}.fa-caret-left:before,.icon-caret-left:before{content:"\f0d9"}.fa-caret-right:before,.icon-caret-right:before{content:"\f0da"}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60}.rst-versions .rst-current-version:after{clear:both;content:"";display:block}.rst-versions .rst-current-version .fa{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}} \ No newline at end of file diff --git a/docs/build/html/_static/css/fonts/Roboto-Slab-Bold.woff b/docs/build/html/_static/css/fonts/Roboto-Slab-Bold.woff deleted file mode 100644 index 6cb60000..00000000 Binary files a/docs/build/html/_static/css/fonts/Roboto-Slab-Bold.woff and /dev/null differ diff --git a/docs/build/html/_static/css/fonts/Roboto-Slab-Bold.woff2 b/docs/build/html/_static/css/fonts/Roboto-Slab-Bold.woff2 deleted file mode 100644 index 7059e231..00000000 Binary files a/docs/build/html/_static/css/fonts/Roboto-Slab-Bold.woff2 and /dev/null differ diff --git a/docs/build/html/_static/css/fonts/Roboto-Slab-Regular.woff b/docs/build/html/_static/css/fonts/Roboto-Slab-Regular.woff deleted file mode 100644 index f815f63f..00000000 Binary files a/docs/build/html/_static/css/fonts/Roboto-Slab-Regular.woff and /dev/null differ diff --git a/docs/build/html/_static/css/fonts/Roboto-Slab-Regular.woff2 b/docs/build/html/_static/css/fonts/Roboto-Slab-Regular.woff2 deleted file mode 100644 index f2c76e5b..00000000 Binary files a/docs/build/html/_static/css/fonts/Roboto-Slab-Regular.woff2 and /dev/null differ diff --git a/docs/build/html/_static/css/fonts/fontawesome-webfont.eot b/docs/build/html/_static/css/fonts/fontawesome-webfont.eot deleted file mode 100644 index e9f60ca9..00000000 Binary files a/docs/build/html/_static/css/fonts/fontawesome-webfont.eot and /dev/null differ diff --git a/docs/build/html/_static/css/fonts/fontawesome-webfont.svg b/docs/build/html/_static/css/fonts/fontawesome-webfont.svg deleted file mode 100644 index 855c845e..00000000 --- a/docs/build/html/_static/css/fonts/fontawesome-webfont.svg +++ /dev/null @@ -1,2671 +0,0 @@ - - - - -Created by FontForge 20120731 at Mon Oct 24 17:37:40 2016 - By ,,, -Copyright Dave Gandy 2016. All rights reserved. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/build/html/_static/css/fonts/fontawesome-webfont.ttf b/docs/build/html/_static/css/fonts/fontawesome-webfont.ttf deleted file mode 100644 index 35acda2f..00000000 Binary files a/docs/build/html/_static/css/fonts/fontawesome-webfont.ttf and /dev/null differ diff --git a/docs/build/html/_static/css/fonts/fontawesome-webfont.woff b/docs/build/html/_static/css/fonts/fontawesome-webfont.woff deleted file mode 100644 index 400014a4..00000000 Binary files a/docs/build/html/_static/css/fonts/fontawesome-webfont.woff and /dev/null differ diff --git a/docs/build/html/_static/css/fonts/fontawesome-webfont.woff2 b/docs/build/html/_static/css/fonts/fontawesome-webfont.woff2 deleted file mode 100644 index 4d13fc60..00000000 Binary files a/docs/build/html/_static/css/fonts/fontawesome-webfont.woff2 and /dev/null differ diff --git a/docs/build/html/_static/css/fonts/lato-bold-italic.woff b/docs/build/html/_static/css/fonts/lato-bold-italic.woff deleted file mode 100644 index 88ad05b9..00000000 Binary files a/docs/build/html/_static/css/fonts/lato-bold-italic.woff and /dev/null differ diff --git a/docs/build/html/_static/css/fonts/lato-bold-italic.woff2 b/docs/build/html/_static/css/fonts/lato-bold-italic.woff2 deleted file mode 100644 index c4e3d804..00000000 Binary files a/docs/build/html/_static/css/fonts/lato-bold-italic.woff2 and /dev/null differ diff --git a/docs/build/html/_static/css/fonts/lato-bold.woff b/docs/build/html/_static/css/fonts/lato-bold.woff deleted file mode 100644 index c6dff51f..00000000 Binary files a/docs/build/html/_static/css/fonts/lato-bold.woff and /dev/null differ diff --git a/docs/build/html/_static/css/fonts/lato-bold.woff2 b/docs/build/html/_static/css/fonts/lato-bold.woff2 deleted file mode 100644 index bb195043..00000000 Binary files a/docs/build/html/_static/css/fonts/lato-bold.woff2 and /dev/null differ diff --git a/docs/build/html/_static/css/fonts/lato-normal-italic.woff b/docs/build/html/_static/css/fonts/lato-normal-italic.woff deleted file mode 100644 index 76114bc0..00000000 Binary files a/docs/build/html/_static/css/fonts/lato-normal-italic.woff and /dev/null differ diff --git a/docs/build/html/_static/css/fonts/lato-normal-italic.woff2 b/docs/build/html/_static/css/fonts/lato-normal-italic.woff2 deleted file mode 100644 index 3404f37e..00000000 Binary files a/docs/build/html/_static/css/fonts/lato-normal-italic.woff2 and /dev/null differ diff --git a/docs/build/html/_static/css/fonts/lato-normal.woff b/docs/build/html/_static/css/fonts/lato-normal.woff deleted file mode 100644 index ae1307ff..00000000 Binary files a/docs/build/html/_static/css/fonts/lato-normal.woff and /dev/null differ diff --git a/docs/build/html/_static/css/fonts/lato-normal.woff2 b/docs/build/html/_static/css/fonts/lato-normal.woff2 deleted file mode 100644 index 3bf98433..00000000 Binary files a/docs/build/html/_static/css/fonts/lato-normal.woff2 and /dev/null differ diff --git a/docs/build/html/_static/css/theme.css b/docs/build/html/_static/css/theme.css deleted file mode 100644 index c03c88f0..00000000 --- a/docs/build/html/_static/css/theme.css +++ /dev/null @@ -1,4 +0,0 @@ -html{box-sizing:border-box}*,:after,:before{box-sizing:inherit}article,aside,details,figcaption,figure,footer,header,hgroup,nav,section{display:block}audio,canvas,video{display:inline-block;*display:inline;*zoom:1}[hidden],audio:not([controls]){display:none}*{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}html{font-size:100%;-webkit-text-size-adjust:100%;-ms-text-size-adjust:100%}body{margin:0}a:active,a:hover{outline:0}abbr[title]{border-bottom:1px dotted}b,strong{font-weight:700}blockquote{margin:0}dfn{font-style:italic}ins{background:#ff9;text-decoration:none}ins,mark{color:#000}mark{background:#ff0;font-style:italic;font-weight:700}.rst-content code,.rst-content tt,code,kbd,pre,samp{font-family:monospace,serif;_font-family:courier new,monospace;font-size:1em}pre{white-space:pre}q{quotes:none}q:after,q:before{content:"";content:none}small{font-size:85%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sup{top:-.5em}sub{bottom:-.25em}dl,ol,ul{margin:0;padding:0;list-style:none;list-style-image:none}li{list-style:none}dd{margin:0}img{border:0;-ms-interpolation-mode:bicubic;vertical-align:middle;max-width:100%}svg:not(:root){overflow:hidden}figure,form{margin:0}label{cursor:pointer}button,input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}button,input{line-height:normal}button,input[type=button],input[type=reset],input[type=submit]{cursor:pointer;-webkit-appearance:button;*overflow:visible}button[disabled],input[disabled]{cursor:default}input[type=search]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box}textarea{resize:vertical}table{border-collapse:collapse;border-spacing:0}td{vertical-align:top}.chromeframe{margin:.2em 0;background:#ccc;color:#000;padding:.2em 0}.ir{display:block;border:0;text-indent:-999em;overflow:hidden;background-color:transparent;background-repeat:no-repeat;text-align:left;direction:ltr;*line-height:0}.ir br{display:none}.hidden{display:none!important;visibility:hidden}.visuallyhidden{border:0;clip:rect(0 0 0 0);height:1px;margin:-1px;overflow:hidden;padding:0;position:absolute;width:1px}.visuallyhidden.focusable:active,.visuallyhidden.focusable:focus{clip:auto;height:auto;margin:0;overflow:visible;position:static;width:auto}.invisible{visibility:hidden}.relative{position:relative}big,small{font-size:100%}@media print{body,html,section{background:none!important}*{box-shadow:none!important;text-shadow:none!important;filter:none!important;-ms-filter:none!important}a,a:visited{text-decoration:underline}.ir a:after,a[href^="#"]:after,a[href^="javascript:"]:after{content:""}blockquote,pre{page-break-inside:avoid}thead{display:table-header-group}img,tr{page-break-inside:avoid}img{max-width:100%!important}@page{margin:.5cm}.rst-content .toctree-wrapper>p.caption,h2,h3,p{orphans:3;widows:3}.rst-content .toctree-wrapper>p.caption,h2,h3{page-break-after:avoid}}.btn,.fa:before,.icon:before,.rst-content .admonition,.rst-content .admonition-title:before,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .code-block-caption .headerlink:before,.rst-content .danger,.rst-content .eqno .headerlink:before,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content p .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-alert,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before,.wy-menu-vertical li button.toctree-expand:before,input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week],select,textarea{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}/*! - * Font Awesome 4.7.0 by @davegandy - http://fontawesome.io - @fontawesome - * License - http://fontawesome.io/license (Font: SIL OFL 1.1, CSS: MIT License) - */@font-face{font-family:FontAwesome;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713);src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix&v=4.7.0) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#fontawesomeregular) format("svg");font-weight:400;font-style:normal}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li button.toctree-expand{display:inline-block;font:normal normal normal 14px/1 FontAwesome;font-size:inherit;text-rendering:auto;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}.fa-lg{font-size:1.33333em;line-height:.75em;vertical-align:-15%}.fa-2x{font-size:2em}.fa-3x{font-size:3em}.fa-4x{font-size:4em}.fa-5x{font-size:5em}.fa-fw{width:1.28571em;text-align:center}.fa-ul{padding-left:0;margin-left:2.14286em;list-style-type:none}.fa-ul>li{position:relative}.fa-li{position:absolute;left:-2.14286em;width:2.14286em;top:.14286em;text-align:center}.fa-li.fa-lg{left:-1.85714em}.fa-border{padding:.2em .25em .15em;border:.08em solid #eee;border-radius:.1em}.fa-pull-left{float:left}.fa-pull-right{float:right}.fa-pull-left.icon,.fa.fa-pull-left,.rst-content .code-block-caption .fa-pull-left.headerlink,.rst-content .eqno .fa-pull-left.headerlink,.rst-content .fa-pull-left.admonition-title,.rst-content code.download span.fa-pull-left:first-child,.rst-content dl dt .fa-pull-left.headerlink,.rst-content h1 .fa-pull-left.headerlink,.rst-content h2 .fa-pull-left.headerlink,.rst-content h3 .fa-pull-left.headerlink,.rst-content h4 .fa-pull-left.headerlink,.rst-content h5 .fa-pull-left.headerlink,.rst-content h6 .fa-pull-left.headerlink,.rst-content p .fa-pull-left.headerlink,.rst-content table>caption .fa-pull-left.headerlink,.rst-content tt.download span.fa-pull-left:first-child,.wy-menu-vertical li.current>a button.fa-pull-left.toctree-expand,.wy-menu-vertical li.on a button.fa-pull-left.toctree-expand,.wy-menu-vertical li button.fa-pull-left.toctree-expand{margin-right:.3em}.fa-pull-right.icon,.fa.fa-pull-right,.rst-content .code-block-caption .fa-pull-right.headerlink,.rst-content .eqno .fa-pull-right.headerlink,.rst-content .fa-pull-right.admonition-title,.rst-content code.download span.fa-pull-right:first-child,.rst-content dl dt .fa-pull-right.headerlink,.rst-content h1 .fa-pull-right.headerlink,.rst-content h2 .fa-pull-right.headerlink,.rst-content h3 .fa-pull-right.headerlink,.rst-content h4 .fa-pull-right.headerlink,.rst-content h5 .fa-pull-right.headerlink,.rst-content h6 .fa-pull-right.headerlink,.rst-content p .fa-pull-right.headerlink,.rst-content table>caption .fa-pull-right.headerlink,.rst-content tt.download span.fa-pull-right:first-child,.wy-menu-vertical li.current>a button.fa-pull-right.toctree-expand,.wy-menu-vertical li.on a button.fa-pull-right.toctree-expand,.wy-menu-vertical li button.fa-pull-right.toctree-expand{margin-left:.3em}.pull-right{float:right}.pull-left{float:left}.fa.pull-left,.pull-left.icon,.rst-content .code-block-caption .pull-left.headerlink,.rst-content .eqno .pull-left.headerlink,.rst-content .pull-left.admonition-title,.rst-content code.download span.pull-left:first-child,.rst-content dl dt .pull-left.headerlink,.rst-content h1 .pull-left.headerlink,.rst-content h2 .pull-left.headerlink,.rst-content h3 .pull-left.headerlink,.rst-content h4 .pull-left.headerlink,.rst-content h5 .pull-left.headerlink,.rst-content h6 .pull-left.headerlink,.rst-content p .pull-left.headerlink,.rst-content table>caption .pull-left.headerlink,.rst-content tt.download span.pull-left:first-child,.wy-menu-vertical li.current>a button.pull-left.toctree-expand,.wy-menu-vertical li.on a button.pull-left.toctree-expand,.wy-menu-vertical li button.pull-left.toctree-expand{margin-right:.3em}.fa.pull-right,.pull-right.icon,.rst-content .code-block-caption .pull-right.headerlink,.rst-content .eqno .pull-right.headerlink,.rst-content .pull-right.admonition-title,.rst-content code.download span.pull-right:first-child,.rst-content dl dt .pull-right.headerlink,.rst-content h1 .pull-right.headerlink,.rst-content h2 .pull-right.headerlink,.rst-content h3 .pull-right.headerlink,.rst-content h4 .pull-right.headerlink,.rst-content h5 .pull-right.headerlink,.rst-content h6 .pull-right.headerlink,.rst-content p .pull-right.headerlink,.rst-content table>caption .pull-right.headerlink,.rst-content tt.download span.pull-right:first-child,.wy-menu-vertical li.current>a button.pull-right.toctree-expand,.wy-menu-vertical li.on a button.pull-right.toctree-expand,.wy-menu-vertical li button.pull-right.toctree-expand{margin-left:.3em}.fa-spin{-webkit-animation:fa-spin 2s linear infinite;animation:fa-spin 2s linear infinite}.fa-pulse{-webkit-animation:fa-spin 1s steps(8) infinite;animation:fa-spin 1s steps(8) infinite}@-webkit-keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}@keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}.fa-rotate-90{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=1)";-webkit-transform:rotate(90deg);-ms-transform:rotate(90deg);transform:rotate(90deg)}.fa-rotate-180{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2)";-webkit-transform:rotate(180deg);-ms-transform:rotate(180deg);transform:rotate(180deg)}.fa-rotate-270{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=3)";-webkit-transform:rotate(270deg);-ms-transform:rotate(270deg);transform:rotate(270deg)}.fa-flip-horizontal{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=0, mirror=1)";-webkit-transform:scaleX(-1);-ms-transform:scaleX(-1);transform:scaleX(-1)}.fa-flip-vertical{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2, mirror=1)";-webkit-transform:scaleY(-1);-ms-transform:scaleY(-1);transform:scaleY(-1)}:root .fa-flip-horizontal,:root .fa-flip-vertical,:root .fa-rotate-90,:root .fa-rotate-180,:root .fa-rotate-270{filter:none}.fa-stack{position:relative;display:inline-block;width:2em;height:2em;line-height:2em;vertical-align:middle}.fa-stack-1x,.fa-stack-2x{position:absolute;left:0;width:100%;text-align:center}.fa-stack-1x{line-height:inherit}.fa-stack-2x{font-size:2em}.fa-inverse{color:#fff}.fa-glass:before{content:""}.fa-music:before{content:""}.fa-search:before,.icon-search:before{content:""}.fa-envelope-o:before{content:""}.fa-heart:before{content:""}.fa-star:before{content:""}.fa-star-o:before{content:""}.fa-user:before{content:""}.fa-film:before{content:""}.fa-th-large:before{content:""}.fa-th:before{content:""}.fa-th-list:before{content:""}.fa-check:before{content:""}.fa-close:before,.fa-remove:before,.fa-times:before{content:""}.fa-search-plus:before{content:""}.fa-search-minus:before{content:""}.fa-power-off:before{content:""}.fa-signal:before{content:""}.fa-cog:before,.fa-gear:before{content:""}.fa-trash-o:before{content:""}.fa-home:before,.icon-home:before{content:""}.fa-file-o:before{content:""}.fa-clock-o:before{content:""}.fa-road:before{content:""}.fa-download:before,.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{content:""}.fa-arrow-circle-o-down:before{content:""}.fa-arrow-circle-o-up:before{content:""}.fa-inbox:before{content:""}.fa-play-circle-o:before{content:""}.fa-repeat:before,.fa-rotate-right:before{content:""}.fa-refresh:before{content:""}.fa-list-alt:before{content:""}.fa-lock:before{content:""}.fa-flag:before{content:""}.fa-headphones:before{content:""}.fa-volume-off:before{content:""}.fa-volume-down:before{content:""}.fa-volume-up:before{content:""}.fa-qrcode:before{content:""}.fa-barcode:before{content:""}.fa-tag:before{content:""}.fa-tags:before{content:""}.fa-book:before,.icon-book:before{content:""}.fa-bookmark:before{content:""}.fa-print:before{content:""}.fa-camera:before{content:""}.fa-font:before{content:""}.fa-bold:before{content:""}.fa-italic:before{content:""}.fa-text-height:before{content:""}.fa-text-width:before{content:""}.fa-align-left:before{content:""}.fa-align-center:before{content:""}.fa-align-right:before{content:""}.fa-align-justify:before{content:""}.fa-list:before{content:""}.fa-dedent:before,.fa-outdent:before{content:""}.fa-indent:before{content:""}.fa-video-camera:before{content:""}.fa-image:before,.fa-photo:before,.fa-picture-o:before{content:""}.fa-pencil:before{content:""}.fa-map-marker:before{content:""}.fa-adjust:before{content:""}.fa-tint:before{content:""}.fa-edit:before,.fa-pencil-square-o:before{content:""}.fa-share-square-o:before{content:""}.fa-check-square-o:before{content:""}.fa-arrows:before{content:""}.fa-step-backward:before{content:""}.fa-fast-backward:before{content:""}.fa-backward:before{content:""}.fa-play:before{content:""}.fa-pause:before{content:""}.fa-stop:before{content:""}.fa-forward:before{content:""}.fa-fast-forward:before{content:""}.fa-step-forward:before{content:""}.fa-eject:before{content:""}.fa-chevron-left:before{content:""}.fa-chevron-right:before{content:""}.fa-plus-circle:before{content:""}.fa-minus-circle:before{content:""}.fa-times-circle:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before{content:""}.fa-check-circle:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before{content:""}.fa-question-circle:before{content:""}.fa-info-circle:before{content:""}.fa-crosshairs:before{content:""}.fa-times-circle-o:before{content:""}.fa-check-circle-o:before{content:""}.fa-ban:before{content:""}.fa-arrow-left:before{content:""}.fa-arrow-right:before{content:""}.fa-arrow-up:before{content:""}.fa-arrow-down:before{content:""}.fa-mail-forward:before,.fa-share:before{content:""}.fa-expand:before{content:""}.fa-compress:before{content:""}.fa-plus:before{content:""}.fa-minus:before{content:""}.fa-asterisk:before{content:""}.fa-exclamation-circle:before,.rst-content .admonition-title:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before{content:""}.fa-gift:before{content:""}.fa-leaf:before{content:""}.fa-fire:before,.icon-fire:before{content:""}.fa-eye:before{content:""}.fa-eye-slash:before{content:""}.fa-exclamation-triangle:before,.fa-warning:before{content:""}.fa-plane:before{content:""}.fa-calendar:before{content:""}.fa-random:before{content:""}.fa-comment:before{content:""}.fa-magnet:before{content:""}.fa-chevron-up:before{content:""}.fa-chevron-down:before{content:""}.fa-retweet:before{content:""}.fa-shopping-cart:before{content:""}.fa-folder:before{content:""}.fa-folder-open:before{content:""}.fa-arrows-v:before{content:""}.fa-arrows-h:before{content:""}.fa-bar-chart-o:before,.fa-bar-chart:before{content:""}.fa-twitter-square:before{content:""}.fa-facebook-square:before{content:""}.fa-camera-retro:before{content:""}.fa-key:before{content:""}.fa-cogs:before,.fa-gears:before{content:""}.fa-comments:before{content:""}.fa-thumbs-o-up:before{content:""}.fa-thumbs-o-down:before{content:""}.fa-star-half:before{content:""}.fa-heart-o:before{content:""}.fa-sign-out:before{content:""}.fa-linkedin-square:before{content:""}.fa-thumb-tack:before{content:""}.fa-external-link:before{content:""}.fa-sign-in:before{content:""}.fa-trophy:before{content:""}.fa-github-square:before{content:""}.fa-upload:before{content:""}.fa-lemon-o:before{content:""}.fa-phone:before{content:""}.fa-square-o:before{content:""}.fa-bookmark-o:before{content:""}.fa-phone-square:before{content:""}.fa-twitter:before{content:""}.fa-facebook-f:before,.fa-facebook:before{content:""}.fa-github:before,.icon-github:before{content:""}.fa-unlock:before{content:""}.fa-credit-card:before{content:""}.fa-feed:before,.fa-rss:before{content:""}.fa-hdd-o:before{content:""}.fa-bullhorn:before{content:""}.fa-bell:before{content:""}.fa-certificate:before{content:""}.fa-hand-o-right:before{content:""}.fa-hand-o-left:before{content:""}.fa-hand-o-up:before{content:""}.fa-hand-o-down:before{content:""}.fa-arrow-circle-left:before,.icon-circle-arrow-left:before{content:""}.fa-arrow-circle-right:before,.icon-circle-arrow-right:before{content:""}.fa-arrow-circle-up:before{content:""}.fa-arrow-circle-down:before{content:""}.fa-globe:before{content:""}.fa-wrench:before{content:""}.fa-tasks:before{content:""}.fa-filter:before{content:""}.fa-briefcase:before{content:""}.fa-arrows-alt:before{content:""}.fa-group:before,.fa-users:before{content:""}.fa-chain:before,.fa-link:before,.icon-link:before{content:""}.fa-cloud:before{content:""}.fa-flask:before{content:""}.fa-cut:before,.fa-scissors:before{content:""}.fa-copy:before,.fa-files-o:before{content:""}.fa-paperclip:before{content:""}.fa-floppy-o:before,.fa-save:before{content:""}.fa-square:before{content:""}.fa-bars:before,.fa-navicon:before,.fa-reorder:before{content:""}.fa-list-ul:before{content:""}.fa-list-ol:before{content:""}.fa-strikethrough:before{content:""}.fa-underline:before{content:""}.fa-table:before{content:""}.fa-magic:before{content:""}.fa-truck:before{content:""}.fa-pinterest:before{content:""}.fa-pinterest-square:before{content:""}.fa-google-plus-square:before{content:""}.fa-google-plus:before{content:""}.fa-money:before{content:""}.fa-caret-down:before,.icon-caret-down:before,.wy-dropdown .caret:before{content:""}.fa-caret-up:before{content:""}.fa-caret-left:before{content:""}.fa-caret-right:before{content:""}.fa-columns:before{content:""}.fa-sort:before,.fa-unsorted:before{content:""}.fa-sort-desc:before,.fa-sort-down:before{content:""}.fa-sort-asc:before,.fa-sort-up:before{content:""}.fa-envelope:before{content:""}.fa-linkedin:before{content:""}.fa-rotate-left:before,.fa-undo:before{content:""}.fa-gavel:before,.fa-legal:before{content:""}.fa-dashboard:before,.fa-tachometer:before{content:""}.fa-comment-o:before{content:""}.fa-comments-o:before{content:""}.fa-bolt:before,.fa-flash:before{content:""}.fa-sitemap:before{content:""}.fa-umbrella:before{content:""}.fa-clipboard:before,.fa-paste:before{content:""}.fa-lightbulb-o:before{content:""}.fa-exchange:before{content:""}.fa-cloud-download:before{content:""}.fa-cloud-upload:before{content:""}.fa-user-md:before{content:""}.fa-stethoscope:before{content:""}.fa-suitcase:before{content:""}.fa-bell-o:before{content:""}.fa-coffee:before{content:""}.fa-cutlery:before{content:""}.fa-file-text-o:before{content:""}.fa-building-o:before{content:""}.fa-hospital-o:before{content:""}.fa-ambulance:before{content:""}.fa-medkit:before{content:""}.fa-fighter-jet:before{content:""}.fa-beer:before{content:""}.fa-h-square:before{content:""}.fa-plus-square:before{content:""}.fa-angle-double-left:before{content:""}.fa-angle-double-right:before{content:""}.fa-angle-double-up:before{content:""}.fa-angle-double-down:before{content:""}.fa-angle-left:before{content:""}.fa-angle-right:before{content:""}.fa-angle-up:before{content:""}.fa-angle-down:before{content:""}.fa-desktop:before{content:""}.fa-laptop:before{content:""}.fa-tablet:before{content:""}.fa-mobile-phone:before,.fa-mobile:before{content:""}.fa-circle-o:before{content:""}.fa-quote-left:before{content:""}.fa-quote-right:before{content:""}.fa-spinner:before{content:""}.fa-circle:before{content:""}.fa-mail-reply:before,.fa-reply:before{content:""}.fa-github-alt:before{content:""}.fa-folder-o:before{content:""}.fa-folder-open-o:before{content:""}.fa-smile-o:before{content:""}.fa-frown-o:before{content:""}.fa-meh-o:before{content:""}.fa-gamepad:before{content:""}.fa-keyboard-o:before{content:""}.fa-flag-o:before{content:""}.fa-flag-checkered:before{content:""}.fa-terminal:before{content:""}.fa-code:before{content:""}.fa-mail-reply-all:before,.fa-reply-all:before{content:""}.fa-star-half-empty:before,.fa-star-half-full:before,.fa-star-half-o:before{content:""}.fa-location-arrow:before{content:""}.fa-crop:before{content:""}.fa-code-fork:before{content:""}.fa-chain-broken:before,.fa-unlink:before{content:""}.fa-question:before{content:""}.fa-info:before{content:""}.fa-exclamation:before{content:""}.fa-superscript:before{content:""}.fa-subscript:before{content:""}.fa-eraser:before{content:""}.fa-puzzle-piece:before{content:""}.fa-microphone:before{content:""}.fa-microphone-slash:before{content:""}.fa-shield:before{content:""}.fa-calendar-o:before{content:""}.fa-fire-extinguisher:before{content:""}.fa-rocket:before{content:""}.fa-maxcdn:before{content:""}.fa-chevron-circle-left:before{content:""}.fa-chevron-circle-right:before{content:""}.fa-chevron-circle-up:before{content:""}.fa-chevron-circle-down:before{content:""}.fa-html5:before{content:""}.fa-css3:before{content:""}.fa-anchor:before{content:""}.fa-unlock-alt:before{content:""}.fa-bullseye:before{content:""}.fa-ellipsis-h:before{content:""}.fa-ellipsis-v:before{content:""}.fa-rss-square:before{content:""}.fa-play-circle:before{content:""}.fa-ticket:before{content:""}.fa-minus-square:before{content:""}.fa-minus-square-o:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before{content:""}.fa-level-up:before{content:""}.fa-level-down:before{content:""}.fa-check-square:before{content:""}.fa-pencil-square:before{content:""}.fa-external-link-square:before{content:""}.fa-share-square:before{content:""}.fa-compass:before{content:""}.fa-caret-square-o-down:before,.fa-toggle-down:before{content:""}.fa-caret-square-o-up:before,.fa-toggle-up:before{content:""}.fa-caret-square-o-right:before,.fa-toggle-right:before{content:""}.fa-eur:before,.fa-euro:before{content:""}.fa-gbp:before{content:""}.fa-dollar:before,.fa-usd:before{content:""}.fa-inr:before,.fa-rupee:before{content:""}.fa-cny:before,.fa-jpy:before,.fa-rmb:before,.fa-yen:before{content:""}.fa-rouble:before,.fa-rub:before,.fa-ruble:before{content:""}.fa-krw:before,.fa-won:before{content:""}.fa-bitcoin:before,.fa-btc:before{content:""}.fa-file:before{content:""}.fa-file-text:before{content:""}.fa-sort-alpha-asc:before{content:""}.fa-sort-alpha-desc:before{content:""}.fa-sort-amount-asc:before{content:""}.fa-sort-amount-desc:before{content:""}.fa-sort-numeric-asc:before{content:""}.fa-sort-numeric-desc:before{content:""}.fa-thumbs-up:before{content:""}.fa-thumbs-down:before{content:""}.fa-youtube-square:before{content:""}.fa-youtube:before{content:""}.fa-xing:before{content:""}.fa-xing-square:before{content:""}.fa-youtube-play:before{content:""}.fa-dropbox:before{content:""}.fa-stack-overflow:before{content:""}.fa-instagram:before{content:""}.fa-flickr:before{content:""}.fa-adn:before{content:""}.fa-bitbucket:before,.icon-bitbucket:before{content:""}.fa-bitbucket-square:before{content:""}.fa-tumblr:before{content:""}.fa-tumblr-square:before{content:""}.fa-long-arrow-down:before{content:""}.fa-long-arrow-up:before{content:""}.fa-long-arrow-left:before{content:""}.fa-long-arrow-right:before{content:""}.fa-apple:before{content:""}.fa-windows:before{content:""}.fa-android:before{content:""}.fa-linux:before{content:""}.fa-dribbble:before{content:""}.fa-skype:before{content:""}.fa-foursquare:before{content:""}.fa-trello:before{content:""}.fa-female:before{content:""}.fa-male:before{content:""}.fa-gittip:before,.fa-gratipay:before{content:""}.fa-sun-o:before{content:""}.fa-moon-o:before{content:""}.fa-archive:before{content:""}.fa-bug:before{content:""}.fa-vk:before{content:""}.fa-weibo:before{content:""}.fa-renren:before{content:""}.fa-pagelines:before{content:""}.fa-stack-exchange:before{content:""}.fa-arrow-circle-o-right:before{content:""}.fa-arrow-circle-o-left:before{content:""}.fa-caret-square-o-left:before,.fa-toggle-left:before{content:""}.fa-dot-circle-o:before{content:""}.fa-wheelchair:before{content:""}.fa-vimeo-square:before{content:""}.fa-try:before,.fa-turkish-lira:before{content:""}.fa-plus-square-o:before,.wy-menu-vertical li button.toctree-expand:before{content:""}.fa-space-shuttle:before{content:""}.fa-slack:before{content:""}.fa-envelope-square:before{content:""}.fa-wordpress:before{content:""}.fa-openid:before{content:""}.fa-bank:before,.fa-institution:before,.fa-university:before{content:""}.fa-graduation-cap:before,.fa-mortar-board:before{content:""}.fa-yahoo:before{content:""}.fa-google:before{content:""}.fa-reddit:before{content:""}.fa-reddit-square:before{content:""}.fa-stumbleupon-circle:before{content:""}.fa-stumbleupon:before{content:""}.fa-delicious:before{content:""}.fa-digg:before{content:""}.fa-pied-piper-pp:before{content:""}.fa-pied-piper-alt:before{content:""}.fa-drupal:before{content:""}.fa-joomla:before{content:""}.fa-language:before{content:""}.fa-fax:before{content:""}.fa-building:before{content:""}.fa-child:before{content:""}.fa-paw:before{content:""}.fa-spoon:before{content:""}.fa-cube:before{content:""}.fa-cubes:before{content:""}.fa-behance:before{content:""}.fa-behance-square:before{content:""}.fa-steam:before{content:""}.fa-steam-square:before{content:""}.fa-recycle:before{content:""}.fa-automobile:before,.fa-car:before{content:""}.fa-cab:before,.fa-taxi:before{content:""}.fa-tree:before{content:""}.fa-spotify:before{content:""}.fa-deviantart:before{content:""}.fa-soundcloud:before{content:""}.fa-database:before{content:""}.fa-file-pdf-o:before{content:""}.fa-file-word-o:before{content:""}.fa-file-excel-o:before{content:""}.fa-file-powerpoint-o:before{content:""}.fa-file-image-o:before,.fa-file-photo-o:before,.fa-file-picture-o:before{content:""}.fa-file-archive-o:before,.fa-file-zip-o:before{content:""}.fa-file-audio-o:before,.fa-file-sound-o:before{content:""}.fa-file-movie-o:before,.fa-file-video-o:before{content:""}.fa-file-code-o:before{content:""}.fa-vine:before{content:""}.fa-codepen:before{content:""}.fa-jsfiddle:before{content:""}.fa-life-bouy:before,.fa-life-buoy:before,.fa-life-ring:before,.fa-life-saver:before,.fa-support:before{content:""}.fa-circle-o-notch:before{content:""}.fa-ra:before,.fa-rebel:before,.fa-resistance:before{content:""}.fa-empire:before,.fa-ge:before{content:""}.fa-git-square:before{content:""}.fa-git:before{content:""}.fa-hacker-news:before,.fa-y-combinator-square:before,.fa-yc-square:before{content:""}.fa-tencent-weibo:before{content:""}.fa-qq:before{content:""}.fa-wechat:before,.fa-weixin:before{content:""}.fa-paper-plane:before,.fa-send:before{content:""}.fa-paper-plane-o:before,.fa-send-o:before{content:""}.fa-history:before{content:""}.fa-circle-thin:before{content:""}.fa-header:before{content:""}.fa-paragraph:before{content:""}.fa-sliders:before{content:""}.fa-share-alt:before{content:""}.fa-share-alt-square:before{content:""}.fa-bomb:before{content:""}.fa-futbol-o:before,.fa-soccer-ball-o:before{content:""}.fa-tty:before{content:""}.fa-binoculars:before{content:""}.fa-plug:before{content:""}.fa-slideshare:before{content:""}.fa-twitch:before{content:""}.fa-yelp:before{content:""}.fa-newspaper-o:before{content:""}.fa-wifi:before{content:""}.fa-calculator:before{content:""}.fa-paypal:before{content:""}.fa-google-wallet:before{content:""}.fa-cc-visa:before{content:""}.fa-cc-mastercard:before{content:""}.fa-cc-discover:before{content:""}.fa-cc-amex:before{content:""}.fa-cc-paypal:before{content:""}.fa-cc-stripe:before{content:""}.fa-bell-slash:before{content:""}.fa-bell-slash-o:before{content:""}.fa-trash:before{content:""}.fa-copyright:before{content:""}.fa-at:before{content:""}.fa-eyedropper:before{content:""}.fa-paint-brush:before{content:""}.fa-birthday-cake:before{content:""}.fa-area-chart:before{content:""}.fa-pie-chart:before{content:""}.fa-line-chart:before{content:""}.fa-lastfm:before{content:""}.fa-lastfm-square:before{content:""}.fa-toggle-off:before{content:""}.fa-toggle-on:before{content:""}.fa-bicycle:before{content:""}.fa-bus:before{content:""}.fa-ioxhost:before{content:""}.fa-angellist:before{content:""}.fa-cc:before{content:""}.fa-ils:before,.fa-shekel:before,.fa-sheqel:before{content:""}.fa-meanpath:before{content:""}.fa-buysellads:before{content:""}.fa-connectdevelop:before{content:""}.fa-dashcube:before{content:""}.fa-forumbee:before{content:""}.fa-leanpub:before{content:""}.fa-sellsy:before{content:""}.fa-shirtsinbulk:before{content:""}.fa-simplybuilt:before{content:""}.fa-skyatlas:before{content:""}.fa-cart-plus:before{content:""}.fa-cart-arrow-down:before{content:""}.fa-diamond:before{content:""}.fa-ship:before{content:""}.fa-user-secret:before{content:""}.fa-motorcycle:before{content:""}.fa-street-view:before{content:""}.fa-heartbeat:before{content:""}.fa-venus:before{content:""}.fa-mars:before{content:""}.fa-mercury:before{content:""}.fa-intersex:before,.fa-transgender:before{content:""}.fa-transgender-alt:before{content:""}.fa-venus-double:before{content:""}.fa-mars-double:before{content:""}.fa-venus-mars:before{content:""}.fa-mars-stroke:before{content:""}.fa-mars-stroke-v:before{content:""}.fa-mars-stroke-h:before{content:""}.fa-neuter:before{content:""}.fa-genderless:before{content:""}.fa-facebook-official:before{content:""}.fa-pinterest-p:before{content:""}.fa-whatsapp:before{content:""}.fa-server:before{content:""}.fa-user-plus:before{content:""}.fa-user-times:before{content:""}.fa-bed:before,.fa-hotel:before{content:""}.fa-viacoin:before{content:""}.fa-train:before{content:""}.fa-subway:before{content:""}.fa-medium:before{content:""}.fa-y-combinator:before,.fa-yc:before{content:""}.fa-optin-monster:before{content:""}.fa-opencart:before{content:""}.fa-expeditedssl:before{content:""}.fa-battery-4:before,.fa-battery-full:before,.fa-battery:before{content:""}.fa-battery-3:before,.fa-battery-three-quarters:before{content:""}.fa-battery-2:before,.fa-battery-half:before{content:""}.fa-battery-1:before,.fa-battery-quarter:before{content:""}.fa-battery-0:before,.fa-battery-empty:before{content:""}.fa-mouse-pointer:before{content:""}.fa-i-cursor:before{content:""}.fa-object-group:before{content:""}.fa-object-ungroup:before{content:""}.fa-sticky-note:before{content:""}.fa-sticky-note-o:before{content:""}.fa-cc-jcb:before{content:""}.fa-cc-diners-club:before{content:""}.fa-clone:before{content:""}.fa-balance-scale:before{content:""}.fa-hourglass-o:before{content:""}.fa-hourglass-1:before,.fa-hourglass-start:before{content:""}.fa-hourglass-2:before,.fa-hourglass-half:before{content:""}.fa-hourglass-3:before,.fa-hourglass-end:before{content:""}.fa-hourglass:before{content:""}.fa-hand-grab-o:before,.fa-hand-rock-o:before{content:""}.fa-hand-paper-o:before,.fa-hand-stop-o:before{content:""}.fa-hand-scissors-o:before{content:""}.fa-hand-lizard-o:before{content:""}.fa-hand-spock-o:before{content:""}.fa-hand-pointer-o:before{content:""}.fa-hand-peace-o:before{content:""}.fa-trademark:before{content:""}.fa-registered:before{content:""}.fa-creative-commons:before{content:""}.fa-gg:before{content:""}.fa-gg-circle:before{content:""}.fa-tripadvisor:before{content:""}.fa-odnoklassniki:before{content:""}.fa-odnoklassniki-square:before{content:""}.fa-get-pocket:before{content:""}.fa-wikipedia-w:before{content:""}.fa-safari:before{content:""}.fa-chrome:before{content:""}.fa-firefox:before{content:""}.fa-opera:before{content:""}.fa-internet-explorer:before{content:""}.fa-television:before,.fa-tv:before{content:""}.fa-contao:before{content:""}.fa-500px:before{content:""}.fa-amazon:before{content:""}.fa-calendar-plus-o:before{content:""}.fa-calendar-minus-o:before{content:""}.fa-calendar-times-o:before{content:""}.fa-calendar-check-o:before{content:""}.fa-industry:before{content:""}.fa-map-pin:before{content:""}.fa-map-signs:before{content:""}.fa-map-o:before{content:""}.fa-map:before{content:""}.fa-commenting:before{content:""}.fa-commenting-o:before{content:""}.fa-houzz:before{content:""}.fa-vimeo:before{content:""}.fa-black-tie:before{content:""}.fa-fonticons:before{content:""}.fa-reddit-alien:before{content:""}.fa-edge:before{content:""}.fa-credit-card-alt:before{content:""}.fa-codiepie:before{content:""}.fa-modx:before{content:""}.fa-fort-awesome:before{content:""}.fa-usb:before{content:""}.fa-product-hunt:before{content:""}.fa-mixcloud:before{content:""}.fa-scribd:before{content:""}.fa-pause-circle:before{content:""}.fa-pause-circle-o:before{content:""}.fa-stop-circle:before{content:""}.fa-stop-circle-o:before{content:""}.fa-shopping-bag:before{content:""}.fa-shopping-basket:before{content:""}.fa-hashtag:before{content:""}.fa-bluetooth:before{content:""}.fa-bluetooth-b:before{content:""}.fa-percent:before{content:""}.fa-gitlab:before,.icon-gitlab:before{content:""}.fa-wpbeginner:before{content:""}.fa-wpforms:before{content:""}.fa-envira:before{content:""}.fa-universal-access:before{content:""}.fa-wheelchair-alt:before{content:""}.fa-question-circle-o:before{content:""}.fa-blind:before{content:""}.fa-audio-description:before{content:""}.fa-volume-control-phone:before{content:""}.fa-braille:before{content:""}.fa-assistive-listening-systems:before{content:""}.fa-american-sign-language-interpreting:before,.fa-asl-interpreting:before{content:""}.fa-deaf:before,.fa-deafness:before,.fa-hard-of-hearing:before{content:""}.fa-glide:before{content:""}.fa-glide-g:before{content:""}.fa-sign-language:before,.fa-signing:before{content:""}.fa-low-vision:before{content:""}.fa-viadeo:before{content:""}.fa-viadeo-square:before{content:""}.fa-snapchat:before{content:""}.fa-snapchat-ghost:before{content:""}.fa-snapchat-square:before{content:""}.fa-pied-piper:before{content:""}.fa-first-order:before{content:""}.fa-yoast:before{content:""}.fa-themeisle:before{content:""}.fa-google-plus-circle:before,.fa-google-plus-official:before{content:""}.fa-fa:before,.fa-font-awesome:before{content:""}.fa-handshake-o:before{content:""}.fa-envelope-open:before{content:""}.fa-envelope-open-o:before{content:""}.fa-linode:before{content:""}.fa-address-book:before{content:""}.fa-address-book-o:before{content:""}.fa-address-card:before,.fa-vcard:before{content:""}.fa-address-card-o:before,.fa-vcard-o:before{content:""}.fa-user-circle:before{content:""}.fa-user-circle-o:before{content:""}.fa-user-o:before{content:""}.fa-id-badge:before{content:""}.fa-drivers-license:before,.fa-id-card:before{content:""}.fa-drivers-license-o:before,.fa-id-card-o:before{content:""}.fa-quora:before{content:""}.fa-free-code-camp:before{content:""}.fa-telegram:before{content:""}.fa-thermometer-4:before,.fa-thermometer-full:before,.fa-thermometer:before{content:""}.fa-thermometer-3:before,.fa-thermometer-three-quarters:before{content:""}.fa-thermometer-2:before,.fa-thermometer-half:before{content:""}.fa-thermometer-1:before,.fa-thermometer-quarter:before{content:""}.fa-thermometer-0:before,.fa-thermometer-empty:before{content:""}.fa-shower:before{content:""}.fa-bath:before,.fa-bathtub:before,.fa-s15:before{content:""}.fa-podcast:before{content:""}.fa-window-maximize:before{content:""}.fa-window-minimize:before{content:""}.fa-window-restore:before{content:""}.fa-times-rectangle:before,.fa-window-close:before{content:""}.fa-times-rectangle-o:before,.fa-window-close-o:before{content:""}.fa-bandcamp:before{content:""}.fa-grav:before{content:""}.fa-etsy:before{content:""}.fa-imdb:before{content:""}.fa-ravelry:before{content:""}.fa-eercast:before{content:""}.fa-microchip:before{content:""}.fa-snowflake-o:before{content:""}.fa-superpowers:before{content:""}.fa-wpexplorer:before{content:""}.fa-meetup:before{content:""}.sr-only{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0,0,0,0);border:0}.sr-only-focusable:active,.sr-only-focusable:focus{position:static;width:auto;height:auto;margin:0;overflow:visible;clip:auto}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-dropdown .caret,.wy-inline-validate.wy-inline-validate-danger .wy-input-context,.wy-inline-validate.wy-inline-validate-info .wy-input-context,.wy-inline-validate.wy-inline-validate-success .wy-input-context,.wy-inline-validate.wy-inline-validate-warning .wy-input-context,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li button.toctree-expand{font-family:inherit}.fa:before,.icon:before,.rst-content .admonition-title:before,.rst-content .code-block-caption .headerlink:before,.rst-content .eqno .headerlink:before,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content p .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before,.wy-menu-vertical li button.toctree-expand:before{font-family:FontAwesome;display:inline-block;font-style:normal;font-weight:400;line-height:1;text-decoration:inherit}.rst-content .code-block-caption a .headerlink,.rst-content .eqno a .headerlink,.rst-content a .admonition-title,.rst-content code.download a span:first-child,.rst-content dl dt a .headerlink,.rst-content h1 a .headerlink,.rst-content h2 a .headerlink,.rst-content h3 a .headerlink,.rst-content h4 a .headerlink,.rst-content h5 a .headerlink,.rst-content h6 a .headerlink,.rst-content p.caption a .headerlink,.rst-content p a .headerlink,.rst-content table>caption a .headerlink,.rst-content tt.download a span:first-child,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li a button.toctree-expand,a .fa,a .icon,a .rst-content .admonition-title,a .rst-content .code-block-caption .headerlink,a .rst-content .eqno .headerlink,a .rst-content code.download span:first-child,a .rst-content dl dt .headerlink,a .rst-content h1 .headerlink,a .rst-content h2 .headerlink,a .rst-content h3 .headerlink,a .rst-content h4 .headerlink,a .rst-content h5 .headerlink,a .rst-content h6 .headerlink,a .rst-content p.caption .headerlink,a .rst-content p .headerlink,a .rst-content table>caption .headerlink,a .rst-content tt.download span:first-child,a .wy-menu-vertical li button.toctree-expand{display:inline-block;text-decoration:inherit}.btn .fa,.btn .icon,.btn .rst-content .admonition-title,.btn .rst-content .code-block-caption .headerlink,.btn .rst-content .eqno .headerlink,.btn .rst-content code.download span:first-child,.btn .rst-content dl dt .headerlink,.btn .rst-content h1 .headerlink,.btn .rst-content h2 .headerlink,.btn .rst-content h3 .headerlink,.btn .rst-content h4 .headerlink,.btn .rst-content h5 .headerlink,.btn .rst-content h6 .headerlink,.btn .rst-content p .headerlink,.btn .rst-content table>caption .headerlink,.btn .rst-content tt.download span:first-child,.btn .wy-menu-vertical li.current>a button.toctree-expand,.btn .wy-menu-vertical li.on a button.toctree-expand,.btn .wy-menu-vertical li button.toctree-expand,.nav .fa,.nav .icon,.nav .rst-content .admonition-title,.nav .rst-content .code-block-caption .headerlink,.nav .rst-content .eqno .headerlink,.nav .rst-content code.download span:first-child,.nav .rst-content dl dt .headerlink,.nav .rst-content h1 .headerlink,.nav .rst-content h2 .headerlink,.nav .rst-content h3 .headerlink,.nav .rst-content h4 .headerlink,.nav .rst-content h5 .headerlink,.nav .rst-content h6 .headerlink,.nav .rst-content p .headerlink,.nav .rst-content table>caption .headerlink,.nav .rst-content tt.download span:first-child,.nav .wy-menu-vertical li.current>a button.toctree-expand,.nav .wy-menu-vertical li.on a button.toctree-expand,.nav .wy-menu-vertical li button.toctree-expand,.rst-content .btn .admonition-title,.rst-content .code-block-caption .btn .headerlink,.rst-content .code-block-caption .nav .headerlink,.rst-content .eqno .btn .headerlink,.rst-content .eqno .nav .headerlink,.rst-content .nav .admonition-title,.rst-content code.download .btn span:first-child,.rst-content code.download .nav span:first-child,.rst-content dl dt .btn .headerlink,.rst-content dl dt .nav .headerlink,.rst-content h1 .btn .headerlink,.rst-content h1 .nav .headerlink,.rst-content h2 .btn .headerlink,.rst-content h2 .nav .headerlink,.rst-content h3 .btn .headerlink,.rst-content h3 .nav .headerlink,.rst-content h4 .btn .headerlink,.rst-content h4 .nav .headerlink,.rst-content h5 .btn .headerlink,.rst-content h5 .nav .headerlink,.rst-content h6 .btn .headerlink,.rst-content h6 .nav .headerlink,.rst-content p .btn .headerlink,.rst-content p .nav .headerlink,.rst-content table>caption .btn .headerlink,.rst-content table>caption .nav .headerlink,.rst-content tt.download .btn span:first-child,.rst-content tt.download .nav span:first-child,.wy-menu-vertical li .btn button.toctree-expand,.wy-menu-vertical li.current>a .btn button.toctree-expand,.wy-menu-vertical li.current>a .nav button.toctree-expand,.wy-menu-vertical li .nav button.toctree-expand,.wy-menu-vertical li.on a .btn button.toctree-expand,.wy-menu-vertical li.on a .nav button.toctree-expand{display:inline}.btn .fa-large.icon,.btn .fa.fa-large,.btn .rst-content .code-block-caption .fa-large.headerlink,.btn .rst-content .eqno .fa-large.headerlink,.btn .rst-content .fa-large.admonition-title,.btn .rst-content code.download span.fa-large:first-child,.btn .rst-content dl dt .fa-large.headerlink,.btn .rst-content h1 .fa-large.headerlink,.btn .rst-content h2 .fa-large.headerlink,.btn .rst-content h3 .fa-large.headerlink,.btn .rst-content h4 .fa-large.headerlink,.btn .rst-content h5 .fa-large.headerlink,.btn .rst-content h6 .fa-large.headerlink,.btn .rst-content p .fa-large.headerlink,.btn .rst-content table>caption .fa-large.headerlink,.btn .rst-content tt.download span.fa-large:first-child,.btn .wy-menu-vertical li button.fa-large.toctree-expand,.nav .fa-large.icon,.nav .fa.fa-large,.nav .rst-content .code-block-caption .fa-large.headerlink,.nav .rst-content .eqno .fa-large.headerlink,.nav .rst-content .fa-large.admonition-title,.nav .rst-content code.download span.fa-large:first-child,.nav .rst-content dl dt .fa-large.headerlink,.nav .rst-content h1 .fa-large.headerlink,.nav .rst-content h2 .fa-large.headerlink,.nav .rst-content h3 .fa-large.headerlink,.nav .rst-content h4 .fa-large.headerlink,.nav .rst-content h5 .fa-large.headerlink,.nav .rst-content h6 .fa-large.headerlink,.nav .rst-content p .fa-large.headerlink,.nav .rst-content table>caption .fa-large.headerlink,.nav .rst-content tt.download span.fa-large:first-child,.nav .wy-menu-vertical li button.fa-large.toctree-expand,.rst-content .btn .fa-large.admonition-title,.rst-content .code-block-caption .btn .fa-large.headerlink,.rst-content .code-block-caption .nav .fa-large.headerlink,.rst-content .eqno .btn .fa-large.headerlink,.rst-content .eqno .nav .fa-large.headerlink,.rst-content .nav .fa-large.admonition-title,.rst-content code.download .btn span.fa-large:first-child,.rst-content code.download .nav span.fa-large:first-child,.rst-content dl dt .btn .fa-large.headerlink,.rst-content dl dt .nav .fa-large.headerlink,.rst-content h1 .btn .fa-large.headerlink,.rst-content h1 .nav .fa-large.headerlink,.rst-content h2 .btn .fa-large.headerlink,.rst-content h2 .nav .fa-large.headerlink,.rst-content h3 .btn .fa-large.headerlink,.rst-content h3 .nav .fa-large.headerlink,.rst-content h4 .btn .fa-large.headerlink,.rst-content h4 .nav .fa-large.headerlink,.rst-content h5 .btn .fa-large.headerlink,.rst-content h5 .nav .fa-large.headerlink,.rst-content h6 .btn .fa-large.headerlink,.rst-content h6 .nav .fa-large.headerlink,.rst-content p .btn .fa-large.headerlink,.rst-content p .nav .fa-large.headerlink,.rst-content table>caption .btn .fa-large.headerlink,.rst-content table>caption .nav .fa-large.headerlink,.rst-content tt.download .btn span.fa-large:first-child,.rst-content tt.download .nav span.fa-large:first-child,.wy-menu-vertical li .btn button.fa-large.toctree-expand,.wy-menu-vertical li .nav button.fa-large.toctree-expand{line-height:.9em}.btn .fa-spin.icon,.btn .fa.fa-spin,.btn .rst-content .code-block-caption .fa-spin.headerlink,.btn .rst-content .eqno .fa-spin.headerlink,.btn .rst-content .fa-spin.admonition-title,.btn .rst-content code.download span.fa-spin:first-child,.btn .rst-content dl dt .fa-spin.headerlink,.btn .rst-content h1 .fa-spin.headerlink,.btn .rst-content h2 .fa-spin.headerlink,.btn .rst-content h3 .fa-spin.headerlink,.btn .rst-content h4 .fa-spin.headerlink,.btn .rst-content h5 .fa-spin.headerlink,.btn .rst-content h6 .fa-spin.headerlink,.btn .rst-content p .fa-spin.headerlink,.btn .rst-content table>caption .fa-spin.headerlink,.btn .rst-content tt.download span.fa-spin:first-child,.btn .wy-menu-vertical li button.fa-spin.toctree-expand,.nav .fa-spin.icon,.nav .fa.fa-spin,.nav .rst-content .code-block-caption .fa-spin.headerlink,.nav .rst-content .eqno .fa-spin.headerlink,.nav .rst-content .fa-spin.admonition-title,.nav .rst-content code.download span.fa-spin:first-child,.nav .rst-content dl dt .fa-spin.headerlink,.nav .rst-content h1 .fa-spin.headerlink,.nav .rst-content h2 .fa-spin.headerlink,.nav .rst-content h3 .fa-spin.headerlink,.nav .rst-content h4 .fa-spin.headerlink,.nav .rst-content h5 .fa-spin.headerlink,.nav .rst-content h6 .fa-spin.headerlink,.nav .rst-content p .fa-spin.headerlink,.nav .rst-content table>caption .fa-spin.headerlink,.nav .rst-content tt.download span.fa-spin:first-child,.nav .wy-menu-vertical li button.fa-spin.toctree-expand,.rst-content .btn .fa-spin.admonition-title,.rst-content .code-block-caption .btn .fa-spin.headerlink,.rst-content .code-block-caption .nav .fa-spin.headerlink,.rst-content .eqno .btn .fa-spin.headerlink,.rst-content .eqno .nav .fa-spin.headerlink,.rst-content .nav .fa-spin.admonition-title,.rst-content code.download .btn span.fa-spin:first-child,.rst-content code.download .nav span.fa-spin:first-child,.rst-content dl dt .btn .fa-spin.headerlink,.rst-content dl dt .nav .fa-spin.headerlink,.rst-content h1 .btn .fa-spin.headerlink,.rst-content h1 .nav .fa-spin.headerlink,.rst-content h2 .btn .fa-spin.headerlink,.rst-content h2 .nav .fa-spin.headerlink,.rst-content h3 .btn .fa-spin.headerlink,.rst-content h3 .nav .fa-spin.headerlink,.rst-content h4 .btn .fa-spin.headerlink,.rst-content h4 .nav .fa-spin.headerlink,.rst-content h5 .btn .fa-spin.headerlink,.rst-content h5 .nav .fa-spin.headerlink,.rst-content h6 .btn .fa-spin.headerlink,.rst-content h6 .nav .fa-spin.headerlink,.rst-content p .btn .fa-spin.headerlink,.rst-content p .nav .fa-spin.headerlink,.rst-content table>caption .btn .fa-spin.headerlink,.rst-content table>caption .nav .fa-spin.headerlink,.rst-content tt.download .btn span.fa-spin:first-child,.rst-content tt.download .nav span.fa-spin:first-child,.wy-menu-vertical li .btn button.fa-spin.toctree-expand,.wy-menu-vertical li .nav button.fa-spin.toctree-expand{display:inline-block}.btn.fa:before,.btn.icon:before,.rst-content .btn.admonition-title:before,.rst-content .code-block-caption .btn.headerlink:before,.rst-content .eqno .btn.headerlink:before,.rst-content code.download span.btn:first-child:before,.rst-content dl dt .btn.headerlink:before,.rst-content h1 .btn.headerlink:before,.rst-content h2 .btn.headerlink:before,.rst-content h3 .btn.headerlink:before,.rst-content h4 .btn.headerlink:before,.rst-content h5 .btn.headerlink:before,.rst-content h6 .btn.headerlink:before,.rst-content p .btn.headerlink:before,.rst-content table>caption .btn.headerlink:before,.rst-content tt.download span.btn:first-child:before,.wy-menu-vertical li button.btn.toctree-expand:before{opacity:.5;-webkit-transition:opacity .05s ease-in;-moz-transition:opacity .05s ease-in;transition:opacity .05s ease-in}.btn.fa:hover:before,.btn.icon:hover:before,.rst-content .btn.admonition-title:hover:before,.rst-content .code-block-caption .btn.headerlink:hover:before,.rst-content .eqno .btn.headerlink:hover:before,.rst-content code.download span.btn:first-child:hover:before,.rst-content dl dt .btn.headerlink:hover:before,.rst-content h1 .btn.headerlink:hover:before,.rst-content h2 .btn.headerlink:hover:before,.rst-content h3 .btn.headerlink:hover:before,.rst-content h4 .btn.headerlink:hover:before,.rst-content h5 .btn.headerlink:hover:before,.rst-content h6 .btn.headerlink:hover:before,.rst-content p .btn.headerlink:hover:before,.rst-content table>caption .btn.headerlink:hover:before,.rst-content tt.download span.btn:first-child:hover:before,.wy-menu-vertical li button.btn.toctree-expand:hover:before{opacity:1}.btn-mini .fa:before,.btn-mini .icon:before,.btn-mini .rst-content .admonition-title:before,.btn-mini .rst-content .code-block-caption .headerlink:before,.btn-mini .rst-content .eqno .headerlink:before,.btn-mini .rst-content code.download span:first-child:before,.btn-mini .rst-content dl dt .headerlink:before,.btn-mini .rst-content h1 .headerlink:before,.btn-mini .rst-content h2 .headerlink:before,.btn-mini .rst-content h3 .headerlink:before,.btn-mini .rst-content h4 .headerlink:before,.btn-mini .rst-content h5 .headerlink:before,.btn-mini .rst-content h6 .headerlink:before,.btn-mini .rst-content p .headerlink:before,.btn-mini .rst-content table>caption .headerlink:before,.btn-mini .rst-content tt.download span:first-child:before,.btn-mini .wy-menu-vertical li button.toctree-expand:before,.rst-content .btn-mini .admonition-title:before,.rst-content .code-block-caption .btn-mini .headerlink:before,.rst-content .eqno .btn-mini .headerlink:before,.rst-content code.download .btn-mini span:first-child:before,.rst-content dl dt .btn-mini .headerlink:before,.rst-content h1 .btn-mini .headerlink:before,.rst-content h2 .btn-mini .headerlink:before,.rst-content h3 .btn-mini .headerlink:before,.rst-content h4 .btn-mini .headerlink:before,.rst-content h5 .btn-mini .headerlink:before,.rst-content h6 .btn-mini .headerlink:before,.rst-content p .btn-mini .headerlink:before,.rst-content table>caption .btn-mini .headerlink:before,.rst-content tt.download .btn-mini span:first-child:before,.wy-menu-vertical li .btn-mini button.toctree-expand:before{font-size:14px;vertical-align:-15%}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.wy-alert{padding:12px;line-height:24px;margin-bottom:24px;background:#e7f2fa}.rst-content .admonition-title,.wy-alert-title{font-weight:700;display:block;color:#fff;background:#6ab0de;padding:6px 12px;margin:-12px -12px 12px}.rst-content .danger,.rst-content .error,.rst-content .wy-alert-danger.admonition,.rst-content .wy-alert-danger.admonition-todo,.rst-content .wy-alert-danger.attention,.rst-content .wy-alert-danger.caution,.rst-content .wy-alert-danger.hint,.rst-content .wy-alert-danger.important,.rst-content .wy-alert-danger.note,.rst-content .wy-alert-danger.seealso,.rst-content .wy-alert-danger.tip,.rst-content .wy-alert-danger.warning,.wy-alert.wy-alert-danger{background:#fdf3f2}.rst-content .danger .admonition-title,.rst-content .danger .wy-alert-title,.rst-content .error .admonition-title,.rst-content .error .wy-alert-title,.rst-content .wy-alert-danger.admonition-todo .admonition-title,.rst-content .wy-alert-danger.admonition-todo .wy-alert-title,.rst-content .wy-alert-danger.admonition .admonition-title,.rst-content .wy-alert-danger.admonition .wy-alert-title,.rst-content .wy-alert-danger.attention .admonition-title,.rst-content .wy-alert-danger.attention .wy-alert-title,.rst-content .wy-alert-danger.caution .admonition-title,.rst-content .wy-alert-danger.caution .wy-alert-title,.rst-content .wy-alert-danger.hint .admonition-title,.rst-content .wy-alert-danger.hint .wy-alert-title,.rst-content .wy-alert-danger.important .admonition-title,.rst-content .wy-alert-danger.important .wy-alert-title,.rst-content .wy-alert-danger.note .admonition-title,.rst-content .wy-alert-danger.note .wy-alert-title,.rst-content .wy-alert-danger.seealso .admonition-title,.rst-content .wy-alert-danger.seealso .wy-alert-title,.rst-content .wy-alert-danger.tip .admonition-title,.rst-content .wy-alert-danger.tip .wy-alert-title,.rst-content .wy-alert-danger.warning .admonition-title,.rst-content .wy-alert-danger.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-danger .admonition-title,.wy-alert.wy-alert-danger .rst-content .admonition-title,.wy-alert.wy-alert-danger .wy-alert-title{background:#f29f97}.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .warning,.rst-content .wy-alert-warning.admonition,.rst-content .wy-alert-warning.danger,.rst-content .wy-alert-warning.error,.rst-content .wy-alert-warning.hint,.rst-content .wy-alert-warning.important,.rst-content .wy-alert-warning.note,.rst-content .wy-alert-warning.seealso,.rst-content .wy-alert-warning.tip,.wy-alert.wy-alert-warning{background:#ffedcc}.rst-content .admonition-todo .admonition-title,.rst-content .admonition-todo .wy-alert-title,.rst-content .attention .admonition-title,.rst-content .attention .wy-alert-title,.rst-content .caution .admonition-title,.rst-content .caution .wy-alert-title,.rst-content .warning .admonition-title,.rst-content .warning .wy-alert-title,.rst-content .wy-alert-warning.admonition .admonition-title,.rst-content .wy-alert-warning.admonition .wy-alert-title,.rst-content .wy-alert-warning.danger .admonition-title,.rst-content .wy-alert-warning.danger .wy-alert-title,.rst-content .wy-alert-warning.error .admonition-title,.rst-content .wy-alert-warning.error .wy-alert-title,.rst-content .wy-alert-warning.hint .admonition-title,.rst-content .wy-alert-warning.hint .wy-alert-title,.rst-content .wy-alert-warning.important .admonition-title,.rst-content .wy-alert-warning.important .wy-alert-title,.rst-content .wy-alert-warning.note .admonition-title,.rst-content .wy-alert-warning.note .wy-alert-title,.rst-content .wy-alert-warning.seealso .admonition-title,.rst-content .wy-alert-warning.seealso .wy-alert-title,.rst-content .wy-alert-warning.tip .admonition-title,.rst-content .wy-alert-warning.tip .wy-alert-title,.rst-content .wy-alert.wy-alert-warning .admonition-title,.wy-alert.wy-alert-warning .rst-content .admonition-title,.wy-alert.wy-alert-warning .wy-alert-title{background:#f0b37e}.rst-content .note,.rst-content .seealso,.rst-content .wy-alert-info.admonition,.rst-content .wy-alert-info.admonition-todo,.rst-content .wy-alert-info.attention,.rst-content .wy-alert-info.caution,.rst-content .wy-alert-info.danger,.rst-content .wy-alert-info.error,.rst-content .wy-alert-info.hint,.rst-content .wy-alert-info.important,.rst-content .wy-alert-info.tip,.rst-content .wy-alert-info.warning,.wy-alert.wy-alert-info{background:#e7f2fa}.rst-content .note .admonition-title,.rst-content .note .wy-alert-title,.rst-content .seealso .admonition-title,.rst-content .seealso .wy-alert-title,.rst-content .wy-alert-info.admonition-todo .admonition-title,.rst-content .wy-alert-info.admonition-todo .wy-alert-title,.rst-content .wy-alert-info.admonition .admonition-title,.rst-content .wy-alert-info.admonition .wy-alert-title,.rst-content .wy-alert-info.attention .admonition-title,.rst-content .wy-alert-info.attention .wy-alert-title,.rst-content .wy-alert-info.caution .admonition-title,.rst-content .wy-alert-info.caution .wy-alert-title,.rst-content .wy-alert-info.danger .admonition-title,.rst-content .wy-alert-info.danger .wy-alert-title,.rst-content .wy-alert-info.error .admonition-title,.rst-content .wy-alert-info.error .wy-alert-title,.rst-content .wy-alert-info.hint .admonition-title,.rst-content .wy-alert-info.hint .wy-alert-title,.rst-content .wy-alert-info.important .admonition-title,.rst-content .wy-alert-info.important .wy-alert-title,.rst-content .wy-alert-info.tip .admonition-title,.rst-content .wy-alert-info.tip .wy-alert-title,.rst-content .wy-alert-info.warning .admonition-title,.rst-content .wy-alert-info.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-info .admonition-title,.wy-alert.wy-alert-info .rst-content .admonition-title,.wy-alert.wy-alert-info .wy-alert-title{background:#6ab0de}.rst-content .hint,.rst-content .important,.rst-content .tip,.rst-content .wy-alert-success.admonition,.rst-content .wy-alert-success.admonition-todo,.rst-content .wy-alert-success.attention,.rst-content .wy-alert-success.caution,.rst-content .wy-alert-success.danger,.rst-content .wy-alert-success.error,.rst-content .wy-alert-success.note,.rst-content .wy-alert-success.seealso,.rst-content .wy-alert-success.warning,.wy-alert.wy-alert-success{background:#dbfaf4}.rst-content .hint .admonition-title,.rst-content .hint .wy-alert-title,.rst-content .important .admonition-title,.rst-content .important .wy-alert-title,.rst-content .tip .admonition-title,.rst-content .tip .wy-alert-title,.rst-content .wy-alert-success.admonition-todo .admonition-title,.rst-content .wy-alert-success.admonition-todo .wy-alert-title,.rst-content .wy-alert-success.admonition .admonition-title,.rst-content .wy-alert-success.admonition .wy-alert-title,.rst-content .wy-alert-success.attention .admonition-title,.rst-content .wy-alert-success.attention .wy-alert-title,.rst-content .wy-alert-success.caution .admonition-title,.rst-content .wy-alert-success.caution .wy-alert-title,.rst-content .wy-alert-success.danger .admonition-title,.rst-content .wy-alert-success.danger .wy-alert-title,.rst-content .wy-alert-success.error .admonition-title,.rst-content .wy-alert-success.error .wy-alert-title,.rst-content .wy-alert-success.note .admonition-title,.rst-content .wy-alert-success.note .wy-alert-title,.rst-content .wy-alert-success.seealso .admonition-title,.rst-content .wy-alert-success.seealso .wy-alert-title,.rst-content .wy-alert-success.warning .admonition-title,.rst-content .wy-alert-success.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-success .admonition-title,.wy-alert.wy-alert-success .rst-content .admonition-title,.wy-alert.wy-alert-success .wy-alert-title{background:#1abc9c}.rst-content .wy-alert-neutral.admonition,.rst-content .wy-alert-neutral.admonition-todo,.rst-content .wy-alert-neutral.attention,.rst-content .wy-alert-neutral.caution,.rst-content .wy-alert-neutral.danger,.rst-content .wy-alert-neutral.error,.rst-content .wy-alert-neutral.hint,.rst-content .wy-alert-neutral.important,.rst-content .wy-alert-neutral.note,.rst-content .wy-alert-neutral.seealso,.rst-content .wy-alert-neutral.tip,.rst-content .wy-alert-neutral.warning,.wy-alert.wy-alert-neutral{background:#f3f6f6}.rst-content .wy-alert-neutral.admonition-todo .admonition-title,.rst-content .wy-alert-neutral.admonition-todo .wy-alert-title,.rst-content .wy-alert-neutral.admonition .admonition-title,.rst-content .wy-alert-neutral.admonition .wy-alert-title,.rst-content .wy-alert-neutral.attention .admonition-title,.rst-content .wy-alert-neutral.attention .wy-alert-title,.rst-content .wy-alert-neutral.caution .admonition-title,.rst-content .wy-alert-neutral.caution .wy-alert-title,.rst-content .wy-alert-neutral.danger .admonition-title,.rst-content .wy-alert-neutral.danger .wy-alert-title,.rst-content .wy-alert-neutral.error .admonition-title,.rst-content .wy-alert-neutral.error .wy-alert-title,.rst-content .wy-alert-neutral.hint .admonition-title,.rst-content .wy-alert-neutral.hint .wy-alert-title,.rst-content .wy-alert-neutral.important .admonition-title,.rst-content .wy-alert-neutral.important .wy-alert-title,.rst-content .wy-alert-neutral.note .admonition-title,.rst-content .wy-alert-neutral.note .wy-alert-title,.rst-content .wy-alert-neutral.seealso .admonition-title,.rst-content .wy-alert-neutral.seealso .wy-alert-title,.rst-content .wy-alert-neutral.tip .admonition-title,.rst-content .wy-alert-neutral.tip .wy-alert-title,.rst-content .wy-alert-neutral.warning .admonition-title,.rst-content .wy-alert-neutral.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-neutral .admonition-title,.wy-alert.wy-alert-neutral .rst-content .admonition-title,.wy-alert.wy-alert-neutral .wy-alert-title{color:#404040;background:#e1e4e5}.rst-content .wy-alert-neutral.admonition-todo a,.rst-content .wy-alert-neutral.admonition a,.rst-content .wy-alert-neutral.attention a,.rst-content .wy-alert-neutral.caution a,.rst-content .wy-alert-neutral.danger a,.rst-content .wy-alert-neutral.error a,.rst-content .wy-alert-neutral.hint a,.rst-content .wy-alert-neutral.important a,.rst-content .wy-alert-neutral.note a,.rst-content .wy-alert-neutral.seealso a,.rst-content .wy-alert-neutral.tip a,.rst-content .wy-alert-neutral.warning a,.wy-alert.wy-alert-neutral a{color:#2980b9}.rst-content .admonition-todo p:last-child,.rst-content .admonition p:last-child,.rst-content .attention p:last-child,.rst-content .caution p:last-child,.rst-content .danger p:last-child,.rst-content .error p:last-child,.rst-content .hint p:last-child,.rst-content .important p:last-child,.rst-content .note p:last-child,.rst-content .seealso p:last-child,.rst-content .tip p:last-child,.rst-content .warning p:last-child,.wy-alert p:last-child{margin-bottom:0}.wy-tray-container{position:fixed;bottom:0;left:0;z-index:600}.wy-tray-container li{display:block;width:300px;background:transparent;color:#fff;text-align:center;box-shadow:0 5px 5px 0 rgba(0,0,0,.1);padding:0 24px;min-width:20%;opacity:0;height:0;line-height:56px;overflow:hidden;-webkit-transition:all .3s ease-in;-moz-transition:all .3s ease-in;transition:all .3s ease-in}.wy-tray-container li.wy-tray-item-success{background:#27ae60}.wy-tray-container li.wy-tray-item-info{background:#2980b9}.wy-tray-container li.wy-tray-item-warning{background:#e67e22}.wy-tray-container li.wy-tray-item-danger{background:#e74c3c}.wy-tray-container li.on{opacity:1;height:56px}@media screen and (max-width:768px){.wy-tray-container{bottom:auto;top:0;width:100%}.wy-tray-container li{width:100%}}button{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle;cursor:pointer;line-height:normal;-webkit-appearance:button;*overflow:visible}button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}button[disabled]{cursor:default}.btn{display:inline-block;border-radius:2px;line-height:normal;white-space:nowrap;text-align:center;cursor:pointer;font-size:100%;padding:6px 12px 8px;color:#fff;border:1px solid rgba(0,0,0,.1);background-color:#27ae60;text-decoration:none;font-weight:400;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 2px -1px hsla(0,0%,100%,.5),inset 0 -2px 0 0 rgba(0,0,0,.1);outline-none:false;vertical-align:middle;*display:inline;zoom:1;-webkit-user-drag:none;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;-webkit-transition:all .1s linear;-moz-transition:all .1s linear;transition:all .1s linear}.btn-hover{background:#2e8ece;color:#fff}.btn:hover{background:#2cc36b;color:#fff}.btn:focus{background:#2cc36b;outline:0}.btn:active{box-shadow:inset 0 -1px 0 0 rgba(0,0,0,.05),inset 0 2px 0 0 rgba(0,0,0,.1);padding:8px 12px 6px}.btn:visited{color:#fff}.btn-disabled,.btn-disabled:active,.btn-disabled:focus,.btn-disabled:hover,.btn:disabled{background-image:none;filter:progid:DXImageTransform.Microsoft.gradient(enabled = false);filter:alpha(opacity=40);opacity:.4;cursor:not-allowed;box-shadow:none}.btn::-moz-focus-inner{padding:0;border:0}.btn-small{font-size:80%}.btn-info{background-color:#2980b9!important}.btn-info:hover{background-color:#2e8ece!important}.btn-neutral{background-color:#f3f6f6!important;color:#404040!important}.btn-neutral:hover{background-color:#e5ebeb!important;color:#404040}.btn-neutral:visited{color:#404040!important}.btn-success{background-color:#27ae60!important}.btn-success:hover{background-color:#295!important}.btn-danger{background-color:#e74c3c!important}.btn-danger:hover{background-color:#ea6153!important}.btn-warning{background-color:#e67e22!important}.btn-warning:hover{background-color:#e98b39!important}.btn-invert{background-color:#222}.btn-invert:hover{background-color:#2f2f2f!important}.btn-link{background-color:transparent!important;color:#2980b9;box-shadow:none;border-color:transparent!important}.btn-link:active,.btn-link:hover{background-color:transparent!important;color:#409ad5!important;box-shadow:none}.btn-link:visited{color:#9b59b6}.wy-btn-group .btn,.wy-control .btn{vertical-align:middle}.wy-btn-group{margin-bottom:24px;*zoom:1}.wy-btn-group:after,.wy-btn-group:before{display:table;content:""}.wy-btn-group:after{clear:both}.wy-dropdown{position:relative;display:inline-block}.wy-dropdown-active .wy-dropdown-menu{display:block}.wy-dropdown-menu{position:absolute;left:0;display:none;float:left;top:100%;min-width:100%;background:#fcfcfc;z-index:100;border:1px solid #cfd7dd;box-shadow:0 2px 2px 0 rgba(0,0,0,.1);padding:12px}.wy-dropdown-menu>dd>a{display:block;clear:both;color:#404040;white-space:nowrap;font-size:90%;padding:0 12px;cursor:pointer}.wy-dropdown-menu>dd>a:hover{background:#2980b9;color:#fff}.wy-dropdown-menu>dd.divider{border-top:1px solid #cfd7dd;margin:6px 0}.wy-dropdown-menu>dd.search{padding-bottom:12px}.wy-dropdown-menu>dd.search input[type=search]{width:100%}.wy-dropdown-menu>dd.call-to-action{background:#e3e3e3;text-transform:uppercase;font-weight:500;font-size:80%}.wy-dropdown-menu>dd.call-to-action:hover{background:#e3e3e3}.wy-dropdown-menu>dd.call-to-action .btn{color:#fff}.wy-dropdown.wy-dropdown-up .wy-dropdown-menu{bottom:100%;top:auto;left:auto;right:0}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu{background:#fcfcfc;margin-top:2px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a{padding:6px 12px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a:hover{background:#2980b9;color:#fff}.wy-dropdown.wy-dropdown-left .wy-dropdown-menu{right:0;left:auto;text-align:right}.wy-dropdown-arrow:before{content:" ";border-bottom:5px solid #f5f5f5;border-left:5px solid transparent;border-right:5px solid transparent;position:absolute;display:block;top:-4px;left:50%;margin-left:-3px}.wy-dropdown-arrow.wy-dropdown-arrow-left:before{left:11px}.wy-form-stacked select{display:block}.wy-form-aligned .wy-help-inline,.wy-form-aligned input,.wy-form-aligned label,.wy-form-aligned select,.wy-form-aligned textarea{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-form-aligned .wy-control-group>label{display:inline-block;vertical-align:middle;width:10em;margin:6px 12px 0 0;float:left}.wy-form-aligned .wy-control{float:left}.wy-form-aligned .wy-control label{display:block}.wy-form-aligned .wy-control select{margin-top:6px}fieldset{margin:0}fieldset,legend{border:0;padding:0}legend{width:100%;white-space:normal;margin-bottom:24px;font-size:150%;*margin-left:-7px}label,legend{display:block}label{margin:0 0 .3125em;color:#333;font-size:90%}input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}.wy-control-group{margin-bottom:24px;max-width:1200px;margin-left:auto;margin-right:auto;*zoom:1}.wy-control-group:after,.wy-control-group:before{display:table;content:""}.wy-control-group:after{clear:both}.wy-control-group.wy-control-group-required>label:after{content:" *";color:#e74c3c}.wy-control-group .wy-form-full,.wy-control-group .wy-form-halves,.wy-control-group .wy-form-thirds{padding-bottom:12px}.wy-control-group .wy-form-full input[type=color],.wy-control-group .wy-form-full input[type=date],.wy-control-group .wy-form-full input[type=datetime-local],.wy-control-group .wy-form-full input[type=datetime],.wy-control-group .wy-form-full input[type=email],.wy-control-group .wy-form-full input[type=month],.wy-control-group .wy-form-full input[type=number],.wy-control-group .wy-form-full input[type=password],.wy-control-group .wy-form-full input[type=search],.wy-control-group .wy-form-full input[type=tel],.wy-control-group .wy-form-full input[type=text],.wy-control-group .wy-form-full input[type=time],.wy-control-group .wy-form-full input[type=url],.wy-control-group .wy-form-full input[type=week],.wy-control-group .wy-form-full select,.wy-control-group .wy-form-halves input[type=color],.wy-control-group .wy-form-halves input[type=date],.wy-control-group .wy-form-halves input[type=datetime-local],.wy-control-group .wy-form-halves input[type=datetime],.wy-control-group .wy-form-halves input[type=email],.wy-control-group .wy-form-halves input[type=month],.wy-control-group .wy-form-halves input[type=number],.wy-control-group .wy-form-halves input[type=password],.wy-control-group .wy-form-halves input[type=search],.wy-control-group .wy-form-halves input[type=tel],.wy-control-group .wy-form-halves input[type=text],.wy-control-group .wy-form-halves input[type=time],.wy-control-group .wy-form-halves input[type=url],.wy-control-group .wy-form-halves input[type=week],.wy-control-group .wy-form-halves select,.wy-control-group .wy-form-thirds input[type=color],.wy-control-group .wy-form-thirds input[type=date],.wy-control-group .wy-form-thirds input[type=datetime-local],.wy-control-group .wy-form-thirds input[type=datetime],.wy-control-group .wy-form-thirds input[type=email],.wy-control-group .wy-form-thirds input[type=month],.wy-control-group .wy-form-thirds input[type=number],.wy-control-group .wy-form-thirds input[type=password],.wy-control-group .wy-form-thirds input[type=search],.wy-control-group .wy-form-thirds input[type=tel],.wy-control-group .wy-form-thirds input[type=text],.wy-control-group .wy-form-thirds input[type=time],.wy-control-group .wy-form-thirds input[type=url],.wy-control-group .wy-form-thirds input[type=week],.wy-control-group .wy-form-thirds select{width:100%}.wy-control-group .wy-form-full{float:left;display:block;width:100%;margin-right:0}.wy-control-group .wy-form-full:last-child{margin-right:0}.wy-control-group .wy-form-halves{float:left;display:block;margin-right:2.35765%;width:48.82117%}.wy-control-group .wy-form-halves:last-child,.wy-control-group .wy-form-halves:nth-of-type(2n){margin-right:0}.wy-control-group .wy-form-halves:nth-of-type(odd){clear:left}.wy-control-group .wy-form-thirds{float:left;display:block;margin-right:2.35765%;width:31.76157%}.wy-control-group .wy-form-thirds:last-child,.wy-control-group .wy-form-thirds:nth-of-type(3n){margin-right:0}.wy-control-group .wy-form-thirds:nth-of-type(3n+1){clear:left}.wy-control-group.wy-control-group-no-input .wy-control,.wy-control-no-input{margin:6px 0 0;font-size:90%}.wy-control-no-input{display:inline-block}.wy-control-group.fluid-input input[type=color],.wy-control-group.fluid-input input[type=date],.wy-control-group.fluid-input input[type=datetime-local],.wy-control-group.fluid-input input[type=datetime],.wy-control-group.fluid-input input[type=email],.wy-control-group.fluid-input input[type=month],.wy-control-group.fluid-input input[type=number],.wy-control-group.fluid-input input[type=password],.wy-control-group.fluid-input input[type=search],.wy-control-group.fluid-input input[type=tel],.wy-control-group.fluid-input input[type=text],.wy-control-group.fluid-input input[type=time],.wy-control-group.fluid-input input[type=url],.wy-control-group.fluid-input input[type=week]{width:100%}.wy-form-message-inline{padding-left:.3em;color:#666;font-size:90%}.wy-form-message{display:block;color:#999;font-size:70%;margin-top:.3125em;font-style:italic}.wy-form-message p{font-size:inherit;font-style:italic;margin-bottom:6px}.wy-form-message p:last-child{margin-bottom:0}input{line-height:normal}input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;*overflow:visible}input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week]{-webkit-appearance:none;padding:6px;display:inline-block;border:1px solid #ccc;font-size:80%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 3px #ddd;border-radius:0;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}input[type=datetime-local]{padding:.34375em .625em}input[disabled]{cursor:default}input[type=checkbox],input[type=radio]{padding:0;margin-right:.3125em;*height:13px;*width:13px}input[type=checkbox],input[type=radio],input[type=search]{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}input[type=search]::-webkit-search-cancel-button,input[type=search]::-webkit-search-decoration{-webkit-appearance:none}input[type=color]:focus,input[type=date]:focus,input[type=datetime-local]:focus,input[type=datetime]:focus,input[type=email]:focus,input[type=month]:focus,input[type=number]:focus,input[type=password]:focus,input[type=search]:focus,input[type=tel]:focus,input[type=text]:focus,input[type=time]:focus,input[type=url]:focus,input[type=week]:focus{outline:0;outline:thin dotted\9;border-color:#333}input.no-focus:focus{border-color:#ccc!important}input[type=checkbox]:focus,input[type=file]:focus,input[type=radio]:focus{outline:thin dotted #333;outline:1px auto #129fea}input[type=color][disabled],input[type=date][disabled],input[type=datetime-local][disabled],input[type=datetime][disabled],input[type=email][disabled],input[type=month][disabled],input[type=number][disabled],input[type=password][disabled],input[type=search][disabled],input[type=tel][disabled],input[type=text][disabled],input[type=time][disabled],input[type=url][disabled],input[type=week][disabled]{cursor:not-allowed;background-color:#fafafa}input:focus:invalid,select:focus:invalid,textarea:focus:invalid{color:#e74c3c;border:1px solid #e74c3c}input:focus:invalid:focus,select:focus:invalid:focus,textarea:focus:invalid:focus{border-color:#e74c3c}input[type=checkbox]:focus:invalid:focus,input[type=file]:focus:invalid:focus,input[type=radio]:focus:invalid:focus{outline-color:#e74c3c}input.wy-input-large{padding:12px;font-size:100%}textarea{overflow:auto;vertical-align:top;width:100%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif}select,textarea{padding:.5em .625em;display:inline-block;border:1px solid #ccc;font-size:80%;box-shadow:inset 0 1px 3px #ddd;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}select{border:1px solid #ccc;background-color:#fff}select[multiple]{height:auto}select:focus,textarea:focus{outline:0}input[readonly],select[disabled],select[readonly],textarea[disabled],textarea[readonly]{cursor:not-allowed;background-color:#fafafa}input[type=checkbox][disabled],input[type=radio][disabled]{cursor:not-allowed}.wy-checkbox,.wy-radio{margin:6px 0;color:#404040;display:block}.wy-checkbox input,.wy-radio input{vertical-align:baseline}.wy-form-message-inline{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-input-prefix,.wy-input-suffix{white-space:nowrap;padding:6px}.wy-input-prefix .wy-input-context,.wy-input-suffix .wy-input-context{line-height:27px;padding:0 8px;display:inline-block;font-size:80%;background-color:#f3f6f6;border:1px solid #ccc;color:#999}.wy-input-suffix .wy-input-context{border-left:0}.wy-input-prefix .wy-input-context{border-right:0}.wy-switch{position:relative;display:block;height:24px;margin-top:12px;cursor:pointer}.wy-switch:before{left:0;top:0;width:36px;height:12px;background:#ccc}.wy-switch:after,.wy-switch:before{position:absolute;content:"";display:block;border-radius:4px;-webkit-transition:all .2s ease-in-out;-moz-transition:all .2s ease-in-out;transition:all .2s ease-in-out}.wy-switch:after{width:18px;height:18px;background:#999;left:-3px;top:-3px}.wy-switch span{position:absolute;left:48px;display:block;font-size:12px;color:#ccc;line-height:1}.wy-switch.active:before{background:#1e8449}.wy-switch.active:after{left:24px;background:#27ae60}.wy-switch.disabled{cursor:not-allowed;opacity:.8}.wy-control-group.wy-control-group-error .wy-form-message,.wy-control-group.wy-control-group-error>label{color:#e74c3c}.wy-control-group.wy-control-group-error input[type=color],.wy-control-group.wy-control-group-error input[type=date],.wy-control-group.wy-control-group-error input[type=datetime-local],.wy-control-group.wy-control-group-error input[type=datetime],.wy-control-group.wy-control-group-error input[type=email],.wy-control-group.wy-control-group-error input[type=month],.wy-control-group.wy-control-group-error input[type=number],.wy-control-group.wy-control-group-error input[type=password],.wy-control-group.wy-control-group-error input[type=search],.wy-control-group.wy-control-group-error input[type=tel],.wy-control-group.wy-control-group-error input[type=text],.wy-control-group.wy-control-group-error input[type=time],.wy-control-group.wy-control-group-error input[type=url],.wy-control-group.wy-control-group-error input[type=week],.wy-control-group.wy-control-group-error textarea{border:1px solid #e74c3c}.wy-inline-validate{white-space:nowrap}.wy-inline-validate .wy-input-context{padding:.5em .625em;display:inline-block;font-size:80%}.wy-inline-validate.wy-inline-validate-success .wy-input-context{color:#27ae60}.wy-inline-validate.wy-inline-validate-danger .wy-input-context{color:#e74c3c}.wy-inline-validate.wy-inline-validate-warning .wy-input-context{color:#e67e22}.wy-inline-validate.wy-inline-validate-info .wy-input-context{color:#2980b9}.rotate-90{-webkit-transform:rotate(90deg);-moz-transform:rotate(90deg);-ms-transform:rotate(90deg);-o-transform:rotate(90deg);transform:rotate(90deg)}.rotate-180{-webkit-transform:rotate(180deg);-moz-transform:rotate(180deg);-ms-transform:rotate(180deg);-o-transform:rotate(180deg);transform:rotate(180deg)}.rotate-270{-webkit-transform:rotate(270deg);-moz-transform:rotate(270deg);-ms-transform:rotate(270deg);-o-transform:rotate(270deg);transform:rotate(270deg)}.mirror{-webkit-transform:scaleX(-1);-moz-transform:scaleX(-1);-ms-transform:scaleX(-1);-o-transform:scaleX(-1);transform:scaleX(-1)}.mirror.rotate-90{-webkit-transform:scaleX(-1) rotate(90deg);-moz-transform:scaleX(-1) rotate(90deg);-ms-transform:scaleX(-1) rotate(90deg);-o-transform:scaleX(-1) rotate(90deg);transform:scaleX(-1) rotate(90deg)}.mirror.rotate-180{-webkit-transform:scaleX(-1) rotate(180deg);-moz-transform:scaleX(-1) rotate(180deg);-ms-transform:scaleX(-1) rotate(180deg);-o-transform:scaleX(-1) rotate(180deg);transform:scaleX(-1) rotate(180deg)}.mirror.rotate-270{-webkit-transform:scaleX(-1) rotate(270deg);-moz-transform:scaleX(-1) rotate(270deg);-ms-transform:scaleX(-1) rotate(270deg);-o-transform:scaleX(-1) rotate(270deg);transform:scaleX(-1) rotate(270deg)}@media only screen and (max-width:480px){.wy-form button[type=submit]{margin:.7em 0 0}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=text],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week],.wy-form label{margin-bottom:.3em;display:block}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week]{margin-bottom:0}.wy-form-aligned .wy-control-group label{margin-bottom:.3em;text-align:left;display:block;width:100%}.wy-form-aligned .wy-control{margin:1.5em 0 0}.wy-form-message,.wy-form-message-inline,.wy-form .wy-help-inline{display:block;font-size:80%;padding:6px 0}}@media screen and (max-width:768px){.tablet-hide{display:none}}@media screen and (max-width:480px){.mobile-hide{display:none}}.float-left{float:left}.float-right{float:right}.full-width{width:100%}.rst-content table.docutils,.rst-content table.field-list,.wy-table{border-collapse:collapse;border-spacing:0;empty-cells:show;margin-bottom:24px}.rst-content table.docutils caption,.rst-content table.field-list caption,.wy-table caption{color:#000;font:italic 85%/1 arial,sans-serif;padding:1em 0;text-align:center}.rst-content table.docutils td,.rst-content table.docutils th,.rst-content table.field-list td,.rst-content table.field-list th,.wy-table td,.wy-table th{font-size:90%;margin:0;overflow:visible;padding:8px 16px}.rst-content table.docutils td:first-child,.rst-content table.docutils th:first-child,.rst-content table.field-list td:first-child,.rst-content table.field-list th:first-child,.wy-table td:first-child,.wy-table th:first-child{border-left-width:0}.rst-content table.docutils thead,.rst-content table.field-list thead,.wy-table thead{color:#000;text-align:left;vertical-align:bottom;white-space:nowrap}.rst-content table.docutils thead th,.rst-content table.field-list thead th,.wy-table thead th{font-weight:700;border-bottom:2px solid #e1e4e5}.rst-content table.docutils td,.rst-content table.field-list td,.wy-table td{background-color:transparent;vertical-align:middle}.rst-content table.docutils td p,.rst-content table.field-list td p,.wy-table td p{line-height:18px}.rst-content table.docutils td p:last-child,.rst-content table.field-list td p:last-child,.wy-table td p:last-child{margin-bottom:0}.rst-content table.docutils .wy-table-cell-min,.rst-content table.field-list .wy-table-cell-min,.wy-table .wy-table-cell-min{width:1%;padding-right:0}.rst-content table.docutils .wy-table-cell-min input[type=checkbox],.rst-content table.field-list .wy-table-cell-min input[type=checkbox],.wy-table .wy-table-cell-min input[type=checkbox]{margin:0}.wy-table-secondary{color:grey;font-size:90%}.wy-table-tertiary{color:grey;font-size:80%}.rst-content table.docutils:not(.field-list) tr:nth-child(2n-1) td,.wy-table-backed,.wy-table-odd td,.wy-table-striped tr:nth-child(2n-1) td{background-color:#f3f6f6}.rst-content table.docutils,.wy-table-bordered-all{border:1px solid #e1e4e5}.rst-content table.docutils td,.wy-table-bordered-all td{border-bottom:1px solid #e1e4e5;border-left:1px solid #e1e4e5}.rst-content table.docutils tbody>tr:last-child td,.wy-table-bordered-all tbody>tr:last-child td{border-bottom-width:0}.wy-table-bordered{border:1px solid #e1e4e5}.wy-table-bordered-rows td{border-bottom:1px solid #e1e4e5}.wy-table-bordered-rows tbody>tr:last-child td{border-bottom-width:0}.wy-table-horizontal td,.wy-table-horizontal th{border-width:0 0 1px;border-bottom:1px solid #e1e4e5}.wy-table-horizontal tbody>tr:last-child td{border-bottom-width:0}.wy-table-responsive{margin-bottom:24px;max-width:100%;overflow:auto}.wy-table-responsive table{margin-bottom:0!important}.wy-table-responsive table td,.wy-table-responsive table th{white-space:nowrap}a{color:#2980b9;text-decoration:none;cursor:pointer}a:hover{color:#3091d1}a:visited{color:#9b59b6}html{height:100%}body,html{overflow-x:hidden}body{font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;font-weight:400;color:#404040;min-height:100%;background:#edf0f2}.wy-text-left{text-align:left}.wy-text-center{text-align:center}.wy-text-right{text-align:right}.wy-text-large{font-size:120%}.wy-text-normal{font-size:100%}.wy-text-small,small{font-size:80%}.wy-text-strike{text-decoration:line-through}.wy-text-warning{color:#e67e22!important}a.wy-text-warning:hover{color:#eb9950!important}.wy-text-info{color:#2980b9!important}a.wy-text-info:hover{color:#409ad5!important}.wy-text-success{color:#27ae60!important}a.wy-text-success:hover{color:#36d278!important}.wy-text-danger{color:#e74c3c!important}a.wy-text-danger:hover{color:#ed7669!important}.wy-text-neutral{color:#404040!important}a.wy-text-neutral:hover{color:#595959!important}.rst-content .toctree-wrapper>p.caption,h1,h2,h3,h4,h5,h6,legend{margin-top:0;font-weight:700;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif}p{line-height:24px;font-size:16px;margin:0 0 24px}h1{font-size:175%}.rst-content .toctree-wrapper>p.caption,h2{font-size:150%}h3{font-size:125%}h4{font-size:115%}h5{font-size:110%}h6{font-size:100%}hr{display:block;height:1px;border:0;border-top:1px solid #e1e4e5;margin:24px 0;padding:0}.rst-content code,.rst-content tt,code{white-space:nowrap;max-width:100%;background:#fff;border:1px solid #e1e4e5;font-size:75%;padding:0 5px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;color:#e74c3c;overflow-x:auto}.rst-content tt.code-large,code.code-large{font-size:90%}.rst-content .section ul,.rst-content .toctree-wrapper ul,.rst-content section ul,.wy-plain-list-disc,article ul{list-style:disc;line-height:24px;margin-bottom:24px}.rst-content .section ul li,.rst-content .toctree-wrapper ul li,.rst-content section ul li,.wy-plain-list-disc li,article ul li{list-style:disc;margin-left:24px}.rst-content .section ul li p:last-child,.rst-content .section ul li ul,.rst-content .toctree-wrapper ul li p:last-child,.rst-content .toctree-wrapper ul li ul,.rst-content section ul li p:last-child,.rst-content section ul li ul,.wy-plain-list-disc li p:last-child,.wy-plain-list-disc li ul,article ul li p:last-child,article ul li ul{margin-bottom:0}.rst-content .section ul li li,.rst-content .toctree-wrapper ul li li,.rst-content section ul li li,.wy-plain-list-disc li li,article ul li li{list-style:circle}.rst-content .section ul li li li,.rst-content .toctree-wrapper ul li li li,.rst-content section ul li li li,.wy-plain-list-disc li li li,article ul li li li{list-style:square}.rst-content .section ul li ol li,.rst-content .toctree-wrapper ul li ol li,.rst-content section ul li ol li,.wy-plain-list-disc li ol li,article ul li ol li{list-style:decimal}.rst-content .section ol,.rst-content .section ol.arabic,.rst-content .toctree-wrapper ol,.rst-content .toctree-wrapper ol.arabic,.rst-content section ol,.rst-content section ol.arabic,.wy-plain-list-decimal,article ol{list-style:decimal;line-height:24px;margin-bottom:24px}.rst-content .section ol.arabic li,.rst-content .section ol li,.rst-content .toctree-wrapper ol.arabic li,.rst-content .toctree-wrapper ol li,.rst-content section ol.arabic li,.rst-content section ol li,.wy-plain-list-decimal li,article ol li{list-style:decimal;margin-left:24px}.rst-content .section ol.arabic li ul,.rst-content .section ol li p:last-child,.rst-content .section ol li ul,.rst-content .toctree-wrapper ol.arabic li ul,.rst-content .toctree-wrapper ol li p:last-child,.rst-content .toctree-wrapper ol li ul,.rst-content section ol.arabic li ul,.rst-content section ol li p:last-child,.rst-content section ol li ul,.wy-plain-list-decimal li p:last-child,.wy-plain-list-decimal li ul,article ol li p:last-child,article ol li ul{margin-bottom:0}.rst-content .section ol.arabic li ul li,.rst-content .section ol li ul li,.rst-content .toctree-wrapper ol.arabic li ul li,.rst-content .toctree-wrapper ol li ul li,.rst-content section ol.arabic li ul li,.rst-content section ol li ul li,.wy-plain-list-decimal li ul li,article ol li ul li{list-style:disc}.wy-breadcrumbs{*zoom:1}.wy-breadcrumbs:after,.wy-breadcrumbs:before{display:table;content:""}.wy-breadcrumbs:after{clear:both}.wy-breadcrumbs>li{display:inline-block;padding-top:5px}.wy-breadcrumbs>li.wy-breadcrumbs-aside{float:right}.rst-content .wy-breadcrumbs>li code,.rst-content .wy-breadcrumbs>li tt,.wy-breadcrumbs>li .rst-content tt,.wy-breadcrumbs>li code{all:inherit;color:inherit}.breadcrumb-item:before{content:"/";color:#bbb;font-size:13px;padding:0 6px 0 3px}.wy-breadcrumbs-extra{margin-bottom:0;color:#b3b3b3;font-size:80%;display:inline-block}@media screen and (max-width:480px){.wy-breadcrumbs-extra,.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}@media print{.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}html{font-size:16px}.wy-affix{position:fixed;top:1.618em}.wy-menu a:hover{text-decoration:none}.wy-menu-horiz{*zoom:1}.wy-menu-horiz:after,.wy-menu-horiz:before{display:table;content:""}.wy-menu-horiz:after{clear:both}.wy-menu-horiz li,.wy-menu-horiz ul{display:inline-block}.wy-menu-horiz li:hover{background:hsla(0,0%,100%,.1)}.wy-menu-horiz li.divide-left{border-left:1px solid #404040}.wy-menu-horiz li.divide-right{border-right:1px solid #404040}.wy-menu-horiz a{height:32px;display:inline-block;line-height:32px;padding:0 16px}.wy-menu-vertical{width:300px}.wy-menu-vertical header,.wy-menu-vertical p.caption{color:#55a5d9;height:32px;line-height:32px;padding:0 1.618em;margin:12px 0 0;display:block;font-weight:700;text-transform:uppercase;font-size:85%;white-space:nowrap}.wy-menu-vertical ul{margin-bottom:0}.wy-menu-vertical li.divide-top{border-top:1px solid #404040}.wy-menu-vertical li.divide-bottom{border-bottom:1px solid #404040}.wy-menu-vertical li.current{background:#e3e3e3}.wy-menu-vertical li.current a{color:grey;border-right:1px solid #c9c9c9;padding:.4045em 2.427em}.wy-menu-vertical li.current a:hover{background:#d6d6d6}.rst-content .wy-menu-vertical li tt,.wy-menu-vertical li .rst-content tt,.wy-menu-vertical li code{border:none;background:inherit;color:inherit;padding-left:0;padding-right:0}.wy-menu-vertical li button.toctree-expand{display:block;float:left;margin-left:-1.2em;line-height:18px;color:#4d4d4d;border:none;background:none;padding:0}.wy-menu-vertical li.current>a,.wy-menu-vertical li.on a{color:#404040;font-weight:700;position:relative;background:#fcfcfc;border:none;padding:.4045em 1.618em}.wy-menu-vertical li.current>a:hover,.wy-menu-vertical li.on a:hover{background:#fcfcfc}.wy-menu-vertical li.current>a:hover button.toctree-expand,.wy-menu-vertical li.on a:hover button.toctree-expand{color:grey}.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand{display:block;line-height:18px;color:#333}.wy-menu-vertical li.toctree-l1.current>a{border-bottom:1px solid #c9c9c9;border-top:1px solid #c9c9c9}.wy-menu-vertical .toctree-l1.current .toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .toctree-l11>ul{display:none}.wy-menu-vertical .toctree-l1.current .current.toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .current.toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .current.toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .current.toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .current.toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .current.toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .current.toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .current.toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .current.toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .current.toctree-l11>ul{display:block}.wy-menu-vertical li.toctree-l3,.wy-menu-vertical li.toctree-l4{font-size:.9em}.wy-menu-vertical li.toctree-l2 a,.wy-menu-vertical li.toctree-l3 a,.wy-menu-vertical li.toctree-l4 a,.wy-menu-vertical li.toctree-l5 a,.wy-menu-vertical li.toctree-l6 a,.wy-menu-vertical li.toctree-l7 a,.wy-menu-vertical li.toctree-l8 a,.wy-menu-vertical li.toctree-l9 a,.wy-menu-vertical li.toctree-l10 a{color:#404040}.wy-menu-vertical li.toctree-l2 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l3 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l4 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l5 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l6 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l7 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l8 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l9 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l10 a:hover button.toctree-expand{color:grey}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a,.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a,.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a,.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a,.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a,.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a,.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a,.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{display:block}.wy-menu-vertical li.toctree-l2.current>a{padding:.4045em 2.427em}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{padding:.4045em 1.618em .4045em 4.045em}.wy-menu-vertical li.toctree-l3.current>a{padding:.4045em 4.045em}.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{padding:.4045em 1.618em .4045em 5.663em}.wy-menu-vertical li.toctree-l4.current>a{padding:.4045em 5.663em}.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a{padding:.4045em 1.618em .4045em 7.281em}.wy-menu-vertical li.toctree-l5.current>a{padding:.4045em 7.281em}.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a{padding:.4045em 1.618em .4045em 8.899em}.wy-menu-vertical li.toctree-l6.current>a{padding:.4045em 8.899em}.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a{padding:.4045em 1.618em .4045em 10.517em}.wy-menu-vertical li.toctree-l7.current>a{padding:.4045em 10.517em}.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a{padding:.4045em 1.618em .4045em 12.135em}.wy-menu-vertical li.toctree-l8.current>a{padding:.4045em 12.135em}.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a{padding:.4045em 1.618em .4045em 13.753em}.wy-menu-vertical li.toctree-l9.current>a{padding:.4045em 13.753em}.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a{padding:.4045em 1.618em .4045em 15.371em}.wy-menu-vertical li.toctree-l10.current>a{padding:.4045em 15.371em}.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{padding:.4045em 1.618em .4045em 16.989em}.wy-menu-vertical li.toctree-l2.current>a,.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{background:#c9c9c9}.wy-menu-vertical li.toctree-l2 button.toctree-expand{color:#a3a3a3}.wy-menu-vertical li.toctree-l3.current>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{background:#bdbdbd}.wy-menu-vertical li.toctree-l3 button.toctree-expand{color:#969696}.wy-menu-vertical li.current ul{display:block}.wy-menu-vertical li ul{margin-bottom:0;display:none}.wy-menu-vertical li ul li a{margin-bottom:0;color:#d9d9d9;font-weight:400}.wy-menu-vertical a{line-height:18px;padding:.4045em 1.618em;display:block;position:relative;font-size:90%;color:#d9d9d9}.wy-menu-vertical a:hover{background-color:#4e4a4a;cursor:pointer}.wy-menu-vertical a:hover button.toctree-expand{color:#d9d9d9}.wy-menu-vertical a:active{background-color:#2980b9;cursor:pointer;color:#fff}.wy-menu-vertical a:active button.toctree-expand{color:#fff}.wy-side-nav-search{display:block;width:300px;padding:.809em;margin-bottom:.809em;z-index:200;background-color:#2980b9;text-align:center;color:#fcfcfc}.wy-side-nav-search input[type=text]{width:100%;border-radius:50px;padding:6px 12px;border-color:#2472a4}.wy-side-nav-search img{display:block;margin:auto auto .809em;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-side-nav-search .wy-dropdown>a,.wy-side-nav-search>a{color:#fcfcfc;font-size:100%;font-weight:700;display:inline-block;padding:4px 6px;margin-bottom:.809em;max-width:100%}.wy-side-nav-search .wy-dropdown>a:hover,.wy-side-nav-search>a:hover{background:hsla(0,0%,100%,.1)}.wy-side-nav-search .wy-dropdown>a img.logo,.wy-side-nav-search>a img.logo{display:block;margin:0 auto;height:auto;width:auto;border-radius:0;max-width:100%;background:transparent}.wy-side-nav-search .wy-dropdown>a.icon img.logo,.wy-side-nav-search>a.icon img.logo{margin-top:.85em}.wy-side-nav-search>div.version{margin-top:-.4045em;margin-bottom:.809em;font-weight:400;color:hsla(0,0%,100%,.3)}.wy-nav .wy-menu-vertical header{color:#2980b9}.wy-nav .wy-menu-vertical a{color:#b3b3b3}.wy-nav .wy-menu-vertical a:hover{background-color:#2980b9;color:#fff}[data-menu-wrap]{-webkit-transition:all .2s ease-in;-moz-transition:all .2s ease-in;transition:all .2s ease-in;position:absolute;opacity:1;width:100%;opacity:0}[data-menu-wrap].move-center{left:0;right:auto;opacity:1}[data-menu-wrap].move-left{right:auto;left:-100%;opacity:0}[data-menu-wrap].move-right{right:-100%;left:auto;opacity:0}.wy-body-for-nav{background:#fcfcfc}.wy-grid-for-nav{position:absolute;width:100%;height:100%}.wy-nav-side{position:fixed;top:0;bottom:0;left:0;padding-bottom:2em;width:300px;overflow-x:hidden;overflow-y:hidden;min-height:100%;color:#9b9b9b;background:#343131;z-index:200}.wy-side-scroll{width:320px;position:relative;overflow-x:hidden;overflow-y:scroll;height:100%}.wy-nav-top{display:none;background:#2980b9;color:#fff;padding:.4045em .809em;position:relative;line-height:50px;text-align:center;font-size:100%;*zoom:1}.wy-nav-top:after,.wy-nav-top:before{display:table;content:""}.wy-nav-top:after{clear:both}.wy-nav-top a{color:#fff;font-weight:700}.wy-nav-top img{margin-right:12px;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-nav-top i{font-size:30px;float:left;cursor:pointer;padding-top:inherit}.wy-nav-content-wrap{margin-left:300px;background:#fcfcfc;min-height:100%}.wy-nav-content{padding:1.618em 3.236em;height:100%;max-width:800px;margin:auto}.wy-body-mask{position:fixed;width:100%;height:100%;background:rgba(0,0,0,.2);display:none;z-index:499}.wy-body-mask.on{display:block}footer{color:grey}footer p{margin-bottom:12px}.rst-content footer span.commit tt,footer span.commit .rst-content tt,footer span.commit code{padding:0;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:1em;background:none;border:none;color:grey}.rst-footer-buttons{*zoom:1}.rst-footer-buttons:after,.rst-footer-buttons:before{width:100%;display:table;content:""}.rst-footer-buttons:after{clear:both}.rst-breadcrumbs-buttons{margin-top:12px;*zoom:1}.rst-breadcrumbs-buttons:after,.rst-breadcrumbs-buttons:before{display:table;content:""}.rst-breadcrumbs-buttons:after{clear:both}#search-results .search li{margin-bottom:24px;border-bottom:1px solid #e1e4e5;padding-bottom:24px}#search-results .search li:first-child{border-top:1px solid #e1e4e5;padding-top:24px}#search-results .search li a{font-size:120%;margin-bottom:12px;display:inline-block}#search-results .context{color:grey;font-size:90%}.genindextable li>ul{margin-left:24px}@media screen and (max-width:768px){.wy-body-for-nav{background:#fcfcfc}.wy-nav-top{display:block}.wy-nav-side{left:-300px}.wy-nav-side.shift{width:85%;left:0}.wy-menu.wy-menu-vertical,.wy-side-nav-search,.wy-side-scroll{width:auto}.wy-nav-content-wrap{margin-left:0}.wy-nav-content-wrap .wy-nav-content{padding:1.618em}.wy-nav-content-wrap.shift{position:fixed;min-width:100%;left:85%;top:0;height:100%;overflow:hidden}}@media screen and (min-width:1100px){.wy-nav-content-wrap{background:rgba(0,0,0,.05)}.wy-nav-content{margin:0;background:#fcfcfc}}@media print{.rst-versions,.wy-nav-side,footer{display:none}.wy-nav-content-wrap{margin-left:0}}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60;*zoom:1}.rst-versions .rst-current-version:after,.rst-versions .rst-current-version:before{display:table;content:""}.rst-versions .rst-current-version:after{clear:both}.rst-content .code-block-caption .rst-versions .rst-current-version .headerlink,.rst-content .eqno .rst-versions .rst-current-version .headerlink,.rst-content .rst-versions .rst-current-version .admonition-title,.rst-content code.download .rst-versions .rst-current-version span:first-child,.rst-content dl dt .rst-versions .rst-current-version .headerlink,.rst-content h1 .rst-versions .rst-current-version .headerlink,.rst-content h2 .rst-versions .rst-current-version .headerlink,.rst-content h3 .rst-versions .rst-current-version .headerlink,.rst-content h4 .rst-versions .rst-current-version .headerlink,.rst-content h5 .rst-versions .rst-current-version .headerlink,.rst-content h6 .rst-versions .rst-current-version .headerlink,.rst-content p .rst-versions .rst-current-version .headerlink,.rst-content table>caption .rst-versions .rst-current-version .headerlink,.rst-content tt.download .rst-versions .rst-current-version span:first-child,.rst-versions .rst-current-version .fa,.rst-versions .rst-current-version .icon,.rst-versions .rst-current-version .rst-content .admonition-title,.rst-versions .rst-current-version .rst-content .code-block-caption .headerlink,.rst-versions .rst-current-version .rst-content .eqno .headerlink,.rst-versions .rst-current-version .rst-content code.download span:first-child,.rst-versions .rst-current-version .rst-content dl dt .headerlink,.rst-versions .rst-current-version .rst-content h1 .headerlink,.rst-versions .rst-current-version .rst-content h2 .headerlink,.rst-versions .rst-current-version .rst-content h3 .headerlink,.rst-versions .rst-current-version .rst-content h4 .headerlink,.rst-versions .rst-current-version .rst-content h5 .headerlink,.rst-versions .rst-current-version .rst-content h6 .headerlink,.rst-versions .rst-current-version .rst-content p .headerlink,.rst-versions .rst-current-version .rst-content table>caption .headerlink,.rst-versions .rst-current-version .rst-content tt.download span:first-child,.rst-versions .rst-current-version .wy-menu-vertical li button.toctree-expand,.wy-menu-vertical li .rst-versions .rst-current-version button.toctree-expand{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}}.rst-content .toctree-wrapper>p.caption,.rst-content h1,.rst-content h2,.rst-content h3,.rst-content h4,.rst-content h5,.rst-content h6{margin-bottom:24px}.rst-content img{max-width:100%;height:auto}.rst-content div.figure,.rst-content figure{margin-bottom:24px}.rst-content div.figure .caption-text,.rst-content figure .caption-text{font-style:italic}.rst-content div.figure p:last-child.caption,.rst-content figure p:last-child.caption{margin-bottom:0}.rst-content div.figure.align-center,.rst-content figure.align-center{text-align:center}.rst-content .section>a>img,.rst-content .section>img,.rst-content section>a>img,.rst-content section>img{margin-bottom:24px}.rst-content abbr[title]{text-decoration:none}.rst-content.style-external-links a.reference.external:after{font-family:FontAwesome;content:"\f08e";color:#b3b3b3;vertical-align:super;font-size:60%;margin:0 .2em}.rst-content blockquote{margin-left:24px;line-height:24px;margin-bottom:24px}.rst-content pre.literal-block{white-space:pre;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;display:block;overflow:auto}.rst-content div[class^=highlight],.rst-content pre.literal-block{border:1px solid #e1e4e5;overflow-x:auto;margin:1px 0 24px}.rst-content div[class^=highlight] div[class^=highlight],.rst-content pre.literal-block div[class^=highlight]{padding:0;border:none;margin:0}.rst-content div[class^=highlight] td.code{width:100%}.rst-content .linenodiv pre{border-right:1px solid #e6e9ea;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;user-select:none;pointer-events:none}.rst-content div[class^=highlight] pre{white-space:pre;margin:0;padding:12px;display:block;overflow:auto}.rst-content div[class^=highlight] pre .hll{display:block;margin:0 -12px;padding:0 12px}.rst-content .linenodiv pre,.rst-content div[class^=highlight] pre,.rst-content pre.literal-block{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:12px;line-height:1.4}.rst-content div.highlight .gp,.rst-content div.highlight span.linenos{user-select:none;pointer-events:none}.rst-content div.highlight span.linenos{display:inline-block;padding-left:0;padding-right:12px;margin-right:12px;border-right:1px solid #e6e9ea}.rst-content .code-block-caption{font-style:italic;font-size:85%;line-height:1;padding:1em 0;text-align:center}@media print{.rst-content .codeblock,.rst-content div[class^=highlight],.rst-content div[class^=highlight] pre{white-space:pre-wrap}}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning{clear:both}.rst-content .admonition-todo .last,.rst-content .admonition-todo>:last-child,.rst-content .admonition .last,.rst-content .admonition>:last-child,.rst-content .attention .last,.rst-content .attention>:last-child,.rst-content .caution .last,.rst-content .caution>:last-child,.rst-content .danger .last,.rst-content .danger>:last-child,.rst-content .error .last,.rst-content .error>:last-child,.rst-content .hint .last,.rst-content .hint>:last-child,.rst-content .important .last,.rst-content .important>:last-child,.rst-content .note .last,.rst-content .note>:last-child,.rst-content .seealso .last,.rst-content .seealso>:last-child,.rst-content .tip .last,.rst-content .tip>:last-child,.rst-content .warning .last,.rst-content .warning>:last-child{margin-bottom:0}.rst-content .admonition-title:before{margin-right:4px}.rst-content .admonition table{border-color:rgba(0,0,0,.1)}.rst-content .admonition table td,.rst-content .admonition table th{background:transparent!important;border-color:rgba(0,0,0,.1)!important}.rst-content .section ol.loweralpha,.rst-content .section ol.loweralpha>li,.rst-content .toctree-wrapper ol.loweralpha,.rst-content .toctree-wrapper ol.loweralpha>li,.rst-content section ol.loweralpha,.rst-content section ol.loweralpha>li{list-style:lower-alpha}.rst-content .section ol.upperalpha,.rst-content .section ol.upperalpha>li,.rst-content .toctree-wrapper ol.upperalpha,.rst-content .toctree-wrapper ol.upperalpha>li,.rst-content section ol.upperalpha,.rst-content section ol.upperalpha>li{list-style:upper-alpha}.rst-content .section ol li>*,.rst-content .section ul li>*,.rst-content .toctree-wrapper ol li>*,.rst-content .toctree-wrapper ul li>*,.rst-content section ol li>*,.rst-content section ul li>*{margin-top:12px;margin-bottom:12px}.rst-content .section ol li>:first-child,.rst-content .section ul li>:first-child,.rst-content .toctree-wrapper ol li>:first-child,.rst-content .toctree-wrapper ul li>:first-child,.rst-content section ol li>:first-child,.rst-content section ul li>:first-child{margin-top:0}.rst-content .section ol li>p,.rst-content .section ol li>p:last-child,.rst-content .section ul li>p,.rst-content .section ul li>p:last-child,.rst-content .toctree-wrapper ol li>p,.rst-content .toctree-wrapper ol li>p:last-child,.rst-content .toctree-wrapper ul li>p,.rst-content .toctree-wrapper ul li>p:last-child,.rst-content section ol li>p,.rst-content section ol li>p:last-child,.rst-content section ul li>p,.rst-content section ul li>p:last-child{margin-bottom:12px}.rst-content .section ol li>p:only-child,.rst-content .section ol li>p:only-child:last-child,.rst-content .section ul li>p:only-child,.rst-content .section ul li>p:only-child:last-child,.rst-content .toctree-wrapper ol li>p:only-child,.rst-content .toctree-wrapper ol li>p:only-child:last-child,.rst-content .toctree-wrapper ul li>p:only-child,.rst-content .toctree-wrapper ul li>p:only-child:last-child,.rst-content section ol li>p:only-child,.rst-content section ol li>p:only-child:last-child,.rst-content section ul li>p:only-child,.rst-content section ul li>p:only-child:last-child{margin-bottom:0}.rst-content .section ol li>ol,.rst-content .section ol li>ul,.rst-content .section ul li>ol,.rst-content .section ul li>ul,.rst-content .toctree-wrapper ol li>ol,.rst-content .toctree-wrapper ol li>ul,.rst-content .toctree-wrapper ul li>ol,.rst-content .toctree-wrapper ul li>ul,.rst-content section ol li>ol,.rst-content section ol li>ul,.rst-content section ul li>ol,.rst-content section ul li>ul{margin-bottom:12px}.rst-content .section ol.simple li>*,.rst-content .section ol.simple li ol,.rst-content .section ol.simple li ul,.rst-content .section ul.simple li>*,.rst-content .section ul.simple li ol,.rst-content .section ul.simple li ul,.rst-content .toctree-wrapper ol.simple li>*,.rst-content .toctree-wrapper ol.simple li ol,.rst-content .toctree-wrapper ol.simple li ul,.rst-content .toctree-wrapper ul.simple li>*,.rst-content .toctree-wrapper ul.simple li ol,.rst-content .toctree-wrapper ul.simple li ul,.rst-content section ol.simple li>*,.rst-content section ol.simple li ol,.rst-content section ol.simple li ul,.rst-content section ul.simple li>*,.rst-content section ul.simple li ol,.rst-content section ul.simple li ul{margin-top:0;margin-bottom:0}.rst-content .line-block{margin-left:0;margin-bottom:24px;line-height:24px}.rst-content .line-block .line-block{margin-left:24px;margin-bottom:0}.rst-content .topic-title{font-weight:700;margin-bottom:12px}.rst-content .toc-backref{color:#404040}.rst-content .align-right{float:right;margin:0 0 24px 24px}.rst-content .align-left{float:left;margin:0 24px 24px 0}.rst-content .align-center{margin:auto}.rst-content .align-center:not(table){display:block}.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink{opacity:0;font-size:14px;font-family:FontAwesome;margin-left:.5em}.rst-content .code-block-caption .headerlink:focus,.rst-content .code-block-caption:hover .headerlink,.rst-content .eqno .headerlink:focus,.rst-content .eqno:hover .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink:focus,.rst-content .toctree-wrapper>p.caption:hover .headerlink,.rst-content dl dt .headerlink:focus,.rst-content dl dt:hover .headerlink,.rst-content h1 .headerlink:focus,.rst-content h1:hover .headerlink,.rst-content h2 .headerlink:focus,.rst-content h2:hover .headerlink,.rst-content h3 .headerlink:focus,.rst-content h3:hover .headerlink,.rst-content h4 .headerlink:focus,.rst-content h4:hover .headerlink,.rst-content h5 .headerlink:focus,.rst-content h5:hover .headerlink,.rst-content h6 .headerlink:focus,.rst-content h6:hover .headerlink,.rst-content p.caption .headerlink:focus,.rst-content p.caption:hover .headerlink,.rst-content p .headerlink:focus,.rst-content p:hover .headerlink,.rst-content table>caption .headerlink:focus,.rst-content table>caption:hover .headerlink{opacity:1}.rst-content p a{overflow-wrap:anywhere}.rst-content .wy-table td p,.rst-content .wy-table td ul,.rst-content .wy-table th p,.rst-content .wy-table th ul,.rst-content table.docutils td p,.rst-content table.docutils td ul,.rst-content table.docutils th p,.rst-content table.docutils th ul,.rst-content table.field-list td p,.rst-content table.field-list td ul,.rst-content table.field-list th p,.rst-content table.field-list th ul{font-size:inherit}.rst-content .btn:focus{outline:2px solid}.rst-content table>caption .headerlink:after{font-size:12px}.rst-content .centered{text-align:center}.rst-content .sidebar{float:right;width:40%;display:block;margin:0 0 24px 24px;padding:24px;background:#f3f6f6;border:1px solid #e1e4e5}.rst-content .sidebar dl,.rst-content .sidebar p,.rst-content .sidebar ul{font-size:90%}.rst-content .sidebar .last,.rst-content .sidebar>:last-child{margin-bottom:0}.rst-content .sidebar .sidebar-title{display:block;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif;font-weight:700;background:#e1e4e5;padding:6px 12px;margin:-24px -24px 24px;font-size:100%}.rst-content .highlighted{background:#f1c40f;box-shadow:0 0 0 2px #f1c40f;display:inline;font-weight:700}.rst-content .citation-reference,.rst-content .footnote-reference{vertical-align:baseline;position:relative;top:-.4em;line-height:0;font-size:90%}.rst-content .citation-reference>span.fn-bracket,.rst-content .footnote-reference>span.fn-bracket{display:none}.rst-content .hlist{width:100%}.rst-content dl dt span.classifier:before{content:" : "}.rst-content dl dt span.classifier-delimiter{display:none!important}html.writer-html4 .rst-content table.docutils.citation,html.writer-html4 .rst-content table.docutils.footnote{background:none;border:none}html.writer-html4 .rst-content table.docutils.citation td,html.writer-html4 .rst-content table.docutils.citation tr,html.writer-html4 .rst-content table.docutils.footnote td,html.writer-html4 .rst-content table.docutils.footnote tr{border:none;background-color:transparent!important;white-space:normal}html.writer-html4 .rst-content table.docutils.citation td.label,html.writer-html4 .rst-content table.docutils.footnote td.label{padding-left:0;padding-right:0;vertical-align:top}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.field-list,html.writer-html5 .rst-content dl.footnote{display:grid;grid-template-columns:auto minmax(80%,95%)}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dt{display:inline-grid;grid-template-columns:max-content auto}html.writer-html5 .rst-content aside.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content div.citation{display:grid;grid-template-columns:auto auto minmax(.65rem,auto) minmax(40%,95%)}html.writer-html5 .rst-content aside.citation>span.label,html.writer-html5 .rst-content aside.footnote>span.label,html.writer-html5 .rst-content div.citation>span.label{grid-column-start:1;grid-column-end:2}html.writer-html5 .rst-content aside.citation>span.backrefs,html.writer-html5 .rst-content aside.footnote>span.backrefs,html.writer-html5 .rst-content div.citation>span.backrefs{grid-column-start:2;grid-column-end:3;grid-row-start:1;grid-row-end:3}html.writer-html5 .rst-content aside.citation>p,html.writer-html5 .rst-content aside.footnote>p,html.writer-html5 .rst-content div.citation>p{grid-column-start:4;grid-column-end:5}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.field-list,html.writer-html5 .rst-content dl.footnote{margin-bottom:24px}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dt{padding-left:1rem}html.writer-html5 .rst-content dl.citation>dd,html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dd,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dd,html.writer-html5 .rst-content dl.footnote>dt{margin-bottom:0}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.footnote{font-size:.9rem}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.footnote>dt{margin:0 .5rem .5rem 0;line-height:1.2rem;word-break:break-all;font-weight:400}html.writer-html5 .rst-content dl.citation>dt>span.brackets:before,html.writer-html5 .rst-content dl.footnote>dt>span.brackets:before{content:"["}html.writer-html5 .rst-content dl.citation>dt>span.brackets:after,html.writer-html5 .rst-content dl.footnote>dt>span.brackets:after{content:"]"}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref{text-align:left;font-style:italic;margin-left:.65rem;word-break:break-word;word-spacing:-.1rem;max-width:5rem}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref>a,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref>a{word-break:keep-all}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref>a:not(:first-child):before,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref>a:not(:first-child):before{content:" "}html.writer-html5 .rst-content dl.citation>dd,html.writer-html5 .rst-content dl.footnote>dd{margin:0 0 .5rem;line-height:1.2rem}html.writer-html5 .rst-content dl.citation>dd p,html.writer-html5 .rst-content dl.footnote>dd p{font-size:.9rem}html.writer-html5 .rst-content aside.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content div.citation{padding-left:1rem;padding-right:1rem;font-size:.9rem;line-height:1.2rem}html.writer-html5 .rst-content aside.citation p,html.writer-html5 .rst-content aside.footnote p,html.writer-html5 .rst-content div.citation p{font-size:.9rem;line-height:1.2rem;margin-bottom:12px}html.writer-html5 .rst-content aside.citation span.backrefs,html.writer-html5 .rst-content aside.footnote span.backrefs,html.writer-html5 .rst-content div.citation span.backrefs{text-align:left;font-style:italic;margin-left:.65rem;word-break:break-word;word-spacing:-.1rem;max-width:5rem}html.writer-html5 .rst-content aside.citation span.backrefs>a,html.writer-html5 .rst-content aside.footnote span.backrefs>a,html.writer-html5 .rst-content div.citation span.backrefs>a{word-break:keep-all}html.writer-html5 .rst-content aside.citation span.backrefs>a:not(:first-child):before,html.writer-html5 .rst-content aside.footnote span.backrefs>a:not(:first-child):before,html.writer-html5 .rst-content div.citation span.backrefs>a:not(:first-child):before{content:" "}html.writer-html5 .rst-content aside.citation span.label,html.writer-html5 .rst-content aside.footnote span.label,html.writer-html5 .rst-content div.citation span.label{line-height:1.2rem}html.writer-html5 .rst-content aside.citation-list,html.writer-html5 .rst-content aside.footnote-list,html.writer-html5 .rst-content div.citation-list{margin-bottom:24px}html.writer-html5 .rst-content dl.option-list kbd{font-size:.9rem}.rst-content table.docutils.footnote,html.writer-html4 .rst-content table.docutils.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content aside.footnote-list aside.footnote,html.writer-html5 .rst-content div.citation-list>div.citation,html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.footnote{color:grey}.rst-content table.docutils.footnote code,.rst-content table.docutils.footnote tt,html.writer-html4 .rst-content table.docutils.citation code,html.writer-html4 .rst-content table.docutils.citation tt,html.writer-html5 .rst-content aside.footnote-list aside.footnote code,html.writer-html5 .rst-content aside.footnote-list aside.footnote tt,html.writer-html5 .rst-content aside.footnote code,html.writer-html5 .rst-content aside.footnote tt,html.writer-html5 .rst-content div.citation-list>div.citation code,html.writer-html5 .rst-content div.citation-list>div.citation tt,html.writer-html5 .rst-content dl.citation code,html.writer-html5 .rst-content dl.citation tt,html.writer-html5 .rst-content dl.footnote code,html.writer-html5 .rst-content dl.footnote tt{color:#555}.rst-content .wy-table-responsive.citation,.rst-content .wy-table-responsive.footnote{margin-bottom:0}.rst-content .wy-table-responsive.citation+:not(.citation),.rst-content .wy-table-responsive.footnote+:not(.footnote){margin-top:24px}.rst-content .wy-table-responsive.citation:last-child,.rst-content .wy-table-responsive.footnote:last-child{margin-bottom:24px}.rst-content table.docutils th{border-color:#e1e4e5}html.writer-html5 .rst-content table.docutils th{border:1px solid #e1e4e5}html.writer-html5 .rst-content table.docutils td>p,html.writer-html5 .rst-content table.docutils th>p{line-height:1rem;margin-bottom:0;font-size:.9rem}.rst-content table.docutils td .last,.rst-content table.docutils td .last>:last-child{margin-bottom:0}.rst-content table.field-list,.rst-content table.field-list td{border:none}.rst-content table.field-list td p{line-height:inherit}.rst-content table.field-list td>strong{display:inline-block}.rst-content table.field-list .field-name{padding-right:10px;text-align:left;white-space:nowrap}.rst-content table.field-list .field-body{text-align:left}.rst-content code,.rst-content tt{color:#000;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;padding:2px 5px}.rst-content code big,.rst-content code em,.rst-content tt big,.rst-content tt em{font-size:100%!important;line-height:normal}.rst-content code.literal,.rst-content tt.literal{color:#e74c3c;white-space:normal}.rst-content code.xref,.rst-content tt.xref,a .rst-content code,a .rst-content tt{font-weight:700;color:#404040;overflow-wrap:normal}.rst-content kbd,.rst-content pre,.rst-content samp{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace}.rst-content a code,.rst-content a tt{color:#2980b9}.rst-content dl{margin-bottom:24px}.rst-content dl dt{font-weight:700;margin-bottom:12px}.rst-content dl ol,.rst-content dl p,.rst-content dl table,.rst-content dl ul{margin-bottom:12px}.rst-content dl dd{margin:0 0 12px 24px;line-height:24px}.rst-content dl dd>ol:last-child,.rst-content dl dd>p:last-child,.rst-content dl dd>table:last-child,.rst-content dl dd>ul:last-child{margin-bottom:0}html.writer-html4 .rst-content dl:not(.docutils),html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple){margin-bottom:24px}html.writer-html4 .rst-content dl:not(.docutils)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt{display:table;margin:6px 0;font-size:90%;line-height:normal;background:#e7f2fa;color:#2980b9;border-top:3px solid #6ab0de;padding:6px;position:relative}html.writer-html4 .rst-content dl:not(.docutils)>dt:before,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt:before{color:#6ab0de}html.writer-html4 .rst-content dl:not(.docutils)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt{margin-bottom:6px;border:none;border-left:3px solid #ccc;background:#f0f0f0;color:#555}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils)>dt:first-child,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt:first-child{margin-top:0}html.writer-html4 .rst-content dl:not(.docutils) code.descclassname,html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descclassname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descname{background-color:transparent;border:none;padding:0;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descname{font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .optional,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .optional{display:inline-block;padding:0 4px;color:#000;font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .property,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .property{display:inline-block;padding-right:8px;max-width:100%}html.writer-html4 .rst-content dl:not(.docutils) .k,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .k{font-style:italic}html.writer-html4 .rst-content dl:not(.docutils) .descclassname,html.writer-html4 .rst-content dl:not(.docutils) .descname,html.writer-html4 .rst-content dl:not(.docutils) .sig-name,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .sig-name{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;color:#000}.rst-content .viewcode-back,.rst-content .viewcode-link{display:inline-block;color:#27ae60;font-size:80%;padding-left:24px}.rst-content .viewcode-back{display:block;float:right}.rst-content p.rubric{margin-bottom:12px;font-weight:700}.rst-content code.download,.rst-content tt.download{background:inherit;padding:inherit;font-weight:400;font-family:inherit;font-size:inherit;color:inherit;border:inherit;white-space:inherit}.rst-content code.download span:first-child,.rst-content tt.download span:first-child{-webkit-font-smoothing:subpixel-antialiased}.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{margin-right:4px}.rst-content .guilabel{border:1px solid #7fbbe3;background:#e7f2fa;font-size:80%;font-weight:700;border-radius:4px;padding:2.4px 6px;margin:auto 2px}.rst-content :not(dl.option-list)>:not(dt):not(kbd):not(.kbd)>.kbd,.rst-content :not(dl.option-list)>:not(dt):not(kbd):not(.kbd)>kbd{color:inherit;font-size:80%;background-color:#fff;border:1px solid #a6a6a6;border-radius:4px;box-shadow:0 2px grey;padding:2.4px 6px;margin:auto 0}.rst-content .versionmodified{font-style:italic}@media screen and (max-width:480px){.rst-content .sidebar{width:100%}}span[id*=MathJax-Span]{color:#404040}.math{text-align:center}@font-face{font-family:Lato;src:url(fonts/lato-normal.woff2?bd03a2cc277bbbc338d464e679fe9942) format("woff2"),url(fonts/lato-normal.woff?27bd77b9162d388cb8d4c4217c7c5e2a) format("woff");font-weight:400;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold.woff2?cccb897485813c7c256901dbca54ecf2) format("woff2"),url(fonts/lato-bold.woff?d878b6c29b10beca227e9eef4246111b) format("woff");font-weight:700;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold-italic.woff2?0b6bb6725576b072c5d0b02ecdd1900d) format("woff2"),url(fonts/lato-bold-italic.woff?9c7e4e9eb485b4a121c760e61bc3707c) format("woff");font-weight:700;font-style:italic;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-normal-italic.woff2?4eb103b4d12be57cb1d040ed5e162e9d) format("woff2"),url(fonts/lato-normal-italic.woff?f28f2d6482446544ef1ea1ccc6dd5892) format("woff");font-weight:400;font-style:italic;font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:400;src:url(fonts/Roboto-Slab-Regular.woff2?7abf5b8d04d26a2cafea937019bca958) format("woff2"),url(fonts/Roboto-Slab-Regular.woff?c1be9284088d487c5e3ff0a10a92e58c) format("woff");font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:700;src:url(fonts/Roboto-Slab-Bold.woff2?9984f4a9bda09be08e83f2506954adbe) format("woff2"),url(fonts/Roboto-Slab-Bold.woff?bed5564a116b05148e3b3bea6fb1162a) format("woff");font-display:block} \ No newline at end of file diff --git a/docs/build/html/_static/doctools.js b/docs/build/html/_static/doctools.js deleted file mode 100644 index d06a71d7..00000000 --- a/docs/build/html/_static/doctools.js +++ /dev/null @@ -1,156 +0,0 @@ -/* - * doctools.js - * ~~~~~~~~~~~ - * - * Base JavaScript utilities for all Sphinx HTML documentation. - * - * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. - * :license: BSD, see LICENSE for details. - * - */ -"use strict"; - -const BLACKLISTED_KEY_CONTROL_ELEMENTS = new Set([ - "TEXTAREA", - "INPUT", - "SELECT", - "BUTTON", -]); - -const _ready = (callback) => { - if (document.readyState !== "loading") { - callback(); - } else { - document.addEventListener("DOMContentLoaded", callback); - } -}; - -/** - * Small JavaScript module for the documentation. - */ -const Documentation = { - init: () => { - Documentation.initDomainIndexTable(); - Documentation.initOnKeyListeners(); - }, - - /** - * i18n support - */ - TRANSLATIONS: {}, - PLURAL_EXPR: (n) => (n === 1 ? 0 : 1), - LOCALE: "unknown", - - // gettext and ngettext don't access this so that the functions - // can safely bound to a different name (_ = Documentation.gettext) - gettext: (string) => { - const translated = Documentation.TRANSLATIONS[string]; - switch (typeof translated) { - case "undefined": - return string; // no translation - case "string": - return translated; // translation exists - default: - return translated[0]; // (singular, plural) translation tuple exists - } - }, - - ngettext: (singular, plural, n) => { - const translated = Documentation.TRANSLATIONS[singular]; - if (typeof translated !== "undefined") - return translated[Documentation.PLURAL_EXPR(n)]; - return n === 1 ? singular : plural; - }, - - addTranslations: (catalog) => { - Object.assign(Documentation.TRANSLATIONS, catalog.messages); - Documentation.PLURAL_EXPR = new Function( - "n", - `return (${catalog.plural_expr})` - ); - Documentation.LOCALE = catalog.locale; - }, - - /** - * helper function to focus on search bar - */ - focusSearchBar: () => { - document.querySelectorAll("input[name=q]")[0]?.focus(); - }, - - /** - * Initialise the domain index toggle buttons - */ - initDomainIndexTable: () => { - const toggler = (el) => { - const idNumber = el.id.substr(7); - const toggledRows = document.querySelectorAll(`tr.cg-${idNumber}`); - if (el.src.substr(-9) === "minus.png") { - el.src = `${el.src.substr(0, el.src.length - 9)}plus.png`; - toggledRows.forEach((el) => (el.style.display = "none")); - } else { - el.src = `${el.src.substr(0, el.src.length - 8)}minus.png`; - toggledRows.forEach((el) => (el.style.display = "")); - } - }; - - const togglerElements = document.querySelectorAll("img.toggler"); - togglerElements.forEach((el) => - el.addEventListener("click", (event) => toggler(event.currentTarget)) - ); - togglerElements.forEach((el) => (el.style.display = "")); - if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) togglerElements.forEach(toggler); - }, - - initOnKeyListeners: () => { - // only install a listener if it is really needed - if ( - !DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS && - !DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS - ) - return; - - document.addEventListener("keydown", (event) => { - // bail for input elements - if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return; - // bail with special keys - if (event.altKey || event.ctrlKey || event.metaKey) return; - - if (!event.shiftKey) { - switch (event.key) { - case "ArrowLeft": - if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; - - const prevLink = document.querySelector('link[rel="prev"]'); - if (prevLink && prevLink.href) { - window.location.href = prevLink.href; - event.preventDefault(); - } - break; - case "ArrowRight": - if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; - - const nextLink = document.querySelector('link[rel="next"]'); - if (nextLink && nextLink.href) { - window.location.href = nextLink.href; - event.preventDefault(); - } - break; - } - } - - // some keyboard layouts may need Shift to get / - switch (event.key) { - case "/": - if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) break; - Documentation.focusSearchBar(); - event.preventDefault(); - } - }); - }, -}; - -// quick alias for translations -const _ = Documentation.gettext; - -_ready(Documentation.init); diff --git a/docs/build/html/_static/documentation_options.js b/docs/build/html/_static/documentation_options.js deleted file mode 100644 index b57ae3b8..00000000 --- a/docs/build/html/_static/documentation_options.js +++ /dev/null @@ -1,14 +0,0 @@ -var DOCUMENTATION_OPTIONS = { - URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), - VERSION: '', - LANGUAGE: 'en', - COLLAPSE_INDEX: false, - BUILDER: 'html', - FILE_SUFFIX: '.html', - LINK_SUFFIX: '.html', - HAS_SOURCE: true, - SOURCELINK_SUFFIX: '.txt', - NAVIGATION_WITH_KEYS: false, - SHOW_SEARCH_SUMMARY: true, - ENABLE_SEARCH_SHORTCUTS: true, -}; \ No newline at end of file diff --git a/docs/build/html/_static/file.png b/docs/build/html/_static/file.png deleted file mode 100644 index a858a410..00000000 Binary files a/docs/build/html/_static/file.png and /dev/null differ diff --git a/docs/build/html/_static/jquery.js b/docs/build/html/_static/jquery.js deleted file mode 100644 index c4c6022f..00000000 --- a/docs/build/html/_static/jquery.js +++ /dev/null @@ -1,2 +0,0 @@ -/*! jQuery v3.6.0 | (c) OpenJS Foundation and other contributors | jquery.org/license */ -!function(e,t){"use strict";"object"==typeof module&&"object"==typeof module.exports?module.exports=e.document?t(e,!0):function(e){if(!e.document)throw new Error("jQuery requires a window with a document");return t(e)}:t(e)}("undefined"!=typeof window?window:this,function(C,e){"use strict";var t=[],r=Object.getPrototypeOf,s=t.slice,g=t.flat?function(e){return t.flat.call(e)}:function(e){return t.concat.apply([],e)},u=t.push,i=t.indexOf,n={},o=n.toString,v=n.hasOwnProperty,a=v.toString,l=a.call(Object),y={},m=function(e){return"function"==typeof e&&"number"!=typeof e.nodeType&&"function"!=typeof e.item},x=function(e){return null!=e&&e===e.window},E=C.document,c={type:!0,src:!0,nonce:!0,noModule:!0};function b(e,t,n){var r,i,o=(n=n||E).createElement("script");if(o.text=e,t)for(r in c)(i=t[r]||t.getAttribute&&t.getAttribute(r))&&o.setAttribute(r,i);n.head.appendChild(o).parentNode.removeChild(o)}function w(e){return null==e?e+"":"object"==typeof e||"function"==typeof e?n[o.call(e)]||"object":typeof e}var f="3.6.0",S=function(e,t){return new S.fn.init(e,t)};function p(e){var t=!!e&&"length"in e&&e.length,n=w(e);return!m(e)&&!x(e)&&("array"===n||0===t||"number"==typeof t&&0+~]|"+M+")"+M+"*"),U=new RegExp(M+"|>"),X=new RegExp(F),V=new RegExp("^"+I+"$"),G={ID:new RegExp("^#("+I+")"),CLASS:new RegExp("^\\.("+I+")"),TAG:new RegExp("^("+I+"|[*])"),ATTR:new RegExp("^"+W),PSEUDO:new RegExp("^"+F),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+M+"*(even|odd|(([+-]|)(\\d*)n|)"+M+"*(?:([+-]|)"+M+"*(\\d+)|))"+M+"*\\)|)","i"),bool:new RegExp("^(?:"+R+")$","i"),needsContext:new RegExp("^"+M+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+M+"*((?:-\\d)?\\d*)"+M+"*\\)|)(?=[^-]|$)","i")},Y=/HTML$/i,Q=/^(?:input|select|textarea|button)$/i,J=/^h\d$/i,K=/^[^{]+\{\s*\[native \w/,Z=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,ee=/[+~]/,te=new RegExp("\\\\[\\da-fA-F]{1,6}"+M+"?|\\\\([^\\r\\n\\f])","g"),ne=function(e,t){var n="0x"+e.slice(1)-65536;return t||(n<0?String.fromCharCode(n+65536):String.fromCharCode(n>>10|55296,1023&n|56320))},re=/([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g,ie=function(e,t){return t?"\0"===e?"\ufffd":e.slice(0,-1)+"\\"+e.charCodeAt(e.length-1).toString(16)+" ":"\\"+e},oe=function(){T()},ae=be(function(e){return!0===e.disabled&&"fieldset"===e.nodeName.toLowerCase()},{dir:"parentNode",next:"legend"});try{H.apply(t=O.call(p.childNodes),p.childNodes),t[p.childNodes.length].nodeType}catch(e){H={apply:t.length?function(e,t){L.apply(e,O.call(t))}:function(e,t){var n=e.length,r=0;while(e[n++]=t[r++]);e.length=n-1}}}function se(t,e,n,r){var i,o,a,s,u,l,c,f=e&&e.ownerDocument,p=e?e.nodeType:9;if(n=n||[],"string"!=typeof t||!t||1!==p&&9!==p&&11!==p)return n;if(!r&&(T(e),e=e||C,E)){if(11!==p&&(u=Z.exec(t)))if(i=u[1]){if(9===p){if(!(a=e.getElementById(i)))return n;if(a.id===i)return n.push(a),n}else if(f&&(a=f.getElementById(i))&&y(e,a)&&a.id===i)return n.push(a),n}else{if(u[2])return H.apply(n,e.getElementsByTagName(t)),n;if((i=u[3])&&d.getElementsByClassName&&e.getElementsByClassName)return H.apply(n,e.getElementsByClassName(i)),n}if(d.qsa&&!N[t+" "]&&(!v||!v.test(t))&&(1!==p||"object"!==e.nodeName.toLowerCase())){if(c=t,f=e,1===p&&(U.test(t)||z.test(t))){(f=ee.test(t)&&ye(e.parentNode)||e)===e&&d.scope||((s=e.getAttribute("id"))?s=s.replace(re,ie):e.setAttribute("id",s=S)),o=(l=h(t)).length;while(o--)l[o]=(s?"#"+s:":scope")+" "+xe(l[o]);c=l.join(",")}try{return H.apply(n,f.querySelectorAll(c)),n}catch(e){N(t,!0)}finally{s===S&&e.removeAttribute("id")}}}return g(t.replace($,"$1"),e,n,r)}function ue(){var r=[];return function e(t,n){return r.push(t+" ")>b.cacheLength&&delete e[r.shift()],e[t+" "]=n}}function le(e){return e[S]=!0,e}function ce(e){var t=C.createElement("fieldset");try{return!!e(t)}catch(e){return!1}finally{t.parentNode&&t.parentNode.removeChild(t),t=null}}function fe(e,t){var n=e.split("|"),r=n.length;while(r--)b.attrHandle[n[r]]=t}function pe(e,t){var n=t&&e,r=n&&1===e.nodeType&&1===t.nodeType&&e.sourceIndex-t.sourceIndex;if(r)return r;if(n)while(n=n.nextSibling)if(n===t)return-1;return e?1:-1}function de(t){return function(e){return"input"===e.nodeName.toLowerCase()&&e.type===t}}function he(n){return function(e){var t=e.nodeName.toLowerCase();return("input"===t||"button"===t)&&e.type===n}}function ge(t){return function(e){return"form"in e?e.parentNode&&!1===e.disabled?"label"in e?"label"in e.parentNode?e.parentNode.disabled===t:e.disabled===t:e.isDisabled===t||e.isDisabled!==!t&&ae(e)===t:e.disabled===t:"label"in e&&e.disabled===t}}function ve(a){return le(function(o){return o=+o,le(function(e,t){var n,r=a([],e.length,o),i=r.length;while(i--)e[n=r[i]]&&(e[n]=!(t[n]=e[n]))})})}function ye(e){return e&&"undefined"!=typeof e.getElementsByTagName&&e}for(e in d=se.support={},i=se.isXML=function(e){var t=e&&e.namespaceURI,n=e&&(e.ownerDocument||e).documentElement;return!Y.test(t||n&&n.nodeName||"HTML")},T=se.setDocument=function(e){var t,n,r=e?e.ownerDocument||e:p;return r!=C&&9===r.nodeType&&r.documentElement&&(a=(C=r).documentElement,E=!i(C),p!=C&&(n=C.defaultView)&&n.top!==n&&(n.addEventListener?n.addEventListener("unload",oe,!1):n.attachEvent&&n.attachEvent("onunload",oe)),d.scope=ce(function(e){return a.appendChild(e).appendChild(C.createElement("div")),"undefined"!=typeof e.querySelectorAll&&!e.querySelectorAll(":scope fieldset div").length}),d.attributes=ce(function(e){return e.className="i",!e.getAttribute("className")}),d.getElementsByTagName=ce(function(e){return e.appendChild(C.createComment("")),!e.getElementsByTagName("*").length}),d.getElementsByClassName=K.test(C.getElementsByClassName),d.getById=ce(function(e){return a.appendChild(e).id=S,!C.getElementsByName||!C.getElementsByName(S).length}),d.getById?(b.filter.ID=function(e){var t=e.replace(te,ne);return function(e){return e.getAttribute("id")===t}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n=t.getElementById(e);return n?[n]:[]}}):(b.filter.ID=function(e){var n=e.replace(te,ne);return function(e){var t="undefined"!=typeof e.getAttributeNode&&e.getAttributeNode("id");return t&&t.value===n}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n,r,i,o=t.getElementById(e);if(o){if((n=o.getAttributeNode("id"))&&n.value===e)return[o];i=t.getElementsByName(e),r=0;while(o=i[r++])if((n=o.getAttributeNode("id"))&&n.value===e)return[o]}return[]}}),b.find.TAG=d.getElementsByTagName?function(e,t){return"undefined"!=typeof t.getElementsByTagName?t.getElementsByTagName(e):d.qsa?t.querySelectorAll(e):void 0}:function(e,t){var n,r=[],i=0,o=t.getElementsByTagName(e);if("*"===e){while(n=o[i++])1===n.nodeType&&r.push(n);return r}return o},b.find.CLASS=d.getElementsByClassName&&function(e,t){if("undefined"!=typeof t.getElementsByClassName&&E)return t.getElementsByClassName(e)},s=[],v=[],(d.qsa=K.test(C.querySelectorAll))&&(ce(function(e){var t;a.appendChild(e).innerHTML="",e.querySelectorAll("[msallowcapture^='']").length&&v.push("[*^$]="+M+"*(?:''|\"\")"),e.querySelectorAll("[selected]").length||v.push("\\["+M+"*(?:value|"+R+")"),e.querySelectorAll("[id~="+S+"-]").length||v.push("~="),(t=C.createElement("input")).setAttribute("name",""),e.appendChild(t),e.querySelectorAll("[name='']").length||v.push("\\["+M+"*name"+M+"*="+M+"*(?:''|\"\")"),e.querySelectorAll(":checked").length||v.push(":checked"),e.querySelectorAll("a#"+S+"+*").length||v.push(".#.+[+~]"),e.querySelectorAll("\\\f"),v.push("[\\r\\n\\f]")}),ce(function(e){e.innerHTML="";var t=C.createElement("input");t.setAttribute("type","hidden"),e.appendChild(t).setAttribute("name","D"),e.querySelectorAll("[name=d]").length&&v.push("name"+M+"*[*^$|!~]?="),2!==e.querySelectorAll(":enabled").length&&v.push(":enabled",":disabled"),a.appendChild(e).disabled=!0,2!==e.querySelectorAll(":disabled").length&&v.push(":enabled",":disabled"),e.querySelectorAll("*,:x"),v.push(",.*:")})),(d.matchesSelector=K.test(c=a.matches||a.webkitMatchesSelector||a.mozMatchesSelector||a.oMatchesSelector||a.msMatchesSelector))&&ce(function(e){d.disconnectedMatch=c.call(e,"*"),c.call(e,"[s!='']:x"),s.push("!=",F)}),v=v.length&&new RegExp(v.join("|")),s=s.length&&new RegExp(s.join("|")),t=K.test(a.compareDocumentPosition),y=t||K.test(a.contains)?function(e,t){var n=9===e.nodeType?e.documentElement:e,r=t&&t.parentNode;return e===r||!(!r||1!==r.nodeType||!(n.contains?n.contains(r):e.compareDocumentPosition&&16&e.compareDocumentPosition(r)))}:function(e,t){if(t)while(t=t.parentNode)if(t===e)return!0;return!1},j=t?function(e,t){if(e===t)return l=!0,0;var n=!e.compareDocumentPosition-!t.compareDocumentPosition;return n||(1&(n=(e.ownerDocument||e)==(t.ownerDocument||t)?e.compareDocumentPosition(t):1)||!d.sortDetached&&t.compareDocumentPosition(e)===n?e==C||e.ownerDocument==p&&y(p,e)?-1:t==C||t.ownerDocument==p&&y(p,t)?1:u?P(u,e)-P(u,t):0:4&n?-1:1)}:function(e,t){if(e===t)return l=!0,0;var n,r=0,i=e.parentNode,o=t.parentNode,a=[e],s=[t];if(!i||!o)return e==C?-1:t==C?1:i?-1:o?1:u?P(u,e)-P(u,t):0;if(i===o)return pe(e,t);n=e;while(n=n.parentNode)a.unshift(n);n=t;while(n=n.parentNode)s.unshift(n);while(a[r]===s[r])r++;return r?pe(a[r],s[r]):a[r]==p?-1:s[r]==p?1:0}),C},se.matches=function(e,t){return se(e,null,null,t)},se.matchesSelector=function(e,t){if(T(e),d.matchesSelector&&E&&!N[t+" "]&&(!s||!s.test(t))&&(!v||!v.test(t)))try{var n=c.call(e,t);if(n||d.disconnectedMatch||e.document&&11!==e.document.nodeType)return n}catch(e){N(t,!0)}return 0":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(e){return e[1]=e[1].replace(te,ne),e[3]=(e[3]||e[4]||e[5]||"").replace(te,ne),"~="===e[2]&&(e[3]=" "+e[3]+" "),e.slice(0,4)},CHILD:function(e){return e[1]=e[1].toLowerCase(),"nth"===e[1].slice(0,3)?(e[3]||se.error(e[0]),e[4]=+(e[4]?e[5]+(e[6]||1):2*("even"===e[3]||"odd"===e[3])),e[5]=+(e[7]+e[8]||"odd"===e[3])):e[3]&&se.error(e[0]),e},PSEUDO:function(e){var t,n=!e[6]&&e[2];return G.CHILD.test(e[0])?null:(e[3]?e[2]=e[4]||e[5]||"":n&&X.test(n)&&(t=h(n,!0))&&(t=n.indexOf(")",n.length-t)-n.length)&&(e[0]=e[0].slice(0,t),e[2]=n.slice(0,t)),e.slice(0,3))}},filter:{TAG:function(e){var t=e.replace(te,ne).toLowerCase();return"*"===e?function(){return!0}:function(e){return e.nodeName&&e.nodeName.toLowerCase()===t}},CLASS:function(e){var t=m[e+" "];return t||(t=new RegExp("(^|"+M+")"+e+"("+M+"|$)"))&&m(e,function(e){return t.test("string"==typeof e.className&&e.className||"undefined"!=typeof e.getAttribute&&e.getAttribute("class")||"")})},ATTR:function(n,r,i){return function(e){var t=se.attr(e,n);return null==t?"!="===r:!r||(t+="","="===r?t===i:"!="===r?t!==i:"^="===r?i&&0===t.indexOf(i):"*="===r?i&&-1:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i;function j(e,n,r){return m(n)?S.grep(e,function(e,t){return!!n.call(e,t,e)!==r}):n.nodeType?S.grep(e,function(e){return e===n!==r}):"string"!=typeof n?S.grep(e,function(e){return-1)[^>]*|#([\w-]+))$/;(S.fn.init=function(e,t,n){var r,i;if(!e)return this;if(n=n||D,"string"==typeof e){if(!(r="<"===e[0]&&">"===e[e.length-1]&&3<=e.length?[null,e,null]:q.exec(e))||!r[1]&&t)return!t||t.jquery?(t||n).find(e):this.constructor(t).find(e);if(r[1]){if(t=t instanceof S?t[0]:t,S.merge(this,S.parseHTML(r[1],t&&t.nodeType?t.ownerDocument||t:E,!0)),N.test(r[1])&&S.isPlainObject(t))for(r in t)m(this[r])?this[r](t[r]):this.attr(r,t[r]);return this}return(i=E.getElementById(r[2]))&&(this[0]=i,this.length=1),this}return e.nodeType?(this[0]=e,this.length=1,this):m(e)?void 0!==n.ready?n.ready(e):e(S):S.makeArray(e,this)}).prototype=S.fn,D=S(E);var L=/^(?:parents|prev(?:Until|All))/,H={children:!0,contents:!0,next:!0,prev:!0};function O(e,t){while((e=e[t])&&1!==e.nodeType);return e}S.fn.extend({has:function(e){var t=S(e,this),n=t.length;return this.filter(function(){for(var e=0;e\x20\t\r\n\f]*)/i,he=/^$|^module$|\/(?:java|ecma)script/i;ce=E.createDocumentFragment().appendChild(E.createElement("div")),(fe=E.createElement("input")).setAttribute("type","radio"),fe.setAttribute("checked","checked"),fe.setAttribute("name","t"),ce.appendChild(fe),y.checkClone=ce.cloneNode(!0).cloneNode(!0).lastChild.checked,ce.innerHTML="",y.noCloneChecked=!!ce.cloneNode(!0).lastChild.defaultValue,ce.innerHTML="",y.option=!!ce.lastChild;var ge={thead:[1,"","
"],col:[2,"","
"],tr:[2,"","
"],td:[3,"","
"],_default:[0,"",""]};function ve(e,t){var n;return n="undefined"!=typeof e.getElementsByTagName?e.getElementsByTagName(t||"*"):"undefined"!=typeof e.querySelectorAll?e.querySelectorAll(t||"*"):[],void 0===t||t&&A(e,t)?S.merge([e],n):n}function ye(e,t){for(var n=0,r=e.length;n",""]);var me=/<|&#?\w+;/;function xe(e,t,n,r,i){for(var o,a,s,u,l,c,f=t.createDocumentFragment(),p=[],d=0,h=e.length;d\s*$/g;function je(e,t){return A(e,"table")&&A(11!==t.nodeType?t:t.firstChild,"tr")&&S(e).children("tbody")[0]||e}function De(e){return e.type=(null!==e.getAttribute("type"))+"/"+e.type,e}function qe(e){return"true/"===(e.type||"").slice(0,5)?e.type=e.type.slice(5):e.removeAttribute("type"),e}function Le(e,t){var n,r,i,o,a,s;if(1===t.nodeType){if(Y.hasData(e)&&(s=Y.get(e).events))for(i in Y.remove(t,"handle events"),s)for(n=0,r=s[i].length;n").attr(n.scriptAttrs||{}).prop({charset:n.scriptCharset,src:n.url}).on("load error",i=function(e){r.remove(),i=null,e&&t("error"===e.type?404:200,e.type)}),E.head.appendChild(r[0])},abort:function(){i&&i()}}});var _t,zt=[],Ut=/(=)\?(?=&|$)|\?\?/;S.ajaxSetup({jsonp:"callback",jsonpCallback:function(){var e=zt.pop()||S.expando+"_"+wt.guid++;return this[e]=!0,e}}),S.ajaxPrefilter("json jsonp",function(e,t,n){var r,i,o,a=!1!==e.jsonp&&(Ut.test(e.url)?"url":"string"==typeof e.data&&0===(e.contentType||"").indexOf("application/x-www-form-urlencoded")&&Ut.test(e.data)&&"data");if(a||"jsonp"===e.dataTypes[0])return r=e.jsonpCallback=m(e.jsonpCallback)?e.jsonpCallback():e.jsonpCallback,a?e[a]=e[a].replace(Ut,"$1"+r):!1!==e.jsonp&&(e.url+=(Tt.test(e.url)?"&":"?")+e.jsonp+"="+r),e.converters["script json"]=function(){return o||S.error(r+" was not called"),o[0]},e.dataTypes[0]="json",i=C[r],C[r]=function(){o=arguments},n.always(function(){void 0===i?S(C).removeProp(r):C[r]=i,e[r]&&(e.jsonpCallback=t.jsonpCallback,zt.push(r)),o&&m(i)&&i(o[0]),o=i=void 0}),"script"}),y.createHTMLDocument=((_t=E.implementation.createHTMLDocument("").body).innerHTML="
",2===_t.childNodes.length),S.parseHTML=function(e,t,n){return"string"!=typeof e?[]:("boolean"==typeof t&&(n=t,t=!1),t||(y.createHTMLDocument?((r=(t=E.implementation.createHTMLDocument("")).createElement("base")).href=E.location.href,t.head.appendChild(r)):t=E),o=!n&&[],(i=N.exec(e))?[t.createElement(i[1])]:(i=xe([e],t,o),o&&o.length&&S(o).remove(),S.merge([],i.childNodes)));var r,i,o},S.fn.load=function(e,t,n){var r,i,o,a=this,s=e.indexOf(" ");return-1").append(S.parseHTML(e)).find(r):e)}).always(n&&function(e,t){a.each(function(){n.apply(this,o||[e.responseText,t,e])})}),this},S.expr.pseudos.animated=function(t){return S.grep(S.timers,function(e){return t===e.elem}).length},S.offset={setOffset:function(e,t,n){var r,i,o,a,s,u,l=S.css(e,"position"),c=S(e),f={};"static"===l&&(e.style.position="relative"),s=c.offset(),o=S.css(e,"top"),u=S.css(e,"left"),("absolute"===l||"fixed"===l)&&-1<(o+u).indexOf("auto")?(a=(r=c.position()).top,i=r.left):(a=parseFloat(o)||0,i=parseFloat(u)||0),m(t)&&(t=t.call(e,n,S.extend({},s))),null!=t.top&&(f.top=t.top-s.top+a),null!=t.left&&(f.left=t.left-s.left+i),"using"in t?t.using.call(e,f):c.css(f)}},S.fn.extend({offset:function(t){if(arguments.length)return void 0===t?this:this.each(function(e){S.offset.setOffset(this,t,e)});var e,n,r=this[0];return r?r.getClientRects().length?(e=r.getBoundingClientRect(),n=r.ownerDocument.defaultView,{top:e.top+n.pageYOffset,left:e.left+n.pageXOffset}):{top:0,left:0}:void 0},position:function(){if(this[0]){var e,t,n,r=this[0],i={top:0,left:0};if("fixed"===S.css(r,"position"))t=r.getBoundingClientRect();else{t=this.offset(),n=r.ownerDocument,e=r.offsetParent||n.documentElement;while(e&&(e===n.body||e===n.documentElement)&&"static"===S.css(e,"position"))e=e.parentNode;e&&e!==r&&1===e.nodeType&&((i=S(e).offset()).top+=S.css(e,"borderTopWidth",!0),i.left+=S.css(e,"borderLeftWidth",!0))}return{top:t.top-i.top-S.css(r,"marginTop",!0),left:t.left-i.left-S.css(r,"marginLeft",!0)}}},offsetParent:function(){return this.map(function(){var e=this.offsetParent;while(e&&"static"===S.css(e,"position"))e=e.offsetParent;return e||re})}}),S.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(t,i){var o="pageYOffset"===i;S.fn[t]=function(e){return $(this,function(e,t,n){var r;if(x(e)?r=e:9===e.nodeType&&(r=e.defaultView),void 0===n)return r?r[i]:e[t];r?r.scrollTo(o?r.pageXOffset:n,o?n:r.pageYOffset):e[t]=n},t,e,arguments.length)}}),S.each(["top","left"],function(e,n){S.cssHooks[n]=Fe(y.pixelPosition,function(e,t){if(t)return t=We(e,n),Pe.test(t)?S(e).position()[n]+"px":t})}),S.each({Height:"height",Width:"width"},function(a,s){S.each({padding:"inner"+a,content:s,"":"outer"+a},function(r,o){S.fn[o]=function(e,t){var n=arguments.length&&(r||"boolean"!=typeof e),i=r||(!0===e||!0===t?"margin":"border");return $(this,function(e,t,n){var r;return x(e)?0===o.indexOf("outer")?e["inner"+a]:e.document.documentElement["client"+a]:9===e.nodeType?(r=e.documentElement,Math.max(e.body["scroll"+a],r["scroll"+a],e.body["offset"+a],r["offset"+a],r["client"+a])):void 0===n?S.css(e,t,i):S.style(e,t,n,i)},s,n?e:void 0,n)}})}),S.each(["ajaxStart","ajaxStop","ajaxComplete","ajaxError","ajaxSuccess","ajaxSend"],function(e,t){S.fn[t]=function(e){return this.on(t,e)}}),S.fn.extend({bind:function(e,t,n){return this.on(e,null,t,n)},unbind:function(e,t){return this.off(e,null,t)},delegate:function(e,t,n,r){return this.on(t,e,n,r)},undelegate:function(e,t,n){return 1===arguments.length?this.off(e,"**"):this.off(t,e||"**",n)},hover:function(e,t){return this.mouseenter(e).mouseleave(t||e)}}),S.each("blur focus focusin focusout resize scroll click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup contextmenu".split(" "),function(e,n){S.fn[n]=function(e,t){return 0",d.insertBefore(c.lastChild,d.firstChild)}function d(){var a=y.elements;return"string"==typeof a?a.split(" "):a}function e(a,b){var c=y.elements;"string"!=typeof c&&(c=c.join(" ")),"string"!=typeof a&&(a=a.join(" ")),y.elements=c+" "+a,j(b)}function f(a){var b=x[a[v]];return b||(b={},w++,a[v]=w,x[w]=b),b}function g(a,c,d){if(c||(c=b),q)return c.createElement(a);d||(d=f(c));var e;return e=d.cache[a]?d.cache[a].cloneNode():u.test(a)?(d.cache[a]=d.createElem(a)).cloneNode():d.createElem(a),!e.canHaveChildren||t.test(a)||e.tagUrn?e:d.frag.appendChild(e)}function h(a,c){if(a||(a=b),q)return a.createDocumentFragment();c=c||f(a);for(var e=c.frag.cloneNode(),g=0,h=d(),i=h.length;i>g;g++)e.createElement(h[g]);return e}function i(a,b){b.cache||(b.cache={},b.createElem=a.createElement,b.createFrag=a.createDocumentFragment,b.frag=b.createFrag()),a.createElement=function(c){return y.shivMethods?g(c,a,b):b.createElem(c)},a.createDocumentFragment=Function("h,f","return function(){var n=f.cloneNode(),c=n.createElement;h.shivMethods&&("+d().join().replace(/[\w\-:]+/g,function(a){return b.createElem(a),b.frag.createElement(a),'c("'+a+'")'})+");return n}")(y,b.frag)}function j(a){a||(a=b);var d=f(a);return!y.shivCSS||p||d.hasCSS||(d.hasCSS=!!c(a,"article,aside,dialog,figcaption,figure,footer,header,hgroup,main,nav,section{display:block}mark{background:#FF0;color:#000}template{display:none}")),q||i(a,d),a}function k(a){for(var b,c=a.getElementsByTagName("*"),e=c.length,f=RegExp("^(?:"+d().join("|")+")$","i"),g=[];e--;)b=c[e],f.test(b.nodeName)&&g.push(b.applyElement(l(b)));return g}function l(a){for(var b,c=a.attributes,d=c.length,e=a.ownerDocument.createElement(A+":"+a.nodeName);d--;)b=c[d],b.specified&&e.setAttribute(b.nodeName,b.nodeValue);return e.style.cssText=a.style.cssText,e}function m(a){for(var b,c=a.split("{"),e=c.length,f=RegExp("(^|[\\s,>+~])("+d().join("|")+")(?=[[\\s,>+~#.:]|$)","gi"),g="$1"+A+"\\:$2";e--;)b=c[e]=c[e].split("}"),b[b.length-1]=b[b.length-1].replace(f,g),c[e]=b.join("}");return c.join("{")}function n(a){for(var b=a.length;b--;)a[b].removeNode()}function o(a){function b(){clearTimeout(g._removeSheetTimer),d&&d.removeNode(!0),d=null}var d,e,g=f(a),h=a.namespaces,i=a.parentWindow;return!B||a.printShived?a:("undefined"==typeof h[A]&&h.add(A),i.attachEvent("onbeforeprint",function(){b();for(var f,g,h,i=a.styleSheets,j=[],l=i.length,n=Array(l);l--;)n[l]=i[l];for(;h=n.pop();)if(!h.disabled&&z.test(h.media)){try{f=h.imports,g=f.length}catch(o){g=0}for(l=0;g>l;l++)n.push(f[l]);try{j.push(h.cssText)}catch(o){}}j=m(j.reverse().join("")),e=k(a),d=c(a,j)}),i.attachEvent("onafterprint",function(){n(e),clearTimeout(g._removeSheetTimer),g._removeSheetTimer=setTimeout(b,500)}),a.printShived=!0,a)}var p,q,r="3.7.3",s=a.html5||{},t=/^<|^(?:button|map|select|textarea|object|iframe|option|optgroup)$/i,u=/^(?:a|b|code|div|fieldset|h1|h2|h3|h4|h5|h6|i|label|li|ol|p|q|span|strong|style|table|tbody|td|th|tr|ul)$/i,v="_html5shiv",w=0,x={};!function(){try{var a=b.createElement("a");a.innerHTML="",p="hidden"in a,q=1==a.childNodes.length||function(){b.createElement("a");var a=b.createDocumentFragment();return"undefined"==typeof a.cloneNode||"undefined"==typeof a.createDocumentFragment||"undefined"==typeof a.createElement}()}catch(c){p=!0,q=!0}}();var y={elements:s.elements||"abbr article aside audio bdi canvas data datalist details dialog figcaption figure footer header hgroup main mark meter nav output picture progress section summary template time video",version:r,shivCSS:s.shivCSS!==!1,supportsUnknownElements:q,shivMethods:s.shivMethods!==!1,type:"default",shivDocument:j,createElement:g,createDocumentFragment:h,addElements:e};a.html5=y,j(b);var z=/^$|\b(?:all|print)\b/,A="html5shiv",B=!q&&function(){var c=b.documentElement;return!("undefined"==typeof b.namespaces||"undefined"==typeof b.parentWindow||"undefined"==typeof c.applyElement||"undefined"==typeof c.removeNode||"undefined"==typeof a.attachEvent)}();y.type+=" print",y.shivPrint=o,o(b),"object"==typeof module&&module.exports&&(module.exports=y)}("undefined"!=typeof window?window:this,document); \ No newline at end of file diff --git a/docs/build/html/_static/js/html5shiv.min.js b/docs/build/html/_static/js/html5shiv.min.js deleted file mode 100644 index cd1c674f..00000000 --- a/docs/build/html/_static/js/html5shiv.min.js +++ /dev/null @@ -1,4 +0,0 @@ -/** -* @preserve HTML5 Shiv 3.7.3 | @afarkas @jdalton @jon_neal @rem | MIT/GPL2 Licensed -*/ -!function(a,b){function c(a,b){var c=a.createElement("p"),d=a.getElementsByTagName("head")[0]||a.documentElement;return c.innerHTML="x",d.insertBefore(c.lastChild,d.firstChild)}function d(){var a=t.elements;return"string"==typeof a?a.split(" "):a}function e(a,b){var c=t.elements;"string"!=typeof c&&(c=c.join(" ")),"string"!=typeof a&&(a=a.join(" ")),t.elements=c+" "+a,j(b)}function f(a){var b=s[a[q]];return b||(b={},r++,a[q]=r,s[r]=b),b}function g(a,c,d){if(c||(c=b),l)return c.createElement(a);d||(d=f(c));var e;return e=d.cache[a]?d.cache[a].cloneNode():p.test(a)?(d.cache[a]=d.createElem(a)).cloneNode():d.createElem(a),!e.canHaveChildren||o.test(a)||e.tagUrn?e:d.frag.appendChild(e)}function h(a,c){if(a||(a=b),l)return a.createDocumentFragment();c=c||f(a);for(var e=c.frag.cloneNode(),g=0,h=d(),i=h.length;i>g;g++)e.createElement(h[g]);return e}function i(a,b){b.cache||(b.cache={},b.createElem=a.createElement,b.createFrag=a.createDocumentFragment,b.frag=b.createFrag()),a.createElement=function(c){return t.shivMethods?g(c,a,b):b.createElem(c)},a.createDocumentFragment=Function("h,f","return function(){var n=f.cloneNode(),c=n.createElement;h.shivMethods&&("+d().join().replace(/[\w\-:]+/g,function(a){return b.createElem(a),b.frag.createElement(a),'c("'+a+'")'})+");return n}")(t,b.frag)}function j(a){a||(a=b);var d=f(a);return!t.shivCSS||k||d.hasCSS||(d.hasCSS=!!c(a,"article,aside,dialog,figcaption,figure,footer,header,hgroup,main,nav,section{display:block}mark{background:#FF0;color:#000}template{display:none}")),l||i(a,d),a}var k,l,m="3.7.3-pre",n=a.html5||{},o=/^<|^(?:button|map|select|textarea|object|iframe|option|optgroup)$/i,p=/^(?:a|b|code|div|fieldset|h1|h2|h3|h4|h5|h6|i|label|li|ol|p|q|span|strong|style|table|tbody|td|th|tr|ul)$/i,q="_html5shiv",r=0,s={};!function(){try{var a=b.createElement("a");a.innerHTML="",k="hidden"in a,l=1==a.childNodes.length||function(){b.createElement("a");var a=b.createDocumentFragment();return"undefined"==typeof a.cloneNode||"undefined"==typeof a.createDocumentFragment||"undefined"==typeof a.createElement}()}catch(c){k=!0,l=!0}}();var t={elements:n.elements||"abbr article aside audio bdi canvas data datalist details dialog figcaption figure footer header hgroup main mark meter nav output picture progress section summary template time video",version:m,shivCSS:n.shivCSS!==!1,supportsUnknownElements:l,shivMethods:n.shivMethods!==!1,type:"default",shivDocument:j,createElement:g,createDocumentFragment:h,addElements:e};a.html5=t,j(b),"object"==typeof module&&module.exports&&(module.exports=t)}("undefined"!=typeof window?window:this,document); \ No newline at end of file diff --git a/docs/build/html/_static/js/theme.js b/docs/build/html/_static/js/theme.js deleted file mode 100644 index 1fddb6ee..00000000 --- a/docs/build/html/_static/js/theme.js +++ /dev/null @@ -1 +0,0 @@ -!function(n){var e={};function t(i){if(e[i])return e[i].exports;var o=e[i]={i:i,l:!1,exports:{}};return n[i].call(o.exports,o,o.exports,t),o.l=!0,o.exports}t.m=n,t.c=e,t.d=function(n,e,i){t.o(n,e)||Object.defineProperty(n,e,{enumerable:!0,get:i})},t.r=function(n){"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(n,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(n,"__esModule",{value:!0})},t.t=function(n,e){if(1&e&&(n=t(n)),8&e)return n;if(4&e&&"object"==typeof n&&n&&n.__esModule)return n;var i=Object.create(null);if(t.r(i),Object.defineProperty(i,"default",{enumerable:!0,value:n}),2&e&&"string"!=typeof n)for(var o in n)t.d(i,o,function(e){return n[e]}.bind(null,o));return i},t.n=function(n){var e=n&&n.__esModule?function(){return n.default}:function(){return n};return t.d(e,"a",e),e},t.o=function(n,e){return Object.prototype.hasOwnProperty.call(n,e)},t.p="",t(t.s=0)}([function(n,e,t){t(1),n.exports=t(3)},function(n,e,t){(function(){var e="undefined"!=typeof window?window.jQuery:t(2);n.exports.ThemeNav={navBar:null,win:null,winScroll:!1,winResize:!1,linkScroll:!1,winPosition:0,winHeight:null,docHeight:null,isRunning:!1,enable:function(n){var t=this;void 0===n&&(n=!0),t.isRunning||(t.isRunning=!0,e((function(e){t.init(e),t.reset(),t.win.on("hashchange",t.reset),n&&t.win.on("scroll",(function(){t.linkScroll||t.winScroll||(t.winScroll=!0,requestAnimationFrame((function(){t.onScroll()})))})),t.win.on("resize",(function(){t.winResize||(t.winResize=!0,requestAnimationFrame((function(){t.onResize()})))})),t.onResize()})))},enableSticky:function(){this.enable(!0)},init:function(n){n(document);var e=this;this.navBar=n("div.wy-side-scroll:first"),this.win=n(window),n(document).on("click","[data-toggle='wy-nav-top']",(function(){n("[data-toggle='wy-nav-shift']").toggleClass("shift"),n("[data-toggle='rst-versions']").toggleClass("shift")})).on("click",".wy-menu-vertical .current ul li a",(function(){var t=n(this);n("[data-toggle='wy-nav-shift']").removeClass("shift"),n("[data-toggle='rst-versions']").toggleClass("shift"),e.toggleCurrent(t),e.hashChange()})).on("click","[data-toggle='rst-current-version']",(function(){n("[data-toggle='rst-versions']").toggleClass("shift-up")})),n("table.docutils:not(.field-list,.footnote,.citation)").wrap("
"),n("table.docutils.footnote").wrap("
"),n("table.docutils.citation").wrap("
"),n(".wy-menu-vertical ul").not(".simple").siblings("a").each((function(){var t=n(this);expand=n(''),expand.on("click",(function(n){return e.toggleCurrent(t),n.stopPropagation(),!1})),t.prepend(expand)}))},reset:function(){var n=encodeURI(window.location.hash)||"#";try{var e=$(".wy-menu-vertical"),t=e.find('[href="'+n+'"]');if(0===t.length){var i=$('.document [id="'+n.substring(1)+'"]').closest("div.section");0===(t=e.find('[href="#'+i.attr("id")+'"]')).length&&(t=e.find('[href="#"]'))}if(t.length>0){$(".wy-menu-vertical .current").removeClass("current").attr("aria-expanded","false"),t.addClass("current").attr("aria-expanded","true"),t.closest("li.toctree-l1").parent().addClass("current").attr("aria-expanded","true");for(let n=1;n<=10;n++)t.closest("li.toctree-l"+n).addClass("current").attr("aria-expanded","true");t[0].scrollIntoView()}}catch(n){console.log("Error expanding nav for anchor",n)}},onScroll:function(){this.winScroll=!1;var n=this.win.scrollTop(),e=n+this.winHeight,t=this.navBar.scrollTop()+(n-this.winPosition);n<0||e>this.docHeight||(this.navBar.scrollTop(t),this.winPosition=n)},onResize:function(){this.winResize=!1,this.winHeight=this.win.height(),this.docHeight=$(document).height()},hashChange:function(){this.linkScroll=!0,this.win.one("hashchange",(function(){this.linkScroll=!1}))},toggleCurrent:function(n){var e=n.closest("li");e.siblings("li.current").removeClass("current").attr("aria-expanded","false"),e.siblings().find("li.current").removeClass("current").attr("aria-expanded","false");var t=e.find("> ul li");t.length&&(t.removeClass("current").attr("aria-expanded","false"),e.toggleClass("current").attr("aria-expanded",(function(n,e){return"true"==e?"false":"true"})))}},"undefined"!=typeof window&&(window.SphinxRtdTheme={Navigation:n.exports.ThemeNav,StickyNav:n.exports.ThemeNav}),function(){for(var n=0,e=["ms","moz","webkit","o"],t=0;t0 - var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1 - var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1 - var s_v = "^(" + C + ")?" + v; // vowel in stem - - this.stemWord = function (w) { - var stem; - var suffix; - var firstch; - var origword = w; - - if (w.length < 3) - return w; - - var re; - var re2; - var re3; - var re4; - - firstch = w.substr(0,1); - if (firstch == "y") - w = firstch.toUpperCase() + w.substr(1); - - // Step 1a - re = /^(.+?)(ss|i)es$/; - re2 = /^(.+?)([^s])s$/; - - if (re.test(w)) - w = w.replace(re,"$1$2"); - else if (re2.test(w)) - w = w.replace(re2,"$1$2"); - - // Step 1b - re = /^(.+?)eed$/; - re2 = /^(.+?)(ed|ing)$/; - if (re.test(w)) { - var fp = re.exec(w); - re = new RegExp(mgr0); - if (re.test(fp[1])) { - re = /.$/; - w = w.replace(re,""); - } - } - else if (re2.test(w)) { - var fp = re2.exec(w); - stem = fp[1]; - re2 = new RegExp(s_v); - if (re2.test(stem)) { - w = stem; - re2 = /(at|bl|iz)$/; - re3 = new RegExp("([^aeiouylsz])\\1$"); - re4 = new RegExp("^" + C + v + "[^aeiouwxy]$"); - if (re2.test(w)) - w = w + "e"; - else if (re3.test(w)) { - re = /.$/; - w = w.replace(re,""); - } - else if (re4.test(w)) - w = w + "e"; - } - } - - // Step 1c - re = /^(.+?)y$/; - if (re.test(w)) { - var fp = re.exec(w); - stem = fp[1]; - re = new RegExp(s_v); - if (re.test(stem)) - w = stem + "i"; - } - - // Step 2 - re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/; - if (re.test(w)) { - var fp = re.exec(w); - stem = fp[1]; - suffix = fp[2]; - re = new RegExp(mgr0); - if (re.test(stem)) - w = stem + step2list[suffix]; - } - - // Step 3 - re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/; - if (re.test(w)) { - var fp = re.exec(w); - stem = fp[1]; - suffix = fp[2]; - re = new RegExp(mgr0); - if (re.test(stem)) - w = stem + step3list[suffix]; - } - - // Step 4 - re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/; - re2 = /^(.+?)(s|t)(ion)$/; - if (re.test(w)) { - var fp = re.exec(w); - stem = fp[1]; - re = new RegExp(mgr1); - if (re.test(stem)) - w = stem; - } - else if (re2.test(w)) { - var fp = re2.exec(w); - stem = fp[1] + fp[2]; - re2 = new RegExp(mgr1); - if (re2.test(stem)) - w = stem; - } - - // Step 5 - re = /^(.+?)e$/; - if (re.test(w)) { - var fp = re.exec(w); - stem = fp[1]; - re = new RegExp(mgr1); - re2 = new RegExp(meq1); - re3 = new RegExp("^" + C + v + "[^aeiouwxy]$"); - if (re.test(stem) || (re2.test(stem) && !(re3.test(stem)))) - w = stem; - } - re = /ll$/; - re2 = new RegExp(mgr1); - if (re.test(w) && re2.test(w)) { - re = /.$/; - w = w.replace(re,""); - } - - // and turn initial Y back to y - if (firstch == "y") - w = firstch.toLowerCase() + w.substr(1); - return w; - } -} - diff --git a/docs/build/html/_static/minus.png b/docs/build/html/_static/minus.png deleted file mode 100644 index d96755fd..00000000 Binary files a/docs/build/html/_static/minus.png and /dev/null differ diff --git a/docs/build/html/_static/plus.png b/docs/build/html/_static/plus.png deleted file mode 100644 index 7107cec9..00000000 Binary files a/docs/build/html/_static/plus.png and /dev/null differ diff --git a/docs/build/html/_static/pygments.css b/docs/build/html/_static/pygments.css deleted file mode 100644 index 08bec689..00000000 --- a/docs/build/html/_static/pygments.css +++ /dev/null @@ -1,74 +0,0 @@ -pre { line-height: 125%; } -td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; } -span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; } -td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } -span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } -.highlight .hll { background-color: #ffffcc } -.highlight { background: #f8f8f8; } -.highlight .c { color: #3D7B7B; font-style: italic } /* Comment */ -.highlight .err { border: 1px solid #FF0000 } /* Error */ -.highlight .k { color: #008000; font-weight: bold } /* Keyword */ -.highlight .o { color: #666666 } /* Operator */ -.highlight .ch { color: #3D7B7B; font-style: italic } /* Comment.Hashbang */ -.highlight .cm { color: #3D7B7B; font-style: italic } /* Comment.Multiline */ -.highlight .cp { color: #9C6500 } /* Comment.Preproc */ -.highlight .cpf { color: #3D7B7B; font-style: italic } /* Comment.PreprocFile */ -.highlight .c1 { color: #3D7B7B; font-style: italic } /* Comment.Single */ -.highlight .cs { color: #3D7B7B; font-style: italic } /* Comment.Special */ -.highlight .gd { color: #A00000 } /* Generic.Deleted */ -.highlight .ge { font-style: italic } /* Generic.Emph */ -.highlight .gr { color: #E40000 } /* Generic.Error */ -.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */ -.highlight .gi { color: #008400 } /* Generic.Inserted */ -.highlight .go { color: #717171 } /* Generic.Output */ -.highlight .gp { color: #000080; font-weight: bold } /* Generic.Prompt */ -.highlight .gs { font-weight: bold } /* Generic.Strong */ -.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */ -.highlight .gt { color: #0044DD } /* Generic.Traceback */ -.highlight .kc { color: #008000; font-weight: bold } /* Keyword.Constant */ -.highlight .kd { color: #008000; font-weight: bold } /* Keyword.Declaration */ -.highlight .kn { color: #008000; font-weight: bold } /* Keyword.Namespace */ -.highlight .kp { color: #008000 } /* Keyword.Pseudo */ -.highlight .kr { color: #008000; font-weight: bold } /* Keyword.Reserved */ -.highlight .kt { color: #B00040 } /* Keyword.Type */ -.highlight .m { color: #666666 } /* Literal.Number */ -.highlight .s { color: #BA2121 } /* Literal.String */ -.highlight .na { color: #687822 } /* Name.Attribute */ -.highlight .nb { color: #008000 } /* Name.Builtin */ -.highlight .nc { color: #0000FF; font-weight: bold } /* Name.Class */ -.highlight .no { color: #880000 } /* Name.Constant */ -.highlight .nd { color: #AA22FF } /* Name.Decorator */ -.highlight .ni { color: #717171; font-weight: bold } /* Name.Entity */ -.highlight .ne { color: #CB3F38; font-weight: bold } /* Name.Exception */ -.highlight .nf { color: #0000FF } /* Name.Function */ -.highlight .nl { color: #767600 } /* Name.Label */ -.highlight .nn { color: #0000FF; font-weight: bold } /* Name.Namespace */ -.highlight .nt { color: #008000; font-weight: bold } /* Name.Tag */ -.highlight .nv { color: #19177C } /* Name.Variable */ -.highlight .ow { color: #AA22FF; font-weight: bold } /* Operator.Word */ -.highlight .w { color: #bbbbbb } /* Text.Whitespace */ -.highlight .mb { color: #666666 } /* Literal.Number.Bin */ -.highlight .mf { color: #666666 } /* Literal.Number.Float */ -.highlight .mh { color: #666666 } /* Literal.Number.Hex */ -.highlight .mi { color: #666666 } /* Literal.Number.Integer */ -.highlight .mo { color: #666666 } /* Literal.Number.Oct */ -.highlight .sa { color: #BA2121 } /* Literal.String.Affix */ -.highlight .sb { color: #BA2121 } /* Literal.String.Backtick */ -.highlight .sc { color: #BA2121 } /* Literal.String.Char */ -.highlight .dl { color: #BA2121 } /* Literal.String.Delimiter */ -.highlight .sd { color: #BA2121; font-style: italic } /* Literal.String.Doc */ -.highlight .s2 { color: #BA2121 } /* Literal.String.Double */ -.highlight .se { color: #AA5D1F; font-weight: bold } /* Literal.String.Escape */ -.highlight .sh { color: #BA2121 } /* Literal.String.Heredoc */ -.highlight .si { color: #A45A77; font-weight: bold } /* Literal.String.Interpol */ -.highlight .sx { color: #008000 } /* Literal.String.Other */ -.highlight .sr { color: #A45A77 } /* Literal.String.Regex */ -.highlight .s1 { color: #BA2121 } /* Literal.String.Single */ -.highlight .ss { color: #19177C } /* Literal.String.Symbol */ -.highlight .bp { color: #008000 } /* Name.Builtin.Pseudo */ -.highlight .fm { color: #0000FF } /* Name.Function.Magic */ -.highlight .vc { color: #19177C } /* Name.Variable.Class */ -.highlight .vg { color: #19177C } /* Name.Variable.Global */ -.highlight .vi { color: #19177C } /* Name.Variable.Instance */ -.highlight .vm { color: #19177C } /* Name.Variable.Magic */ -.highlight .il { color: #666666 } /* Literal.Number.Integer.Long */ \ No newline at end of file diff --git a/docs/build/html/_static/searchtools.js b/docs/build/html/_static/searchtools.js deleted file mode 100644 index 97d56a74..00000000 --- a/docs/build/html/_static/searchtools.js +++ /dev/null @@ -1,566 +0,0 @@ -/* - * searchtools.js - * ~~~~~~~~~~~~~~~~ - * - * Sphinx JavaScript utilities for the full-text search. - * - * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. - * :license: BSD, see LICENSE for details. - * - */ -"use strict"; - -/** - * Simple result scoring code. - */ -if (typeof Scorer === "undefined") { - var Scorer = { - // Implement the following function to further tweak the score for each result - // The function takes a result array [docname, title, anchor, descr, score, filename] - // and returns the new score. - /* - score: result => { - const [docname, title, anchor, descr, score, filename] = result - return score - }, - */ - - // query matches the full name of an object - objNameMatch: 11, - // or matches in the last dotted part of the object name - objPartialMatch: 6, - // Additive scores depending on the priority of the object - objPrio: { - 0: 15, // used to be importantResults - 1: 5, // used to be objectResults - 2: -5, // used to be unimportantResults - }, - // Used when the priority is not in the mapping. - objPrioDefault: 0, - - // query found in title - title: 15, - partialTitle: 7, - // query found in terms - term: 5, - partialTerm: 2, - }; -} - -const _removeChildren = (element) => { - while (element && element.lastChild) element.removeChild(element.lastChild); -}; - -/** - * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions#escaping - */ -const _escapeRegExp = (string) => - string.replace(/[.*+\-?^${}()|[\]\\]/g, "\\$&"); // $& means the whole matched string - -const _displayItem = (item, searchTerms) => { - const docBuilder = DOCUMENTATION_OPTIONS.BUILDER; - const docUrlRoot = DOCUMENTATION_OPTIONS.URL_ROOT; - const docFileSuffix = DOCUMENTATION_OPTIONS.FILE_SUFFIX; - const docLinkSuffix = DOCUMENTATION_OPTIONS.LINK_SUFFIX; - const showSearchSummary = DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY; - - const [docName, title, anchor, descr, score, _filename] = item; - - let listItem = document.createElement("li"); - let requestUrl; - let linkUrl; - if (docBuilder === "dirhtml") { - // dirhtml builder - let dirname = docName + "/"; - if (dirname.match(/\/index\/$/)) - dirname = dirname.substring(0, dirname.length - 6); - else if (dirname === "index/") dirname = ""; - requestUrl = docUrlRoot + dirname; - linkUrl = requestUrl; - } else { - // normal html builders - requestUrl = docUrlRoot + docName + docFileSuffix; - linkUrl = docName + docLinkSuffix; - } - let linkEl = listItem.appendChild(document.createElement("a")); - linkEl.href = linkUrl + anchor; - linkEl.dataset.score = score; - linkEl.innerHTML = title; - if (descr) - listItem.appendChild(document.createElement("span")).innerHTML = - " (" + descr + ")"; - else if (showSearchSummary) - fetch(requestUrl) - .then((responseData) => responseData.text()) - .then((data) => { - if (data) - listItem.appendChild( - Search.makeSearchSummary(data, searchTerms) - ); - }); - Search.output.appendChild(listItem); -}; -const _finishSearch = (resultCount) => { - Search.stopPulse(); - Search.title.innerText = _("Search Results"); - if (!resultCount) - Search.status.innerText = Documentation.gettext( - "Your search did not match any documents. Please make sure that all words are spelled correctly and that you've selected enough categories." - ); - else - Search.status.innerText = _( - `Search finished, found ${resultCount} page(s) matching the search query.` - ); -}; -const _displayNextItem = ( - results, - resultCount, - searchTerms -) => { - // results left, load the summary and display it - // this is intended to be dynamic (don't sub resultsCount) - if (results.length) { - _displayItem(results.pop(), searchTerms); - setTimeout( - () => _displayNextItem(results, resultCount, searchTerms), - 5 - ); - } - // search finished, update title and status message - else _finishSearch(resultCount); -}; - -/** - * Default splitQuery function. Can be overridden in ``sphinx.search`` with a - * custom function per language. - * - * The regular expression works by splitting the string on consecutive characters - * that are not Unicode letters, numbers, underscores, or emoji characters. - * This is the same as ``\W+`` in Python, preserving the surrogate pair area. - */ -if (typeof splitQuery === "undefined") { - var splitQuery = (query) => query - .split(/[^\p{Letter}\p{Number}_\p{Emoji_Presentation}]+/gu) - .filter(term => term) // remove remaining empty strings -} - -/** - * Search Module - */ -const Search = { - _index: null, - _queued_query: null, - _pulse_status: -1, - - htmlToText: (htmlString) => { - const htmlElement = new DOMParser().parseFromString(htmlString, 'text/html'); - htmlElement.querySelectorAll(".headerlink").forEach((el) => { el.remove() }); - const docContent = htmlElement.querySelector('[role="main"]'); - if (docContent !== undefined) return docContent.textContent; - console.warn( - "Content block not found. Sphinx search tries to obtain it via '[role=main]'. Could you check your theme or template." - ); - return ""; - }, - - init: () => { - const query = new URLSearchParams(window.location.search).get("q"); - document - .querySelectorAll('input[name="q"]') - .forEach((el) => (el.value = query)); - if (query) Search.performSearch(query); - }, - - loadIndex: (url) => - (document.body.appendChild(document.createElement("script")).src = url), - - setIndex: (index) => { - Search._index = index; - if (Search._queued_query !== null) { - const query = Search._queued_query; - Search._queued_query = null; - Search.query(query); - } - }, - - hasIndex: () => Search._index !== null, - - deferQuery: (query) => (Search._queued_query = query), - - stopPulse: () => (Search._pulse_status = -1), - - startPulse: () => { - if (Search._pulse_status >= 0) return; - - const pulse = () => { - Search._pulse_status = (Search._pulse_status + 1) % 4; - Search.dots.innerText = ".".repeat(Search._pulse_status); - if (Search._pulse_status >= 0) window.setTimeout(pulse, 500); - }; - pulse(); - }, - - /** - * perform a search for something (or wait until index is loaded) - */ - performSearch: (query) => { - // create the required interface elements - const searchText = document.createElement("h2"); - searchText.textContent = _("Searching"); - const searchSummary = document.createElement("p"); - searchSummary.classList.add("search-summary"); - searchSummary.innerText = ""; - const searchList = document.createElement("ul"); - searchList.classList.add("search"); - - const out = document.getElementById("search-results"); - Search.title = out.appendChild(searchText); - Search.dots = Search.title.appendChild(document.createElement("span")); - Search.status = out.appendChild(searchSummary); - Search.output = out.appendChild(searchList); - - const searchProgress = document.getElementById("search-progress"); - // Some themes don't use the search progress node - if (searchProgress) { - searchProgress.innerText = _("Preparing search..."); - } - Search.startPulse(); - - // index already loaded, the browser was quick! - if (Search.hasIndex()) Search.query(query); - else Search.deferQuery(query); - }, - - /** - * execute search (requires search index to be loaded) - */ - query: (query) => { - const filenames = Search._index.filenames; - const docNames = Search._index.docnames; - const titles = Search._index.titles; - const allTitles = Search._index.alltitles; - const indexEntries = Search._index.indexentries; - - // stem the search terms and add them to the correct list - const stemmer = new Stemmer(); - const searchTerms = new Set(); - const excludedTerms = new Set(); - const highlightTerms = new Set(); - const objectTerms = new Set(splitQuery(query.toLowerCase().trim())); - splitQuery(query.trim()).forEach((queryTerm) => { - const queryTermLower = queryTerm.toLowerCase(); - - // maybe skip this "word" - // stopwords array is from language_data.js - if ( - stopwords.indexOf(queryTermLower) !== -1 || - queryTerm.match(/^\d+$/) - ) - return; - - // stem the word - let word = stemmer.stemWord(queryTermLower); - // select the correct list - if (word[0] === "-") excludedTerms.add(word.substr(1)); - else { - searchTerms.add(word); - highlightTerms.add(queryTermLower); - } - }); - - if (SPHINX_HIGHLIGHT_ENABLED) { // set in sphinx_highlight.js - localStorage.setItem("sphinx_highlight_terms", [...highlightTerms].join(" ")) - } - - // console.debug("SEARCH: searching for:"); - // console.info("required: ", [...searchTerms]); - // console.info("excluded: ", [...excludedTerms]); - - // array of [docname, title, anchor, descr, score, filename] - let results = []; - _removeChildren(document.getElementById("search-progress")); - - const queryLower = query.toLowerCase(); - for (const [title, foundTitles] of Object.entries(allTitles)) { - if (title.toLowerCase().includes(queryLower) && (queryLower.length >= title.length/2)) { - for (const [file, id] of foundTitles) { - let score = Math.round(100 * queryLower.length / title.length) - results.push([ - docNames[file], - titles[file] !== title ? `${titles[file]} > ${title}` : title, - id !== null ? "#" + id : "", - null, - score, - filenames[file], - ]); - } - } - } - - // search for explicit entries in index directives - for (const [entry, foundEntries] of Object.entries(indexEntries)) { - if (entry.includes(queryLower) && (queryLower.length >= entry.length/2)) { - for (const [file, id] of foundEntries) { - let score = Math.round(100 * queryLower.length / entry.length) - results.push([ - docNames[file], - titles[file], - id ? "#" + id : "", - null, - score, - filenames[file], - ]); - } - } - } - - // lookup as object - objectTerms.forEach((term) => - results.push(...Search.performObjectSearch(term, objectTerms)) - ); - - // lookup as search terms in fulltext - results.push(...Search.performTermsSearch(searchTerms, excludedTerms)); - - // let the scorer override scores with a custom scoring function - if (Scorer.score) results.forEach((item) => (item[4] = Scorer.score(item))); - - // now sort the results by score (in opposite order of appearance, since the - // display function below uses pop() to retrieve items) and then - // alphabetically - results.sort((a, b) => { - const leftScore = a[4]; - const rightScore = b[4]; - if (leftScore === rightScore) { - // same score: sort alphabetically - const leftTitle = a[1].toLowerCase(); - const rightTitle = b[1].toLowerCase(); - if (leftTitle === rightTitle) return 0; - return leftTitle > rightTitle ? -1 : 1; // inverted is intentional - } - return leftScore > rightScore ? 1 : -1; - }); - - // remove duplicate search results - // note the reversing of results, so that in the case of duplicates, the highest-scoring entry is kept - let seen = new Set(); - results = results.reverse().reduce((acc, result) => { - let resultStr = result.slice(0, 4).concat([result[5]]).map(v => String(v)).join(','); - if (!seen.has(resultStr)) { - acc.push(result); - seen.add(resultStr); - } - return acc; - }, []); - - results = results.reverse(); - - // for debugging - //Search.lastresults = results.slice(); // a copy - // console.info("search results:", Search.lastresults); - - // print the results - _displayNextItem(results, results.length, searchTerms); - }, - - /** - * search for object names - */ - performObjectSearch: (object, objectTerms) => { - const filenames = Search._index.filenames; - const docNames = Search._index.docnames; - const objects = Search._index.objects; - const objNames = Search._index.objnames; - const titles = Search._index.titles; - - const results = []; - - const objectSearchCallback = (prefix, match) => { - const name = match[4] - const fullname = (prefix ? prefix + "." : "") + name; - const fullnameLower = fullname.toLowerCase(); - if (fullnameLower.indexOf(object) < 0) return; - - let score = 0; - const parts = fullnameLower.split("."); - - // check for different match types: exact matches of full name or - // "last name" (i.e. last dotted part) - if (fullnameLower === object || parts.slice(-1)[0] === object) - score += Scorer.objNameMatch; - else if (parts.slice(-1)[0].indexOf(object) > -1) - score += Scorer.objPartialMatch; // matches in last name - - const objName = objNames[match[1]][2]; - const title = titles[match[0]]; - - // If more than one term searched for, we require other words to be - // found in the name/title/description - const otherTerms = new Set(objectTerms); - otherTerms.delete(object); - if (otherTerms.size > 0) { - const haystack = `${prefix} ${name} ${objName} ${title}`.toLowerCase(); - if ( - [...otherTerms].some((otherTerm) => haystack.indexOf(otherTerm) < 0) - ) - return; - } - - let anchor = match[3]; - if (anchor === "") anchor = fullname; - else if (anchor === "-") anchor = objNames[match[1]][1] + "-" + fullname; - - const descr = objName + _(", in ") + title; - - // add custom score for some objects according to scorer - if (Scorer.objPrio.hasOwnProperty(match[2])) - score += Scorer.objPrio[match[2]]; - else score += Scorer.objPrioDefault; - - results.push([ - docNames[match[0]], - fullname, - "#" + anchor, - descr, - score, - filenames[match[0]], - ]); - }; - Object.keys(objects).forEach((prefix) => - objects[prefix].forEach((array) => - objectSearchCallback(prefix, array) - ) - ); - return results; - }, - - /** - * search for full-text terms in the index - */ - performTermsSearch: (searchTerms, excludedTerms) => { - // prepare search - const terms = Search._index.terms; - const titleTerms = Search._index.titleterms; - const filenames = Search._index.filenames; - const docNames = Search._index.docnames; - const titles = Search._index.titles; - - const scoreMap = new Map(); - const fileMap = new Map(); - - // perform the search on the required terms - searchTerms.forEach((word) => { - const files = []; - const arr = [ - { files: terms[word], score: Scorer.term }, - { files: titleTerms[word], score: Scorer.title }, - ]; - // add support for partial matches - if (word.length > 2) { - const escapedWord = _escapeRegExp(word); - Object.keys(terms).forEach((term) => { - if (term.match(escapedWord) && !terms[word]) - arr.push({ files: terms[term], score: Scorer.partialTerm }); - }); - Object.keys(titleTerms).forEach((term) => { - if (term.match(escapedWord) && !titleTerms[word]) - arr.push({ files: titleTerms[word], score: Scorer.partialTitle }); - }); - } - - // no match but word was a required one - if (arr.every((record) => record.files === undefined)) return; - - // found search word in contents - arr.forEach((record) => { - if (record.files === undefined) return; - - let recordFiles = record.files; - if (recordFiles.length === undefined) recordFiles = [recordFiles]; - files.push(...recordFiles); - - // set score for the word in each file - recordFiles.forEach((file) => { - if (!scoreMap.has(file)) scoreMap.set(file, {}); - scoreMap.get(file)[word] = record.score; - }); - }); - - // create the mapping - files.forEach((file) => { - if (fileMap.has(file) && fileMap.get(file).indexOf(word) === -1) - fileMap.get(file).push(word); - else fileMap.set(file, [word]); - }); - }); - - // now check if the files don't contain excluded terms - const results = []; - for (const [file, wordList] of fileMap) { - // check if all requirements are matched - - // as search terms with length < 3 are discarded - const filteredTermCount = [...searchTerms].filter( - (term) => term.length > 2 - ).length; - if ( - wordList.length !== searchTerms.size && - wordList.length !== filteredTermCount - ) - continue; - - // ensure that none of the excluded terms is in the search result - if ( - [...excludedTerms].some( - (term) => - terms[term] === file || - titleTerms[term] === file || - (terms[term] || []).includes(file) || - (titleTerms[term] || []).includes(file) - ) - ) - break; - - // select one (max) score for the file. - const score = Math.max(...wordList.map((w) => scoreMap.get(file)[w])); - // add result to the result list - results.push([ - docNames[file], - titles[file], - "", - null, - score, - filenames[file], - ]); - } - return results; - }, - - /** - * helper function to return a node containing the - * search summary for a given text. keywords is a list - * of stemmed words. - */ - makeSearchSummary: (htmlText, keywords) => { - const text = Search.htmlToText(htmlText); - if (text === "") return null; - - const textLower = text.toLowerCase(); - const actualStartPosition = [...keywords] - .map((k) => textLower.indexOf(k.toLowerCase())) - .filter((i) => i > -1) - .slice(-1)[0]; - const startWithContext = Math.max(actualStartPosition - 120, 0); - - const top = startWithContext === 0 ? "" : "..."; - const tail = startWithContext + 240 < text.length ? "..." : ""; - - let summary = document.createElement("p"); - summary.classList.add("context"); - summary.textContent = top + text.substr(startWithContext, 240).trim() + tail; - - return summary; - }, -}; - -_ready(Search.init); diff --git a/docs/build/html/_static/sphinx_highlight.js b/docs/build/html/_static/sphinx_highlight.js deleted file mode 100644 index aae669d7..00000000 --- a/docs/build/html/_static/sphinx_highlight.js +++ /dev/null @@ -1,144 +0,0 @@ -/* Highlighting utilities for Sphinx HTML documentation. */ -"use strict"; - -const SPHINX_HIGHLIGHT_ENABLED = true - -/** - * highlight a given string on a node by wrapping it in - * span elements with the given class name. - */ -const _highlight = (node, addItems, text, className) => { - if (node.nodeType === Node.TEXT_NODE) { - const val = node.nodeValue; - const parent = node.parentNode; - const pos = val.toLowerCase().indexOf(text); - if ( - pos >= 0 && - !parent.classList.contains(className) && - !parent.classList.contains("nohighlight") - ) { - let span; - - const closestNode = parent.closest("body, svg, foreignObject"); - const isInSVG = closestNode && closestNode.matches("svg"); - if (isInSVG) { - span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); - } else { - span = document.createElement("span"); - span.classList.add(className); - } - - span.appendChild(document.createTextNode(val.substr(pos, text.length))); - parent.insertBefore( - span, - parent.insertBefore( - document.createTextNode(val.substr(pos + text.length)), - node.nextSibling - ) - ); - node.nodeValue = val.substr(0, pos); - - if (isInSVG) { - const rect = document.createElementNS( - "http://www.w3.org/2000/svg", - "rect" - ); - const bbox = parent.getBBox(); - rect.x.baseVal.value = bbox.x; - rect.y.baseVal.value = bbox.y; - rect.width.baseVal.value = bbox.width; - rect.height.baseVal.value = bbox.height; - rect.setAttribute("class", className); - addItems.push({ parent: parent, target: rect }); - } - } - } else if (node.matches && !node.matches("button, select, textarea")) { - node.childNodes.forEach((el) => _highlight(el, addItems, text, className)); - } -}; -const _highlightText = (thisNode, text, className) => { - let addItems = []; - _highlight(thisNode, addItems, text, className); - addItems.forEach((obj) => - obj.parent.insertAdjacentElement("beforebegin", obj.target) - ); -}; - -/** - * Small JavaScript module for the documentation. - */ -const SphinxHighlight = { - - /** - * highlight the search words provided in localstorage in the text - */ - highlightSearchWords: () => { - if (!SPHINX_HIGHLIGHT_ENABLED) return; // bail if no highlight - - // get and clear terms from localstorage - const url = new URL(window.location); - const highlight = - localStorage.getItem("sphinx_highlight_terms") - || url.searchParams.get("highlight") - || ""; - localStorage.removeItem("sphinx_highlight_terms") - url.searchParams.delete("highlight"); - window.history.replaceState({}, "", url); - - // get individual terms from highlight string - const terms = highlight.toLowerCase().split(/\s+/).filter(x => x); - if (terms.length === 0) return; // nothing to do - - // There should never be more than one element matching "div.body" - const divBody = document.querySelectorAll("div.body"); - const body = divBody.length ? divBody[0] : document.querySelector("body"); - window.setTimeout(() => { - terms.forEach((term) => _highlightText(body, term, "highlighted")); - }, 10); - - const searchBox = document.getElementById("searchbox"); - if (searchBox === null) return; - searchBox.appendChild( - document - .createRange() - .createContextualFragment( - '

' + - '' + - _("Hide Search Matches") + - "

" - ) - ); - }, - - /** - * helper function to hide the search marks again - */ - hideSearchWords: () => { - document - .querySelectorAll("#searchbox .highlight-link") - .forEach((el) => el.remove()); - document - .querySelectorAll("span.highlighted") - .forEach((el) => el.classList.remove("highlighted")); - localStorage.removeItem("sphinx_highlight_terms") - }, - - initEscapeListener: () => { - // only install a listener if it is really needed - if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) return; - - document.addEventListener("keydown", (event) => { - // bail for input elements - if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return; - // bail with special keys - if (event.shiftKey || event.altKey || event.ctrlKey || event.metaKey) return; - if (DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS && (event.key === "Escape")) { - SphinxHighlight.hideSearchWords(); - event.preventDefault(); - } - }); - }, -}; - -_ready(SphinxHighlight.highlightSearchWords); -_ready(SphinxHighlight.initEscapeListener); diff --git a/docs/build/html/contributing.html b/docs/build/html/contributing.html deleted file mode 100644 index 938a6c1d..00000000 --- a/docs/build/html/contributing.html +++ /dev/null @@ -1,224 +0,0 @@ - - - - - - - Contributing to CPL — Common Python Library documentation - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

Contributing to CPL

-

We would love for you to contribute to CPL and help make it even better than it is today! As a contributor, here are the guidelines we would like you to follow:

- -
-

Found a Bug?

-

If you find a bug in the source code, you can help us by submitting an issue to our Gitea Repository. Even better, you can submit a Pull Request with a fix.

-
-
-

Feature Request

-

You can request a new feature by submitting an issue to our Gitea Repository. If you would like to implement a new feature, please consider the size of the change in order to determine the right steps to proceed:

-

For a Major Feature, first open an issue and outline your proposal so that it can be discussed. This process allows us to better coordinate our efforts, prevent duplication of work, and help you to craft the change so that it is successfully accepted into the project.

-

Note: Adding a new topic to the documentation, or significantly re-writing a topic, counts as a major feature.

-

Small Features can be crafted and directly submitted as a Pull Request.

-
-
-

Submission Guidelines

-
-

Submitting an Issue

-

Before you submit an issue, please search the issue tracker, maybe an issue for your problem already exists and the discussion might inform you of workarounds readily available.

-

We want to fix all the issues as soon as possible, but before fixing a bug we need to reproduce and confirm it. In order to reproduce bugs, we require that you provide a minimal reproduction. Having a minimal reproducible scenario gives us a wealth of important information without going back and forth to you with additional questions.

-

A minimal reproduction allows us to quickly confirm a bug (or point out a coding problem) as well as confirm that we are fixing the right problem.

-

We require a minimal reproduction to save maintainers’ time and ultimately be able to fix more bugs. Often, developers find coding problems themselves while preparing a minimal reproduction. We understand that sometimes it might be hard to extract essential bits of code from a larger codebase but we really need to isolate the problem before we can fix it.

-

Unfortunately, we are not able to investigate / fix bugs without a minimal reproduction, so if we don’t hear back from you, we are going to close an issue that doesn’t have enough info to be reproduced.

-
-
-

Submitting a Pull Request

-

Before you submit your Pull Request (PR) consider the following guidelines:

-
    -

  1. Search the repository for an open or closed PR that relates to your submission. You don’t want to duplicate existing efforts.

    2. -

  2. Be sure that an issue describes the problem you’re fixing, or documents the design for the feature you’d like to add. Discussing the design upfront helps to ensure that we’re ready to accept your work.

    3. -

  3. Fork the sh-edraft.de/cpl repo.

    4. -

  4. In your forked repository, make your changes in a new git branch:

    -
    git checkout -b my-fix-branch master
-
    -
    -
    5. -

  5. Create your patch, including appropriate test cases.

    6. -
- -
    -

  1. Commit your changes.

    -
    git commit --all
-
    -
    -

    Note: the optional commit -a command line option will automatically “add” and “rm” edited files.

    -
    2. -

  2. Push your branch to the repository:

    -
    git push origin my-fix-branch
-
    -
    -
    3. -

  3. In Gitea, send a pull request to cpl:master

    4. -
-
-
-

Reviewing a Pull Request

-

The sh-edraft.de team reserves the right not to accept pull requests from community members who haven’t been good citizens of the community. Such behavior includes not following the CPL coding rules and applies within or outside of CPL managed channels.

-
-

Addressing review feedback

-

If we ask for changes via code reviews then:

-
    -

  1. Make the required updates to the code.

    2. -

  2. Create a fixup commit and push to your repository (this will update your Pull Request):

    -
    git commit --all --fixup HEAD
-git push
-
    -
    -
    3. -
-

That’s it! Thank you for your contribution!

-
-
-
-
-

Coding Rules

-

To ensure consistency throughout the source code, keep these rules in mind as you are working:

- -
-
-

License

-

By contributing, you agree that your contributions will be licensed under its MIT License. -See LICENSE

- -
-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/build/html/cpl_cli.add.html b/docs/build/html/cpl_cli.add.html deleted file mode 100644 index fa7f0700..00000000 --- a/docs/build/html/cpl_cli.add.html +++ /dev/null @@ -1,192 +0,0 @@ - - - - - - - cpl add — Common Python Library documentation - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

cpl add

-
-

Contents

- -

Removes a project from workspace.

-

cpl add <source-project> <target-project>
-cpl a <source-project> <target-project>
-cpl A <source-project> <target-project>

-
-
-

Description

-

Adds a project reference to given project.

-

If you call the command in a CPL workspace, you can use the project names. Otherwise the paths of the projects must be specified.

-
-
-

Arguments

- - - - - - - - - - - - - - - - - -

Argument

Description

Value type

<source-project>

Name of the project to which the reference has to be added

str

<target-project>

Name of the project to be referenced

str

-
-
-

Flags

- - - - - - - - - - - -

Argument

Description

--simulate

Specifies whether the command is simulated

-
-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/build/html/cpl_cli.build.html b/docs/build/html/cpl_cli.build.html deleted file mode 100644 index 51851f4a..00000000 --- a/docs/build/html/cpl_cli.build.html +++ /dev/null @@ -1,159 +0,0 @@ - - - - - - - cpl build — Common Python Library documentation - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

cpl build

-
-

Contents

- - -

Copies an python app into an output directory named build/ at the given output path. Must be executed within a CPL workspace or project directory

-

cpl build
-cpl b
-cpl B

-
-
-

Description

-

The command can be used to build a project of type “console” or “library”.

-

The build command copies all included source files to the output directory. You can run the source files in the output directory directly.

-

The command is used to prepare the source files for the publish command or to copy them to an target for execution.

- -
-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/build/html/cpl_cli.generate.html b/docs/build/html/cpl_cli.generate.html deleted file mode 100644 index 9d53a079..00000000 --- a/docs/build/html/cpl_cli.generate.html +++ /dev/null @@ -1,238 +0,0 @@ - - - - - - - cpl generate — Common Python Library documentation - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

cpl generate

-
-

Contents

- -

Generate a file based on schematic.

-

cpl generate <schematic> <name>
-cpl g <schematic> <name>
-cpl G <schematic> <name>

-
-
-

Description

-

Generates files based on a schematic.

-

You can define custom schematics by creating templates in a .cpl folder.

-
-
-

Arguments

- - - - - - - - - - - - - - - - - - - - - -

Argument

Description

Value type

<schematic>

The schematic to generate.

str

<name>

The name of the generated file.

str

--base

First element of path will be used as base-path not ‘src’. For example: ‘cpl g c test/Test’ will be created at src/test/ with –base it would be test/

str

-
-
-

Schematics

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Schematic

Description

Arguments

abc

Abstract base class

<name>

class

Class

<name>

enum

Enum class

<name>

pipe

Pipe class

<name>

service

Service class

<name>

settings

Configmodel

<name>

test

Test class

<name>

thread

Thread class

<name>

validator

Validator class

<name>

command

Discord bot command class

<name>

event

Discord bot event class

<name>

-
-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/build/html/cpl_cli.help.html b/docs/build/html/cpl_cli.help.html deleted file mode 100644 index 38d5941c..00000000 --- a/docs/build/html/cpl_cli.help.html +++ /dev/null @@ -1,170 +0,0 @@ - - - - - - - cpl help — Common Python Library documentation - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

cpl help

-
-

Contents

- -

Lists available command and their short descriptions.

-

cpl help <command>
-cpl h <command>
-cpl H <command>

-
-
-

Description

-

Lists available command and their short descriptions.

-
-
-

Arguments

- - - - - - - - - - - - - -

Argument

Description

Value type

<command>

Shows a help message for this command in the console.

str

-
-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/build/html/cpl_cli.html b/docs/build/html/cpl_cli.html deleted file mode 100644 index 6525cecb..00000000 --- a/docs/build/html/cpl_cli.html +++ /dev/null @@ -1,212 +0,0 @@ - - - - - - - CLI reference — Common Python Library documentation - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
- -
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/build/html/cpl_cli.install.html b/docs/build/html/cpl_cli.install.html deleted file mode 100644 index beed348d..00000000 --- a/docs/build/html/cpl_cli.install.html +++ /dev/null @@ -1,193 +0,0 @@ - - - - - - - cpl install — Common Python Library documentation - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

cpl install

-
-

Contents

- -

Installs given package via pip

-

cpl install <package>
-cpl i <package>
-cpl I <package>

-
-
-

Description

-

Install given package to project via pip. -Without given package it will install the depedencies of the CPL project your in.

-
-
-

Arguments

- - - - - - - - - - - - - -

Argument

Description

Value type

<package>

The package to install

str

-
-
-

Flags

- - - - - - - - - - - - - - - - - -

Argument

Description

--dev

Specifies whether the command is in development mode

--virtual

Specifies whether the command is virtual mode

--simulate

Specifies whether the command is simulated

-
-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/build/html/cpl_cli.new.html b/docs/build/html/cpl_cli.new.html deleted file mode 100644 index 31f66dfa..00000000 --- a/docs/build/html/cpl_cli.new.html +++ /dev/null @@ -1,227 +0,0 @@ - - - - - - - cpl new — Common Python Library documentation - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

cpl new

-
-

Contents

- -

Generates a workspace and initial project or add a project to workspace.

-

cpl new <type> <name>
-cpl n <type> <name>
-cpl N <type> <name>

-
-
-

Description

-

Generates a workspace and initial project or add a project to workspace.

-

You can define custom project types by creating templates in a .cpl folder.

-

If the command is running in a CPL workspace, it will add the new project to the workspace.

- - - - - - - - - - - - - - - - - - - - - -

Argument

Description

Value type

<type>

The type of the project, see types

str

<name>

The name of the project

str

--base

First element of path will be used as base-path not ‘src’. For example: ‘cpl g c test/Test’ will be created at src/test/ with –base it would be test/

str

-
-
-

Project types

- - - - - - - - - - - - - - -

Project type

Description

console

A simple console application

library

A package

-
-
-

Flags

- - - - - - - - - - - - - - - - - - - - - - - - - - -

Argument

Description

--async

Specifies whether async is used

--application-base

Specifies whether application base is used

--startup

Specifies whether startup is used

--service-providing

Specifies whether service-providing is used

--nothing

Specifies whether nothing is used

--venv

Specifies whether venv is used

-
-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/build/html/cpl_cli.overview.html b/docs/build/html/cpl_cli.overview.html deleted file mode 100644 index ee566ab2..00000000 --- a/docs/build/html/cpl_cli.overview.html +++ /dev/null @@ -1,240 +0,0 @@ - - - - - - - CLI Overview and Command Reference — Common Python Library documentation - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

CLI Overview and Command Reference

-
-

Table of Contents

-
    -

  1. Install CPL

    2. -

  2. Install CPL CLI

    3. -

  3. Basic workflow

    4. -

  4. CLI command-language syntax

    5. -

  5. Command overview

    6. -
-
-
-

Basic workflow

-

To create, build, and serve a new, basic CPL project on a development server, go to the parent directory of your new workspace use the following commands:

-
cpl new console my-first-project
-cd my-first-project
-cpl start
-
-
-

In the terminal you will the output of the app.

-
-
-

CLI command-language syntax

-

cpl commandNameOrAlias requiredArg [optionalsArgs]

-
    -

  • Most commands, and some options, have aliases. Aliases are shown in the syntax statement for each command.

    • -

  • Arguments are not prefixed.

    • -
-
-

Relative paths

-

Options that specify files can be given as absolute paths, or as paths relative to the current working directory, which is generally either the workspace or project root.

-
-
-

Schematics

-

The cpl generate command takes as an argument the artifact to be generated. In addition to any general options, each artifact defines its own options in a schematic. Schematic options are supplied to the command in the same format as immediate command options.

-
-
-
-

Command overview

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Command

Alias

Description

add

a or a

Adds a project reference to given project.

build

b or B

Prepares files for publish into an output directory named dist/ at the given output path. Must be executed from within a workspace directory.

generate

g or G

Generate a new file.

help

h or H

Lists available command and their short descriptions.

install

i or I

With argument installs packages to project, without argument installs project dependencies.

new

n or N

Creates new CPL project.

publish

p or P

Prepares files for publish into an output directory named dist/ at the given output path and executes setup.py. Must be executed from within a library workspace directory.

remove

r or R

Removes a project from workspace.

start

s or S

Starts CPL project, restarting on file changes.

uninstall

ui or UI

Uninstalls packages from project.

update

u or U

Update CPL and project dependencies.

version

v or V

Outputs CPL CLI version.

-
-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/build/html/cpl_cli.publish.html b/docs/build/html/cpl_cli.publish.html deleted file mode 100644 index af4609f6..00000000 --- a/docs/build/html/cpl_cli.publish.html +++ /dev/null @@ -1,160 +0,0 @@ - - - - - - - cpl publish — Common Python Library documentation - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

cpl publish

-
-

Contents

- - -

Prepares files for publish into an output directory named dist/ at the given output path and executes setup.py.

-

cpl publish
-cpl p
-cpl P

-
-
-

Description

-

The command can be used to publish a project of type “console” or “library”.

-

The publish command builds the source files and then creates an setup.py with data from cpl_core.json. -The command executes the setup.py and removes all source files with the setup.py from the ‘publish/’ directory.

-

Generated files of setup.py are in the ‘publish/setup/’ directory.

- -
-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/build/html/cpl_cli.remove.html b/docs/build/html/cpl_cli.remove.html deleted file mode 100644 index c796e9aa..00000000 --- a/docs/build/html/cpl_cli.remove.html +++ /dev/null @@ -1,187 +0,0 @@ - - - - - - - cpl remove — Common Python Library documentation - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

cpl remove

-
-

Contents

- -

Removes a project from workspace.

-

cpl remove <project>
-cpl r <project>
-cpl R <project>

-
-
-

Description

-

Removes a project reference and the files from workspace.

-

If you call the command in a CPL workspace, you can use the project names. Otherwise the paths of the projects must be specified.

-
-
-

Arguments

- - - - - - - - - - - - - -

Argument

Description

Value type

<project>

The name of the project to delete

str

-
-
-

Flags

- - - - - - - - - - - -

Argument

Description

--simulate

Specifies whether the command is simulated

-
-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/build/html/cpl_cli.run.html b/docs/build/html/cpl_cli.run.html deleted file mode 100644 index 5598f46a..00000000 --- a/docs/build/html/cpl_cli.run.html +++ /dev/null @@ -1,155 +0,0 @@ - - - - - - - cpl run — Common Python Library documentation - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

cpl run

-

Starts your application once.

-

cpl run
-cpl r
-cpl R

- - - - - - - - - - - - - - - - - -

Argument

Description

Value type

<project>

Optional parameter to specify which project to start, if not set default project will be started.

str

--dev

To run the project from source and not from dist after build.

str

-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/build/html/cpl_cli.start.html b/docs/build/html/cpl_cli.start.html deleted file mode 100644 index 212c54fc..00000000 --- a/docs/build/html/cpl_cli.start.html +++ /dev/null @@ -1,151 +0,0 @@ - - - - - - - cpl start — Common Python Library documentation - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

cpl start

-

Starts your application, restarting on file changes.

-

cpl start
-cpl s
-cpl S

- - - - - - - - - - - - - -

Argument

Description

Value type

--dev

To run the project from source and not from dist after build.

str

-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/build/html/cpl_cli.uninstall.html b/docs/build/html/cpl_cli.uninstall.html deleted file mode 100644 index c466b5da..00000000 --- a/docs/build/html/cpl_cli.uninstall.html +++ /dev/null @@ -1,192 +0,0 @@ - - - - - - - cpl uninstall — Common Python Library documentation - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

cpl uninstall

-
-

Contents

- -

Uninstalls given package via pip

-

cpl uninstall <package>
-cpl ui <package>
-cpl UI <package>

-
-
-

Description

-

Uninstall given package from project via pip.

-
-
-

Arguments

- - - - - - - - - - - - - -

Argument

Description

Value type

<package>

The package to uninstall

str

-
-
-

Flags

- - - - - - - - - - - - - - - - - -

Argument

Description

--dev

Specifies whether the command is in development mode

--virtual

Specifies whether the command is virtual mode

--simulate

Specifies whether the command is simulated

-
-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/build/html/cpl_cli.update.html b/docs/build/html/cpl_cli.update.html deleted file mode 100644 index 902de8d8..00000000 --- a/docs/build/html/cpl_cli.update.html +++ /dev/null @@ -1,155 +0,0 @@ - - - - - - - cpl update — Common Python Library documentation - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

cpl update

-

Updates the CPL and project dependencies.

-

cpl update
-cpl u
-cpl U

-
-

Flags

- - - - - - - - - - - -

Argument

Description

--simulate

Specifies whether the command is simulated

-
-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/build/html/cpl_cli.version.html b/docs/build/html/cpl_cli.version.html deleted file mode 100644 index 3e2c4799..00000000 --- a/docs/build/html/cpl_cli.version.html +++ /dev/null @@ -1,137 +0,0 @@ - - - - - - - cpl version — Common Python Library documentation - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

cpl version

-

Lists the version of CPL, CPL CLI and all installed packages from pip.

-

cpl version
-cpl v
-cpl V

-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/build/html/cpl_core.application.html b/docs/build/html/cpl_core.application.html deleted file mode 100644 index 0e18088f..00000000 --- a/docs/build/html/cpl_core.application.html +++ /dev/null @@ -1,433 +0,0 @@ - - - - - - - cpl_core.application package — Common Python Library documentation - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

cpl_core.application package

-
-

Submodules

-
-
-

cpl_core.application.application_abc module

-
-
-class cpl_core.application.application_abc.ApplicationABC(config: ConfigurationABC, services: ServiceProviderABC)
-

Bases: ABC

-

ABC for the Application class

-
-
Parameters:
-
config: cpl_core.configuration.configuration_abc.ConfigurationABC

Contains object loaded from appsettings

-
-
services: cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC

Contains instances of prepared objects

-
-
-
-
-
-
-abstract configure()
-

Configure the application

-

Called by cpl_core.application.application_abc.ApplicationABC.run

-
- -
-
-abstract main()
-

Custom entry point

-

Called by cpl_core.application.application_abc.ApplicationABC.run

-
- -
-
-run()
-

Entry point

-

Called by custom Application.main

-
- -
-
-async run_async()
-

Entry point

-

Called by custom Application.main

-
- -
- -
-
-

cpl_core.application.application_builder module

-
-
-class cpl_core.application.application_builder.ApplicationBuilder(app: Type[ApplicationABC])
-

Bases: ApplicationBuilderABC

-

This is class is used to build an object of cpl_core.application.application_abc.ApplicationABC

-
-
Parameter:
-
app: Type[cpl_core.application.application_abc.ApplicationABC]

Application to build

-
-
-
-
-
-
-build() → ApplicationABC
-

Creates custom application object

-
-
Returns:

Object of cpl_core.application.application_abc.ApplicationABC

-
-
-
- -
-
-async build_async() → ApplicationABC
-

Creates custom application object async

-
-
Returns:

Object of cpl_core.application.application_abc.ApplicationABC

-
-
-
- -
-
-use_extension(extension: Type[ApplicationExtensionABC | StartupExtensionABC]) → ApplicationBuilder
-
- -
-
-use_startup(startup: Type[StartupABC]) → ApplicationBuilder
-

Sets the custom startup class to use async

-
-
Parameter:
-
startup: Type[cpl_core.application.startup_abc.StartupABC]

Startup class to use

-
-
-
-
-
- -
- -
-
-

cpl_core.application.application_builder_abc module

-
-
-class cpl_core.application.application_builder_abc.ApplicationBuilderABC(*args)
-

Bases: ABC

-

ABC for the cpl_core.application.application_builder.ApplicationBuilder

-
-
-abstract build() → ApplicationABC
-

Creates custom application object

-
-
Returns:

Object of cpl_core.application.application_abc.ApplicationABC

-
-
-
- -
-
-abstract async build_async() → ApplicationABC
-

Creates custom application object async

-
-
Returns:

Object of cpl_core.application.application_abc.ApplicationABC

-
-
-
- -
-
-abstract async use_startup(startup: Type[StartupABC])
-

Sets the custom startup class to use async

-
-
Parameter:
-
startup: Type[cpl_core.application.startup_abc.StartupABC]

Startup class to use

-
-
-
-
-
- -
- -
-
-

cpl_core.application.application_extension_abc module

-
-
-class cpl_core.application.application_extension_abc.ApplicationExtensionABC
-

Bases: ABC

-
-
-abstract async run(config: ConfigurationABC, services: ServiceProviderABC)
-
- -
- -
-
-

cpl_core.application.startup_abc module

-
-
-class cpl_core.application.startup_abc.StartupABC
-

Bases: ABC

-

ABC for the startup class

-
-
-abstract configure_configuration(config: ConfigurationABC, env: ApplicationEnvironmentABC) → ConfigurationABC
-

Creates configuration of application

-
-
Parameter:

config: cpl_core.configuration.configuration_abc.ConfigurationABC -env: cpl_core.environment.application_environment_abc

-
-
Returns:

Object of cpl_core.configuration.configuration_abc.ConfigurationABC

-
-
-
- -
-
-abstract configure_services(service: ServiceCollectionABC, env: ApplicationEnvironmentABC) → ServiceProviderABC
-

Creates service provider

-
-
Parameter:

services: cpl_core.dependency_injection.service_collection_abc -env: cpl_core.environment.application_environment_abc

-
-
Returns:

Object of cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC

-
-
-
- -
- -
-
-

cpl_core.application.startup_extension_abc module

-
-
-class cpl_core.application.startup_extension_abc.StartupExtensionABC
-

Bases: ABC

-

ABC for startup extension classes

-
-
-abstract configure_configuration(config: ConfigurationABC, env: ApplicationEnvironmentABC)
-

Creates configuration of application

-
-
Parameter:

config: cpl_core.configuration.configuration_abc.ConfigurationABC -env: cpl_core.environment.application_environment_abc

-
-
-
- -
-
-abstract configure_services(service: ServiceCollectionABC, env: ApplicationEnvironmentABC)
-

Creates service provider

-
-
Parameter:

services: cpl_core.dependency_injection.service_collection_abc -env: cpl_core.environment.application_environment_abc

-
-
-
- -
- -
-
-

Module contents

-
-

cpl-core CPL core

-

CPL core package

-
-
copyright:
-
    -

  1. 2020 - 2023 sh-edraft.de

    2. -
-
-
license:
-

MIT, see LICENSE for more details.

-
-
-
-
-
-class cpl_core.application.VersionInfo(major, minor, micro)
-

Bases: tuple

-
-
-major
-

Alias for field number 0

-
- -
-
-micro
-

Alias for field number 2

-
- -
-
-minor
-

Alias for field number 1

-
- -
- -
-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/build/html/cpl_core.configuration.html b/docs/build/html/cpl_core.configuration.html deleted file mode 100644 index a0ca14f8..00000000 --- a/docs/build/html/cpl_core.configuration.html +++ /dev/null @@ -1,779 +0,0 @@ - - - - - - - cpl_core.configuration package — Common Python Library documentation - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

cpl_core.configuration package

-
-

Submodules

-
-
-

cpl_core.configuration.argument_abc module

-
-
-class cpl_core.configuration.argument_abc.ArgumentABC(token: str, name: str, aliases: list[str], prevent_next_executable: bool = False, console_arguments: list['ArgumentABC'] | None = None)
-

Bases: ABC

-
-
-add_console_argument(arg_type: ArgumentTypeEnum, *args, **kwargs) → ArgumentABC
-

Creates and adds a console argument to known console arguments

-
-
Parameter:
-
arg_type: str

Specifies the specific type of the argument

-
-
-
-
Returns:

self cpl_core.configuration.console_argument.ConsoleArgument not created argument!

-
-
-
- -
-
-property aliases: list[str]
-
- -
-
-property console_arguments: list['ArgumentABC']
-
- -
-
-property name: str
-
- -
-
-property prevent_next_executable: bool
-
- -
-
-property token: str
-
- -
- -
-
-

cpl_core.configuration.argument_builder module

-
-
-class cpl_core.configuration.argument_builder.ArgumentBuilder
-

Bases: object

-
-
-static build_argument(arg_type: ArgumentTypeEnum, *args, **kwargs) → ExecutableArgument | FlagArgument | VariableArgument
-
- -
- -
-
-

cpl_core.configuration.argument_executable_abc module

-
-
-class cpl_core.configuration.argument_executable_abc.ArgumentExecutableABC
-

Bases: ABC

-
-
-abstract run(args: list[str])
-
- -
- -
-
-

cpl_core.configuration.argument_type_enum module

-
-
-class cpl_core.configuration.argument_type_enum.ArgumentTypeEnum(value)
-

Bases: Enum

-

An enumeration.

-
-
-Executable = 1
-
- -
-
-Flag = 0
-
- -
-
-Variable = 3
-
- -
- -
-
-

cpl_core.configuration.configuration module

-
-
-class cpl_core.configuration.configuration.Configuration
-

Bases: ConfigurationABC

-
-
-add_configuration(key_type: T, value: any)
-

Add configuration object

-
-
Parameter:
-
key_type: Union[str, type]

Type of the value

-
-
value: any

Object of the value

-
-
-
-
-
- -
-
-add_console_argument(argument: ArgumentABC)
-

Adds console argument to known console arguments

-
-
Parameter:
-
argument: cpl_core.configuration.console_argument.ConsoleArgumentABC

Specifies the console argument

-
-
-
-
-
- -
-
-add_environment_variables(prefix: str)
-

Reads the environment variables

-
-
Parameter:
-
prefix: str

Prefix of the variables

-
-
-
-
-
- -
-
-add_json_file(name: str, optional: bool | None = None, output: bool = True, path: str | None = None)
-

Reads and saves settings from given json file

-
-
Parameter:
-
name: str

Name of the file

-
-
optional: str

Specifies whether an error should occur if the file was not found

-
-
output: bool

Specifies whether an output should take place

-
-
path: str

Path in which the file should be stored

-
-
-
-
-
- -
-
-property additional_arguments: list[str]
-
- -
-
-property argument_error_function: Callable | None
-
- -
-
-property arguments: list[cpl_core.configuration.argument_abc.ArgumentABC]
-
- -
-
-create_console_argument(arg_type: ArgumentTypeEnum, token: str, name: str, aliases: list[str], *args, **kwargs) → ArgumentABC
-

Creates and adds a console argument to known console arguments

-
-
Parameter:
-
token: str

Specifies optional beginning of argument

-
-
name str

Specifies name of argument

-
-
aliases list[str]

Specifies possible aliases of name

-
-
value_token str

Specifies were the value begins

-
-
is_value_token_optional bool

Specifies if values are optional

-
-
runnable: cpl_core.configuration.console_argument.ConsoleArgumentABC

Specifies class to run when called if value is not None

-
-
-
-
Returns:

Object of cpl_core.configuration.console_argument.ConsoleArgumentABC

-
-
-
- -
-
-property environment: ApplicationEnvironmentABC
-
- -
-
-for_each_argument(call: Callable)
-

Iterates through all arguments and calls the call function

-
-
Parameter:
-
call: Callable

Call for each argument

-
-
-
-
-
- -
-
-get_configuration(search_type: Type[T]) → T | None
-

Returns value from configuration by given type

-
-
Parameter:
-
search_type: Union[str, Type[cpl_core.configuration.configuration_model_abc.ConfigurationModelABC]]

Type to search for

-
-
-
-
Returns:

Object of Union[str, cpl_core.configuration.configuration_model_abc.ConfigurationModelABC]

-
-
-
- -
-
-parse_console_arguments(services: ServiceProviderABC, error: bool | None = None) → bool
-

Reads the console arguments

-
-
Parameter:
-
error: bool

Defines is invalid argument error will be shown or not

-
-
-
-
Returns:

Bool to specify if executables were executed or not.

-
-
-
- -
- -
-
-

cpl_core.configuration.configuration_abc module

-
-
-class cpl_core.configuration.configuration_abc.ConfigurationABC
-

Bases: ABC

-
-
-abstract add_configuration(key_type: T, value: any)
-

Add configuration object

-
-
Parameter:
-
key_type: Union[str, type]

Type of the value

-
-
value: any

Object of the value

-
-
-
-
-
- -
-
-abstract add_console_argument(argument: ArgumentABC)
-

Adds console argument to known console arguments

-
-
Parameter:
-
argument: cpl_core.configuration.console_argument.ConsoleArgumentABC

Specifies the console argument

-
-
-
-
-
- -
-
-abstract add_environment_variables(prefix: str)
-

Reads the environment variables

-
-
Parameter:
-
prefix: str

Prefix of the variables

-
-
-
-
-
- -
-
-abstract add_json_file(name: str, optional: bool | None = None, output: bool = True, path: str | None = None)
-

Reads and saves settings from given json file

-
-
Parameter:
-
name: str

Name of the file

-
-
optional: str

Specifies whether an error should occur if the file was not found

-
-
output: bool

Specifies whether an output should take place

-
-
path: str

Path in which the file should be stored

-
-
-
-
-
- -
-
-abstract property additional_arguments: list[str]
-
- -
-
-abstract property argument_error_function: Callable | None
-
- -
-
-abstract property arguments: list[cpl_core.configuration.argument_abc.ArgumentABC]
-
- -
-
-abstract create_console_argument(arg_type: ArgumentTypeEnum, token: str, name: str, aliases: list[str], *args, **kwargs) → ArgumentABC
-

Creates and adds a console argument to known console arguments

-
-
Parameter:
-
token: str

Specifies optional beginning of argument

-
-
name str

Specifies name of argument

-
-
aliases list[str]

Specifies possible aliases of name

-
-
value_token str

Specifies were the value begins

-
-
is_value_token_optional bool

Specifies if values are optional

-
-
runnable: cpl_core.configuration.console_argument.ConsoleArgumentABC

Specifies class to run when called if value is not None

-
-
-
-
Returns:

Object of cpl_core.configuration.console_argument.ConsoleArgumentABC

-
-
-
- -
-
-abstract property environment: ApplicationEnvironmentABC
-
- -
-
-abstract for_each_argument(call: Callable)
-

Iterates through all arguments and calls the call function

-
-
Parameter:
-
call: Callable

Call for each argument

-
-
-
-
-
- -
-
-abstract get_configuration(search_type: Type[T]) → T | None
-

Returns value from configuration by given type

-
-
Parameter:
-
search_type: Union[str, Type[cpl_core.configuration.configuration_model_abc.ConfigurationModelABC]]

Type to search for

-
-
-
-
Returns:

Object of Union[str, cpl_core.configuration.configuration_model_abc.ConfigurationModelABC]

-
-
-
- -
-
-abstract parse_console_arguments(services: ServiceProviderABC, error: bool = None) → bool
-

Reads the console arguments

-
-
Parameter:
-
error: bool

Defines is invalid argument error will be shown or not

-
-
-
-
Returns:

Bool to specify if executables were executed or not.

-
-
-
- -
- -
-
-

cpl_core.configuration.configuration_model_abc module

-
-
-class cpl_core.configuration.configuration_model_abc.ConfigurationModelABC
-

Bases: ABC

-
-
-from_dict(settings: dict)
-

DEPRECATED: Set attributes as typed arguments in __init__ instead. See https://docs.sh-edraft.de/cpl/deprecated.html#ConfigurationModelABC-from_dict-method for further information -Converts attributes to dict

-
-
Parameter:

settings: dict

-
-
-
- -
- -
-
-cpl_core.configuration.configuration_model_abc.base_func(method)
-
- -
-
-

cpl_core.configuration.configuration_variable_name_enum module

-
-
-class cpl_core.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum(value)
-

Bases: Enum

-

An enumeration.

-
-
-customer = 'CUSTOMER'
-
- -
-
-environment = 'ENVIRONMENT'
-
- -
-
-name = 'NAME'
-
- -
-
-static to_list()
-
- -
- -
-
-

cpl_core.configuration.executable_argument module

-
-
-class cpl_core.configuration.executable_argument.ExecutableArgument(token: str, name: str, aliases: list[str], executable: Type[ArgumentExecutableABC], prevent_next_executable: bool = False, validators: list[Type[cpl_core.configuration.validator_abc.ValidatorABC]] | None = None, console_arguments: list['ArgumentABC'] | None = None)
-

Bases: ArgumentABC

-
-
-property executable_type: type
-
- -
-
-run(args: list[str])
-

Executes runnable if exists

-
- -
-
-set_executable(executable: ArgumentExecutableABC)
-
- -
-
-property validators: list[Type[cpl_core.configuration.validator_abc.ValidatorABC]]
-
- -
- -
-
-

cpl_core.configuration.flag_argument module

-
-
-class cpl_core.configuration.flag_argument.FlagArgument(token: str, name: str, aliases: list[str], prevent_next_executable: bool = False, console_arguments: list['ArgumentABC'] | None = None)
-

Bases: ArgumentABC

-
- -
-
-

cpl_core.configuration.validator_abc module

-
-
-class cpl_core.configuration.validator_abc.ValidatorABC
-

Bases: ABC

-
-
-abstract validate() → bool
-
- -
- -
-
-

cpl_core.configuration.variable_argument module

-
-
-class cpl_core.configuration.variable_argument.VariableArgument(token: str, name: str, aliases: list[str], value_token: str, prevent_next_executable: bool = False, console_arguments: list['ArgumentABC'] | None = None)
-

Bases: ArgumentABC

-
-
-set_value(value: str)
-
- -
-
-property value: str
-
- -
-
-property value_token: str
-
- -
- -
-
-

Module contents

-
-

cpl-core CPL core

-

CPL core package

-
-
copyright:
-
    -

  1. 2020 - 2023 sh-edraft.de

    2. -
-
-
license:
-

MIT, see LICENSE for more details.

-
-
-
-
-
-class cpl_core.configuration.VersionInfo(major, minor, micro)
-

Bases: tuple

-
-
-major
-

Alias for field number 0

-
- -
-
-micro
-

Alias for field number 2

-
- -
-
-minor
-

Alias for field number 1

-
- -
- -
-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/build/html/cpl_core.console.html b/docs/build/html/cpl_core.console.html deleted file mode 100644 index 5c9bbd8a..00000000 --- a/docs/build/html/cpl_core.console.html +++ /dev/null @@ -1,695 +0,0 @@ - - - - - - - cpl_core.console package — Common Python Library documentation - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

cpl_core.console package

-
-

Submodules

-
-
-

cpl_core.console.background_color_enum module

-
-
-class cpl_core.console.background_color_enum.BackgroundColorEnum(value)
-

Bases: Enum

-

An enumeration.

-
-
-blue = 'on_blue'
-
- -
-
-cyan = 'on_cyan'
-
- -
-
-default = 'on_default'
-
- -
-
-green = 'on_green'
-
- -
-
-grey = 'on_grey'
-
- -
-
-magenta = 'on_magenta'
-
- -
-
-red = 'on_red'
-
- -
-
-white = 'on_white'
-
- -
-
-yellow = 'on_yellow'
-
- -
- -
-
-

cpl_core.console.console module

-
-
-class cpl_core.console.console.Console
-

Bases: object

-

Useful functions for handling with input and output

-
-
-class property background_color: str
-

str(object=’’) -> str -str(bytes_or_buffer[, encoding[, errors]]) -> str

-

Create a new string object from the given object. If encoding or -errors is specified, then the object must expose a data buffer -that will be decoded using the given encoding and error handler. -Otherwise, returns the result of object.__str__() (if defined) -or repr(object). -encoding defaults to sys.getdefaultencoding(). -errors defaults to ‘strict’.

-
- -
-
-classmethod banner(string: str)
-

Prints the string as a banner

-
-
Parameter:
-
string: str

Message to print as banner

-
-
-
-
-
- -
-
-classmethod clear()
-

Clears the console

-
- -
-
-classmethod close()
-

Closes the application

-
- -
-
-classmethod color_reset()
-

Resets the color settings

-
- -
-
-classmethod disable()
-

Disables console interaction

-
- -
-
-classmethod enable()
-

Enables console interaction

-
- -
-
-classmethod error(string: str, tb: str | None = None)
-

Prints an error with traceback

-
-
Parameter:
-
string: str

Error message

-
-
tb: str

Error traceback

-
-
-
-
-
- -
-
-class property foreground_color: str
-

str(object=’’) -> str -str(bytes_or_buffer[, encoding[, errors]]) -> str

-

Create a new string object from the given object. If encoding or -errors is specified, then the object must expose a data buffer -that will be decoded using the given encoding and error handler. -Otherwise, returns the result of object.__str__() (if defined) -or repr(object). -encoding defaults to sys.getdefaultencoding(). -errors defaults to ‘strict’.

-
- -
-
-classmethod read(output: str | None = None) → str
-

Reads in line

-
-
Parameter:
-
output: str

String to print before input

-
-
-
-
Returns:

input()

-
-
-
- -
-
-classmethod read_line(output: str | None = None) → str
-

Reads in next line

-
-
Parameter:
-
output: str

String to print before input

-
-
-
-
Returns:

input()

-
-
-
- -
-
-classmethod reset_cursor_position()
-

Resets cursor position

-
- -
-
-classmethod select(char: str, message: str, options: list[str], header_foreground_color: str | ForegroundColorEnum = ForegroundColorEnum.default, header_background_color: str | BackgroundColorEnum = BackgroundColorEnum.default, option_foreground_color: str | ForegroundColorEnum = ForegroundColorEnum.default, option_background_color: str | BackgroundColorEnum = BackgroundColorEnum.default, cursor_foreground_color: str | ForegroundColorEnum = ForegroundColorEnum.default, cursor_background_color: str | BackgroundColorEnum = BackgroundColorEnum.default) → str
-

Prints select menu

-
-
Parameter:
-
char: str

Character to show which element is selected

-
-
message: str

Message or header of the selection

-
-
options: List[str]

Selectable options

-
-
header_foreground_color: Union[str, cpl_core.console.foreground_color_enum.ForegroundColorEnum]

Foreground color of the header

-
-
header_background_color: Union[str, cpl_core.console.background_color_enum.BackgroundColorEnum]

Background color of the header

-
-
option_foreground_color: Union[str, cpl_core.console.foreground_color_enum.ForegroundColorEnum]

Foreground color of the options

-
-
option_background_color: Union[str, cpl_core.console.background_color_enum.BackgroundColorEnum]

Background color of the options

-
-
cursor_foreground_color: Union[str, cpl_core.console.foreground_color_enum.ForegroundColorEnum]

Foreground color of the cursor

-
-
cursor_background_color: Union[str, cpl_core.console.background_color_enum.BackgroundColorEnum]

Background color of the cursor

-
-
-
-
Returns:

Selected option as str

-
-
-
- -
-
-classmethod set_background_color(color: BackgroundColorEnum | str)
-

Sets the background color

-
-
Parameter:
-
color: Union[cpl_core.console.background_color_enum.BackgroundColorEnum, str]

Background color of the console

-
-
-
-
-
- -
-
-classmethod set_cursor_position(x: int, y: int)
-

Sets cursor position

-
-
Parameter:
-
x: int

X coordinate

-
-
y: int

Y coordinate

-
-
-
-
-
- -
-
-classmethod set_foreground_color(color: ForegroundColorEnum | str)
-

Sets the foreground color

-
-
Parameter:
-
color: Union[cpl_core.console.background_color_enum.BackgroundColorEnum, str]

Foreground color of the console

-
-
-
-
-
- -
-
-classmethod set_hold_back(value: bool)
-
- -
-
-classmethod spinner(message: str, call: Callable, *args, text_foreground_color: str | ForegroundColorEnum | None = None, spinner_foreground_color: str | ForegroundColorEnum | None = None, text_background_color: str | BackgroundColorEnum | None = None, spinner_background_color: str | BackgroundColorEnum | None = None, **kwargs) → any
-

Shows spinner and calls given function, when function has ended the spinner stops

-
-
Parameter:
-
message: str

Message of the spinner

-
-
call: Callable

Function to call

-
-
args: list

Arguments of the function

-
-
text_foreground_color: Union[str, cpl_core.console.foreground_color_enum.ForegroundColorEnum]

Foreground color of the text

-
-
spinner_foreground_color: Union[str, cpl_core.console.foreground_color_enum.ForegroundColorEnum]

Foreground color of the spinner

-
-
text_background_color: Union[str, cpl_core.console.background_color_enum.BackgroundColorEnum]

Background color of the text

-
-
spinner_background_color: Union[str, cpl_core.console.background_color_enum.BackgroundColorEnum]

Background color of the spinner

-
-
kwargs: dict

Keyword arguments of the call

-
-
-
-
Returns:

Return value of call

-
-
-
- -
-
-classmethod table(header: list[str], values: list[list[str]])
-

Prints a table with header and values

-
-
Parameter:
-
header: List[str]

Header of the table

-
-
values: List[List[str]]

Values of the table

-
-
-
-
-
- -
-
-classmethod write(*args, end='')
-

Prints in active line

-
-
Parameter:
-
args: list

Elements to print

-
-
end: str

Last character to print

-
-
-
-
-
- -
-
-classmethod write_at(x: int, y: int, *args)
-

Prints at given position

-
-
Parameter:
-
x: int

X coordinate

-
-
y: int

Y coordinate

-
-
args: list

Elements to print

-
-
-
-
-
- -
-
-classmethod write_line(*args)
-

Prints to new line

-
-
Parameter:
-
args: list

Elements to print

-
-
-
-
-
- -
-
-classmethod write_line_at(x: int, y: int, *args)
-

Prints new line at given position

-
-
Parameter:
-
x: int

X coordinate

-
-
y: int

Y coordinate

-
-
args: list

Elements to print

-
-
-
-
-
- -
- -
-
-

cpl_core.console.console_call module

-
-
-class cpl_core.console.console_call.ConsoleCall(function: Callable, *args)
-

Bases: object

-

Represents a console call, for hold back when spinner is active

-
-
Parameter:
-
function: Callable

Function to call

-
-
args: list

List of arguments

-
-
-
-
-
-
-property args
-
- -
-
-property function
-
- -
- -
-
-

cpl_core.console.foreground_color_enum module

-
-
-class cpl_core.console.foreground_color_enum.ForegroundColorEnum(value)
-

Bases: Enum

-

An enumeration.

-
-
-blue = 'blue'
-
- -
-
-cyan = 'cyan'
-
- -
-
-default = 'default'
-
- -
-
-green = 'green'
-
- -
-
-grey = 'grey'
-
- -
-
-magenta = 'magenta'
-
- -
-
-red = 'red'
-
- -
-
-white = 'white'
-
- -
-
-yellow = 'yellow'
-
- -
- -
-
-

cpl_core.console.spinner_thread module

-
-
-class cpl_core.console.spinner_thread.SpinnerThread(msg_len: int, foreground_color: ForegroundColorEnum, background_color: BackgroundColorEnum)
-

Bases: Thread

-

Thread to show spinner in terminal

-
-
Parameter:
-
msg_len: int

Length of the message

-
-
foreground_color: cpl_core.console.foreground_color.ForegroundColorEnum

Foreground color of the spinner

-
-
background_color: cpl_core.console.background_color.BackgroundColorEnum

Background color of the spinner

-
-
-
-
-
-
-exit()
-

Stops the spinner

-
- -
-
-run() → None
-

Entry point of thread, shows the spinner

-
- -
-
-stop_spinning()
-

Stops the spinner

-
- -
- -
-
-

Module contents

-
-

cpl-core CPL core

-

CPL core package

-
-
copyright:
-
    -

  1. 2020 - 2023 sh-edraft.de

    2. -
-
-
license:
-

MIT, see LICENSE for more details.

-
-
-
-
-
-class cpl_core.console.VersionInfo(major, minor, micro)
-

Bases: tuple

-
-
-major
-

Alias for field number 0

-
- -
-
-micro
-

Alias for field number 2

-
- -
-
-minor
-

Alias for field number 1

-
- -
- -
-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/build/html/cpl_core.database.connection.html b/docs/build/html/cpl_core.database.connection.html deleted file mode 100644 index 717b961f..00000000 --- a/docs/build/html/cpl_core.database.connection.html +++ /dev/null @@ -1,253 +0,0 @@ - - - - - - - cpl_core.database.connection package — Common Python Library documentation - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

cpl_core.database.connection package

-
-

Submodules

-
-
-

cpl_core.database.connection.database_connection module

-
-
-class cpl_core.database.connection.database_connection.DatabaseConnection
-

Bases: DatabaseConnectionABC

-

Representation of the database connection

-
-
-connect(database_settings: DatabaseSettings)
-

Connects to a database by connection string

-
-
Parameter:
-
connection_string: str

Database connection string, see: https://docs.sqlalchemy.org/en/14/core/engines.html

-
-
-
-
-
- -
-
-property cursor: MySQLCursorBuffered
-
- -
-
-property server: MySQLConnectionAbstract
-
- -
- -
-
-

cpl_core.database.connection.database_connection_abc module

-
-
-class cpl_core.database.connection.database_connection_abc.DatabaseConnectionABC
-

Bases: ABC

-

ABC for the cpl_core.database.connection.database_connection.DatabaseConnection

-
-
-abstract connect(database_settings: DatabaseSettings)
-

Connects to a database by connection string

-
-
Parameter:
-
connection_string: str

Database connection string, see: https://docs.sqlalchemy.org/en/14/core/engines.html

-
-
-
-
-
- -
-
-abstract property cursor: MySQLCursorBuffered
-
- -
-
-abstract property server: MySQLConnectionAbstract
-
- -
- -
-
-

Module contents

-
-

cpl-core CPL core

-

CPL core package

-
-
copyright:
-
    -

  1. 2020 - 2023 sh-edraft.de

    2. -
-
-
license:
-

MIT, see LICENSE for more details.

-
-
-
-
-
-class cpl_core.database.connection.VersionInfo(major, minor, micro)
-

Bases: tuple

-
-
-major
-

Alias for field number 0

-
- -
-
-micro
-

Alias for field number 2

-
- -
-
-minor
-

Alias for field number 1

-
- -
- -
-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/build/html/cpl_core.database.context.html b/docs/build/html/cpl_core.database.context.html deleted file mode 100644 index 7e1eb9f5..00000000 --- a/docs/build/html/cpl_core.database.context.html +++ /dev/null @@ -1,277 +0,0 @@ - - - - - - - cpl_core.database.context package — Common Python Library documentation - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

cpl_core.database.context package

-
-

Submodules

-
-
-

cpl_core.database.context.database_context module

-
-
-class cpl_core.database.context.database_context.DatabaseContext
-

Bases: DatabaseContextABC

-

Representation of the database context

-
-
Parameter:

database_settings: cpl_core.database.database_settings.DatabaseSettings

-
-
-
-
-connect(database_settings: DatabaseSettings)
-

Connects to a database by connection settings

-
-
Parameter:

database_settings cpl_core.database.database_settings.DatabaseSettings

-
-
-
- -
-
-property cursor: MySQLCursorBuffered
-
- -
-
-save_changes()
-

Saves changes of the database

-
- -
-
-select(statement: str) → list[tuple]
-

Runs SQL Statements

-
-
Parameter:

statement: str

-
-
Returns:

list: Fetched list of selected elements

-
-
-
- -
- -
-
-

cpl_core.database.context.database_context_abc module

-
-
-class cpl_core.database.context.database_context_abc.DatabaseContextABC(*args)
-

Bases: ABC

-

ABC for the cpl_core.database.context.database_context.DatabaseContext

-
-
-abstract connect(database_settings: DatabaseSettings)
-

Connects to a database by connection settings

-
-
Parameter:

database_settings cpl_core.database.database_settings.DatabaseSettings

-
-
-
- -
-
-abstract property cursor: MySQLCursorBuffered
-
- -
-
-abstract save_changes()
-

Saves changes of the database

-
- -
-
-abstract select(statement: str) → list[tuple]
-

Runs SQL Statements

-
-
Parameter:

statement: str

-
-
Returns:

list: Fetched list of selected elements

-
-
-
- -
- -
-
-

Module contents

-
-

cpl-core CPL core

-

CPL core package

-
-
copyright:
-
    -

  1. 2020 - 2023 sh-edraft.de

    2. -
-
-
license:
-

MIT, see LICENSE for more details.

-
-
-
-
-
-class cpl_core.database.context.VersionInfo(major, minor, micro)
-

Bases: tuple

-
-
-major
-

Alias for field number 0

-
- -
-
-micro
-

Alias for field number 2

-
- -
-
-minor
-

Alias for field number 1

-
- -
- -
-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/build/html/cpl_core.database.html b/docs/build/html/cpl_core.database.html deleted file mode 100644 index 220bb5b1..00000000 --- a/docs/build/html/cpl_core.database.html +++ /dev/null @@ -1,416 +0,0 @@ - - - - - - - cpl_core.database package — Common Python Library documentation - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

cpl_core.database package

-
-

Subpackages

-
- -
-
-
-

Submodules

-
-
-

cpl_core.database.database_settings module

-
-
-class cpl_core.database.database_settings.DatabaseSettings(host: str | None = None, port: int | None = None, user: str | None = None, password: str | None = None, databse: str | None = None, charset: str | None = None, use_unicode: bool | None = None, buffered: bool | None = None, auth_plugin: bool | None = None)
-

Bases: ConfigurationModelABC

-

Represents settings for the database connection

-
-
-property auth_plugin: str | None
-
- -
-
-property buffered: bool | None
-
- -
-
-property charset: str | None
-
- -
-
-property database: str | None
-
- -
-
-property host: str | None
-
- -
-
-property password: str | None
-
- -
-
-property port: int | None
-
- -
-
-property use_unicode: bool | None
-
- -
-
-property user: str | None
-
- -
- -
-
-

cpl_core.database.database_settings_name_enum module

-
-
-class cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum(value)
-

Bases: Enum

-

An enumeration.

-
-
-auth_plugin = 'AuthPlugin'
-
- -
-
-buffered = 'Buffered'
-
- -
-
-charset = 'Charset'
-
- -
-
-database = 'Database'
-
- -
-
-host = 'Host'
-
- -
-
-password = 'Password'
-
- -
-
-port = 'Port'
-
- -
-
-use_unicode = 'UseUnicode'
-
- -
-
-user = 'User'
-
- -
- -
-
-

cpl_core.database.table_abc module

-
-
-class cpl_core.database.table_abc.TableABC
-

Bases: ABC

-
-
-property created_at: datetime
-
- -
-
-abstract property delete_string: str
-
- -
-
-abstract property insert_string: str
-
- -
-
-property modified_at: datetime
-
- -
-
-abstract property udpate_string: str
-
- -
- -
-
-

Module contents

-
-

cpl-core CPL core

-

CPL core package

-
-
copyright:
-
    -

  1. 2020 - 2023 sh-edraft.de

    2. -
-
-
license:
-

MIT, see LICENSE for more details.

-
-
-
-
-
-class cpl_core.database.VersionInfo(major, minor, micro)
-

Bases: tuple

-
-
-major
-

Alias for field number 0

-
- -
-
-micro
-

Alias for field number 2

-
- -
-
-minor
-

Alias for field number 1

-
- -
- -
-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/build/html/cpl_core.dependency_injection.html b/docs/build/html/cpl_core.dependency_injection.html deleted file mode 100644 index f42e21da..00000000 --- a/docs/build/html/cpl_core.dependency_injection.html +++ /dev/null @@ -1,803 +0,0 @@ - - - - - - - cpl_core.dependency_injection package — Common Python Library documentation - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

cpl_core.dependency_injection package

-
-

Submodules

-
-
-

cpl_core.dependency_injection.scope module

-
-
-class cpl_core.dependency_injection.scope.Scope(service_provider: ServiceProviderABC)
-

Bases: ScopeABC

-
-
-dispose()
-

Sets service_provider to None

-
- -
-
-property service_provider: ServiceProviderABC
-

Returns to service provider of scope

-
-
Returns:

Object of type cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC

-
-
-
- -
- -
-
-

cpl_core.dependency_injection.scope_abc module

-
-
-class cpl_core.dependency_injection.scope_abc.ScopeABC
-

Bases: ABC

-

ABC for the class cpl_core.dependency_injection.scope.Scope

-
-
-abstract dispose()
-

Sets service_provider to None

-
- -
-
-abstract property service_provider
-

Returns to service provider of scope

-
-
Returns:

Object of type cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC

-
-
-
- -
- -
-
-

cpl_core.dependency_injection.scope_builder module

-
-
-class cpl_core.dependency_injection.scope_builder.ScopeBuilder(service_provider: ServiceProviderABC)
-

Bases: object

-

Class to build cpl_core.dependency_injection.scope.Scope

-
-
-build() → ScopeABC
-

Returns scope

-
-
Returns:

Object of type cpl_core.dependency_injection.scope.Scope

-
-
-
- -
- -
-
-

cpl_core.dependency_injection.service_collection module

-
-
-class cpl_core.dependency_injection.service_collection.ServiceCollection(config: ConfigurationABC)
-

Bases: ServiceCollectionABC

-

Representation of the collection of services

-
-
-add_db_context(db_context_type: Type[DatabaseContextABC], db_settings: DatabaseSettings)
-

Adds database context

-
-
Parameter:
-
db_context: Type[cpl_core.database.context.database_context_abc.DatabaseContextABC]

Database context

-
-
-
-
-
- -
-
-add_logging()
-

Adds the CPL internal logger

-
- -
-
-add_pipes()
-

Adds the CPL internal pipes as transient

-
- -
-
-add_scoped(service_type: T, service: Callable | None = None)
-

Adds a service with scoped lifetime

-
-
Parameter:
-
service_type: Type

Type of the service

-
-
service: Callable

Object of the service

-
-
-
-
Returns:

self: cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC

-
-
-
- -
-
-add_singleton(service_type: T, service: T | None = None)
-

Adds a service with singleton lifetime

-
-
Parameter:
-
service_type: Type

Type of the service

-
-
service: Callable

Object of the service

-
-
-
-
Returns:

self: cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC

-
-
-
- -
-
-add_transient(service_type: T, service: T | None = None)
-

Adds a service with transient lifetime

-
-
Parameter:
-
service_type: Type

Type of the service

-
-
service: Callable

Object of the service

-
-
-
-
Returns:

self: cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC

-
-
-
- -
-
-build_service_provider() → ServiceProviderABC
-

Creates instance of the service provider

-
-
Returns:

Object of type cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC

-
-
-
- -
- -
-
-

cpl_core.dependency_injection.service_collection_abc module

-
-
-class cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC
-

Bases: ABC

-

ABC for the class cpl_core.dependency_injection.service_collection.ServiceCollection

-
-
-abstract add_db_context(db_context_type: Type[DatabaseContextABC], db_settings: DatabaseSettings)
-

Adds database context

-
-
Parameter:
-
db_context: Type[cpl_core.database.context.database_context_abc.DatabaseContextABC]

Database context

-
-
-
-
-
- -
-
-add_discord()
-

Adds the CPL discord

-
- -
-
-abstract add_logging()
-

Adds the CPL internal logger

-
- -
-
-abstract add_pipes()
-

Adds the CPL internal pipes as transient

-
- -
-
-abstract add_scoped(service_type: T, service: T | None = None) → ServiceCollectionABC
-

Adds a service with scoped lifetime

-
-
Parameter:
-
service_type: Type

Type of the service

-
-
service: Callable

Object of the service

-
-
-
-
Returns:

self: cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC

-
-
-
- -
-
-abstract add_singleton(service_type: T, service: T | None = None) → ServiceCollectionABC
-

Adds a service with singleton lifetime

-
-
Parameter:
-
service_type: Type

Type of the service

-
-
service: Callable

Object of the service

-
-
-
-
Returns:

self: cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC

-
-
-
- -
-
-abstract add_transient(service_type: T, service: T | None = None) → ServiceCollectionABC
-

Adds a service with transient lifetime

-
-
Parameter:
-
service_type: Type

Type of the service

-
-
service: Callable

Object of the service

-
-
-
-
Returns:

self: cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC

-
-
-
- -
-
-add_translation()
-

Adds the CPL translation

-
- -
-
-abstract build_service_provider() → ServiceProviderABC
-

Creates instance of the service provider

-
-
Returns:

Object of type cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC

-
-
-
- -
- -
-
-

cpl_core.dependency_injection.service_descriptor module

-
-
-class cpl_core.dependency_injection.service_descriptor.ServiceDescriptor(implementation: type | object | None, lifetime: ServiceLifetimeEnum, base_type=None)
-

Bases: object

-

Descriptor of a service

-
-
Parameter:
-
implementation: Union[type, Optional[object]]

Object or type of service

-
-
lifetime: cpl_core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum

Lifetime of the service

-
-
-
-
-
-
-property base_type: type
-
- -
-
-property implementation: type | object | None
-
- -
-
-property lifetime: ServiceLifetimeEnum
-
- -
-
-property service_type: type
-
- -
- -
-
-

cpl_core.dependency_injection.service_lifetime_enum module

-
-
-class cpl_core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum(value)
-

Bases: Enum

-

An enumeration.

-
-
-scoped = 1
-
- -
-
-singleton = 0
-
- -
-
-transient = 2
-
- -
- -
-
-

cpl_core.dependency_injection.service_provider module

-
-
-class cpl_core.dependency_injection.service_provider.ServiceProvider(service_descriptors: list[cpl_core.dependency_injection.service_descriptor.ServiceDescriptor], config: ConfigurationABC, db_context: DatabaseContextABC | None)
-

Bases: ServiceProviderABC

-

Provider for the services

-
-

Parameter

-
-
-
service_descriptors: list[cpl_core.dependency_injection.service_descriptor.ServiceDescriptor]

Descriptor of the service

-
-
config: cpl_core.configuration.configuration_abc.ConfigurationABC

CPL Configuration

-
-
db_context: Optional[cpl_core.database.context.database_context_abc.DatabaseContextABC]

Database representation

-
-
-
-
-
-build_by_signature(sig: Signature) → list[T]
-
- -
-
-build_service(service_type: type, *args, **kwargs) → object
-

Creates instance of given type

-
-

Parameter

-
-
-
instance_type: type

The type of the searched instance

-
-
-
-
-
-

Returns

-
-

Object of the given type

-
-
-
- -
-
-create_scope() → ScopeABC
-

Creates a service scope

-
-

Returns

-
-
-
-
- -
-
-get_service(service_type: T, *args, **kwargs) → T | None
-

Returns instance of given type

-
-

Parameter

-
-
-
instance_type: cpl_core.type.T

The type of the searched instance

-
-
-
-
-
-

Returns

-
-

Object of type Optional[cpl_core.type.T]

-
-
-
- -
-
-get_services(service_type: T, *args, **kwargs) → list[Optional[T]]
-

Returns instance of given type

-
-

Parameter

-
-
-
instance_type: cpl_core.type.T

The type of the searched instance

-
-
-
-
-
-

Returns

-
-

Object of type list[Optional[cpl_core.type.T]

-
-
-
- -
-
-set_scope(scope: ScopeABC)
-

Sets the scope of service provider

-
-

Parameter

-
-
-
Object of type cpl_core.dependency_injection.scope_abc.ScopeABC

Service scope

-
-
-
-
-
- -
-
- -
-
-

cpl_core.dependency_injection.service_provider_abc module

-
-
-class cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC
-

Bases: ABC

-

ABC for the class cpl_core.dependency_injection.service_provider.ServiceProvider

-
-
-abstract build_by_signature(sig: Signature) → list[T]
-
- -
-
-abstract build_service(service_type: type, *args, **kwargs) → object
-

Creates instance of given type

-
-

Parameter

-
-
-
instance_type: type

The type of the searched instance

-
-
-
-
-
-

Returns

-
-

Object of the given type

-
-
-
- -
-
-abstract create_scope() → ScopeABC
-

Creates a service scope

-
-

Returns

-
-
-
-
- -
-
-abstract get_service(instance_type: T, *args, **kwargs) → T | None
-

Returns instance of given type

-
-

Parameter

-
-
-
instance_type: cpl_core.type.T

The type of the searched instance

-
-
-
-
-
-

Returns

-
-

Object of type Optional[cpl_core.type.T]

-
-
-
- -
-
-abstract get_services(service_type: T, *args, **kwargs) → list[Optional[T]]
-

Returns instance of given type

-
-

Parameter

-
-
-
instance_type: cpl_core.type.T

The type of the searched instance

-
-
-
-
-
-

Returns

-
-

Object of type list[Optional[cpl_core.type.T]

-
-
-
- -
-
-classmethod inject(f=None)
-

Decorator to allow injection into static and class methods

-
-

Parameter

-
-

f: Callable

-
-
-
-

Returns

-
-

function

-
-
-
- -
-
-classmethod set_global_provider(provider: ServiceProviderABC)
-
- -
-
-abstract set_scope(scope: ScopeABC)
-

Sets the scope of service provider

-
-

Parameter

-
-
-
Object of type cpl_core.dependency_injection.scope_abc.ScopeABC

Service scope

-
-
-
-
-
- -
- -
-
-

Module contents

-
-

cpl-core CPL core

-

CPL core package

-
-
copyright:
-
    -

  1. 2020 - 2023 sh-edraft.de

    2. -
-
-
license:
-

MIT, see LICENSE for more details.

-
-
-
-
-
-class cpl_core.dependency_injection.VersionInfo(major, minor, micro)
-

Bases: tuple

-
-
-major
-

Alias for field number 0

-
- -
-
-micro
-

Alias for field number 2

-
- -
-
-minor
-

Alias for field number 1

-
- -
- -
-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/build/html/cpl_core.environment.html b/docs/build/html/cpl_core.environment.html deleted file mode 100644 index 52ffc65e..00000000 --- a/docs/build/html/cpl_core.environment.html +++ /dev/null @@ -1,390 +0,0 @@ - - - - - - - cpl_core.environment package — Common Python Library documentation - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

cpl_core.environment package

-
-

Submodules

-
-
-

cpl_core.environment.application_environment module

-
-
-class cpl_core.environment.application_environment.ApplicationEnvironment(name: EnvironmentNameEnum = EnvironmentNameEnum.production)
-

Bases: ApplicationEnvironmentABC

-

Represents environment of the application

-
-
Parameter:

name: cpl_core.environment.environment_name_enum.EnvironmentNameEnum

-
-
-
-
-property application_name: str
-
- -
-
-property customer: str
-
- -
-
-property date_time_now: datetime
-
- -
-
-property end_time: datetime
-
- -
-
-property environment_name: str
-
- -
-
-property host_name
-
- -
-
-property runtime_directory: str
-
- -
-
-set_runtime_directory(runtime_directory: str)
-

Sets the current runtime directory

-
-
Parameter:
-
runtime_directory: str

Path of the runtime directory

-
-
-
-
-
- -
-
-set_working_directory(working_directory: str)
-

Sets the current working directory

-
-
Parameter:
-
working_directory: str

Path of the current working directory

-
-
-
-
-
- -
-
-property start_time: datetime
-
- -
-
-property working_directory: str
-
- -
- -
-
-

cpl_core.environment.application_environment_abc module

-
-
-class cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC
-

Bases: ABC

-

ABC of the class cpl_core.environment.application_environment.ApplicationEnvironment

-
-
-abstract property application_name: str
-
- -
-
-abstract property customer: str
-
- -
-
-abstract property date_time_now: datetime
-
- -
-
-abstract property end_time
-
- -
-
-abstract property environment_name: str
-
- -
-
-abstract property host_name: str
-
- -
-
-abstract property runtime_directory: str
-
- -
-
-abstract set_runtime_directory(runtime_directory: str)
-

Sets the current runtime directory

-
-
Parameter:
-
runtime_directory: str

Path of the runtime directory

-
-
-
-
-
- -
-
-abstract set_working_directory(working_directory: str)
-

Sets the current working directory

-
-
Parameter:
-
working_directory: str

Path of the current working directory

-
-
-
-
-
- -
-
-abstract property start_time: datetime
-
- -
-
-abstract property working_directory: str
-
- -
- -
-
-

cpl_core.environment.environment_name_enum module

-
-
-class cpl_core.environment.environment_name_enum.EnvironmentNameEnum(value)
-

Bases: Enum

-

An enumeration.

-
-
-development = 'development'
-
- -
-
-production = 'production'
-
- -
-
-staging = 'staging'
-
- -
-
-testing = 'testing'
-
- -
- -
-
-

Module contents

-
-

cpl-core CPL core

-

CPL core package

-
-
copyright:
-
    -

  1. 2020 - 2023 sh-edraft.de

    2. -
-
-
license:
-

MIT, see LICENSE for more details.

-
-
-
-
-
-class cpl_core.environment.VersionInfo(major, minor, micro)
-

Bases: tuple

-
-
-major
-

Alias for field number 0

-
- -
-
-micro
-

Alias for field number 2

-
- -
-
-minor
-

Alias for field number 1

-
- -
- -
-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/build/html/cpl_core.html b/docs/build/html/cpl_core.html deleted file mode 100644 index fb651a48..00000000 --- a/docs/build/html/cpl_core.html +++ /dev/null @@ -1,956 +0,0 @@ - - - - - - - API reference — Common Python Library documentation - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

API reference

-
- -
-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/build/html/cpl_core.logging.html b/docs/build/html/cpl_core.logging.html deleted file mode 100644 index 673100bf..00000000 --- a/docs/build/html/cpl_core.logging.html +++ /dev/null @@ -1,558 +0,0 @@ - - - - - - - cpl_core.logging package — Common Python Library documentation - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

cpl_core.logging package

-
-

Submodules

-
-
-

cpl_core.logging.logger_abc module

-
-
-class cpl_core.logging.logger_abc.LoggerABC
-

Bases: ABC

-

ABC for cpl_core.logging.logger_service.Logger

-
-
-abstract debug(name: str, message: str)
-

Writes a debug message

-
-
Parameter:
-
name: str

Message name

-
-
message: str

Message string

-
-
-
-
-
- -
-
-abstract error(name: str, message: str, ex: Exception | None = None)
-

Writes an error

-
-
Parameter:
-
name: str

Error name

-
-
message: str

Error message

-
-
ex: Exception

Thrown exception

-
-
-
-
-
- -
-
-abstract fatal(name: str, message: str, ex: Exception | None = None)
-

Writes an error and ends the program

-
-
Parameter:
-
name: str

Error name

-
-
message: str

Error message

-
-
ex: Exception

Thrown exception

-
-
-
-
-
- -
-
-abstract header(string: str)
-

Writes a header message

-
-
Parameter:
-
string: str

String to write as header

-
-
-
-
-
- -
-
-abstract info(name: str, message: str)
-

Writes an information

-
-
Parameter:
-
name: str

Message name

-
-
message: str

Message string

-
-
-
-
-
- -
-
-abstract trace(name: str, message: str)
-

Writes a trace message

-
-
Parameter:
-
name: str

Message name

-
-
message: str

Message string

-
-
-
-
-
- -
-
-abstract warn(name: str, message: str)
-

Writes an warning

-
-
Parameter:
-
name: str

Message name

-
-
message: str

Message string

-
-
-
-
-
- -
- -
-
-

cpl_core.logging.logger_service module

-
-
-class cpl_core.logging.logger_service.Logger(logging_settings: LoggingSettings, time_format: TimeFormatSettings, env: ApplicationEnvironmentABC)
-

Bases: LoggerABC

-

Service for logging

-
-
Parameter:
-
logging_settings: cpl_core.logging.logging_settings.LoggingSettings

Settings for the logger

-
-
time_format: cpl_core.time.time_format_settings.TimeFormatSettings

Time format settings

-
-
env: cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC

Environment of the application

-
-
-
-
-
-
-create() → None
-

Creates path tree and logfile

-
- -
-
-debug(name: str, message: str)
-

Writes a debug message

-
-
Parameter:
-
name: str

Message name

-
-
message: str

Message string

-
-
-
-
-
- -
-
-error(name: str, message: str, ex: Exception | None = None)
-

Writes an error

-
-
Parameter:
-
name: str

Error name

-
-
message: str

Error message

-
-
ex: Exception

Thrown exception

-
-
-
-
-
- -
-
-fatal(name: str, message: str, ex: Exception | None = None)
-

Writes an error and ends the program

-
-
Parameter:
-
name: str

Error name

-
-
message: str

Error message

-
-
ex: Exception

Thrown exception

-
-
-
-
-
- -
-
-header(string: str)
-

Writes a header message

-
-
Parameter:
-
string: str

String to write as header

-
-
-
-
-
- -
-
-info(name: str, message: str)
-

Writes an information

-
-
Parameter:
-
name: str

Message name

-
-
message: str

Message string

-
-
-
-
-
- -
-
-trace(name: str, message: str)
-

Writes a trace message

-
-
Parameter:
-
name: str

Message name

-
-
message: str

Message string

-
-
-
-
-
- -
-
-warn(name: str, message: str)
-

Writes an warning

-
-
Parameter:
-
name: str

Message name

-
-
message: str

Message string

-
-
-
-
-
- -
- -
-
-

cpl_core.logging.logging_level_enum module

-
-
-class cpl_core.logging.logging_level_enum.LoggingLevelEnum(value)
-

Bases: Enum

-

An enumeration.

-
-
-DEBUG = 5
-
- -
-
-ERROR = 2
-
- -
-
-FATAL = 1
-
- -
-
-INFO = 4
-
- -
-
-OFF = 0
-
- -
-
-TRACE = 6
-
- -
-
-WARN = 3
-
- -
- -
-
-

cpl_core.logging.logging_settings module

-
-
-class cpl_core.logging.logging_settings.LoggingSettings(path: str | None = None, filename: str | None = None, console_log_level: LoggingLevelEnum | None = None, file_log_level: LoggingLevelEnum | None = None)
-

Bases: ConfigurationModelABC

-

Representation of logging settings

-
-
-property console: LoggingLevelEnum
-
- -
-
-property filename: str
-
- -
-
-property level: LoggingLevelEnum
-
- -
-
-property path: str
-
- -
- -
-
-

cpl_core.logging.logging_settings_name_enum module

-
-
-class cpl_core.logging.logging_settings_name_enum.LoggingSettingsNameEnum(value)
-

Bases: Enum

-

An enumeration.

-
-
-console_level = 'ConsoleLogLevel'
-
- -
-
-file_level = 'FileLogLevel'
-
- -
-
-filename = 'Filename'
-
- -
-
-path = 'Path'
-
- -
- -
-
-

Module contents

-
-

cpl-core CPL core

-

CPL core package

-
-
copyright:
-
    -

  1. 2020 - 2023 sh-edraft.de

    2. -
-
-
license:
-

MIT, see LICENSE for more details.

-
-
-
-
-
-class cpl_core.logging.VersionInfo(major, minor, micro)
-

Bases: tuple

-
-
-major
-

Alias for field number 0

-
- -
-
-micro
-

Alias for field number 2

-
- -
-
-minor
-

Alias for field number 1

-
- -
- -
-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/build/html/cpl_core.mailing.html b/docs/build/html/cpl_core.mailing.html deleted file mode 100644 index b871fdcb..00000000 --- a/docs/build/html/cpl_core.mailing.html +++ /dev/null @@ -1,459 +0,0 @@ - - - - - - - cpl_core.mailing package — Common Python Library documentation - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

cpl_core.mailing package

-
-

Submodules

-
-
-

cpl_core.mailing.email module

-
-
-class cpl_core.mailing.email.EMail(header: list[str] | None = None, subject: str | None = None, body: str | None = None, transceiver: str | None = None, receiver: list[str] | None = None)
-

Bases: object

-

Represents an email

-
-
Parameter:
-
header: list[str]

Header of the E-Mail

-
-
subject: str

Subject of the E-Mail

-
-
body: str

Body of the E-Mail

-
-
transceiver: str

Transceiver of the E-Mail

-
-
receiver: list[str]

Receiver of the E-Mail

-
-
-
-
-
-
-add_header(header: str)
-

Adds header

-
-
Parameter:
-
header: str

The header of the E-Mail

-
-
-
-
-
- -
-
-add_receiver(receiver: str)
-

Adds receiver

-
-
Parameter:
-
receiver: str

The receiver of the E-Mail

-
-
-
-
-
- -
-
-property body: str
-
- -
-
-static check_mail(address: str) → bool
-

Checks if an email is valid

-
-
Parameter:
-
address: str

The address to check

-
-
-
-
Returns:

Result if E-Mail is valid or not

-
-
-
- -
-
-get_content(transceiver: str)
-

Returns the mail as string

-
-
Parameter:
-
transceiver: str

The transceiver of the E-Mail

-
-
-
-
Returns:

E-Mail as string

-
-
-
- -
-
-property header: str
-
- -
-
-property header_list: list[str]
-
- -
-
-property receiver: str
-
- -
-
-property receiver_list: list[str]
-
- -
-
-property subject: str
-
- -
-
-property transceiver: str
-
- -
- -
-
-

cpl_core.mailing.email_client_abc module

-
-
-class cpl_core.mailing.email_client_abc.EMailClientABC
-

Bases: ABC

-

ABC of cpl_core.mailing.email_client_service.EMailClient

-
-
-abstract connect()
-

Connects to server

-
- -
-
-abstract send_mail(email: EMail)
-

Sends email

-
-
Parameter:
-
email: cpl_core.mailing.email.EMail

Object of the E-Mail to send

-
-
-
-
-
- -
- -
-
-

cpl_core.mailing.email_client_service module

-
-
-class cpl_core.mailing.email_client_service.EMailClient(environment: ApplicationEnvironmentABC, logger: LoggerABC, mail_settings: EMailClientSettings)
-

Bases: EMailClientABC

-

Service to send emails

-
-
Parameter:
-
environment: cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC

Environment of the application

-
-
logger: cpl_core.logging.logger_abc.LoggerABC

The logger to use

-
-
mail_settings: cpl_core.mailing.email_client_settings.EMailClientSettings

Settings for mailing

-
-
-
-
-
-
-connect()
-

Connects to server

-
- -
-
-create()
-

Creates connection

-
- -
-
-login()
-

Login to server

-
- -
-
-send_mail(email: EMail)
-

Sends email

-
-
Parameter:
-
email: cpl_core.mailing.email.EMail

Object of the E-Mail to send

-
-
-
-
-
- -
- -
-
-

cpl_core.mailing.email_client_settings module

-
-
-class cpl_core.mailing.email_client_settings.EMailClientSettings(host: str | None = None, port: int | None = None, user_name: str | None = None, credentials: str | None = None)
-

Bases: ConfigurationModelABC

-

Representation of mailing settings

-
-
-property credentials: str
-
- -
-
-property host: str
-
- -
-
-property port: int
-
- -
-
-property user_name: str
-
- -
- -
-
-

cpl_core.mailing.email_client_settings_name_enum module

-
-
-class cpl_core.mailing.email_client_settings_name_enum.EMailClientSettingsNameEnum(value)
-

Bases: Enum

-

An enumeration.

-
-
-credentials = 'Credentials'
-
- -
-
-host = 'Host'
-
- -
-
-port = 'Port'
-
- -
-
-user_name = 'UserName'
-
- -
- -
-
-

Module contents

-
-

cpl-core CPL core

-

CPL core package

-
-
copyright:
-
    -

  1. 2020 - 2023 sh-edraft.de

    2. -
-
-
license:
-

MIT, see LICENSE for more details.

-
-
-
-
-
-class cpl_core.mailing.VersionInfo(major, minor, micro)
-

Bases: tuple

-
-
-major
-

Alias for field number 0

-
- -
-
-micro
-

Alias for field number 2

-
- -
-
-minor
-

Alias for field number 1

-
- -
- -
-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/build/html/cpl_core.pipes.html b/docs/build/html/cpl_core.pipes.html deleted file mode 100644 index f9e28e08..00000000 --- a/docs/build/html/cpl_core.pipes.html +++ /dev/null @@ -1,366 +0,0 @@ - - - - - - - cpl_core.pipes package — Common Python Library documentation - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

cpl_core.pipes package

-
-

Submodules

-
-
-

cpl_core.pipes.bool_pipe module

-
-
-class cpl_core.pipes.bool_pipe.BoolPipe
-

Bases: PipeABC

-
-
-transform(value: bool, *args)
-
- -
- -
-
-

cpl_core.pipes.first_char_to_lower_pipe module

-
-
-class cpl_core.pipes.first_char_to_lower_pipe.FirstCharToLowerPipe
-

Bases: PipeABC

-
-
-transform(value: any, *args)
-

Converts first char to lower

-
-
Parameter:
-
value: str

String to convert

-
-
-
-
Returns:

String with first char as lower

-
-
-
- -
- -
-
-

cpl_core.pipes.first_to_upper_pipe module

-
-
-class cpl_core.pipes.first_to_upper_pipe.FirstToUpperPipe
-

Bases: PipeABC

-
-
-transform(value: str, *args)
-

Converts first char to upper

-
-
Parameter:
-
chars: str

String to convert

-
-
-
-
Returns:

String with first char as upper

-
-
-
- -
- -
-
-

cpl_core.pipes.ip_address_pipe module

-
-
-class cpl_core.pipes.ip_address_pipe.IPAddressPipe
-

Bases: PipeABC

-
-
-transform(value: list[int], *args)
-
- -
- -
-
-

cpl_core.pipes.pipe_abc module

-
-
-class cpl_core.pipes.pipe_abc.PipeABC
-

Bases: ABC

-
-
-abstract transform(value: any, *args)
-
- -
- -
-
-

cpl_core.pipes.to_camel_case_pipe module

-
-
-class cpl_core.pipes.to_camel_case_pipe.ToCamelCasePipe
-

Bases: PipeABC

-
-
-transform(value: str, *args) → str
-

Converts string to camel case

-
-
Parameter:
-
chars: str

String to convert

-
-
-
-
Returns:

String converted to CamelCase

-
-
-
- -
- -
-
-

cpl_core.pipes.to_snake_case_pipe module

-
-
-class cpl_core.pipes.to_snake_case_pipe.ToSnakeCasePipe
-

Bases: PipeABC

-
-
-transform(value: str, *args) → str
-

Converts string to snake case

-
-
Parameter:
-
chars: str

String to convert

-
-
-
-
Returns:

String converted to snake_case

-
-
-
- -
- -
-
-

cpl_core.pipes.version_pipe module

-
-
-class cpl_core.pipes.version_pipe.VersionPipe
-

Bases: PipeABC

-
-
-transform(value: dict, *args)
-
- -
- -
-
-

Module contents

-
-

cpl-core CPL core

-

CPL core package

-
-
copyright:
-
    -

  1. 2020 - 2023 sh-edraft.de

    2. -
-
-
license:
-

MIT, see LICENSE for more details.

-
-
-
-
-
-class cpl_core.pipes.VersionInfo(major, minor, micro)
-

Bases: tuple

-
-
-major
-

Alias for field number 0

-
- -
-
-micro
-

Alias for field number 2

-
- -
-
-minor
-

Alias for field number 1

-
- -
- -
-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/build/html/cpl_core.time.html b/docs/build/html/cpl_core.time.html deleted file mode 100644 index ae064fab..00000000 --- a/docs/build/html/cpl_core.time.html +++ /dev/null @@ -1,250 +0,0 @@ - - - - - - - cpl_core.time package — Common Python Library documentation - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

cpl_core.time package

-
-

Submodules

-
-
-

cpl_core.time.time_format_settings module

-
-
-class cpl_core.time.time_format_settings.TimeFormatSettings(date_format: str | None = None, time_format: str | None = None, date_time_format: str | None = None, date_time_log_format: str | None = None)
-

Bases: ConfigurationModelABC

-

Representation of time format settings

-
-
-property date_format: str
-
- -
-
-property date_time_format: str
-
- -
-
-property date_time_log_format
-
- -
-
-property time_format: str
-
- -
- -
-
-

cpl_core.time.time_format_settings_names_enum module

-
-
-class cpl_core.time.time_format_settings_names_enum.TimeFormatSettingsNamesEnum(value)
-

Bases: Enum

-

An enumeration.

-
-
-date_format = 'DateFormat'
-
- -
-
-date_time_format = 'DateTimeFormat'
-
- -
-
-date_time_log_format = 'DateTimeLogFormat'
-
- -
-
-time_format = 'TimeFormat'
-
- -
- -
-
-

Module contents

-
-

cpl-core CPL core

-

CPL core package

-
-
copyright:
-
    -

  1. 2020 - 2023 sh-edraft.de

    2. -
-
-
license:
-

MIT, see LICENSE for more details.

-
-
-
-
-
-class cpl_core.time.VersionInfo(major, minor, micro)
-

Bases: tuple

-
-
-major
-

Alias for field number 0

-
- -
-
-micro
-

Alias for field number 2

-
- -
-
-minor
-

Alias for field number 1

-
- -
- -
-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/build/html/cpl_core.utils.html b/docs/build/html/cpl_core.utils.html deleted file mode 100644 index c8d54372..00000000 --- a/docs/build/html/cpl_core.utils.html +++ /dev/null @@ -1,425 +0,0 @@ - - - - - - - cpl_core.utils package — Common Python Library documentation - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

cpl_core.utils package

-
-

Submodules

-
-
-

cpl_core.utils.credential_manager module

-
-
-class cpl_core.utils.credential_manager.CredentialManager
-

Bases: object

-

Handles credential encryption and decryption

-
-
-static build_string(string: str, credentials: str)
-

Builds string with credentials in it

-
-
Parameter:
-
string: str

String in which the variable is replaced by credentials

-
-
credentials: str

String to encode

-
-
-
-
Returns:

Decoded string

-
-
-
- -
-
-static decrypt(string: str) → str
-

Decode with base64

-
-
Parameter:
-
string: str

String to decode

-
-
-
-
Returns:

Decoded string

-
-
-
- -
-
-static encrypt(string: str) → str
-

Encode with base64

-
-
Parameter:
-
string: str

String to encode

-
-
-
-
Returns:

Encoded string

-
-
-
- -
- -
-
-

cpl_core.utils.pip module

-
-
-class cpl_core.utils.pip.Pip
-

Bases: object

-

Executes pip commands

-
-
-classmethod get_executable() → str
-
- -
-
-classmethod get_outdated() → bytes
-

Gets table of outdated packages

-
-
Returns:

Bytes string of the command result

-
-
-
- -
-
-classmethod get_package(package: str) → str | None
-

Gets given package py local pip list

-
-
Parameter:

package: str

-
-
Returns:

The package name as string

-
-
-
- -
-
-classmethod install(package: str, *args, source: str | None = None, stdout=None, stderr=None)
-

Installs given package

-
-
Parameter:
-
package: str

The name of the package

-
-
args: list

Arguments for the command

-
-
source: str

Extra index URL

-
-
stdout: str

Stdout of subprocess.run

-
-
stderr: str

Stderr of subprocess.run

-
-
-
-
-
- -
-
-classmethod reset_executable()
-

Resets the executable to system standard

-
- -
-
-classmethod set_executable(executable: str)
-

Sets the executable

-
-
Parameter:
-
executable: str

The python command

-
-
-
-
-
- -
-
-classmethod uninstall(package: str, stdout=None, stderr=None)
-

Uninstalls given package

-
-
Parameter:
-
package: str

The name of the package

-
-
stdout: str

Stdout of subprocess.run

-
-
stderr: str

Stderr of subprocess.run

-
-
-
-
-
- -
- -
-
-

cpl_core.utils.string module

-
-
-class cpl_core.utils.string.String
-

Bases: object

-

Useful functions for strings

-
-
-static convert_to_camel_case(chars: str) → str
-

Converts string to camel case

-
-
Parameter:
-
chars: str

String to convert

-
-
-
-
Returns:

String converted to CamelCase

-
-
-
- -
-
-static convert_to_snake_case(chars: str) → str
-

Converts string to snake case

-
-
Parameter:
-
chars: str

String to convert

-
-
-
-
Returns:

String converted to snake_case

-
-
-
- -
-
-static first_to_lower(chars: str) → str
-

Converts first char to lower

-
-
Parameter:
-
chars: str

String to convert

-
-
-
-
Returns:

String with first char as lower

-
-
-
- -
-
-static first_to_upper(chars: str) → str
-

Converts first char to upper

-
-
Parameter:
-
chars: str

String to convert

-
-
-
-
Returns:

String with first char as upper

-
-
-
- -
-
-static random_string(chars: str, length: int) → str
-

Creates random string by given chars and length

-
-
Returns:

String of random chars

-
-
-
- -
- -
-
-

Module contents

-
-

cpl-core CPL core

-

CPL core package

-
-
copyright:
-
    -

  1. 2020 - 2023 sh-edraft.de

    2. -
-
-
license:
-

MIT, see LICENSE for more details.

-
-
-
-
-
-class cpl_core.utils.VersionInfo(major, minor, micro)
-

Bases: tuple

-
-
-major
-

Alias for field number 0

-
- -
-
-micro
-

Alias for field number 2

-
- -
-
-minor
-

Alias for field number 1

-
- -
- -
-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/build/html/cpl_discord.application.html b/docs/build/html/cpl_discord.application.html deleted file mode 100644 index 591e290f..00000000 --- a/docs/build/html/cpl_discord.application.html +++ /dev/null @@ -1,197 +0,0 @@ - - - - - - - cpl_discord.application package — Common Python Library documentation - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

cpl_discord.application package

-
-

Submodules

-
-
-

cpl_discord.application.discord_bot_application_abc module

-
-
-class cpl_discord.application.discord_bot_application_abc.DiscordBotApplicationABC(config: ConfigurationABC, services: ServiceProviderABC)
-

Bases: ApplicationABC

-
-
-abstract stop_async()
-
- -
- -
-
-

Module contents

-
-

cpl-discord CPL Discord

-

Link between discord.py and CPL

-
-
copyright:
-
    -

  1. 2022 - 2023 sh-edraft.de

    2. -
-
-
license:
-

MIT, see LICENSE for more details.

-
-
-
-
-
-class cpl_discord.application.VersionInfo(major, minor, micro)
-

Bases: tuple

-
-
-major
-

Alias for field number 0

-
- -
-
-micro
-

Alias for field number 2

-
- -
-
-minor
-

Alias for field number 1

-
- -
- -
-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/build/html/cpl_discord.command.html b/docs/build/html/cpl_discord.command.html deleted file mode 100644 index 0599f8f0..00000000 --- a/docs/build/html/cpl_discord.command.html +++ /dev/null @@ -1,205 +0,0 @@ - - - - - - - cpl_discord.command package — Common Python Library documentation - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

cpl_discord.command package

-
-

Submodules

-
-
-

cpl_discord.command.discord_command_abc module

-
-
-class cpl_discord.command.discord_command_abc.DiscordCommandABC(*args: Any, **kwargs: Any)
-

Bases: ABC, Cog

-
- -
-
-

cpl_discord.command.discord_commands_meta module

-
-
-class cpl_discord.command.discord_commands_meta.DiscordCogMeta(name, bases, namespace, **kwargs)
-

Bases: ABCMeta, CogMeta

-
- -
-
-

Module contents

-
-

cpl-discord CPL Discord

-

Link between discord.py and CPL

-
-
copyright:
-
    -

  1. 2022 - 2023 sh-edraft.de

    2. -
-
-
license:
-

MIT, see LICENSE for more details.

-
-
-
-
-
-class cpl_discord.command.VersionInfo(major, minor, micro)
-

Bases: tuple

-
-
-major
-

Alias for field number 0

-
- -
-
-micro
-

Alias for field number 2

-
- -
-
-minor
-

Alias for field number 1

-
- -
- -
-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/build/html/cpl_discord.configuration.html b/docs/build/html/cpl_discord.configuration.html deleted file mode 100644 index e29509b8..00000000 --- a/docs/build/html/cpl_discord.configuration.html +++ /dev/null @@ -1,202 +0,0 @@ - - - - - - - cpl_discord.configuration package — Common Python Library documentation - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

cpl_discord.configuration package

-
-

Submodules

-
-
-

cpl_discord.configuration.discord_bot_settings module

-
-
-class cpl_discord.configuration.discord_bot_settings.DiscordBotSettings(token: str | None = None, prefix: str | None = None)
-

Bases: ConfigurationModelABC

-
-
-property prefix: str
-
- -
-
-property token: str
-
- -
- -
-
-

Module contents

-
-

cpl-discord CPL Discord

-

Link between discord.py and CPL

-
-
copyright:
-
    -

  1. 2022 - 2023 sh-edraft.de

    2. -
-
-
license:
-

MIT, see LICENSE for more details.

-
-
-
-
-
-class cpl_discord.configuration.VersionInfo(major, minor, micro)
-

Bases: tuple

-
-
-major
-

Alias for field number 0

-
- -
-
-micro
-

Alias for field number 2

-
- -
-
-minor
-

Alias for field number 1

-
- -
- -
-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/build/html/cpl_discord.container.html b/docs/build/html/cpl_discord.container.html deleted file mode 100644 index 4e0f7d5e..00000000 --- a/docs/build/html/cpl_discord.container.html +++ /dev/null @@ -1,754 +0,0 @@ - - - - - - - cpl_discord.container package — Common Python Library documentation - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

cpl_discord.container package

-
-

Submodules

-
-
-

cpl_discord.container.category_channel module

-
-
-class cpl_discord.container.category_channel.CategoryChannel(_t: CategoryChannel)
-

Bases: CategoryChannel, Container

-
-
-category_id: int | None
-
- -
-
-guild: Guild
-
- -
-
-id: int
-
- -
-
-name: str
-
- -
-
-nsfw
-
- -
-
-position: int
-
- -
-
-property text_channels: TextChannel
-

List[TextChannel]: Returns the text channels that are under this category.

-
- -
-
-property voice_channels: VoiceChannel
-

List[VoiceChannel]: Returns the voice channels that are under this category.

-
- -
- -
-
-

cpl_discord.container.container module

-
-
-class cpl_discord.container.container.Container(_o: object, _t: type)
-

Bases: object

-
- -
-
-

cpl_discord.container.guild module

-
-
-class cpl_discord.container.guild.Guild(_t: Guild)
-

Bases: Container, Guild

-
-
-afk_channel
-
- -
-
-afk_timeout
-
- -
-
-approximate_member_count
-
- -
-
-approximate_presence_count
-
- -
-
-property categories: CategoryChannel
-

List[CategoryChannel]: A list of categories that belongs to this guild.

-

This is sorted by the position and are in UI order from top to bottom.

-
- -
-
-default_notifications
-
- -
-
-description
-
- -
-
-emojis
-
- -
-
-explicit_content_filter
-
- -
-
-features
-
- -
-
-id: int
-
- -
-
-max_members
-
- -
-
-max_presences
-
- -
-
-max_video_channel_users
-
- -
-
-property members: Member
-

Sequence[Member]: A list of members that belong to this guild.

-
- -
-
-mfa_level
-
- -
-
-name
-
- -
-
-nsfw_level
-
- -
-
-owner_id
-
- -
-
-preferred_locale
-
- -
-
-premium_progress_bar_enabled
-
- -
-
-premium_subscription_count
-
- -
-
-premium_tier
-
- -
-
-property roles: Role
-

Sequence[Role]: Returns a sequence of the guild’s roles in hierarchy order.

-

The first element of this sequence will be the lowest role in the -hierarchy.

-
- -
-
-stickers
-
- -
-
-property text_channels: TextChannel
-

List[TextChannel]: A list of text channels that belongs to this guild.

-

This is sorted by the position and are in UI order from top to bottom.

-
- -
-
-property threads: TextChannel
-

Sequence[Thread]: A list of threads that you have permission to view.

-
-

New in version 2.0.

-
-
- -
-
-unavailable
-
- -
-
-vanity_url_code
-
- -
-
-verification_level
-
- -
-
-property voice_channels: VoiceChannel
-

List[VoiceChannel]: A list of voice channels that belongs to this guild.

-

This is sorted by the position and are in UI order from top to bottom.

-
- -
-
-widget_enabled
-
- -
- -
-
-

cpl_discord.container.member module

-
-
-class cpl_discord.container.member.Member(_t: Member)
-

Bases: Member, Container

-
-
-activities: Tuple[ActivityTypes, ...]
-
- -
-
-guild: Guild
-
- -
-
-joined_at: datetime.datetime | None
-
- -
-
-nick: str | None
-
- -
-
-pending: bool
-
- -
-
-premium_since: datetime.datetime | None
-
- -
-
-property roles: Role
-

List[Role]: A list of Role that the member belongs to. Note -that the first element of this list is always the default ‘@everyone’ -role.

-

These roles are sorted by their position in the role hierarchy.

-
- -
-
-timed_out_until: datetime.datetime | None
-
- -
- -
-
-

cpl_discord.container.role module

-
-
-class cpl_discord.container.role.Role(_t: Role)
-

Bases: Role, Container

-
-
-guild: Guild
-
- -
-
-hoist
-
- -
-
-id: int
-
- -
-
-managed
-
- -
-
-property members: Member
-

List[Member]: Returns all the members with this role.

-
- -
-
-mentionable
-
- -
-
-name
-
- -
-
-position
-
- -
-
-tags
-
- -
-
-unicode_emoji
-
- -
- -
-
-

cpl_discord.container.text_channel module

-
-
-class cpl_discord.container.text_channel.TextChannel(_t: TextChannel)
-

Bases: TextChannel, Container

-
-
-category_id: int | None
-
- -
-
-default_auto_archive_duration
-
- -
-
-guild: Guild
-
- -
-
-id: int
-
- -
-
-last_message_id
-
- -
-
-property members: Member
-

List[Member]: Returns all members that can see this channel.

-
- -
-
-name: str
-
- -
-
-nsfw
-
- -
-
-position: int
-
- -
-
-slowmode_delay
-
- -
-
-property threads: Thread
-

List[Thread]: Returns all the threads that you can see.

-
-

New in version 2.0.

-
-
- -
-
-topic
-
- -
- -
-
-

cpl_discord.container.thread module

-
-
-class cpl_discord.container.thread.Thread(_t: Thread)
-

Bases: Thread, Container

-
-
-archive_timestamp
-
- -
-
-archived
-
- -
-
-archiver_id
-
- -
-
-auto_archive_duration
-
- -
-
-guild: Guild
-
- -
-
-id: int
-
- -
-
-invitable
-
- -
-
-last_message_id
-
- -
-
-locked
-
- -
-
-me
-
- -
-
-member_count
-
- -
-
-property members: Member
-

List[ThreadMember]: A list of thread members in this thread.

-

This requires Intents.members to be properly filled. Most of the time however, -this data is not provided by the gateway and a call to fetch_members() is -needed.

-
- -
-
-message_count
-
- -
-
-name
-
- -
-
-owner_id
-
- -
-
-parent_id
-
- -
-
-slowmode_delay
-
- -
- -
-
-

cpl_discord.container.voice_channel module

-
-
-class cpl_discord.container.voice_channel.VoiceChannel(_t: VoiceChannel)
-

Bases: VoiceChannel, Container

-
-
-property members: Member
-

List[Member]: Returns all members that are currently inside this voice channel.

-
- -
- -
-
-

Module contents

-
-

cpl-discord CPL Discord

-

Link between discord.py and CPL

-
-
copyright:
-
    -

  1. 2022 - 2023 sh-edraft.de

    2. -
-
-
license:
-

MIT, see LICENSE for more details.

-
-
-
-
-
-class cpl_discord.container.VersionInfo(major, minor, micro)
-

Bases: tuple

-
-
-major
-

Alias for field number 0

-
- -
-
-micro
-

Alias for field number 2

-
- -
-
-minor
-

Alias for field number 1

-
- -
- -
-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/build/html/cpl_discord.events.html b/docs/build/html/cpl_discord.events.html deleted file mode 100644 index d4fcca83..00000000 --- a/docs/build/html/cpl_discord.events.html +++ /dev/null @@ -1,1097 +0,0 @@ - - - - - - - cpl_discord.events package — Common Python Library documentation - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

cpl_discord.events package

-
-

Submodules

-
-
-

cpl_discord.events.on_bulk_message_delete_abc module

-
-
-class cpl_discord.events.on_bulk_message_delete_abc.OnBulkMessageDeleteABC
-

Bases: ABC

-
-
-abstract async on_bulk_message_delete(messages: list[discord.message.Message])
-
- -
- -
-
-

cpl_discord.events.on_command_abc module

-
-
-class cpl_discord.events.on_command_abc.OnCommandABC
-

Bases: ABC

-
-
-abstract async on_command(ctx: Context)
-
- -
- -
-
-

cpl_discord.events.on_command_completion_abc module

-
-
-class cpl_discord.events.on_command_completion_abc.OnCommandCompletionABC
-

Bases: ABC

-
-
-abstract async on_command_completion(ctx: Context)
-
- -
- -
-
-

cpl_discord.events.on_command_error_abc module

-
-
-class cpl_discord.events.on_command_error_abc.OnCommandErrorABC
-

Bases: ABC

-
-
-abstract async on_command_error(ctx: Context, error: CommandError)
-
- -
- -
-
-

cpl_discord.events.on_connect_abc module

-
-
-class cpl_discord.events.on_connect_abc.OnConnectABC
-

Bases: ABC

-
-
-abstract async on_connect()
-
- -
- -
-
-

cpl_discord.events.on_disconnect_abc module

-
-
-class cpl_discord.events.on_disconnect_abc.OnDisconnectABC
-

Bases: ABC

-
-
-abstract async on_disconnect()
-
- -
- -
-
-

cpl_discord.events.on_error_abc module

-
-
-class cpl_discord.events.on_error_abc.OnErrorABC
-

Bases: ABC

-
-
-abstract async on_error(event: str, *args, **kwargs)
-
- -
- -
-
-

cpl_discord.events.on_group_join_abc module

-
-
-class cpl_discord.events.on_group_join_abc.OnGroupJoinABC
-

Bases: ABC

-
-
-abstract async on_group_join(channel: GroupChannel, user: User)
-
- -
- -
-
-

cpl_discord.events.on_group_remove_abc module

-
-
-class cpl_discord.events.on_group_remove_abc.OnGroupRemoveABC
-

Bases: ABC

-
-
-abstract async on_group_remove(chhanel: GroupChannel, user: User)
-
- -
- -
-
-

cpl_discord.events.on_guild_available_abc module

-
-
-class cpl_discord.events.on_guild_available_abc.OnGuildAvailableABC
-

Bases: ABC

-
-
-abstract async on_guild_available(guild: Guild)
-
- -
- -
-
-

cpl_discord.events.on_guild_channel_create_abc module

-
-
-class cpl_discord.events.on_guild_channel_create_abc.OnGuildChannelCreateABC
-

Bases: ABC

-
-
-abstract async on_guild_channel_create(channel: GuildChannel)
-
- -
- -
-
-

cpl_discord.events.on_guild_channel_delete_abc module

-
-
-class cpl_discord.events.on_guild_channel_delete_abc.OnGuildChannelDeleteABC
-

Bases: ABC

-
-
-abstract async on_guild_channel_delete(channel: GuildChannel)
-
- -
- -
-
-

cpl_discord.events.on_guild_channel_pins_update_abc module

-
-
-class cpl_discord.events.on_guild_channel_pins_update_abc.OnGuildChannelPinsUpdateABC
-

Bases: ABC

-
-
-abstract async on_guild_channel_pins_update(channel: GuildChannel, list_pin: datetime | None)
-
- -
- -
-
-

cpl_discord.events.on_guild_channel_update_abc module

-
-
-class cpl_discord.events.on_guild_channel_update_abc.OnGuildChannelUpdateABC
-

Bases: ABC

-
-
-abstract async on_guild_channel_update(before: GuildChannel, after: GuildChannel)
-
- -
- -
-
-

cpl_discord.events.on_guild_emojis_update_abc module

-
-
-class cpl_discord.events.on_guild_emojis_update_abc.OnGuildEmojisUpdateABC
-

Bases: ABC

-
-
-abstract async on_guild_emojis_update(guild: Guild, before: Sequence[Emoji], after: Sequence[Emoji])
-
- -
- -
-
-

cpl_discord.events.on_guild_integrations_update_abc module

-
-
-class cpl_discord.events.on_guild_integrations_update_abc.OnGuildIntegrationsUpdateABC
-

Bases: ABC

-
-
-abstract async on_guild_integrations_update(guild: Guild)
-
- -
- -
-
-

cpl_discord.events.on_guild_join_abc module

-
-
-class cpl_discord.events.on_guild_join_abc.OnGuildJoinABC
-

Bases: ABC

-
-
-abstract async on_guild_join(guild: Guild)
-
- -
- -
-
-

cpl_discord.events.on_guild_remove_abc module

-
-
-class cpl_discord.events.on_guild_remove_abc.OnGuildRemoveABC
-

Bases: ABC

-
-
-abstract async on_guild_remove(guild: Guild)
-
- -
- -
-
-

cpl_discord.events.on_guild_role_create_abc module

-
-
-class cpl_discord.events.on_guild_role_create_abc.OnGuildRoleCreateABC
-

Bases: ABC

-
-
-abstract async on_guild_role_create(role: Role)
-
- -
- -
-
-

cpl_discord.events.on_guild_role_delete_abc module

-
-
-class cpl_discord.events.on_guild_role_delete_abc.OnGuildRoleDeleteABC
-

Bases: ABC

-
-
-abstract async on_guild_role_delete(role: Role)
-
- -
- -
-
-

cpl_discord.events.on_guild_role_update_abc module

-
-
-class cpl_discord.events.on_guild_role_update_abc.OnGuildRoleUpdateABC
-

Bases: ABC

-
-
-abstract async on_guild_role_update(before: Role, after: Role)
-
- -
- -
-
-

cpl_discord.events.on_guild_unavailable_abc module

-
-
-class cpl_discord.events.on_guild_unavailable_abc.OnGuildUnavailableABC
-

Bases: ABC

-
-
-abstract async on_guild_unavailable(guild: Guild)
-
- -
- -
-
-

cpl_discord.events.on_guild_update_abc module

-
-
-class cpl_discord.events.on_guild_update_abc.OnGuildUpdateABC
-

Bases: ABC

-
-
-abstract async on_guild_update(before: Guild, after: Guild)
-
- -
- -
-
-

cpl_discord.events.on_invite_create_abc module

-
-
-class cpl_discord.events.on_invite_create_abc.OnInviteCreateABC
-

Bases: ABC

-
-
-abstract async on_invite_create(invite: Invite)
-
- -
- -
-
-

cpl_discord.events.on_invite_delete_abc module

-
-
-class cpl_discord.events.on_invite_delete_abc.OnInviteDeleteABC
-

Bases: ABC

-
-
-abstract async on_invite_delete(invite: Invite)
-
- -
- -
-
-

cpl_discord.events.on_member_ban_abc module

-
-
-class cpl_discord.events.on_member_ban_abc.OnMemberBanABC
-

Bases: ABC

-
-
-abstract async on_member_ban(guild: Guild, user: User)
-
- -
- -
-
-

cpl_discord.events.on_member_join_abc module

-
-
-class cpl_discord.events.on_member_join_abc.OnMemberJoinABC
-

Bases: ABC

-
-
-abstract async on_member_join(member: Member)
-
- -
- -
-
-

cpl_discord.events.on_member_remove_abc module

-
-
-class cpl_discord.events.on_member_remove_abc.OnMemberRemoveABC
-

Bases: ABC

-
-
-abstract async on_member_remove(member: Member)
-
- -
- -
-
-

cpl_discord.events.on_member_unban_abc module

-
-
-class cpl_discord.events.on_member_unban_abc.OnMemberUnbanABC
-

Bases: ABC

-
-
-abstract async on_member_unban(guild: Guild, user: User)
-
- -
- -
-
-

cpl_discord.events.on_member_update_abc module

-
-
-class cpl_discord.events.on_member_update_abc.OnMemberUpdateABC
-

Bases: ABC

-
-
-abstract async on_member_update(before: Member, after: Member)
-
- -
- -
-
-

cpl_discord.events.on_message_abc module

-
-
-class cpl_discord.events.on_message_abc.OnMessageABC
-

Bases: ABC

-
-
-abstract async on_message(message: Message)
-
- -
- -
-
-

cpl_discord.events.on_message_delete_abc module

-
-
-class cpl_discord.events.on_message_delete_abc.OnMessageDeleteABC
-

Bases: ABC

-
-
-abstract async on_message_delete(message: Message)
-
- -
- -
-
-

cpl_discord.events.on_message_edit_abc module

-
-
-class cpl_discord.events.on_message_edit_abc.OnMessageEditABC
-

Bases: ABC

-
-
-abstract async on_message_edit(before: Message, after: Message)
-
- -
- -
-
-

cpl_discord.events.on_private_channel_create_abc module

-
-
-class cpl_discord.events.on_private_channel_create_abc.OnPrivateChannelCreateABC
-

Bases: ABC

-
-
-abstract async on_private_channel_create(channel: PrivateChannel)
-
- -
- -
-
-

cpl_discord.events.on_private_channel_delete_abc module

-
-
-class cpl_discord.events.on_private_channel_delete_abc.OnPrivateChannelDeleteABC
-

Bases: ABC

-
-
-abstract async on_private_channel_delete(channel: PrivateChannel)
-
- -
- -
-
-

cpl_discord.events.on_private_channel_pins_update_abc module

-
-
-class cpl_discord.events.on_private_channel_pins_update_abc.OnPrivateChannelPinsUpdateABC
-

Bases: ABC

-
-
-abstract async on_private_channel_pins_update(channel: PrivateChannel, list_pin: datetime | None)
-
- -
- -
-
-

cpl_discord.events.on_private_channel_update_abc module

-
-
-class cpl_discord.events.on_private_channel_update_abc.OnPrivateChannelUpdateABC
-

Bases: ABC

-
-
-abstract async on_private_channel_update(before: GroupChannel, after: GroupChannel)
-
- -
- -
-
-

cpl_discord.events.on_raw_reaction_add_abc module

-
-
-class cpl_discord.events.on_raw_reaction_add_abc.OnRawReactionAddABC
-

Bases: ABC

-
-
-abstract async on_raw_reaction_add(payload: RawReactionActionEvent)
-
- -
- -
-
-

cpl_discord.events.on_raw_reaction_clear_abc module

-
-
-class cpl_discord.events.on_raw_reaction_clear_abc.OnRawReactionClearABC
-

Bases: ABC

-
-
-abstract async on_raw_reaction_clear(payload: RawReactionActionEvent)
-
- -
- -
-
-

cpl_discord.events.on_raw_reaction_clear_emoji_abc module

-
-
-class cpl_discord.events.on_raw_reaction_clear_emoji_abc.OnRawReactionClearEmojiABC
-

Bases: ABC

-
-
-abstract async on_raw_reaction_clear_emoji(payload: RawReactionActionEvent)
-
- -
- -
-
-

cpl_discord.events.on_raw_reaction_remove_abc module

-
-
-class cpl_discord.events.on_raw_reaction_remove_abc.OnRawReactionRemoveABC
-

Bases: ABC

-
-
-abstract async on_raw_reaction_remove(payload: RawReactionActionEvent)
-
- -
- -
-
-

cpl_discord.events.on_reaction_add_abc module

-
-
-class cpl_discord.events.on_reaction_add_abc.OnReactionAddABC
-

Bases: ABC

-
-
-abstract async on_reaction_add(reaction: Reaction, user: User)
-
- -
- -
-
-

cpl_discord.events.on_reaction_clear_abc module

-
-
-class cpl_discord.events.on_reaction_clear_abc.OnReactionClearABC
-

Bases: ABC

-
-
-abstract async on_reaction_clear(message: Message, reactions: list[discord.reaction.Reaction])
-
- -
- -
-
-

cpl_discord.events.on_reaction_clear_emoji_abc module

-
-
-class cpl_discord.events.on_reaction_clear_emoji_abc.OnReactionClearEmojiABC
-

Bases: ABC

-
-
-abstract async on_reaction_clear_emoji(reaction: Reaction)
-
- -
- -
-
-

cpl_discord.events.on_reaction_remove_abc module

-
-
-class cpl_discord.events.on_reaction_remove_abc.OnReactionRemoveABC
-

Bases: ABC

-
-
-abstract async on_reaction_remove(reaction: Reaction, user: User)
-
- -
- -
-
-

cpl_discord.events.on_ready_abc module

-
-
-class cpl_discord.events.on_ready_abc.OnReadyABC
-

Bases: ABC

-
-
-abstract async on_ready()
-
- -
- -
-
-

cpl_discord.events.on_resume_abc module

-
-
-class cpl_discord.events.on_resume_abc.OnResumeABC
-

Bases: ABC

-
-
-abstract async on_resume()
-
- -
- -
-
-

cpl_discord.events.on_typing_abc module

-
-
-class cpl_discord.events.on_typing_abc.OnTypingABC
-

Bases: ABC

-
-
-abstract async on_typing(channel: Messageable, user: User | Member, when: datetime)
-
- -
- -
-
-

cpl_discord.events.on_user_update_abc module

-
-
-class cpl_discord.events.on_user_update_abc.OnUserUpdateABC
-

Bases: ABC

-
-
-abstract async on_user_update(before: User, after: User)
-
- -
- -
-
-

cpl_discord.events.on_voice_state_update_abc module

-
-
-class cpl_discord.events.on_voice_state_update_abc.OnVoiceStateUpdateABC
-

Bases: ABC

-
-
-abstract async on_voice_state_update(member: Member, before: VoiceState, after: VoiceState)
-
- -
- -
-
-

cpl_discord.events.on_webhooks_update_abc module

-
-
-class cpl_discord.events.on_webhooks_update_abc.OnWebhooksUpdateABC
-

Bases: ABC

-
-
-abstract async on_webhooks_update(channel: GuildChannel)
-
- -
- -
-
-

Module contents

-
-

cpl-discord CPL Discord

-

Link between discord.py and CPL

-
-
copyright:
-
    -

  1. 2022 - 2023 sh-edraft.de

    2. -
-
-
license:
-

MIT, see LICENSE for more details.

-
-
-
-
-
-class cpl_discord.events.VersionInfo(major, minor, micro)
-

Bases: tuple

-
-
-major
-

Alias for field number 0

-
- -
-
-micro
-

Alias for field number 2

-
- -
-
-minor
-

Alias for field number 1

-
- -
- -
-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/build/html/cpl_discord.helper.html b/docs/build/html/cpl_discord.helper.html deleted file mode 100644 index 60211dee..00000000 --- a/docs/build/html/cpl_discord.helper.html +++ /dev/null @@ -1,197 +0,0 @@ - - - - - - - cpl_discord.helper package — Common Python Library documentation - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

cpl_discord.helper package

-
-

Submodules

-
-
-

cpl_discord.helper.to_containers_converter module

-
-
-class cpl_discord.helper.to_containers_converter.ToContainersConverter
-

Bases: object

-
-
-static convert(_l: list[object] | Sequence[object], _t: type) → list[cpl_discord.container.container.Container]
-
- -
- -
-
-

Module contents

-
-

cpl-discord CPL Discord

-

Link between discord.py and CPL

-
-
copyright:
-
    -

  1. 2022 - 2023 sh-edraft.de

    2. -
-
-
license:
-

MIT, see LICENSE for more details.

-
-
-
-
-
-class cpl_discord.helper.VersionInfo(major, minor, micro)
-

Bases: tuple

-
-
-major
-

Alias for field number 0

-
- -
-
-micro
-

Alias for field number 2

-
- -
-
-minor
-

Alias for field number 1

-
- -
- -
-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/build/html/cpl_discord.html b/docs/build/html/cpl_discord.html deleted file mode 100644 index 12841b46..00000000 --- a/docs/build/html/cpl_discord.html +++ /dev/null @@ -1,1264 +0,0 @@ - - - - - - - Discord Reference — Common Python Library documentation - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

Discord Reference

-
- -
-
-

cpl_discord.discord_event_types_enum module

-
-
-class cpl_discord.discord_event_types_enum.DiscordEventTypesEnum(value)
-

Bases: Enum

-

An enumeration.

-
-
-on_bulk_message_delete = <class 'cpl_discord.events.on_bulk_message_delete_abc.OnBulkMessageDeleteABC'>
-
- -
-
-on_command = <class 'cpl_discord.events.on_command_abc.OnCommandABC'>
-
- -
-
-on_command_completion = <class 'cpl_discord.events.on_command_completion_abc.OnCommandCompletionABC'>
-
- -
-
-on_command_error = <class 'cpl_discord.events.on_command_error_abc.OnCommandErrorABC'>
-
- -
-
-on_connect = <class 'cpl_discord.events.on_connect_abc.OnConnectABC'>
-
- -
-
-on_disconnect = <class 'cpl_discord.events.on_disconnect_abc.OnDisconnectABC'>
-
- -
-
-on_error = <class 'cpl_discord.events.on_error_abc.OnErrorABC'>
-
- -
-
-on_group_join = <class 'cpl_discord.events.on_group_join_abc.OnGroupJoinABC'>
-
- -
-
-on_group_remove = <class 'cpl_discord.events.on_group_remove_abc.OnGroupRemoveABC'>
-
- -
-
-on_guild_available = <class 'cpl_discord.events.on_guild_available_abc.OnGuildAvailableABC'>
-
- -
-
-on_guild_channel_create = <class 'cpl_discord.events.on_guild_channel_create_abc.OnGuildChannelCreateABC'>
-
- -
-
-on_guild_channel_delete = <class 'cpl_discord.events.on_guild_channel_delete_abc.OnGuildChannelDeleteABC'>
-
- -
-
-on_guild_channel_pins_update = <class 'cpl_discord.events.on_guild_channel_pins_update_abc.OnGuildChannelPinsUpdateABC'>
-
- -
-
-on_guild_channel_update = <class 'cpl_discord.events.on_guild_channel_update_abc.OnGuildChannelUpdateABC'>
-
- -
-
-on_guild_emojis_update = <class 'cpl_discord.events.on_guild_emojis_update_abc.OnGuildEmojisUpdateABC'>
-
- -
-
-on_guild_integrations_update = <class 'cpl_discord.events.on_guild_integrations_update_abc.OnGuildIntegrationsUpdateABC'>
-
- -
-
-on_guild_join = <class 'cpl_discord.events.on_guild_join_abc.OnGuildJoinABC'>
-
- -
-
-on_guild_remove = <class 'cpl_discord.events.on_guild_remove_abc.OnGuildRemoveABC'>
-
- -
-
-on_guild_role_create = <class 'cpl_discord.events.on_guild_role_create_abc.OnGuildRoleCreateABC'>
-
- -
-
-on_guild_role_delete = <class 'cpl_discord.events.on_guild_role_delete_abc.OnGuildRoleDeleteABC'>
-
- -
-
-on_guild_role_update = <class 'cpl_discord.events.on_guild_role_update_abc.OnGuildRoleUpdateABC'>
-
- -
-
-on_guild_unavailable = <class 'cpl_discord.events.on_guild_unavailable_abc.OnGuildUnavailableABC'>
-
- -
-
-on_guild_update = <class 'cpl_discord.events.on_guild_update_abc.OnGuildUpdateABC'>
-
- -
-
-on_invite_create = <class 'cpl_discord.events.on_invite_create_abc.OnInviteCreateABC'>
-
- -
-
-on_invite_delete = <class 'cpl_discord.events.on_invite_delete_abc.OnInviteDeleteABC'>
-
- -
-
-on_member_ban = <class 'cpl_discord.events.on_member_ban_abc.OnMemberBanABC'>
-
- -
-
-on_member_join = <class 'cpl_discord.events.on_member_join_abc.OnMemberJoinABC'>
-
- -
-
-on_member_remove = <class 'cpl_discord.events.on_member_remove_abc.OnMemberRemoveABC'>
-
- -
-
-on_member_unban = <class 'cpl_discord.events.on_member_unban_abc.OnMemberUnbanABC'>
-
- -
-
-on_member_update = <class 'cpl_discord.events.on_member_update_abc.OnMemberUpdateABC'>
-
- -
-
-on_message = <class 'cpl_discord.events.on_message_abc.OnMessageABC'>
-
- -
-
-on_message_delete = <class 'cpl_discord.events.on_message_delete_abc.OnMessageDeleteABC'>
-
- -
-
-on_message_edit = <class 'cpl_discord.events.on_message_edit_abc.OnMessageEditABC'>
-
- -
-
-on_private_channel_create = <class 'cpl_discord.events.on_private_channel_create_abc.OnPrivateChannelCreateABC'>
-
- -
-
-on_private_channel_delete = <class 'cpl_discord.events.on_private_channel_delete_abc.OnPrivateChannelDeleteABC'>
-
- -
-
-on_private_channel_pins_update = <class 'cpl_discord.events.on_private_channel_pins_update_abc.OnPrivateChannelPinsUpdateABC'>
-
- -
-
-on_private_channel_update = <class 'cpl_discord.events.on_private_channel_update_abc.OnPrivateChannelUpdateABC'>
-
- -
-
-on_raw_reaction_add = <class 'cpl_discord.events.on_raw_reaction_add_abc.OnRawReactionAddABC'>
-
- -
-
-on_raw_reaction_clear = <class 'cpl_discord.events.on_raw_reaction_clear_abc.OnRawReactionClearABC'>
-
- -
-
-on_raw_reaction_clear_emoji = <class 'cpl_discord.events.on_raw_reaction_clear_emoji_abc.OnRawReactionClearEmojiABC'>
-
- -
-
-on_raw_reaction_remove = <class 'cpl_discord.events.on_raw_reaction_remove_abc.OnRawReactionRemoveABC'>
-
- -
-
-on_reaction_add = <class 'cpl_discord.events.on_reaction_add_abc.OnReactionAddABC'>
-
- -
-
-on_reaction_clear = <class 'cpl_discord.events.on_reaction_clear_abc.OnReactionClearABC'>
-
- -
-
-on_reaction_clear_emoji = <class 'cpl_discord.events.on_reaction_clear_emoji_abc.OnReactionClearEmojiABC'>
-
- -
-
-on_reaction_remove = <class 'cpl_discord.events.on_reaction_remove_abc.OnReactionRemoveABC'>
-
- -
-
-on_ready = <class 'cpl_discord.events.on_ready_abc.OnReadyABC'>
-
- -
-
-on_resume = <class 'cpl_discord.events.on_resume_abc.OnResumeABC'>
-
- -
-
-on_scheduled_event_create = <class 'cpl_discord.events.on_scheduled_event_create_abc.OnScheduledEventCreateABC'>
-
- -
-
-on_scheduled_event_delete = <class 'cpl_discord.events.on_scheduled_event_delete_abc.OnScheduledEventDeleteABC'>
-
- -
-
-on_scheduled_event_update = <class 'cpl_discord.events.on_scheduled_event_update_abc.OnScheduledEventUpdateABC'>
-
- -
-
-on_scheduled_event_user_add = <class 'cpl_discord.events.on_scheduled_event_user_add_abc.OnScheduledEventUserAddABC'>
-
- -
-
-on_scheduled_event_user_remove = <class 'cpl_discord.events.on_scheduled_event_user_remove_abc.OnScheduledEventUserRemoveABC'>
-
- -
-
-on_typing = <class 'cpl_discord.events.on_typing_abc.OnTypingABC'>
-
- -
-
-on_user_update = <class 'cpl_discord.events.on_user_update_abc.OnUserUpdateABC'>
-
- -
-
-on_voice_state_update = <class 'cpl_discord.events.on_voice_state_update_abc.OnVoiceStateUpdateABC'>
-
- -
-
-on_webhooks_update = <class 'cpl_discord.events.on_webhooks_update_abc.OnWebhooksUpdateABC'>
-
- -
- -
-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/build/html/cpl_discord.service.html b/docs/build/html/cpl_discord.service.html deleted file mode 100644 index c6227598..00000000 --- a/docs/build/html/cpl_discord.service.html +++ /dev/null @@ -1,882 +0,0 @@ - - - - - - - cpl_discord.service package — Common Python Library documentation - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

cpl_discord.service package

-
-

Submodules

-
-
-

cpl_discord.service.command_error_handler_service module

-
-
-class cpl_discord.service.command_error_handler_service.CommandErrorHandlerService(logger: LoggerABC)
-

Bases: OnCommandErrorABC

-
-
-async on_command_error(ctx: Context, error: CommandError)
-
- -
- -
-
-

cpl_discord.service.discord_bot_service module

-
-
-class cpl_discord.service.discord_bot_service.DiscordBotService(config: ConfigurationABC, logger: LoggerABC, discord_bot_settings: DiscordBotSettings, env: ApplicationEnvironmentABC, logging_st: LoggingSettings, discord_service: DiscordServiceABC, *args, **kwargs)
-

Bases: DiscordBotServiceABC

-
-
-property guilds: Guild
-

Sequence[Guild]: The guilds that the connected client is a member of.

-
- -
-
-async on_ready()
-
- -
-
-async start_async()
-
- -
-
-async stop_async()
-
- -
- -
-
-

cpl_discord.service.discord_bot_service_abc module

-
-
-class cpl_discord.service.discord_bot_service_abc.DiscordBotServiceABC(*args, **kwargs)
-

Bases: Bot

-
-
-abstract property guilds: Guild
-

Sequence[Guild]: The guilds that the connected client is a member of.

-
- -
-
-abstract async on_ready()
-
- -
-
-abstract async start_async()
-
- -
-
-abstract async stop_async()
-
- -
- -
-
-

cpl_discord.service.discord_collection module

-
-
-class cpl_discord.service.discord_collection.DiscordCollection(service_collection: ServiceCollectionABC)
-

Bases: DiscordCollectionABC

-
-
-add_command(_t: Type[DiscordCommandABC])
-
- -
-
-add_event(_t_event: Type, _t: Type)
-
- -
-
-get_commands() → DiscordCommandABC
-
- -
-
-get_events_by_base(_t_event: Type) → List | None
-
- -
- -
-
-

cpl_discord.service.discord_collection_abc module

-
-
-class cpl_discord.service.discord_collection_abc.DiscordCollectionABC
-

Bases: ABC

-
-
-abstract add_command(_t: Type[DiscordCommandABC])
-
- -
-
-abstract add_event(_t_event: Type, _t: Type)
-
- -
-
-abstract get_commands() → DiscordCommandABC
-
- -
-
-abstract get_events_by_base(_t_event: Type)
-
- -
- -
-
-

cpl_discord.service.discord_service module

-
-
-class cpl_discord.service.discord_service.DiscordService(*args: Any, **kwargs: Any)
-

Bases: DiscordServiceABC, Cog

-
-
-async init(bot: Bot)
-
- -
-
-async on_bulk_message_delete(messages: list[discord.message.Message])
-
- -
-
-async on_command(ctx: Context)
-
- -
-
-async on_command_completion(ctx: Context)
-
- -
-
-async on_command_error(ctx: Context, error: CommandError)
-
- -
-
-async on_connect()
-
- -
-
-async on_disconnect()
-
- -
-
-async on_error(event: str, *args, **kwargs)
-
- -
-
-async on_group_join(channel: GroupChannel, user: User)
-
- -
-
-async on_group_remove(channel: GroupChannel, user: User)
-
- -
-
-async on_guild_available(guild: Guild)
-
- -
-
-async on_guild_channel_create(channel: GuildChannel)
-
- -
-
-async on_guild_channel_delete(channel: GuildChannel)
-
- -
-
-async on_guild_channel_pins_update(channel: GuildChannel, list_pin: datetime | None)
-
- -
-
-async on_guild_channel_update(before: GuildChannel, after: GuildChannel)
-
- -
-
-async on_guild_emojis_update(guild: Guild, before: Sequence[Emoji], after: Sequence[Emoji])
-
- -
-
-async on_guild_integrations_update(guild: Guild)
-
- -
-
-async on_guild_join(guild: Guild)
-
- -
-
-async on_guild_remove(guild: Guild)
-
- -
-
-async on_guild_role_create(role: Role)
-
- -
-
-async on_guild_role_delete(role: Role)
-
- -
-
-async on_guild_role_update(before: Role, after: Role)
-
- -
-
-async on_guild_unavailable(guild: Guild)
-
- -
-
-async on_guild_update(before: Guild, after: Guild)
-
- -
-
-async on_invite_create(invite: Invite)
-
- -
-
-async on_invite_delete(invite: Invite)
-
- -
-
-async on_member_ban(guild: Guild, user: User)
-
- -
-
-async on_member_join(member: Member)
-
- -
-
-async on_member_remove(member: Member)
-
- -
-
-async on_member_unban(guild: Guild, user: User)
-
- -
-
-async on_member_update(before: Member, after: Member)
-
- -
-
-async on_message(message: Message)
-
- -
-
-async on_message_delete(message: Message)
-
- -
-
-async on_message_edit(before: Message, after: Message)
-
- -
-
-async on_private_channel_create(channel: PrivateChannel)
-
- -
-
-async on_private_channel_delete(channel: PrivateChannel)
-
- -
-
-async on_private_channel_pins_update(channel: PrivateChannel, list_pin: datetime | None)
-
- -
-
-async on_private_channel_update(before: GroupChannel, after: GroupChannel)
-
- -
-
-async on_raw_reaction_add(payload: RawReactionActionEvent)
-
- -
-
-async on_raw_reaction_clear(payload: RawReactionActionEvent)
-
- -
-
-async on_raw_reaction_clear_emoji(payload: RawReactionActionEvent)
-
- -
-
-async on_raw_reaction_remove(payload: RawReactionActionEvent)
-
- -
-
-async on_reaction_add(reaction: Reaction, user: User)
-
- -
-
-async on_reaction_clear(message: Message, reactions: list[discord.reaction.Reaction])
-
- -
-
-async on_reaction_clear_emoji(reaction: Reaction)
-
- -
-
-async on_reaction_remove(reaction: Reaction, user: User)
-
- -
-
-async on_ready()
-
- -
-
-async on_resume()
-
- -
-
-async on_scheduled_event_create(event: ScheduledEvent)
-
- -
-
-async on_scheduled_event_delete(event: ScheduledEvent)
-
- -
-
-async on_scheduled_event_update(before: ScheduledEvent, after: ScheduledEvent)
-
- -
-
-async on_scheduled_event_user_add(event: ScheduledEvent, user: User)
-
- -
-
-async on_scheduled_event_user_remove(event: ScheduledEvent, user: User)
-
- -
-
-async on_typing(channel: Messageable, user: User | Member, when: datetime)
-
- -
-
-async on_user_update(before: User, after: User)
-
- -
-
-async on_voice_state_update(member: Member, before: VoiceState, after: VoiceState)
-
- -
-
-async on_webhooks_update(channel: GuildChannel)
-
- -
- -
-
-

cpl_discord.service.discord_service_abc module

-
-
-class cpl_discord.service.discord_service_abc.DiscordServiceABC
-

Bases: ABC

-
-
-abstract init(bot: Bot)
-
- -
-
-abstract async on_bulk_message_delete(messages: list[discord.message.Message])
-
- -
-
-abstract async on_command()
-
- -
-
-abstract async on_command_completion()
-
- -
-
-abstract async on_command_error()
-
- -
-
-abstract async on_connect()
-
- -
-
-abstract async on_disconnect()
-
- -
-
-abstract async on_error(event: str, *args, **kwargs)
-
- -
-
-abstract async on_group_join(chhanel: GroupChannel, user: User)
-
- -
-
-abstract async on_group_remove(chhanel: GroupChannel, user: User)
-
- -
-
-abstract async on_guild_available(guild: Guild)
-
- -
-
-abstract async on_guild_channel_create(channel: GuildChannel)
-
- -
-
-abstract async on_guild_channel_delete(channel: GuildChannel)
-
- -
-
-abstract async on_guild_channel_pins_update(channel: GuildChannel, list_pin: datetime | None)
-
- -
-
-abstract async on_guild_channel_update(before: GuildChannel, after: GuildChannel)
-
- -
-
-abstract async on_guild_emojis_update(guild: Guild, before: Sequence[Emoji], after: Sequence[Emoji])
-
- -
-
-abstract async on_guild_integrations_update(guild: Guild)
-
- -
-
-abstract async on_guild_join(guild: Guild)
-
- -
-
-abstract async on_guild_remove(guild: Guild)
-
- -
-
-abstract async on_guild_role_create(role: Role)
-
- -
-
-abstract async on_guild_role_delete(role: Role)
-
- -
-
-abstract async on_guild_role_update(before: Role, after: Role)
-
- -
-
-abstract async on_guild_unavailable(guild: Guild)
-
- -
-
-abstract async on_guild_update(before: Guild, after: Guild)
-
- -
-
-abstract async on_invite_create(invite: Invite)
-
- -
-
-abstract async on_invite_delete(invite: Invite)
-
- -
-
-abstract async on_member_ban(guild: Guild, user: User)
-
- -
-
-abstract async on_member_join(member: Member)
-
- -
-
-abstract async on_member_remove(member: Member)
-
- -
-
-abstract async on_member_unban(guild: Guild, user: User)
-
- -
-
-abstract async on_member_update(before: Member, after: Member)
-
- -
-
-abstract async on_message(message: Message)
-
- -
-
-abstract async on_message_delete(message: Message)
-
- -
-
-abstract async on_message_edit(before: Message, after: Message)
-
- -
-
-abstract async on_private_channel_create(channel: PrivateChannel)
-
- -
-
-abstract async on_private_channel_delete(channel: PrivateChannel)
-
- -
-
-abstract async on_private_channel_pins_update(channel: PrivateChannel, list_pin: datetime | None)
-
- -
-
-abstract async on_private_channel_update(before: GroupChannel, after: GroupChannel)
-
- -
-
-abstract async on_reaction_add(reaction: Reaction, user: User)
-
- -
-
-abstract async on_reaction_clear(message: Message, reactions: list[discord.reaction.Reaction])
-
- -
-
-abstract async on_reaction_clear_emoji(reaction: Reaction)
-
- -
-
-abstract async on_reaction_remove(reaction: Reaction, user: User)
-
- -
-
-abstract async on_ready()
-
- -
-
-abstract async on_resume()
-
- -
-
-abstract async on_typing(channel: Messageable, user: User | Member, when: datetime)
-
- -
-
-abstract async on_user_update(before: User, after: User)
-
- -
-
-abstract async on_voice_state_update(member: Member, before: VoiceState, after: VoiceState)
-
- -
-
-abstract async on_webhooks_update(channel: GuildChannel)
-
- -
- -
-
-

Module contents

-
-

cpl-discord CPL Discord

-

Link between discord.py and CPL

-
-
copyright:
-
    -

  1. 2022 - 2023 sh-edraft.de

    2. -
-
-
license:
-

MIT, see LICENSE for more details.

-
-
-
-
-
-class cpl_discord.service.VersionInfo(major, minor, micro)
-

Bases: tuple

-
-
-major
-

Alias for field number 0

-
- -
-
-micro
-

Alias for field number 2

-
- -
-
-minor
-

Alias for field number 1

-
- -
- -
-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/build/html/cpl_query.base.html b/docs/build/html/cpl_query.base.html deleted file mode 100644 index dc49e4fa..00000000 --- a/docs/build/html/cpl_query.base.html +++ /dev/null @@ -1,945 +0,0 @@ - - - - - - - cpl_query.base package — Common Python Library documentation - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

cpl_query.base package

-
-

Submodules

-
-
-

cpl_query.base.default_lambda module

-
-
-cpl_query.base.default_lambda.default_lambda(x: object)
-
- -
-
-

cpl_query.base.ordered_queryable module

-
-
-class cpl_query.base.ordered_queryable.OrderedQueryable(_t: type, _values: Iterable | None = None, _func: Callable | None = None)
-

Bases: OrderedQueryableABC

-

Implementation of :class: cpl_query.base.ordered_queryable_abc.OrderedQueryableABC

-
-
-then_by(_func: Callable) → OrderedQueryableABC
-

Sorts OrderedList in ascending order by function

-
-
Parameter:

func: Callable

-
-
Returns:

list of cpl_query.base.ordered_queryable_abc.OrderedQueryableABC

-
-
-
- -
-
-then_by_descending(_func: Callable) → OrderedQueryableABC
-

Sorts OrderedList in descending order by function

-
-
Parameter:

func: Callable

-
-
Returns:

list of cpl_query.base.ordered_queryable_abc.OrderedQueryableABC

-
-
-
- -
- -
-
-

cpl_query.base.ordered_queryable_abc module

-
-
-class cpl_query.base.ordered_queryable_abc.OrderedQueryableABC(_t: type, _values: Iterable | None = None, _func: Callable | None = None)
-

Bases: QueryableABC

-
-
-abstract then_by(func: Callable) → OrderedQueryableABC
-

Sorts OrderedList in ascending order by function

-
-
Parameter:

func: Callable

-
-
Returns:

list of cpl_query.base.ordered_queryable_abc.OrderedQueryableABC

-
-
-
- -
-
-abstract then_by_descending(func: Callable) → OrderedQueryableABC
-

Sorts OrderedList in descending order by function

-
-
Parameter:

func: Callable

-
-
Returns:

list of cpl_query.base.ordered_queryable_abc.OrderedQueryableABC

-
-
-
- -
- -
-
-

cpl_query.base.queryable_abc module

-
-
-class cpl_query.base.queryable_abc.QueryableABC(t: type, values: Iterable | None = None)
-

Bases: Sequence

-
-
-all(_func: Callable | None = None) → bool
-

Checks if every element of list equals result found by function

-
-

Parameter

-
-
-
func: Callable

selected value

-
-
-
-
-
-

Returns

-
-

bool

-
-
-
- -
-
-any(_func: Callable | None = None) → bool
-

Checks if list contains result found by function

-
-

Parameter

-
-
-
func: Callable

selected value

-
-
-
-
-
-

Returns

-
-

bool

-
-
-
- -
-
-average(_func: Callable | None = None) → int | float | complex
-

Returns average value of list

-
-

Parameter

-
-
-
func: Callable

selected value

-
-
-
-
-
-

Returns

-
-

Union[int, float, complex]

-
-
-
- -
-
-contains(_value: object) → bool
-

Checks if list contains value given by function

-
-

Parameter

-
-
-
value: object

value

-
-
-
-
-
-

Returns

-
-

bool

-
-
-
- -
-
-count(_func: Callable | None = None) → int
-

Returns length of list or count of found elements

-
-

Parameter

-
-
-
func: Callable

selected value

-
-
-
-
-
-

Returns

-
-

int

-
-
-
- -
-
-distinct(_func: Callable | None = None) → QueryableABC
-

Returns list without redundancies

-
-

Parameter

-
-
-
func: Callable

selected value

-
-
-
-
-
-

Returns

-
-
-
class:
-

cpl_query.base.queryable_abc.QueryableABC

-
-
-
-
-
- -
-
-element_at(_index: int) → any
-

Returns element at given index

-
-

Parameter

-
-
-
_index: int

index

-
-
-
-
-
-

Returns

-
-

Value at _index: any

-
-
-
- -
-
-element_at_or_default(_index: int) → any | None
-

Returns element at given index or None

-
-

Parameter

-
-
-
_index: int

index

-
-
-
-
-
-

Returns

-
-

Value at _index: Optional[any]

-
-
-
- -
-
-first() → any
-

Returns first element

-
-

Returns

-
-

First element of list: any

-
-
-
- -
-
-first_or_default() → any
-

Returns first element or None

-
-

Returns

-
-

First element of list: Optional[any]

-
-
-
- -
-
-for_each(_func: Callable | None = None)
-

Runs given function for each element of list

-
-

Parameter

-
-
-
func: :class: Callable

function to call

-
-
-
-
-
- -
-
-group_by(_func: Callable | None = None) → QueryableABC
-

Groups by func

-
-

Returns

-
-

Grouped list[list[any]]: any

-
-
-
- -
-
-last() → any
-

Returns last element

-
-

Returns

-
-

Last element of list: any

-
-
-
- -
-
-last_or_default() → any
-

Returns last element or None

-
-

Returns

-
-

Last element of list: Optional[any]

-
-
-
- -
-
-max(_func: Callable | None = None) → object
-

Returns the highest value

-
-

Parameter

-
-
-
func: Callable

selected value

-
-
-
-
-
-

Returns

-
-

object

-
-
-
- -
-
-median(_func=None) → int | float
-

Return the median value of data elements

-
-

Returns

-
-

Union[int, float]

-
-
-
- -
-
-min(_func: Callable | None = None) → object
-

Returns the lowest value

-
-

Parameter

-
-
-
func: Callable

selected value

-
-
-
-
-
-

Returns

-
-

object

-
-
-
- -
-
-order_by(_func: Callable = None) → OrderedQueryableABC
-

Sorts elements by function in ascending order

-
-

Parameter

-
-
-
func: Callable

selected value

-
-
-
-
-
-

Returns

-
-
-
class:
-

cpl_query.base.ordered_queryable_abc.OrderedQueryableABC

-
-
-
-
-
- -
-
-order_by_descending(_func: Callable = None) → OrderedQueryableABC
-

Sorts elements by function in descending order

-
-

Parameter

-
-
-
func: Callable

selected value

-
-
-
-
-
-

Returns

-
-
-
class:
-

cpl_query.base.ordered_queryable_abc.OrderedQueryableABC

-
-
-
-
-
- -
-
-reverse() → QueryableABC
-

Reverses list

-
-

Returns

-
-
-
class:
-

cpl_query.base.queryable_abc.QueryableABC

-
-
-
-
-
- -
-
-select(_func: Callable) → QueryableABC
-

Formats each element of list to a given format

-
-

Returns

-
-
-
class:
-

cpl_query.base.queryable_abc.QueryableABC

-
-
-
-
-
- -
-
-select_many(_func: Callable) → QueryableABC
-

Flattens resulting lists to one

-
-

Returns

-
-
-
class:
-

cpl_query.base.queryable_abc.QueryableABC

-
-
-
-
-
- -
-
-single() → any
-

Returns one single element of list

-
-

Returns

-
-

Found value: any

-
-
-
-

Raises

-
-

ArgumentNoneException: when argument is None -Exception: when argument is None or found more than one element

-
-
-
- -
-
-single_or_default() → any | None
-

Returns one single element of list

-
-

Returns

-
-

Found value: Optional[any]

-
-
-
- -
-
-skip(_index: int) → QueryableABC
-

Skips all elements from index

-
-

Parameter

-
-
-
_index: int

index

-
-
-
-
-
-

Returns

-
-
-
class:
-

cpl_query.base.queryable_abc.QueryableABC

-
-
-
-
-
- -
-
-skip_last(_index: int) → QueryableABC
-

Skips all elements after index

-
-

Parameter

-
-
-
_index: int

index

-
-
-
-
-
-

Returns

-
-
-
class:
-

cpl_query.base.queryable_abc.QueryableABC

-
-
-
-
-
- -
-
-split(_func: Callable) → QueryableABC
-

Splits the list by given function

-
-

Parameter

-
-
-
func: Callable

seperator

-
-
-
-
-
-

Returns

-
-
-
class:
-

cpl_query.base.queryable_abc.QueryableABC

-
-
-
-
-
- -
-
-sum(_func: Callable | None = None) → int | float | complex
-

Sum of all values

-
-

Parameter

-
-
-
func: Callable

selected value

-
-
-
-
-
-

Returns

-
-

Union[int, float, complex]

-
-
-
- -
-
-take(_index: int) → QueryableABC
-

Takes all elements from index

-
-

Parameter

-
-
-
_index: int

index

-
-
-
-
-
-

Returns

-
-
-
class:
-

cpl_query.base.queryable_abc.QueryableABC

-
-
-
-
-
- -
-
-take_last(_index: int) → QueryableABC
-

Takes all elements after index

-
-

Parameter

-
-
-
_index: int

index

-
-
-
-
-
-

Returns

-
-
-
class:
-

cpl_query.base.queryable_abc.QueryableABC

-
-
-
-
-
- -
-
-where(_func: Callable | None = None) → QueryableABC
-

Select element by function

-
-

Parameter

-
-
-
func: Callable

selected value

-
-
-
-
-
-

Returns

-
-
-
class:
-

cpl_query.base.queryable_abc.QueryableABC

-
-
-
-
-
- -
- -
-
-

cpl_query.base.sequence module

-
-
-class cpl_query.base.sequence.Sequence(t: type, values: Iterable | None = None)
-

Bases: ABC

-
-
-copy() → Sequence
-

Creates a copy of sequence

-
-
Returns:

Sequence

-
-
-
- -
-
-classmethod empty() → Sequence
-

Returns an empty sequence

-
-
Returns:

Sequence object that contains no elements

-
-
-
- -
-
-index_of(_object: object) → int
-

Returns the index of given element

-
-
Returns:

Index of object

-
-
Raises:

IndexError if object not in sequence

-
-
-
- -
-
-classmethod range(start: int, length: int) → Sequence
-
- -
-
-to_list() → list
-

Converts :class: cpl_query.base.sequence_abc.SequenceABC to :class: list

-
-
Returns:
-
class:
-

list

-
-
-
-
-
- -
-
-property type: type
-
- -
- -
-
-

Module contents

-
-

cpl-query CPL Queries

-

CPL Python integrated Queries

-
-
copyright:
-
    -

  1. 2021 - 2023 sh-edraft.de

    2. -
-
-
license:
-

MIT, see LICENSE for more details.

-
-
-
-
-
-class cpl_query.base.VersionInfo(major, minor, micro)
-

Bases: tuple

-
-
-major
-

Alias for field number 0

-
- -
-
-micro
-

Alias for field number 2

-
- -
-
-minor
-

Alias for field number 1

-
- -
- -
-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/build/html/cpl_query.enumerable.html b/docs/build/html/cpl_query.enumerable.html deleted file mode 100644 index c79a8263..00000000 --- a/docs/build/html/cpl_query.enumerable.html +++ /dev/null @@ -1,217 +0,0 @@ - - - - - - - cpl_query.enumerable package — Common Python Library documentation - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

cpl_query.enumerable package

-
-

Submodules

-
-
-

cpl_query.enumerable.enumerable module

-
-
-class cpl_query.enumerable.enumerable.Enumerable(t: type | None = None, values: list | None = None)
-

Bases: EnumerableABC

-

Implementation of :class: cpl_query.enumerable.enumerable_abc.EnumerableABC

-
- -
-
-

cpl_query.enumerable.enumerable_abc module

-
-
-class cpl_query.enumerable.enumerable_abc.EnumerableABC(t: type | None = None, values: list | None = None)
-

Bases: QueryableABC

-

ABC to define functions on list

-
-
-to_iterable() → IterableABC
-

Converts :class: cpl_query.enumerable.enumerable_abc.EnumerableABC to :class: cpl_query.iterable.iterable_abc.IterableABC

-
-
Returns:
-
class:
-

cpl_query.iterable.iterable_abc.IterableABC

-
-
-
-
-
- -
- -
-
-

Module contents

-
-

cpl-query CPL Queries

-

CPL Python integrated Queries

-
-
copyright:
-
    -

  1. 2021 - 2023 sh-edraft.de

    2. -
-
-
license:
-

MIT, see LICENSE for more details.

-
-
-
-
-
-class cpl_query.enumerable.VersionInfo(major, minor, micro)
-

Bases: tuple

-
-
-major
-

Alias for field number 0

-
- -
-
-micro
-

Alias for field number 2

-
- -
-
-minor
-

Alias for field number 1

-
- -
- -
-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/build/html/cpl_query.extension.html b/docs/build/html/cpl_query.extension.html deleted file mode 100644 index 3a8bffbc..00000000 --- a/docs/build/html/cpl_query.extension.html +++ /dev/null @@ -1,217 +0,0 @@ - - - - - - - cpl_query.extension package — Common Python Library documentation - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

cpl_query.extension package

-
-

Submodules

-
-
-

cpl_query.extension.list module

-
-
-class cpl_query.extension.list.List(t: type | None = None, values: Iterator | None = None)
-

Bases: Iterable

-

Implementation of :class: cpl_query.extension.iterable.Iterable

-
-
-to_enumerable() → EnumerableABC
-

Converts :class: cpl_query.iterable.iterable_abc.IterableABC to :class: cpl_query.enumerable.enumerable_abc.EnumerableABC

-
-
Returns:
-
class:
-

cpl_query.enumerable.enumerable_abc.EnumerableABC

-
-
-
-
-
- -
-
-to_iterable() → IterableABC
-

Converts :class: cpl_query.enumerable.enumerable_abc.EnumerableABC to :class: cpl_query.iterable.iterable_abc.IterableABC

-
-
Returns:
-
class:
-

cpl_query.iterable.iterable_abc.IterableABC

-
-
-
-
-
- -
- -
-
-

Module contents

-
-

cpl-query CPL Queries

-

CPL Python integrated Queries

-
-
copyright:
-
    -

  1. 2021 - 2023 sh-edraft.de

    2. -
-
-
license:
-

MIT, see LICENSE for more details.

-
-
-
-
-
-class cpl_query.extension.VersionInfo(major, minor, micro)
-

Bases: tuple

-
-
-major
-

Alias for field number 0

-
- -
-
-micro
-

Alias for field number 2

-
- -
-
-minor
-

Alias for field number 1

-
- -
- -
-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/build/html/cpl_query.html b/docs/build/html/cpl_query.html deleted file mode 100644 index 22ff2ce8..00000000 --- a/docs/build/html/cpl_query.html +++ /dev/null @@ -1,286 +0,0 @@ - - - - - - - Query reference — Common Python Library documentation - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

Query reference

-
- -
-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/build/html/cpl_query.iterable.html b/docs/build/html/cpl_query.iterable.html deleted file mode 100644 index 71ec2f4a..00000000 --- a/docs/build/html/cpl_query.iterable.html +++ /dev/null @@ -1,273 +0,0 @@ - - - - - - - cpl_query.iterable package — Common Python Library documentation - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

cpl_query.iterable package

-
-

Submodules

-
-
-

cpl_query.iterable.iterable module

-
-
-class cpl_query.iterable.iterable.Iterable(t: type | None = None, values: Iterable | None = None)
-

Bases: IterableABC

-
- -
-
-

cpl_query.iterable.iterable_abc module

-
-
-class cpl_query.iterable.iterable_abc.IterableABC(t: type | None = None, values: Iterable | None = None)
-

Bases: QueryableABC

-

ABC to define functions on list

-
-
-add(_object: object)
-

Adds element to list

-
-
Parameter:
-
_object: object

value

-
-
-
-
-
- -
-
-append(_object: object)
-
- -
-
-extend(_IterableABC__iterable: Iterable) → IterableABC
-

Adds elements of given list to list

-
-
Parameter:
-
__iterable: :class: cpl_query.extension.iterable.Iterable

index

-
-
-
-
-
- -
-
-remove(_object: object)
-

Removes element from list

-
-
Parameter:
-
_object: object

value

-
-
-
-
-
- -
-
-remove_at(_index: int)
-

Removes element from list

-
-
Parameter:
-
_object: object

value

-
-
-
-
-
- -
-
-to_enumerable() → EnumerableABC
-

Converts :class: cpl_query.iterable.iterable_abc.IterableABC to :class: cpl_query.enumerable.enumerable_abc.EnumerableABC

-
-
Returns:
-
class:
-

cpl_query.enumerable.enumerable_abc.EnumerableABC

-
-
-
-
-
- -
- -
-
-

Module contents

-
-

cpl-query CPL Queries

-

CPL Python integrated Queries

-
-
copyright:
-
    -

  1. 2021 - 2023 sh-edraft.de

    2. -
-
-
license:
-

MIT, see LICENSE for more details.

-
-
-
-
-
-class cpl_query.iterable.VersionInfo(major, minor, micro)
-

Bases: tuple

-
-
-major
-

Alias for field number 0

-
- -
-
-micro
-

Alias for field number 2

-
- -
-
-minor
-

Alias for field number 1

-
- -
- -
-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/build/html/cpl_translation.html b/docs/build/html/cpl_translation.html deleted file mode 100644 index e84ef5b9..00000000 --- a/docs/build/html/cpl_translation.html +++ /dev/null @@ -1,254 +0,0 @@ - - - - - - - Translation reference — Common Python Library documentation - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

Translation reference

-
-

cpl_translation.translate_pipe

-
-
-class cpl_translation.translate_pipe.TranslatePipe(translation: TranslationServiceABC)
-

Bases: PipeABC

-
-
-transform(value: any, *args)
-
- -
- -
-
-

cpl_translation.translation_service

-
-
-class cpl_translation.translation_service.TranslationService
-

Bases: TranslationServiceABC

-
-
-load(lang: str)
-
- -
-
-load_by_settings(settings: TranslationSettings)
-
- -
-
-set_default_lang(lang: str)
-
- -
-
-set_lang(lang: str)
-
- -
-
-translate(key: str) → str
-
- -
- -
-
-

cpl_translation.translation_service_abc

-
-
-class cpl_translation.translation_service_abc.TranslationServiceABC
-

Bases: ABC

-
-
-abstract load(lang: str)
-
- -
-
-abstract load_by_settings(settings: TranslationSettings)
-
- -
-
-abstract set_default_lang(lang: str)
-
- -
-
-abstract set_lang(lang: str)
-
- -
-
-abstract translate(key: str) → str
-
- -
- -
-
-

cpl_translation.translation_settings

-
-
-class cpl_translation.translation_settings.TranslationSettings(languages: list | None = None, default_lang: str | None = None)
-

Bases: ConfigurationModelABC

-
-
-property default_language: str
-
- -
-
-property languages: list[str]
-
- -
- -
-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/build/html/deprecated.html b/docs/build/html/deprecated.html deleted file mode 100644 index 4c3bda8c..00000000 --- a/docs/build/html/deprecated.html +++ /dev/null @@ -1,182 +0,0 @@ - - - - - - - Deprecated — Common Python Library documentation - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

Deprecated

-
-

Table of Contents

-
    -

  1. ConfigurationModelABC.from_dict

    2. -
-
-
-

ConfigurationModelABC from_dict method

-

We now process the configuration models directly in the configuration by recursive parameter parsing.

-

The JSONProcessor now goes through the JSON and the arguments of the init and links the attributes by name from the -JSON and the name of the keyword argument. -Now, based on the type, either simply assigns the value. With a dict the processor is called recursively and so the -JSON is processed further. This way nested ConfigurationModels can be processed.

-

For this the code must be adapted as follows:

-

From this:

-
class VersionSettings(ConfigurationModelABC):
-
-    def __init__(self):
-        ConfigurationModelABC.__init__(self)
-
-        self.major: Optional[str] = "0"
-        self.minor: Optional[str] = "0"
-        self.micro: Optional[str] = "0"
-
-    def from_dict(self, settings: dict):
-        self.major = settings["Major"]
-        self.minor = settings["Minor"]
-        micro = settings["Micro"]
-        if micro != '':
-            self.micro = micro
-
-
-

To this:

-
class VersionSettings(ConfigurationModelABC):
-    def __init__(self, major: str = None, minor: str = None, micro: str = None):
-        ConfigurationModelABC.__init__(self)
-
-        self.major: Optional[str] = major
-        self.minor: Optional[str] = minor
-        self.micro: Optional[str] = micro if micro != "" else None
-
-
-

This makes the from_dict function obsolete.

-

A few rules must be observed:

-
    -

  • Only simple types can be processed -
    -Wrong: dict[str, str] -
    -Correct: dict -
    -
    -Incorrect: list[str] -
    -Correct: list

    • -

  • The arguments must be optional, i.e. created as kwargs -
    -Incorrect: def __init__(self, x: int, y: int) -
    -Correct: def __init__(self, x: int = None, y: int = None)

    • -
-
-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/build/html/genindex.html b/docs/build/html/genindex.html deleted file mode 100644 index 7a59b6af..00000000 --- a/docs/build/html/genindex.html +++ /dev/null @@ -1,4105 +0,0 @@ - - - - - - Index — Common Python Library documentation - - - - - - - - - - - - - - - -
- - -
- -
-
-
-
    -
    • -
  • Index
    • -
  • -
    • -
-
-
-
-
- - -

Index

- -
- A - | B - | C - | D - | E - | F - | G - | H - | I - | J - | L - | M - | N - | O - | P - | Q - | R - | S - | T - | U - | V - | W - | Y - -
-

A

- - - -
- -

B

- - - -
- -

C

- - - -
- -

D

- - - -
- -

E

- - - -
- -

F

- - - -
- -

G

- - - -
- -

H

- - - -
- -

I

- - - -
- -

J

- - -
- -

L

- - - -
- -

M

- - -
- -

N

- - - -
- -

O

- - - -
- -

P

- - - -
- -

Q

- - -
- -

R

- - - -
- -

S

- - - -
- -

T

- - - -
- -

U

- - - -
- -

V

- - - -
- -

W

- - - -
- -

Y

- - -
- - - -
-
-
- -
- -
-

© Copyright 2021 - 2023, Sven Heidemann.

-
- - Built with Sphinx using a - theme - provided by Read the Docs. - - -
-
-
-
-
- - - - \ No newline at end of file diff --git a/docs/build/html/getting_started.html b/docs/build/html/getting_started.html deleted file mode 100644 index 56d73522..00000000 --- a/docs/build/html/getting_started.html +++ /dev/null @@ -1,187 +0,0 @@ - - - - - - - Getting started — Common Python Library documentation - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

Getting started

-
- -
-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/build/html/index.html b/docs/build/html/index.html deleted file mode 100644 index 227be550..00000000 --- a/docs/build/html/index.html +++ /dev/null @@ -1,285 +0,0 @@ - - - - - - - Introduction to the CPL Docs — Common Python Library documentation - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

Introduction to the CPL Docs

-

The Common Python Library (CPL) is a package for python and a development platform meant to help you create simple and efficient server and desktop applications.

-

This CPL docs help you learn, understand and use the package. From your first application to complex apps for enterprises.

-
-

Features

-
    -
  • -
    cpl-core
      -

    • Expandable

      • -
    • -
      Application base
        -

      • Standardized application classes

        • -

      • Application object builder

        • -

      • Application extension classes

        • -

      • Startup classes

        • -

      • Startup extension classes

        • -
      -
      -
      -
      • -
    • -
      Configuration
        -

      • Configure via object mapped JSON

        • -

      • Console argument handling

        • -
      -
      -
      -
      • -
    • -
      Console class for in and output
        -

      • Banner

        • -

      • Spinner

        • -

      • Options (menu)

        • -

      • Table

        • -

      • Write

        • -

      • Write_at

        • -

      • Write_line

        • -

      • Write_line_at

        • -
      -
      -
      -
      • -
    • -
      Dependency injection
        -

      • Service lifetimes: singleton, scoped and transient

        • -
      -
      -
      -
      • -
    • -
      Providing of application environment
        -

      • Environment (development, staging, testing, production)

        • -

      • Appname

        • -

      • Customer

        • -

      • Hostname

        • -

      • Runtime directory

        • -

      • Working directory

        • -
      -
      -
      -
      • -
    • -
      Logging
        -

      • Standardized logger

        • -

      • Log-level (FATAL, ERROR, WARN, INFO, DEBUG & TRACE)

        • -
      -
      -
      -
      • -
    • -
      Mail handling
        -

      • Send mails

        • -
      -
      -
      -
      • -
    • -
      Pipe classes
        -

      • Convert input

        • -
      -
      -
      -
      • -
    • -
      Utils
        -
      • -
        Credential manager
          -

        • Encryption via BASE64

          • -
        -
        -
        -
        • -
      • -
        PIP wrapper class based on subprocess
          -

        • Run pip commands

          • -
        -
        -
        -
        • -
      • -
        String converter to different variants
          -

        • to_lower_case

          • -

        • to_camel_case

          • -

        • …

          • -
        -
        -
        -
        • -
      -
      -
      -
      • -
    -
    -
    -
    • -
  • -
    cpl-cli
      -

    • Expandle

      • -

    • Code generation

      • -

    • Package managing

      • -

    • Build & Publishing

      • -
    -
    -
    -
    • -
  • -
    cpl-discord
      -

    • Utils for discord.py

      • -

    • Connector between cpl-core and discord.py

      • -

    • Prepared services for dependency injection

      • -
    -
    -
    -
    • -
  • -
    cpl-query
      -

    • Python list extensions

      • -

    • Functions for sorting and filtering

      • -

    • Like linq from C# but in python xD

      • -
    -
    -
    -
    • -
  • -
    cpl-translate
      -

    • Generic translations

      • -

    • Prepared translation service and translate pipe

      • -

    • Get translation from JSON files key dot.key notation

      • -
    -
    -
    -
    • -
-
-
-

Manuals

-

These pages go into great detail about everything the Library can do.

-
- -
-
-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/build/html/introduction.html b/docs/build/html/introduction.html deleted file mode 100644 index 0cfebe27..00000000 --- a/docs/build/html/introduction.html +++ /dev/null @@ -1,217 +0,0 @@ - - - - - - - Introduction to the CPL Docs — Common Python Library documentation - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

Introduction to the CPL Docs

-

The Common Python Library (CPL) is a package for python and a development platform meant to help you create simple and efficient server and desktop applications.

-

This CPL docs help you learn, understand and use the package. From your first application to complex apps for enterprises.

-
-

Feature overview

-
    -

  • Expandle

    • -

  • Application base

    -
      -

    • Standardized application classes

      • -

    • Application object builder

      • -

    • Application extension classes

      • -

    • Startup classes

      • -

    • Startup extension classes

      • -
    -
    • -

  • Configuration

    -
      -

    • Configure via object mapped JSON

      • -

    • Console argument handling

      • -
    -
    • -

  • Console class for in and output

    -
      -

    • Banner

      • -

    • Spinner

      • -

    • Options (menu)

      • -

    • Table

      • -

    • Write

      • -

    • Write_at

      • -

    • Write_line

      • -

    • Write_line_at

      • -
    -
    • -

  • Dependency injection

    -
      -

    • Service lifetimes: singleton, scoped and transient

      • -
    -
    • -

  • Providing of application environment

    -
      -

    • Environment (development, staging, testing, production)

      • -

    • Appname

      • -

    • Customer

      • -

    • Hostname

      • -

    • Runtime directory

      • -

    • Working directory

      • -
    -
    • -

  • Logging

    -
      -

    • Standardized logger

      • -

    • Log-level (FATAL, ERROR, WARN, INFO, DEBUG & TRACE)

      • -
    -
    • -

  • Mail handling

    -
      -

    • Send mails

      • -
    -
    • -

  • Pipe classes

    -
      -

    • Convert input

      • -
    -
    • -

  • Utils

    -
      -

    • Credential manager

      -
        -

      • Encryption via BASE64

        • -
      -
      • -

    • PIP wrapper class based on subprocess

      -
        -

      • Run pip commands

        • -
      -
      • -

    • String converter to different variants

      -
        -

      • to_lower_case

        • -

      • to_camel_case

        • -

      • …

        • -
      -
      • -
    -
    • -
-
-
-

Explore

- -
-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/build/html/modules.html b/docs/build/html/modules.html deleted file mode 100644 index 02f77f17..00000000 --- a/docs/build/html/modules.html +++ /dev/null @@ -1,1077 +0,0 @@ - - - - - - - Packages — Common Python Library documentation - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

Packages

-
- -
-
- - -
-
-
- -
- -
-

© Copyright 2021 - 2023, Sven Heidemann.

-
- - Built with Sphinx using a - theme - provided by Read the Docs. - - -
-
-
-
-
- - - - \ No newline at end of file diff --git a/docs/build/html/objects.inv b/docs/build/html/objects.inv deleted file mode 100644 index 4d216378..00000000 Binary files a/docs/build/html/objects.inv and /dev/null differ diff --git a/docs/build/html/py-modindex.html b/docs/build/html/py-modindex.html deleted file mode 100644 index 5c39ab26..00000000 --- a/docs/build/html/py-modindex.html +++ /dev/null @@ -1,1020 +0,0 @@ - - - - - - Python Module Index — Common Python Library documentation - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
-
    -
    • -
  • Python Module Index
    • -
  • -
    • -
-
-
-
-
- - -

Python Module Index

- -
- c -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 
- c
- cpl_core -
    - cpl_core.application -
    - cpl_core.application.application_abc -
    - cpl_core.application.application_builder -
    - cpl_core.application.application_builder_abc -
    - cpl_core.application.application_extension_abc -
    - cpl_core.application.startup_abc -
    - cpl_core.application.startup_extension_abc -
    - cpl_core.configuration -
    - cpl_core.configuration.argument_abc -
    - cpl_core.configuration.argument_builder -
    - cpl_core.configuration.argument_executable_abc -
    - cpl_core.configuration.argument_type_enum -
    - cpl_core.configuration.configuration -
    - cpl_core.configuration.configuration_abc -
    - cpl_core.configuration.configuration_model_abc -
    - cpl_core.configuration.configuration_variable_name_enum -
    - cpl_core.configuration.executable_argument -
    - cpl_core.configuration.flag_argument -
    - cpl_core.configuration.validator_abc -
    - cpl_core.configuration.variable_argument -
    - cpl_core.console -
    - cpl_core.console.background_color_enum -
    - cpl_core.console.console -
    - cpl_core.console.console_call -
    - cpl_core.console.foreground_color_enum -
    - cpl_core.console.spinner_thread -
    - cpl_core.database -
    - cpl_core.database.connection -
    - cpl_core.database.connection.database_connection -
    - cpl_core.database.connection.database_connection_abc -
    - cpl_core.database.context -
    - cpl_core.database.context.database_context -
    - cpl_core.database.context.database_context_abc -
    - cpl_core.database.database_settings -
    - cpl_core.database.database_settings_name_enum -
    - cpl_core.database.table_abc -
    - cpl_core.dependency_injection -
    - cpl_core.dependency_injection.scope -
    - cpl_core.dependency_injection.scope_abc -
    - cpl_core.dependency_injection.scope_builder -
    - cpl_core.dependency_injection.service_collection -
    - cpl_core.dependency_injection.service_collection_abc -
    - cpl_core.dependency_injection.service_descriptor -
    - cpl_core.dependency_injection.service_lifetime_enum -
    - cpl_core.dependency_injection.service_provider -
    - cpl_core.dependency_injection.service_provider_abc -
    - cpl_core.environment -
    - cpl_core.environment.application_environment -
    - cpl_core.environment.application_environment_abc -
    - cpl_core.environment.environment_name_enum -
    - cpl_core.logging -
    - cpl_core.logging.logger_abc -
    - cpl_core.logging.logger_service -
    - cpl_core.logging.logging_level_enum -
    - cpl_core.logging.logging_settings -
    - cpl_core.logging.logging_settings_name_enum -
    - cpl_core.mailing -
    - cpl_core.mailing.email -
    - cpl_core.mailing.email_client_abc -
    - cpl_core.mailing.email_client_service -
    - cpl_core.mailing.email_client_settings -
    - cpl_core.mailing.email_client_settings_name_enum -
    - cpl_core.pipes -
    - cpl_core.pipes.bool_pipe -
    - cpl_core.pipes.first_char_to_lower_pipe -
    - cpl_core.pipes.first_to_upper_pipe -
    - cpl_core.pipes.ip_address_pipe -
    - cpl_core.pipes.pipe_abc -
    - cpl_core.pipes.to_camel_case_pipe -
    - cpl_core.pipes.to_snake_case_pipe -
    - cpl_core.pipes.version_pipe -
    - cpl_core.time -
    - cpl_core.time.time_format_settings -
    - cpl_core.time.time_format_settings_names_enum -
    - cpl_core.utils -
    - cpl_core.utils.credential_manager -
    - cpl_core.utils.pip -
    - cpl_core.utils.string -
- cpl_discord -
    - cpl_discord.application -
    - cpl_discord.application.discord_bot_application_abc -
    - cpl_discord.command -
    - cpl_discord.command.discord_command_abc -
    - cpl_discord.command.discord_commands_meta -
    - cpl_discord.configuration -
    - cpl_discord.configuration.discord_bot_settings -
    - cpl_discord.container -
    - cpl_discord.container.category_channel -
    - cpl_discord.container.container -
    - cpl_discord.container.guild -
    - cpl_discord.container.member -
    - cpl_discord.container.role -
    - cpl_discord.container.text_channel -
    - cpl_discord.container.thread -
    - cpl_discord.container.voice_channel -
    - cpl_discord.discord_event_types_enum -
    - cpl_discord.events -
    - cpl_discord.events.on_bulk_message_delete_abc -
    - cpl_discord.events.on_command_abc -
    - cpl_discord.events.on_command_completion_abc -
    - cpl_discord.events.on_command_error_abc -
    - cpl_discord.events.on_connect_abc -
    - cpl_discord.events.on_disconnect_abc -
    - cpl_discord.events.on_error_abc -
    - cpl_discord.events.on_group_join_abc -
    - cpl_discord.events.on_group_remove_abc -
    - cpl_discord.events.on_guild_available_abc -
    - cpl_discord.events.on_guild_channel_create_abc -
    - cpl_discord.events.on_guild_channel_delete_abc -
    - cpl_discord.events.on_guild_channel_pins_update_abc -
    - cpl_discord.events.on_guild_channel_update_abc -
    - cpl_discord.events.on_guild_emojis_update_abc -
    - cpl_discord.events.on_guild_integrations_update_abc -
    - cpl_discord.events.on_guild_join_abc -
    - cpl_discord.events.on_guild_remove_abc -
    - cpl_discord.events.on_guild_role_create_abc -
    - cpl_discord.events.on_guild_role_delete_abc -
    - cpl_discord.events.on_guild_role_update_abc -
    - cpl_discord.events.on_guild_unavailable_abc -
    - cpl_discord.events.on_guild_update_abc -
    - cpl_discord.events.on_invite_create_abc -
    - cpl_discord.events.on_invite_delete_abc -
    - cpl_discord.events.on_member_ban_abc -
    - cpl_discord.events.on_member_join_abc -
    - cpl_discord.events.on_member_remove_abc -
    - cpl_discord.events.on_member_unban_abc -
    - cpl_discord.events.on_member_update_abc -
    - cpl_discord.events.on_message_abc -
    - cpl_discord.events.on_message_delete_abc -
    - cpl_discord.events.on_message_edit_abc -
    - cpl_discord.events.on_private_channel_create_abc -
    - cpl_discord.events.on_private_channel_delete_abc -
    - cpl_discord.events.on_private_channel_pins_update_abc -
    - cpl_discord.events.on_private_channel_update_abc -
    - cpl_discord.events.on_raw_reaction_add_abc -
    - cpl_discord.events.on_raw_reaction_clear_abc -
    - cpl_discord.events.on_raw_reaction_clear_emoji_abc -
    - cpl_discord.events.on_raw_reaction_remove_abc -
    - cpl_discord.events.on_reaction_add_abc -
    - cpl_discord.events.on_reaction_clear_abc -
    - cpl_discord.events.on_reaction_clear_emoji_abc -
    - cpl_discord.events.on_reaction_remove_abc -
    - cpl_discord.events.on_ready_abc -
    - cpl_discord.events.on_resume_abc -
    - cpl_discord.events.on_typing_abc -
    - cpl_discord.events.on_user_update_abc -
    - cpl_discord.events.on_voice_state_update_abc -
    - cpl_discord.events.on_webhooks_update_abc -
    - cpl_discord.helper -
    - cpl_discord.helper.to_containers_converter -
    - cpl_discord.service -
    - cpl_discord.service.command_error_handler_service -
    - cpl_discord.service.discord_bot_service -
    - cpl_discord.service.discord_bot_service_abc -
    - cpl_discord.service.discord_collection -
    - cpl_discord.service.discord_collection_abc -
    - cpl_discord.service.discord_service -
    - cpl_discord.service.discord_service_abc -
- cpl_query -
    - cpl_query.base -
    - cpl_query.base.default_lambda -
    - cpl_query.base.ordered_queryable -
    - cpl_query.base.ordered_queryable_abc -
    - cpl_query.base.queryable_abc -
    - cpl_query.base.sequence -
    - cpl_query.enumerable -
    - cpl_query.enumerable.enumerable -
    - cpl_query.enumerable.enumerable_abc -
    - cpl_query.extension -
    - cpl_query.extension.list -
    - cpl_query.iterable -
    - cpl_query.iterable.iterable -
    - cpl_query.iterable.iterable_abc -
- cpl_translation -
    - cpl_translation.translate_pipe -
    - cpl_translation.translation_service -
    - cpl_translation.translation_service_abc -
    - cpl_translation.translation_settings -
- - -
-
-
- -
- -
-

© Copyright 2021 - 2023, Sven Heidemann.

-
- - Built with Sphinx using a - theme - provided by Read the Docs. - - -
-
-
-
-
- - - - \ No newline at end of file diff --git a/docs/build/html/quickstart.html b/docs/build/html/quickstart.html deleted file mode 100644 index b18d11b2..00000000 --- a/docs/build/html/quickstart.html +++ /dev/null @@ -1,320 +0,0 @@ - - - - - - - Getting started with CPL — Common Python Library documentation - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

Getting started with CPL

-

Welcome to CPL!

-

This tutorial introduces you to the essentials of the CPL package by walking through building an console based app.

-
-

Table of Contents

-
    -

  1. Prerequisites

    2. -

  2. Create the project

    3. -

  3. Create a menu

    4. -

  4. What’s next

    5. -
-
-
-

Prerequisites

-

To get most out of this tutorial you should already have a basic understanding of the following.

- -

Also you need to have the following installed.

- -
-
-

Create the project

-

To create the sample project to the following:

-
    -

  1. Open a terminal

    2. -

  2. Run

    -
    cpl new console sample-project
-
    -
    -
    3. -

  3. We don’t want to use Application base or Dependency injection:

    -
    Do you want to use application base? (y/n) n
-
-Do you want to use service providing? (y/n) n
-
    -
    -

    The ouput should look like this:

    -
    Creating sample-project/LICENSE                                                                     done
-Creating sample-project/README.md                                                                   done
-Creating sample-project/src/tests/__init__.py                                                       done
-Creating sample-project/appsettings.json                                                            done
-Creating sample-project/src/sample-project/__init__.py                                              done
-Creating sample-project/src/sample-projectmain.py                                                   done
-
    -
    -
    4. -

  4. Open the project with an IDE like VS Code or PyCharm

    -

    IDE

    -
    5. -

  5. Set the ‘src’ directory as source folder

    -

    IDE set src folder

    -
    6. -

  6. Run the application

    -

    You should see an output like:

    -
    Hello World
-
    -
    -
    7. -

  7. In PyCharm you have to enable Emulate terminal in output console!

    -

    IDE emulate console

    -
    8. -
-
-
-

Create a menu

-
    -

  1. Open the ‘sample-project/main.py’

    2. -

  2. Change ‘Hello World’ to ‘Password generator:’ in line 5

    3. -

  3. Add Console.select as follows:

    -
    from cpl_core.console import Console
-
-
-def main():
-    Console.write_line('Password generator:')
-    options = [
-        'Only lower case',
-        'Only upper case',
-        'Lower and upper case'
-        'Exit'
-    ]
-    option = Console.select('>', 'Select option: ', options)
-
-
-if __name__ == '__main__':
-    main()
-
-
    -
    -
    4. -

  4. Get Id of the selected option:

    -
    index = options.index(option)
-
    -
    -
    5. -

  5. Create the generate function as follows:

    -
    def generate_password(letters: str, length: int) -> str:
-    return ''.join(random.choice(letters) for i in range(length))
-
    -
    -

    Add imports:

    -
    import random
-import string
-
    -
    -
    6. -

  6. Get length of the password:

    -
    length = int(Console.read('Length: '))
-
    -
    -
    7. -

  7. Validate the selected option:

    -
    index = options.index(option)
-letters = ''
-
-if index == 0:
-    letters = string.ascii_lowercase
-elif index == 1:
-    letters = string.ascii_uppercase
-elif index == 2:
-    letters = string.ascii_letters
-elif index == len(options) - 1:
-    exit()
-
    -
    -
    8. -

  8. Print the generated password:

    -
    Console.write_line('Password: ', generate_password(letters, length))
-
    -
    -
    9. -

  9. The full ‘sample-project/main.py’:

    -
    import random
-import string
-
-from cpl_core.console import Console
-
-
-def generate_password(letters: str, length: int) -> str:
-    return ''.join(random.choice(letters) for i in range(length))
-
-
-def main():
-    Console.write_line('Password generator:')
-    options = [
-        'Only lower case',
-        'Only upper case',
-        'Lower and upper case',
-        'Exit'
-    ]
-    option = Console.select('>', 'Select option: ', options)
-
-    length = int(Console.read('Length: '))
-
-    index = options.index(option)
-    letters = ''
-    if index == 0:
-        letters = string.ascii_lowercase
-    elif index == 1:
-        letters = string.ascii_uppercase
-    elif index == 2:
-        letters = string.ascii_letters
-    elif index == len(options) - 1:
-        exit()
-
-    Console.write_line('Password: ', generate_password(letters, length))
-
-
-if __name__ == '__main__':
-    main()
-
-
    -
    -
    10. -
-
-
-

What’s next

-

In this section, you’ve created an application that uses user input to generate a password.

-

To continue exploring CPL and developing applications:

- - -
-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/build/html/search.html b/docs/build/html/search.html deleted file mode 100644 index 332ebb5f..00000000 --- a/docs/build/html/search.html +++ /dev/null @@ -1,127 +0,0 @@ - - - - - - Search — Common Python Library documentation - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
-
    -
    • -
  • Search
    • -
  • -
    • -
-
-
-
-
- - - - -
- -
- -
-
-
- -
- -
-

© Copyright 2021 - 2023, Sven Heidemann.

-
- - Built with Sphinx using a - theme - provided by Read the Docs. - - -
-
-
-
-
- - - - - - - - - \ No newline at end of file diff --git a/docs/build/html/searchindex.js b/docs/build/html/searchindex.js deleted file mode 100644 index 34d8664e..00000000 --- a/docs/build/html/searchindex.js +++ /dev/null @@ -1 +0,0 @@ -Search.setIndex({"docnames": ["contributing", "cpl_cli", "cpl_cli.add", "cpl_cli.build", "cpl_cli.generate", "cpl_cli.help", "cpl_cli.install", "cpl_cli.new", "cpl_cli.overview", "cpl_cli.publish", "cpl_cli.remove", "cpl_cli.run", "cpl_cli.start", "cpl_cli.uninstall", "cpl_cli.update", "cpl_cli.version", "cpl_core", "cpl_core.application", "cpl_core.configuration", "cpl_core.console", "cpl_core.database", "cpl_core.database.connection", "cpl_core.database.context", "cpl_core.dependency_injection", "cpl_core.environment", "cpl_core.logging", "cpl_core.mailing", "cpl_core.pipes", "cpl_core.time", "cpl_core.utils", "cpl_discord", "cpl_discord.application", "cpl_discord.command", "cpl_discord.configuration", "cpl_discord.container", "cpl_discord.events", "cpl_discord.helper", "cpl_discord.service", "cpl_query", "cpl_query.base", "cpl_query.enumerable", "cpl_query.extension", "cpl_query.iterable", "cpl_translation", "deprecated", "getting_started", "index", "introduction", "modules", "quickstart", "setup", "tutorials", "tutorials.appsettings", "tutorials.console", "tutorials.console-arguments", "tutorials.create-startup", "tutorials.extend-application", "tutorials.extend-startup", "tutorials.logging", "tutorials.mail", "tutorials.templating"], "filenames": ["contributing.md", "cpl_cli.rst", "cpl_cli.add.md", "cpl_cli.build.md", "cpl_cli.generate.md", "cpl_cli.help.md", "cpl_cli.install.md", "cpl_cli.new.md", "cpl_cli.overview.md", "cpl_cli.publish.md", "cpl_cli.remove.md", "cpl_cli.run.md", "cpl_cli.start.md", "cpl_cli.uninstall.md", "cpl_cli.update.md", "cpl_cli.version.md", "cpl_core.rst", "cpl_core.application.rst", "cpl_core.configuration.rst", "cpl_core.console.rst", "cpl_core.database.rst", "cpl_core.database.connection.rst", "cpl_core.database.context.rst", "cpl_core.dependency_injection.rst", "cpl_core.environment.rst", "cpl_core.logging.rst", "cpl_core.mailing.rst", "cpl_core.pipes.rst", "cpl_core.time.rst", "cpl_core.utils.rst", "cpl_discord.rst", "cpl_discord.application.rst", "cpl_discord.command.rst", "cpl_discord.configuration.rst", "cpl_discord.container.rst", "cpl_discord.events.rst", "cpl_discord.helper.rst", "cpl_discord.service.rst", "cpl_query.rst", "cpl_query.base.rst", "cpl_query.enumerable.rst", "cpl_query.extension.rst", "cpl_query.iterable.rst", "cpl_translation.rst", "deprecated.md", "getting_started.rst", "index.rst", "introduction.md", "modules.rst", "quickstart.md", "setup.md", "tutorials.rst", "tutorials.appsettings.md", "tutorials.console.md", "tutorials.console-arguments.md", "tutorials.create-startup.md", "tutorials.extend-application.md", "tutorials.extend-startup.md", "tutorials.logging.md", "tutorials.mail.md", "tutorials.templating.md"], "titles": ["Contributing to CPL", "CLI reference", "cpl add", "cpl build", "cpl generate", "cpl help", "cpl install", "cpl new", "CLI Overview and Command Reference", "cpl publish", "cpl remove", "cpl run", "cpl start", "cpl uninstall", "cpl update", "cpl version", "API reference", "cpl_core.application package", "cpl_core.configuration package", "cpl_core.console package", "cpl_core.database package", "cpl_core.database.connection package", "cpl_core.database.context package", "cpl_core.dependency_injection package", "cpl_core.environment package", "cpl_core.logging package", "cpl_core.mailing package", "cpl_core.pipes package", "cpl_core.time package", "cpl_core.utils package", "Discord Reference", "cpl_discord.application package", "cpl_discord.command package", "cpl_discord.configuration package", "cpl_discord.container package", "cpl_discord.events package", "cpl_discord.helper package", "cpl_discord.service package", "Query reference", "cpl_query.base package", "cpl_query.enumerable package", "cpl_query.extension package", "cpl_query.iterable package", "Translation reference", "Deprecated", "Getting started", "Introduction to the CPL Docs", "Introduction to the CPL Docs", "Packages", "Getting started with CPL", "Setting up the local environment and workspace", "Tutorials", "Using appsettings.json", "Use cpl_core.console.Console", "Handle console arguments", "Create startup class", "Extend application", "Extend startup", "Use builtin logger", "Send mails", "Using cpl g & cpl n templating"], "terms": {"we": [0, 44, 49, 60], "would": [0, 4, 7], "love": 0, "you": [0, 2, 3, 4, 7, 8, 10, 34, 46, 47, 49, 50, 60], "help": [0, 1, 8, 46, 47, 48, 60], "make": [0, 44, 50], "even": 0, "better": 0, "than": [0, 39], "i": [0, 2, 3, 6, 7, 8, 10, 13, 14, 17, 18, 19, 26, 29, 34, 37, 39, 44, 46, 47, 49, 50, 60], "todai": 0, "As": 0, "contributor": 0, "here": [0, 50, 60], "ar": [0, 8, 9, 18, 34], "like": [0, 46, 49, 60], "follow": [0, 8, 44, 49, 50], "issus": 0, "If": [0, 2, 7, 10, 19, 50], "find": 0, "sourc": [0, 2, 3, 9, 11, 12, 29, 49, 50], "can": [0, 2, 3, 4, 7, 8, 9, 10, 34, 44, 46, 50, 60], "u": [0, 8, 14], "our": 0, "gitea": 0, "repositori": 0, "fix": 0, "new": [0, 1, 8, 19, 34, 45, 48, 49, 50, 51], "implement": [0, 16, 23, 39, 40, 41], "pleas": 0, "consid": 0, "size": 0, "chang": [0, 8, 12, 22, 49], "order": [0, 34, 39], "determin": 0, "right": 0, "step": 0, "proce": 0, "For": [0, 4, 7, 44, 60], "major": [0, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 44], "first": [0, 4, 7, 8, 27, 29, 34, 38, 39, 46, 47, 60], "open": [0, 49, 50], "outlin": 0, "your": [0, 6, 8, 11, 12, 46, 47, 50, 60], "propos": 0, "so": [0, 44, 50], "discuss": 0, "thi": [0, 5, 17, 34, 44, 46, 47, 49, 50, 60], "process": [0, 44], "allow": [0, 23], "coordin": [0, 19], "effort": 0, "prevent": 0, "duplic": 0, "work": [0, 8, 24, 46, 47], "craft": 0, "successfulli": 0, "accept": 0, "project": [0, 1, 2, 3, 6, 8, 9, 10, 11, 12, 13, 14, 45, 48, 50, 51], "note": [0, 34], "ad": [0, 2], "topic": [0, 30, 34], "document": 0, "significantli": 0, "re": 0, "write": [0, 16, 19, 25, 46, 47], "count": [0, 38, 39], "small": 0, "directli": [0, 3, 44], "befor": [0, 19, 35, 37], "search": [0, 18, 23], "tracker": 0, "mayb": 0, "problem": 0, "alreadi": [0, 49, 50], "exist": [0, 18, 60], "might": 0, "inform": [0, 18, 25, 50, 60], "workaround": 0, "readili": 0, "avail": [0, 5, 8, 60], "want": [0, 49], "all": [0, 3, 9, 15, 18, 34, 38, 39, 60], "soon": [0, 45, 51], "possibl": [0, 18], "need": [0, 34, 49, 50], "reproduc": 0, "confirm": 0, "In": [0, 8, 49, 60], "requir": [0, 34], "provid": [0, 7, 17, 23, 34, 46, 47, 49, 50], "minim": 0, "reproduct": 0, "have": [0, 8, 34, 49, 50], "scenario": 0, "give": 0, "wealth": 0, "import": [0, 49, 60], "without": [0, 6, 8, 39], "go": [0, 8, 46], "back": [0, 19], "forth": 0, "addit": [0, 8], "question": 0, "A": [0, 2, 7, 34, 44, 60], "quickli": 0, "point": [0, 17, 19], "out": [0, 49, 50], "well": 0, "save": [0, 18, 22], "maintain": 0, "time": [0, 16, 25, 34, 48], "ultim": 0, "abl": 0, "more": [0, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 31, 32, 33, 34, 35, 36, 37, 39, 40, 41, 42, 50, 60], "often": 0, "develop": [0, 6, 8, 13, 16, 24, 46, 47, 49, 50], "themselv": 0, "while": 0, "prepar": [0, 3, 8, 9, 17, 46], "understand": [0, 46, 47, 49, 50], "sometim": 0, "hard": 0, "extract": 0, "essenti": [0, 49], "bit": 0, "from": [0, 2, 8, 9, 10, 11, 12, 13, 15, 17, 18, 19, 34, 39, 42, 44, 46, 47, 49, 60], "larger": 0, "codebas": 0, "realli": 0, "isol": 0, "unfortun": 0, "investig": 0, "don": [0, 49], "t": [0, 18, 23, 39, 40, 41, 42, 49], "hear": 0, "close": [0, 16, 19], "doesn": 0, "enough": 0, "info": [0, 16, 25, 46, 47], "pr": 0, "relat": 0, "Be": 0, "sure": 0, "describ": 0, "design": 0, "d": 0, "add": [0, 1, 7, 8, 18, 23, 26, 38, 42, 48, 49], "upfront": 0, "ensur": 0, "readi": [0, 50], "fork": 0, "sh": [0, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 31, 32, 33, 34, 35, 36, 37, 39, 40, 41, 42, 50], "edraft": [0, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 31, 32, 33, 34, 35, 36, 37, 39, 40, 41, 42, 50], "de": [0, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 31, 32, 33, 34, 35, 36, 37, 39, 40, 41, 42, 50], "repo": 0, "git": 0, "branch": 0, "checkout": 0, "b": [0, 3, 8], "my": [0, 8, 50], "master": 0, "creat": [0, 4, 7, 8, 9, 16, 17, 18, 19, 23, 25, 26, 29, 39, 44, 45, 46, 47, 51, 60], "patch": 0, "includ": [0, 3, 50], "appropri": [0, 60], "test": [0, 4, 7, 16, 24, 46, 47, 49, 60], "case": [0, 27, 29, 49], "commit": 0, "option": [0, 8, 11, 18, 19, 23, 39, 44, 46, 47, 49], "command": [0, 1, 2, 3, 4, 5, 6, 7, 9, 10, 13, 14, 29, 30, 46, 47, 48, 50], "line": [0, 19, 49], "automat": 0, "rm": 0, "edit": 0, "file": [0, 3, 4, 8, 9, 10, 12, 18, 46, 50, 60], "push": 0, "origin": 0, "send": [0, 26, 45, 46, 47, 51], "The": [0, 3, 4, 6, 7, 8, 9, 10, 13, 23, 26, 29, 34, 37, 44, 46, 47, 49, 50, 60], "team": 0, "reserv": 0, "commun": 0, "member": [0, 30, 35, 37, 48], "who": 0, "haven": 0, "been": 0, "good": 0, "citizen": 0, "Such": 0, "behavior": 0, "appli": 0, "within": [0, 3, 8], "outsid": 0, "manag": [0, 30, 34, 46, 47], "channel": [0, 34, 35, 37], "ask": 0, "via": [0, 6, 13, 46, 47], "updat": [0, 1, 8, 48], "fixup": 0, "head": 0, "That": 0, "": [0, 8, 12, 34, 45], "thank": 0, "To": [0, 8, 11, 12, 44, 49, 50], "consist": 0, "throughout": 0, "keep": 0, "mind": 0, "must": [0, 2, 3, 8, 10, 19, 44, 60], "one": [0, 39], "unit": 0, "public": 0, "api": [0, 46, 47, 48], "method": [0, 18, 23], "pep": 0, "8": 0, "style": 0, "guid": 0, "python": [0, 3, 29, 39, 40, 41, 42, 46, 47, 49, 50], "By": 0, "agre": 0, "under": [0, 34], "its": [0, 8], "mit": [0, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 31, 32, 33, 34, 35, 36, 37, 39, 40, 41, 42], "see": [0, 7, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 31, 32, 33, 34, 35, 36, 37, 39, 40, 41, 42, 49, 50], "overview": [1, 48, 50], "tabl": [1, 16, 19, 29, 45, 46, 47, 48], "content": [1, 16, 30, 38, 45, 48, 51], "basic": [1, 48, 49, 50], "workflow": [1, 48], "languag": [1, 43, 48], "syntax": [1, 48], "rel": [1, 48], "path": [1, 2, 3, 4, 7, 9, 10, 16, 18, 24, 25, 48, 50, 60], "schemat": [1, 45, 48, 51], "cpl": [1, 8, 16, 30, 38, 45, 48, 50, 51], "descript": [1, 8, 11, 12, 14, 30, 34, 48], "argument": [1, 3, 7, 8, 9, 11, 12, 14, 16, 18, 19, 29, 39, 44, 45, 46, 47, 48, 51], "flag": [1, 16, 18, 48], "build": [1, 8, 9, 11, 12, 16, 17, 23, 29, 46, 48, 49, 50], "gener": [1, 7, 8, 9, 45, 46, 48, 49, 50, 51], "instal": [1, 8, 15, 16, 29, 45, 48, 49], "type": [1, 2, 3, 4, 5, 6, 9, 10, 11, 12, 13, 17, 18, 23, 34, 36, 37, 38, 39, 40, 41, 42, 44, 45, 48, 51], "publish": [1, 3, 8, 46, 48, 50], "remov": [1, 2, 8, 9, 38, 42, 48], "run": [1, 3, 7, 12, 16, 17, 18, 19, 22, 29, 39, 46, 47, 48, 49, 50], "start": [1, 8, 11, 39, 46, 47, 48, 60], "uninstal": [1, 8, 16, 29, 48], "version": [1, 8, 34, 48], "workspac": [2, 3, 7, 8, 10, 45, 60], "target": [2, 3], "refer": [2, 10, 46, 47, 48], "given": [2, 3, 6, 8, 9, 13, 18, 19, 23, 29, 39, 42], "call": [2, 10, 17, 18, 19, 34, 39, 44, 60], "us": [2, 3, 4, 7, 8, 9, 10, 17, 19, 26, 29, 45, 46, 47, 49, 50, 51], "name": [2, 3, 4, 7, 8, 9, 10, 16, 18, 24, 25, 29, 30, 32, 34, 44, 50, 60], "otherwis": [2, 10, 19], "specifi": [2, 6, 7, 8, 10, 11, 13, 14, 18, 19], "valu": [2, 3, 4, 5, 6, 7, 9, 10, 11, 12, 13, 16, 18, 19, 20, 23, 24, 25, 26, 27, 28, 30, 39, 40, 41, 42, 43, 44], "which": [2, 8, 11, 18, 19, 29, 50, 60], "ha": [2, 19, 60], "str": [2, 3, 4, 5, 6, 7, 9, 10, 11, 12, 13, 18, 19, 20, 21, 22, 24, 25, 26, 27, 28, 29, 33, 34, 35, 37, 43, 44, 49, 60], "referenc": 2, "simul": [2, 6, 10, 13, 14], "whether": [2, 6, 7, 10, 13, 14, 18], "copi": [3, 38, 39], "an": [3, 8, 9, 17, 18, 19, 20, 23, 24, 25, 26, 28, 30, 39, 49, 50, 60], "app": [3, 8, 17, 45, 46, 47, 49], "output": [3, 8, 9, 18, 19, 46, 47, 49, 50], "directori": [3, 8, 9, 24, 46, 47, 49], "execut": [3, 8, 9, 16, 18, 29], "consol": [3, 5, 7, 8, 9, 16, 18, 25, 45, 46, 47, 48, 49, 51, 60], "librari": [3, 7, 8, 9, 45, 46, 47], "them": 3, "base": [4, 7, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 40, 41, 42, 43, 44, 46, 47, 48, 49], "g": [4, 7, 8, 45, 51], "defin": [4, 7, 8, 18, 19, 40, 42, 50, 60], "custom": [4, 7, 16, 17, 18, 24, 46, 47], "templat": [4, 7, 45, 51], "folder": [4, 7, 49, 60], "element": [4, 7, 19, 22, 34, 39, 42], "src": [4, 7, 49], "exampl": [4, 7, 60], "c": [4, 7, 46], "abc": [4, 17, 18, 20, 21, 22, 23, 24, 25, 26, 27, 32, 35, 37, 39, 40, 42, 43, 60], "abstract": [4, 17, 18, 20, 21, 22, 23, 24, 25, 26, 27, 31, 35, 37, 39, 43], "class": [4, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 39, 40, 41, 42, 43, 44, 45, 46, 47, 51, 60], "enum": [4, 18, 19, 20, 23, 24, 25, 26, 28, 30, 60], "pipe": [4, 16, 23, 46, 47, 48], "servic": [4, 7, 17, 18, 23, 25, 26, 30, 31, 46, 47, 48, 49, 60], "set": [4, 11, 17, 18, 19, 20, 22, 23, 24, 25, 26, 28, 29, 43, 44, 45, 49], "configmodel": 4, "thread": [4, 19, 30, 48], "valid": [4, 16, 18, 26, 49], "discord": [4, 23, 46, 48], "bot": [4, 37], "event": [4, 30, 37, 48], "list": [5, 8, 15, 18, 19, 22, 23, 26, 27, 29, 34, 35, 36, 37, 38, 39, 40, 42, 43, 44, 46, 48, 60], "short": [5, 8], "h": [5, 8], "show": [5, 19], "messag": [5, 19, 25, 35, 37], "packag": [6, 7, 8, 13, 15, 16, 30, 38, 45, 46, 47, 49], "pip": [6, 13, 15, 16, 46, 47, 48, 49, 50], "deped": 6, "dev": [6, 11, 12, 13], "mode": [6, 13], "virtual": [6, 13], "initi": [7, 45, 60], "n": [7, 8, 45, 49, 50, 51], "simpl": [7, 44, 46, 47, 50], "applic": [7, 11, 12, 16, 19, 24, 25, 26, 30, 45, 46, 47, 48, 49, 50, 51, 60], "async": [7, 17, 35, 37], "startup": [7, 17, 45, 46, 47, 51, 60], "noth": 7, "venv": 7, "serv": 8, "server": [8, 20, 21, 26, 46, 47, 50], "parent": 8, "cd": [8, 50], "termin": [8, 19, 49, 50], "commandnameoralia": 8, "requiredarg": 8, "optionalsarg": 8, "most": [8, 34, 49, 50], "some": 8, "alias": [8, 16, 18], "shown": [8, 18, 50], "statement": [8, 22], "each": [8, 18, 39], "prefix": [8, 18, 30, 33], "absolut": 8, "current": [8, 24, 34], "either": [8, 44], "root": 8, "take": [8, 18, 38, 39], "artifact": 8, "ani": [8, 18, 19, 27, 32, 37, 38, 39, 43, 60], "own": 8, "suppli": 8, "same": [8, 60], "format": [8, 25, 28, 39], "immedi": 8, "alia": [8, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 31, 32, 33, 34, 35, 36, 37, 39, 40, 41, 42, 60], "dist": [8, 9, 11, 12], "With": [8, 44], "depend": [8, 14, 46, 47, 49], "p": [8, 9], "setup": [8, 9, 47, 50], "py": [8, 9, 29, 31, 32, 33, 34, 35, 36, 37, 46, 49, 60], "r": [8, 10, 11], "restart": [8, 12, 50], "ui": [8, 13, 34], "v": [8, 15, 49], "data": [9, 19, 34, 39], "cpl_core": [9, 16, 45, 48, 49, 50, 51, 60], "json": [9, 18, 44, 45, 46, 47, 49, 50, 51, 60], "delet": 10, "onc": 11, "paramet": [11, 17, 18, 19, 21, 22, 24, 25, 26, 27, 29, 42, 44], "default": [11, 16, 19, 34, 50], "after": [11, 12, 35, 37, 39], "cli": [15, 45, 46, 47, 48, 49], "submodul": [16, 30, 38, 48], "application_abc": [16, 48], "modul": [16, 38, 48], "applicationabc": [16, 17, 31, 48], "configur": [16, 17, 23, 30, 44, 46, 47, 48, 60], "main": [16, 17, 49], "run_async": [16, 17], "application_build": [16, 48], "applicationbuild": [16, 17, 48], "build_async": [16, 17], "use_extens": [16, 17], "use_startup": [16, 17, 60], "application_builder_abc": [16, 48], "applicationbuilderabc": [16, 17, 48], "application_extension_abc": [16, 48], "applicationextensionabc": [16, 17, 48], "startup_abc": [16, 48], "startupabc": [16, 17, 48, 60], "configure_configur": [16, 17, 60], "configure_servic": [16, 17, 60], "startup_extension_abc": [16, 48], "startupextensionabc": [16, 17, 48], "core": [16, 46, 48, 50], "versioninfo": [16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 48], "micro": [16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 44], "minor": [16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 44], "argument_abc": [16, 48], "argumentabc": [16, 18, 48], "add_console_argu": [16, 18], "console_argu": [16, 18], "prevent_next_execut": [16, 18], "token": [16, 18, 30, 33], "argument_build": [16, 48], "argumentbuild": [16, 18, 48], "build_argu": [16, 18], "argument_executable_abc": [16, 48], "argumentexecutableabc": [16, 18, 48], "argument_type_enum": [16, 48], "argumenttypeenum": [16, 18, 48], "variabl": [16, 18, 29], "add_configur": [16, 18], "add_environment_vari": [16, 18], "add_json_fil": [16, 18], "additional_argu": [16, 18], "argument_error_funct": [16, 18], "create_console_argu": [16, 18], "environ": [16, 17, 18, 25, 26, 45, 46, 47, 48, 60], "for_each_argu": [16, 18], "get_configur": [16, 18], "parse_console_argu": [16, 18], "configuration_abc": [16, 17, 23, 48], "configurationabc": [16, 17, 18, 23, 31, 37, 48, 60], "configuration_model_abc": [16, 48], "configurationmodelabc": [16, 18, 20, 25, 26, 28, 33, 43, 48], "from_dict": [16, 18], "base_func": [16, 18, 48], "configuration_variable_name_enum": [16, 48], "configurationvariablenameenum": [16, 18, 48], "to_list": [16, 18, 38, 39], "executable_argu": [16, 48], "executableargu": [16, 18, 48], "executable_typ": [16, 18], "set_execut": [16, 18, 29], "flag_argu": [16, 48], "flagargu": [16, 18, 48], "validator_abc": [16, 48], "validatorabc": [16, 18, 48], "variable_argu": [16, 48], "variableargu": [16, 18, 48], "set_valu": [16, 18], "value_token": [16, 18], "background_color_enum": [16, 48], "backgroundcolorenum": [16, 19, 48], "blue": [16, 19], "cyan": [16, 19], "green": [16, 19], "grei": [16, 19], "magenta": [16, 19], "red": [16, 19], "white": [16, 19], "yellow": [16, 19], "background_color": [16, 19], "banner": [16, 19, 46, 47], "clear": [16, 19], "color_reset": [16, 19], "disabl": [16, 19], "enabl": [16, 19, 49], "error": [16, 18, 19, 25, 35, 37, 46, 47], "foreground_color": [16, 19], "read": [16, 18, 19, 49], "read_lin": [16, 19], "reset_cursor_posit": [16, 19], "select": [16, 19, 20, 22, 38, 39, 49], "set_background_color": [16, 19], "set_cursor_posit": [16, 19], "set_foreground_color": [16, 19], "set_hold_back": [16, 19], "spinner": [16, 19, 46, 47], "write_at": [16, 19, 46, 47], "write_lin": [16, 19, 46, 47, 49], "write_line_at": [16, 19, 46, 47], "console_cal": [16, 48], "consolecal": [16, 19, 48], "arg": [16, 17, 18, 19, 22, 23, 27, 29, 32, 35, 37, 43, 60], "function": [16, 18, 19, 23, 29, 39, 40, 42, 44, 46, 49], "foreground_color_enum": [16, 48], "foregroundcolorenum": [16, 19, 48], "spinner_thread": [16, 48], "spinnerthread": [16, 19, 48], "exit": [16, 19, 49], "stop_spin": [16, 19], "databas": [16, 23, 48], "subpackag": [16, 48], "connect": [16, 20, 22, 26, 37, 48], "database_connect": [16, 20], "database_connection_abc": [16, 20], "context": [16, 20, 23, 35, 37, 48, 50], "database_context": [16, 20], "database_context_abc": [16, 20, 23], "database_set": [16, 21, 22, 48], "databaseset": [16, 20, 21, 22, 23, 48], "auth_plugin": [16, 20], "buffer": [16, 19, 20], "charset": [16, 20], "host": [16, 20, 26], "password": [16, 20, 49], "port": [16, 20, 26], "use_unicod": [16, 20], "user": [16, 20, 35, 37, 49], "database_settings_name_enum": [16, 48], "databasesettingsnameenum": [16, 20, 48], "table_abc": [16, 48], "tableabc": [16, 20, 48], "created_at": [16, 20], "delete_str": [16, 20], "insert_str": [16, 20], "modified_at": [16, 20], "udpate_str": [16, 20], "dependency_inject": [16, 17, 48, 60], "scope": [16, 46, 47, 48], "dispos": [16, 23], "service_provid": [16, 48], "scope_abc": [16, 48], "scopeabc": [16, 23, 48], "scope_build": [16, 48], "scopebuild": [16, 23, 48], "service_collect": [16, 37, 48], "servicecollect": [16, 23, 48], "add_db_context": [16, 23], "add_log": [16, 23], "add_pip": [16, 23], "add_scop": [16, 23], "add_singleton": [16, 23], "add_transi": [16, 23], "build_service_provid": [16, 23, 60], "service_collection_abc": [16, 17, 48], "servicecollectionabc": [16, 17, 23, 37, 48, 60], "add_discord": [16, 23], "add_transl": [16, 23], "service_descriptor": [16, 48], "servicedescriptor": [16, 23, 48], "base_typ": [16, 23], "lifetim": [16, 23, 46, 47], "service_typ": [16, 23], "service_lifetime_enum": [16, 48], "servicelifetimeenum": [16, 23, 48], "singleton": [16, 23, 46, 47], "transient": [16, 23, 46, 47], "serviceprovid": [16, 23, 48], "build_by_signatur": [16, 23], "build_servic": [16, 23], "create_scop": [16, 23], "get_servic": [16, 23], "set_scop": [16, 23], "service_provider_abc": [16, 17, 48], "serviceproviderabc": [16, 17, 18, 23, 31, 48, 60], "inject": [16, 23, 46, 47, 49], "set_global_provid": [16, 23], "application_environ": [16, 48], "applicationenviron": [16, 24, 48, 60], "application_nam": [16, 24], "date_time_now": [16, 24], "end_tim": [16, 24], "environment_nam": [16, 24], "host_nam": [16, 24], "runtime_directori": [16, 24], "set_runtime_directori": [16, 24], "set_working_directori": [16, 24], "start_tim": [16, 24], "working_directori": [16, 24], "application_environment_abc": [16, 17, 25, 26, 48], "applicationenvironmentabc": [16, 17, 18, 24, 25, 26, 37, 48], "environment_name_enum": [16, 48], "environmentnameenum": [16, 24, 48], "product": [16, 24, 46, 47], "stage": [16, 24, 46, 47], "log": [16, 26, 46, 47, 48], "logger_abc": [16, 26, 48], "loggerabc": [16, 25, 26, 37, 48], "debug": [16, 25, 46, 47], "fatal": [16, 25, 46, 47], "header": [16, 19, 25, 26], "trace": [16, 25, 46, 47], "warn": [16, 25, 46, 47], "logger_servic": [16, 48], "logger": [16, 23, 25, 26, 37, 45, 46, 47, 48, 51], "logging_level_enum": [16, 48], "logginglevelenum": [16, 25, 48], "off": [16, 25], "logging_set": [16, 48], "loggingset": [16, 25, 37, 48], "filenam": [16, 25], "level": [16, 25, 46, 47], "logging_settings_name_enum": [16, 48], "loggingsettingsnameenum": [16, 25, 48], "console_level": [16, 25], "file_level": [16, 25], "mail": [16, 45, 46, 47, 48, 51], "email": [16, 48], "add_head": [16, 26], "add_receiv": [16, 26], "bodi": [16, 26], "check_mail": [16, 26], "get_cont": [16, 26], "header_list": [16, 26], "receiv": [16, 26], "receiver_list": [16, 26], "subject": [16, 26], "transceiv": [16, 26], "email_client_abc": [16, 48], "emailclientabc": [16, 26, 48], "send_mail": [16, 26], "email_client_servic": [16, 48], "emailcli": [16, 26, 48], "login": [16, 26], "email_client_set": [16, 48], "emailclientset": [16, 26, 48], "credenti": [16, 26, 29, 46, 47], "user_nam": [16, 26], "email_client_settings_name_enum": [16, 48], "emailclientsettingsnameenum": [16, 26, 48], "bool_pip": [16, 48], "boolpip": [16, 27, 48], "transform": [16, 27, 43, 48], "first_char_to_lower_pip": [16, 48], "firstchartolowerpip": [16, 27, 48], "first_to_upper_pip": [16, 48], "firsttoupperpip": [16, 27, 48], "ip_address_pip": [16, 48], "ipaddresspip": [16, 27, 48], "pipe_abc": [16, 48], "pipeabc": [16, 27, 43, 48], "to_camel_case_pip": [16, 48], "tocamelcasepip": [16, 27, 48], "to_snake_case_pip": [16, 48], "tosnakecasepip": [16, 27, 48], "version_pip": [16, 48], "versionpip": [16, 27, 48], "time_format_set": [16, 25, 48], "timeformatset": [16, 25, 28, 48], "date_format": [16, 28], "date_time_format": [16, 28], "date_time_log_format": [16, 28], "time_format": [16, 25, 28], "time_format_settings_names_enum": [16, 48], "timeformatsettingsnamesenum": [16, 28, 48], "util": [16, 46, 47, 48, 60], "credential_manag": [16, 48], "credentialmanag": [16, 29, 48], "build_str": [16, 29], "decrypt": [16, 29], "encrypt": [16, 29, 46, 47], "get_execut": [16, 29], "get_outd": [16, 29], "get_packag": [16, 29], "reset_execut": [16, 29], "string": [16, 19, 21, 25, 26, 27, 46, 47, 48, 49, 60], "convert_to_camel_cas": [16, 29], "convert_to_snake_cas": [16, 29, 60], "first_to_low": [16, 29], "first_to_upp": [16, 29], "random_str": [16, 29], "config": [17, 23, 31, 37], "contain": [17, 30, 36, 38, 39, 48], "object": [17, 18, 19, 23, 26, 29, 34, 36, 39, 42, 46, 47], "load": [17, 43, 48], "appset": [17, 45, 49, 51], "instanc": [17, 23], "entri": [17, 19], "return": [17, 18, 19, 22, 26, 27, 29, 34, 40, 41, 42, 49, 60], "extens": [17, 38, 42, 46, 47, 48], "env": [17, 25, 37], "copyright": [17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 31, 32, 33, 34, 35, 36, 37, 39, 40, 41, 42], "2020": [17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29], "2023": [17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 31, 32, 33, 34, 35, 36, 37, 39, 40, 41, 42], "licens": [17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 31, 32, 33, 34, 35, 36, 37, 39, 40, 41, 42, 49], "detail": [17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 31, 32, 33, 34, 35, 36, 37, 39, 40, 41, 42, 46], "tupl": [17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 31, 32, 33, 34, 35, 36, 37, 39, 40, 41, 42], "field": [17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 31, 32, 33, 34, 35, 36, 37, 39, 40, 41, 42], "number": [17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 31, 32, 33, 34, 35, 36, 37, 39, 40, 41, 42], "0": [17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 31, 32, 33, 34, 35, 36, 37, 39, 40, 41, 42, 44, 49, 60], "2": [17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 31, 32, 33, 34, 35, 36, 37, 39, 40, 41, 42, 49, 60], "1": [17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 31, 32, 33, 34, 35, 36, 37, 39, 40, 41, 42, 49, 60], "bool": [18, 19, 20, 26, 27, 34, 39, 60], "fals": 18, "none": [18, 19, 20, 23, 25, 26, 28, 29, 33, 34, 35, 37, 39, 40, 41, 42, 43, 44, 60], "arg_typ": 18, "kwarg": [18, 19, 23, 32, 35, 37, 44], "known": 18, "specif": 18, "self": [18, 23, 44, 60], "consoleargu": 18, "properti": [18, 19, 20, 21, 22, 23, 24, 25, 26, 28, 33, 34, 37, 39, 43], "static": [18, 23, 26, 29, 36], "enumer": [18, 19, 20, 23, 24, 25, 26, 28, 30, 38, 41, 42, 48], "3": [18, 25], "key_typ": 18, "union": [18, 19, 23, 39], "consoleargumentabc": 18, "true": 18, "should": [18, 49, 50, 60], "occur": 18, "wa": [18, 50], "found": [18, 39], "place": 18, "store": 18, "callabl": [18, 19, 23, 39], "begin": [18, 60], "were": 18, "is_value_token_opt": 18, "runnabl": 18, "when": [18, 19, 35, 37, 39, 60], "iter": [18, 38, 39, 40, 41, 48], "through": [18, 44, 49], "search_typ": 18, "invalid": 18, "dict": [18, 19, 27, 44, 60], "deprec": [18, 46], "attribut": [18, 44], "__init__": [18, 44, 49, 60], "instead": 18, "http": [18, 21, 50], "doc": [18, 21], "html": [18, 21], "further": [18, 44], "convert": [18, 27, 29, 30, 36, 39, 40, 41, 42, 46, 47], "on_blu": 19, "on_cyan": 19, "on_default": 19, "on_green": 19, "on_grei": 19, "on_magenta": 19, "on_r": 19, "on_whit": 19, "on_yellow": 19, "handl": [19, 29, 45, 46, 47, 51], "input": [19, 46, 47, 49], "bytes_or_buff": 19, "encod": [19, 29], "expos": 19, "decod": [19, 29], "handler": 19, "result": [19, 26, 29, 39], "__str__": 19, "repr": 19, "sy": 19, "getdefaultencod": 19, "strict": 19, "classmethod": [19, 23, 29, 39, 60], "print": [19, 49], "reset": [19, 29], "color": 19, "interact": 19, "tb": 19, "traceback": 19, "next": [19, 45], "cursor": [19, 20, 21, 22], "posit": [19, 30, 34], "char": [19, 27, 29], "header_foreground_color": 19, "header_background_color": 19, "option_foreground_color": 19, "option_background_color": 19, "cursor_foreground_color": 19, "cursor_background_color": 19, "menu": [19, 45, 46, 47], "charact": 19, "foreground": 19, "background": 19, "x": [19, 39, 44], "int": [19, 20, 26, 27, 29, 34, 39, 42, 44, 49], "y": [19, 44, 49], "text_foreground_color": 19, "spinner_foreground_color": 19, "text_background_color": 19, "spinner_background_color": 19, "end": [19, 25], "stop": 19, "text": [19, 34], "keyword": [19, 44], "activ": [19, 30, 34], "last": [19, 38, 39], "repres": [19, 20, 24, 26], "hold": 19, "msg_len": 19, "length": [19, 29, 39, 49], "databaseconnect": [20, 21], "databaseconnectionabc": [20, 21], "databasecontext": [20, 22], "save_chang": [20, 22], "databasecontextabc": [20, 22, 23], "databs": 20, "authplugin": 20, "useunicod": 20, "datetim": [20, 24, 34, 35, 37], "represent": [21, 22, 23, 25, 26, 28], "connection_str": 21, "sqlalchemi": 21, "org": 21, "en": 21, "14": 21, "engin": 21, "mysqlcursorbuff": [21, 22], "mysqlconnectionabstract": 21, "sql": 22, "fetch": 22, "collect": 23, "db_context_typ": 23, "db_set": 23, "db_context": 23, "intern": [23, 60], "translat": [23, 46, 48], "descriptor": 23, "sig": 23, "signatur": 23, "instance_typ": 23, "f": [23, 60], "decor": 23, "runtim": [24, 46, 47], "ex": 25, "except": [25, 39], "thrown": 25, "program": 25, "tree": 25, "logfil": 25, "5": [25, 49], "4": 25, "6": 25, "console_log_level": 25, "file_log_level": 25, "consoleloglevel": 25, "fileloglevel": 25, "e": [26, 44, 60], "address": 26, "check": [26, 39, 60], "mail_set": 26, "usernam": 26, "lower": [27, 29, 49], "upper": [27, 29, 49], "camel": [27, 29], "camelcas": [27, 29], "snake": [27, 29], "snake_cas": [27, 29], "dateformat": 28, "datetimeformat": 28, "datetimelogformat": 28, "timeformat": 28, "replac": [29, 60], "base64": [29, 46, 47], "byte": 29, "get": [29, 46, 47, 50], "outdat": 29, "local": [29, 45], "stdout": 29, "stderr": 29, "extra": [29, 50], "index": [29, 39, 42, 49, 50], "url": [29, 50], "subprocess": [29, 46, 47], "system": 29, "standard": [29, 46, 47], "random": [29, 49], "discord_bot_application_abc": [30, 48], "discordbotapplicationabc": [30, 31, 48], "stop_async": [30, 31, 37], "discord_command_abc": [30, 48], "discordcommandabc": [30, 32, 37, 48], "discord_commands_meta": [30, 48], "discordcogmeta": [30, 32, 48], "discord_bot_set": [30, 37, 48], "discordbotset": [30, 33, 37, 48], "category_channel": [30, 48], "categorychannel": [30, 34, 48], "category_id": [30, 34], "guild": [30, 35, 37, 48], "id": [30, 34, 49], "nsfw": [30, 34], "text_channel": [30, 48], "voice_channel": [30, 48], "afk_channel": [30, 34], "afk_timeout": [30, 34], "approximate_member_count": [30, 34], "approximate_presence_count": [30, 34], "categori": [30, 34], "default_notif": [30, 34], "emoji": [30, 34, 35, 37], "explicit_content_filt": [30, 34], "featur": [30, 34, 50], "max_memb": [30, 34], "max_pres": [30, 34], "max_video_channel_us": [30, 34], "mfa_level": [30, 34], "nsfw_level": [30, 34], "owner_id": [30, 34], "preferred_local": [30, 34], "premium_progress_bar_en": [30, 34], "premium_subscription_count": [30, 34], "premium_ti": [30, 34], "role": [30, 35, 37, 48], "sticker": [30, 34], "unavail": [30, 34], "vanity_url_cod": [30, 34], "verification_level": [30, 34], "widget_en": [30, 34], "joined_at": [30, 34], "nick": [30, 34], "pend": [30, 34], "premium_sinc": [30, 34], "timed_out_until": [30, 34], "hoist": [30, 34], "mention": [30, 34], "tag": [30, 34], "unicode_emoji": [30, 34], "textchannel": [30, 34, 48], "default_auto_archive_dur": [30, 34], "last_message_id": [30, 34], "slowmode_delai": [30, 34], "archive_timestamp": [30, 34], "archiv": [30, 34], "archiver_id": [30, 34], "auto_archive_dur": [30, 34], "invit": [30, 34, 35, 37], "lock": [30, 34], "me": [30, 34], "member_count": [30, 34], "message_count": [30, 34], "parent_id": [30, 34], "voicechannel": [30, 34, 48], "on_bulk_message_delete_abc": [30, 48], "onbulkmessagedeleteabc": [30, 35, 48], "on_bulk_message_delet": [30, 35, 37, 48], "on_command_abc": [30, 48], "oncommandabc": [30, 35, 48], "on_command": [30, 35, 37, 48], "on_command_completion_abc": [30, 48], "oncommandcompletionabc": [30, 35, 48], "on_command_complet": [30, 35, 37, 48], "on_command_error_abc": [30, 48], "oncommanderrorabc": [30, 35, 37, 48], "on_command_error": [30, 35, 37, 48], "on_connect_abc": [30, 48], "onconnectabc": [30, 35, 48], "on_connect": [30, 35, 37, 48], "on_disconnect_abc": [30, 48], "ondisconnectabc": [30, 35, 48], "on_disconnect": [30, 35, 37, 48], "on_error_abc": [30, 48], "onerrorabc": [30, 35, 48], "on_error": [30, 35, 37, 48], "on_group_join_abc": [30, 48], "ongroupjoinabc": [30, 35, 48], "on_group_join": [30, 35, 37, 48], "on_group_remove_abc": [30, 48], "ongroupremoveabc": [30, 35, 48], "on_group_remov": [30, 35, 37, 48], "on_guild_available_abc": [30, 48], "onguildavailableabc": [30, 35, 48], "on_guild_avail": [30, 35, 37, 48], "on_guild_channel_create_abc": [30, 48], "onguildchannelcreateabc": [30, 35, 48], "on_guild_channel_cr": [30, 35, 37, 48], "on_guild_channel_delete_abc": [30, 48], "onguildchanneldeleteabc": [30, 35, 48], "on_guild_channel_delet": [30, 35, 37, 48], "on_guild_channel_pins_update_abc": [30, 48], "onguildchannelpinsupdateabc": [30, 35, 48], "on_guild_channel_pins_upd": [30, 35, 37, 48], "on_guild_channel_update_abc": [30, 48], "onguildchannelupdateabc": [30, 35, 48], "on_guild_channel_upd": [30, 35, 37, 48], "on_guild_emojis_update_abc": [30, 48], "onguildemojisupdateabc": [30, 35, 48], "on_guild_emojis_upd": [30, 35, 37, 48], "on_guild_integrations_update_abc": [30, 48], "onguildintegrationsupdateabc": [30, 35, 48], "on_guild_integrations_upd": [30, 35, 37, 48], "on_guild_join_abc": [30, 48], "onguildjoinabc": [30, 35, 48], "on_guild_join": [30, 35, 37, 48], "on_guild_remove_abc": [30, 48], "onguildremoveabc": [30, 35, 48], "on_guild_remov": [30, 35, 37, 48], "on_guild_role_create_abc": [30, 48], "onguildrolecreateabc": [30, 35, 48], "on_guild_role_cr": [30, 35, 37, 48], "on_guild_role_delete_abc": [30, 48], "onguildroledeleteabc": [30, 35, 48], "on_guild_role_delet": [30, 35, 37, 48], "on_guild_role_update_abc": [30, 48], "onguildroleupdateabc": [30, 35, 48], "on_guild_role_upd": [30, 35, 37, 48], "on_guild_unavailable_abc": [30, 48], "onguildunavailableabc": [30, 35, 48], "on_guild_unavail": [30, 35, 37, 48], "on_guild_update_abc": [30, 48], "onguildupdateabc": [30, 35, 48], "on_guild_upd": [30, 35, 37, 48], "on_invite_create_abc": [30, 48], "oninvitecreateabc": [30, 35, 48], "on_invite_cr": [30, 35, 37, 48], "on_invite_delete_abc": [30, 48], "oninvitedeleteabc": [30, 35, 48], "on_invite_delet": [30, 35, 37, 48], "on_member_ban_abc": [30, 48], "onmemberbanabc": [30, 35, 48], "on_member_ban": [30, 35, 37, 48], "on_member_join_abc": [30, 48], "onmemberjoinabc": [30, 35, 48], "on_member_join": [30, 35, 37, 48], "on_member_remove_abc": [30, 48], "onmemberremoveabc": [30, 35, 48], "on_member_remov": [30, 35, 37, 48], "on_member_unban_abc": [30, 48], "onmemberunbanabc": [30, 35, 48], "on_member_unban": [30, 35, 37, 48], "on_member_update_abc": [30, 48], "onmemberupdateabc": [30, 35, 48], "on_member_upd": [30, 35, 37, 48], "on_message_abc": [30, 48], "onmessageabc": [30, 35, 48], "on_messag": [30, 35, 37, 48], "on_message_delete_abc": [30, 48], "onmessagedeleteabc": [30, 35, 48], "on_message_delet": [30, 35, 37, 48], "on_message_edit_abc": [30, 48], "onmessageeditabc": [30, 35, 48], "on_message_edit": [30, 35, 37, 48], "on_private_channel_create_abc": [30, 48], "onprivatechannelcreateabc": [30, 35, 48], "on_private_channel_cr": [30, 35, 37, 48], "on_private_channel_delete_abc": [30, 48], "onprivatechanneldeleteabc": [30, 35, 48], "on_private_channel_delet": [30, 35, 37, 48], "on_private_channel_pins_update_abc": [30, 48], "onprivatechannelpinsupdateabc": [30, 35, 48], "on_private_channel_pins_upd": [30, 35, 37, 48], "on_private_channel_update_abc": [30, 48], "onprivatechannelupdateabc": [30, 35, 48], "on_private_channel_upd": [30, 35, 37, 48], "on_raw_reaction_add_abc": [30, 48], "onrawreactionaddabc": [30, 35, 48], "on_raw_reaction_add": [30, 35, 37, 48], "on_raw_reaction_clear_abc": [30, 48], "onrawreactionclearabc": [30, 35, 48], "on_raw_reaction_clear": [30, 35, 37, 48], "on_raw_reaction_clear_emoji_abc": [30, 48], "onrawreactionclearemojiabc": [30, 35, 48], "on_raw_reaction_clear_emoji": [30, 35, 37, 48], "on_raw_reaction_remove_abc": [30, 48], "onrawreactionremoveabc": [30, 35, 48], "on_raw_reaction_remov": [30, 35, 37, 48], "on_reaction_add_abc": [30, 48], "onreactionaddabc": [30, 35, 48], "on_reaction_add": [30, 35, 37, 48], "on_reaction_clear_abc": [30, 48], "onreactionclearabc": [30, 35, 48], "on_reaction_clear": [30, 35, 37, 48], "on_reaction_clear_emoji_abc": [30, 48], "onreactionclearemojiabc": [30, 35, 48], "on_reaction_clear_emoji": [30, 35, 37, 48], "on_reaction_remove_abc": [30, 48], "onreactionremoveabc": [30, 35, 48], "on_reaction_remov": [30, 35, 37, 48], "on_ready_abc": [30, 48], "onreadyabc": [30, 35, 48], "on_readi": [30, 35, 37, 48], "on_resume_abc": [30, 48], "onresumeabc": [30, 35, 48], "on_resum": [30, 35, 37, 48], "on_typing_abc": [30, 48], "ontypingabc": [30, 35, 48], "on_typ": [30, 35, 37, 48], "on_user_update_abc": [30, 48], "onuserupdateabc": [30, 35, 48], "on_user_upd": [30, 35, 37, 48], "on_voice_state_update_abc": [30, 48], "onvoicestateupdateabc": [30, 35, 48], "on_voice_state_upd": [30, 35, 37, 48], "on_webhooks_update_abc": [30, 48], "onwebhooksupdateabc": [30, 35, 48], "on_webhooks_upd": [30, 35, 37, 48], "helper": [30, 48], "to_containers_convert": [30, 48], "tocontainersconvert": [30, 36, 48], "command_error_handler_servic": [30, 48], "commanderrorhandlerservic": [30, 37, 48], "discord_bot_servic": [30, 48], "discordbotservic": [30, 37, 48], "start_async": [30, 37], "discord_bot_service_abc": [30, 48], "discordbotserviceabc": [30, 37, 48], "discord_collect": [30, 48], "discordcollect": [30, 37, 48], "add_command": [30, 37], "add_ev": [30, 37], "get_command": [30, 37], "get_events_by_bas": [30, 37], "discord_collection_abc": [30, 48], "discordcollectionabc": [30, 37, 48], "discord_servic": [30, 48], "discordservic": [30, 37, 48], "init": [30, 37, 44, 60], "on_scheduled_event_cr": [30, 37, 48], "on_scheduled_event_delet": [30, 37, 48], "on_scheduled_event_upd": [30, 37, 48], "on_scheduled_event_user_add": [30, 37, 48], "on_scheduled_event_user_remov": [30, 37, 48], "discord_service_abc": [30, 48], "discordserviceabc": [30, 37, 48], "discordeventtypesenum": [30, 48], "on_scheduled_event_create_abc": 30, "onscheduledeventcreateabc": 30, "on_scheduled_event_delete_abc": 30, "onscheduledeventdeleteabc": 30, "on_scheduled_event_update_abc": 30, "onscheduledeventupdateabc": 30, "on_scheduled_event_user_add_abc": 30, "onscheduledeventuseraddabc": 30, "on_scheduled_event_user_remove_abc": 30, "onscheduledeventuserremoveabc": 30, "link": [31, 32, 33, 34, 35, 36, 37, 44], "between": [31, 32, 33, 34, 35, 36, 37, 46], "2022": [31, 32, 33, 34, 35, 36, 37], "cog": [32, 37], "namespac": 32, "abcmeta": 32, "cogmeta": 32, "_t": [34, 36, 37, 39], "voic": 34, "_o": 34, "belong": 34, "sort": [34, 39, 46], "top": 34, "bottom": 34, "sequenc": [34, 35, 36, 37, 38, 48], "hierarchi": 34, "lowest": [34, 39], "permiss": 34, "view": 34, "activitytyp": 34, "alwai": 34, "everyon": 34, "These": [34, 46], "threadmemb": 34, "intent": 34, "properli": 34, "fill": 34, "howev": 34, "gatewai": 34, "fetch_memb": 34, "insid": 34, "ctx": [35, 37], "commanderror": [35, 37], "groupchannel": [35, 37], "chhanel": [35, 37], "guildchannel": [35, 37], "list_pin": [35, 37], "privatechannel": [35, 37], "payload": [35, 37], "rawreactionactionev": [35, 37], "reaction": [35, 37], "voicest": [35, 37], "_l": 36, "logging_st": 37, "client": 37, "_t_event": 37, "scheduledev": 37, "cpl_queri": [38, 48], "default_lambda": [38, 48], "ordered_query": [38, 48], "orderedquery": [38, 39, 48], "then_bi": [38, 39], "then_by_descend": [38, 39], "ordered_queryable_abc": [38, 48], "orderedqueryableabc": [38, 39, 48], "queryable_abc": [38, 48], "queryableabc": [38, 39, 40, 42, 48], "averag": [38, 39], "distinct": [38, 39], "element_at": [38, 39], "element_at_or_default": [38, 39], "first_or_default": [38, 39], "for_each": [38, 39], "group_bi": [38, 39], "last_or_default": [38, 39], "max": [38, 39], "median": [38, 39], "min": [38, 39], "order_bi": [38, 39], "order_by_descend": [38, 39], "revers": [38, 39], "select_mani": [38, 39], "singl": [38, 39], "single_or_default": [38, 39], "skip": [38, 39], "skip_last": [38, 39], "split": [38, 39, 60], "sum": [38, 39], "take_last": [38, 39], "where": [38, 39], "empti": [38, 39], "index_of": [38, 39], "rang": [38, 39, 49], "enumerable_abc": [38, 41, 42, 48], "enumerableabc": [38, 40, 41, 42, 48], "to_iter": [38, 40, 41], "to_enumer": [38, 41, 42], "iterable_abc": [38, 40, 41, 48], "iterableabc": [38, 40, 41, 42, 48], "append": [38, 42], "extend": [38, 42, 45, 51], "remove_at": [38, 42], "_valu": 39, "_func": 39, "orderedlist": 39, "ascend": 39, "func": 39, "descend": 39, "everi": 39, "equal": 39, "float": 39, "complex": [39, 46, 47, 60], "redund": 39, "_index": [39, 42], "group": 39, "highest": 39, "flatten": 39, "argumentnoneexcept": 39, "seper": 39, "_object": [39, 42], "indexerror": 39, "sequence_abc": 39, "sequenceabc": 39, "integr": [39, 40, 41, 42], "2021": [39, 40, 41, 42], "_iterableabc__iter": 42, "__iter": 42, "translatepip": [43, 48], "translationserviceabc": [43, 48], "translationservic": [43, 48], "lang": 43, "load_by_set": [43, 48], "translationset": [43, 48], "set_default_lang": [43, 48], "set_lang": [43, 48], "kei": [43, 46, 50], "default_lang": 43, "default_languag": [43, 48], "now": [44, 60], "model": 44, "recurs": 44, "pars": 44, "jsonprocessor": 44, "goe": 44, "simpli": 44, "assign": 44, "processor": 44, "wai": 44, "nest": 44, "configurationmodel": 44, "code": [44, 46, 49, 50, 60], "adapt": 44, "versionset": 44, "def": [44, 49, 60], "els": 44, "obsolet": 44, "few": 44, "rule": 44, "observ": 44, "onli": [44, 49], "wrong": 44, "correct": 44, "incorrect": 44, "prerequisit": [45, 51], "what": 45, "up": 45, "queri": [45, 46, 47, 48], "tutori": [45, 49, 50], "come": [45, 51], "builtin": [45, 51], "common": [46, 47], "platform": [46, 47], "meant": [46, 47], "effici": [46, 47], "desktop": [46, 47], "learn": [46, 47, 50], "enterpris": [46, 47], "expand": 46, "builder": [46, 47], "map": [46, 47], "appnam": [46, 47], "hostnam": [46, 47], "wrapper": [46, 47], "differ": [46, 47], "variant": [46, 47], "to_lower_cas": [46, 47], "to_camel_cas": [46, 47], "expandl": [46, 47], "connector": 46, "filter": 46, "linq": 46, "xd": 46, "dot": 46, "notat": 46, "page": 46, "great": 46, "about": [46, 50], "everyth": 46, "do": [46, 49, 60], "contribut": 46, "cpl_discord": 48, "discord_event_types_enum": 48, "cpl_translat": 48, "translate_pip": 48, "translation_servic": 48, "translation_service_abc": 48, "translation_set": 48, "welcom": 49, "introduc": 49, "walk": 49, "also": [49, 50, 60], "sampl": 49, "ouput": 49, "look": [49, 60], "done": 49, "readm": 49, "md": 49, "projectmain": 49, "pycharm": 49, "hello": [49, 50], "world": [49, 50], "emul": 49, "__name__": 49, "__main__": 49, "generate_password": 49, "letter": [49, 60], "join": 49, "choic": 49, "ascii_lowercas": 49, "elif": 49, "ascii_uppercas": 49, "ascii_lett": 49, "len": 49, "full": 49, "section": 49, "ve": 49, "continu": 49, "explor": 49, "window": 50, "prompt": 50, "declin": 50, "enter": 50, "press": 50, "lib": 50, "live": 50, "navig": 50, "launch": 50, "watch": 50, "chnage": 50, "those": 50, "success": 50, "similar": 50, "fore": 50, "pyhton": 50, "schematic_your_schemat": 60, "detect": 60, "schematic_": 60, "endswith": 60, "your_schemat": 60, "choos": 60, "attent": 60, "It": 60, "overwrit": 60, "cpl_cli": 60, "generate_schematic_abc": 60, "generateschematicabc": 60, "get_cod": 60, "textwrap": 60, "dedent": 60, "atr": 60, "build_code_str": 60, "_class_nam": 60, "regist": 60, "cl": 60, "littl": 60, "therefor": 60, "divid": 60, "sever": 60, "veri": 60, "structur": 60, "explain": 60, "project_consol": 60, "project_file_licens": 60, "project_file_appset": 60, "project_fil": 60, "project_file_readm": 60, "project_file_code_main": 60, "project_file_code_startup": 60, "project_file_code_appl": 60, "how": 60, "illustr": 60, "project_type_abc": 60, "projecttypeabc": 60, "workspaceset": 60, "base_path": 60, "project_nam": 60, "use_application_api": 60, "use_service_provid": 60, "use_async": 60, "project_file_data": 60, "projectfil": 60, "projectfileappset": 60, "projectfileappl": 60, "projectfilemain": 60, "projectfilestartup": 60, "projectfilereadm": 60, "projectfilelicens": 60, "schematic_init": 60, "project_path": 60, "add_templ": 60, "exactli": 60, "normal": 60, "inherit": 60, "filetemplateabc": 60, "codefiletemplateabc": 60, "code_file_template_abc": 60, "file_template_abc": 60, "_name": 60, "_code": 60, "dump": 60, "indent": 60}, "objects": {"cpl_core": [[17, 0, 0, "-", "application"], [18, 0, 0, "-", "configuration"], [19, 0, 0, "-", "console"], [20, 0, 0, "-", "database"], [23, 0, 0, "-", "dependency_injection"], [24, 0, 0, "-", "environment"], [25, 0, 0, "-", "logging"], [26, 0, 0, "-", "mailing"], [27, 0, 0, "-", "pipes"], [28, 0, 0, "-", "time"], [29, 0, 0, "-", "utils"]], "cpl_core.application": [[17, 1, 1, "", "VersionInfo"], [17, 0, 0, "-", "application_abc"], [17, 0, 0, "-", "application_builder"], [17, 0, 0, "-", "application_builder_abc"], [17, 0, 0, "-", "application_extension_abc"], [17, 0, 0, "-", "startup_abc"], [17, 0, 0, "-", "startup_extension_abc"]], "cpl_core.application.VersionInfo": [[17, 2, 1, "", "major"], [17, 2, 1, "", "micro"], [17, 2, 1, "", "minor"]], "cpl_core.application.application_abc": [[17, 1, 1, "", "ApplicationABC"]], "cpl_core.application.application_abc.ApplicationABC": [[17, 3, 1, "", "configure"], [17, 3, 1, "", "main"], [17, 3, 1, "", "run"], [17, 3, 1, "", "run_async"]], "cpl_core.application.application_builder": [[17, 1, 1, "", "ApplicationBuilder"]], "cpl_core.application.application_builder.ApplicationBuilder": [[17, 3, 1, "", "build"], [17, 3, 1, "", "build_async"], [17, 3, 1, "", "use_extension"], [17, 3, 1, "", "use_startup"]], "cpl_core.application.application_builder_abc": [[17, 1, 1, "", "ApplicationBuilderABC"]], "cpl_core.application.application_builder_abc.ApplicationBuilderABC": [[17, 3, 1, "", "build"], [17, 3, 1, "", "build_async"], [17, 3, 1, "", "use_startup"]], "cpl_core.application.application_extension_abc": [[17, 1, 1, "", "ApplicationExtensionABC"]], "cpl_core.application.application_extension_abc.ApplicationExtensionABC": [[17, 3, 1, "", "run"]], "cpl_core.application.startup_abc": [[17, 1, 1, "", "StartupABC"]], "cpl_core.application.startup_abc.StartupABC": [[17, 3, 1, "", "configure_configuration"], [17, 3, 1, "", "configure_services"]], "cpl_core.application.startup_extension_abc": [[17, 1, 1, "", "StartupExtensionABC"]], "cpl_core.application.startup_extension_abc.StartupExtensionABC": [[17, 3, 1, "", "configure_configuration"], [17, 3, 1, "", "configure_services"]], "cpl_core.configuration": [[18, 1, 1, "", "VersionInfo"], [18, 0, 0, "-", "argument_abc"], [18, 0, 0, "-", "argument_builder"], [18, 0, 0, "-", "argument_executable_abc"], [18, 0, 0, "-", "argument_type_enum"], [18, 0, 0, "-", "configuration"], [18, 0, 0, "-", "configuration_abc"], [18, 0, 0, "-", "configuration_model_abc"], [18, 0, 0, "-", "configuration_variable_name_enum"], [18, 0, 0, "-", "executable_argument"], [18, 0, 0, "-", "flag_argument"], [18, 0, 0, "-", "validator_abc"], [18, 0, 0, "-", "variable_argument"]], "cpl_core.configuration.VersionInfo": [[18, 2, 1, "", "major"], [18, 2, 1, "", "micro"], [18, 2, 1, "", "minor"]], "cpl_core.configuration.argument_abc": [[18, 1, 1, "", "ArgumentABC"]], "cpl_core.configuration.argument_abc.ArgumentABC": [[18, 3, 1, "", "add_console_argument"], [18, 4, 1, "", "aliases"], [18, 4, 1, "", "console_arguments"], [18, 4, 1, "", "name"], [18, 4, 1, "", "prevent_next_executable"], [18, 4, 1, "", "token"]], "cpl_core.configuration.argument_builder": [[18, 1, 1, "", "ArgumentBuilder"]], "cpl_core.configuration.argument_builder.ArgumentBuilder": [[18, 3, 1, "", "build_argument"]], "cpl_core.configuration.argument_executable_abc": [[18, 1, 1, "", "ArgumentExecutableABC"]], "cpl_core.configuration.argument_executable_abc.ArgumentExecutableABC": [[18, 3, 1, "", "run"]], "cpl_core.configuration.argument_type_enum": [[18, 1, 1, "", "ArgumentTypeEnum"]], "cpl_core.configuration.argument_type_enum.ArgumentTypeEnum": [[18, 2, 1, "", "Executable"], [18, 2, 1, "", "Flag"], [18, 2, 1, "", "Variable"]], "cpl_core.configuration.configuration": [[18, 1, 1, "", "Configuration"]], "cpl_core.configuration.configuration.Configuration": [[18, 3, 1, "", "add_configuration"], [18, 3, 1, "", "add_console_argument"], [18, 3, 1, "", "add_environment_variables"], [18, 3, 1, "", "add_json_file"], [18, 4, 1, "", "additional_arguments"], [18, 4, 1, "", "argument_error_function"], [18, 4, 1, "", "arguments"], [18, 3, 1, "", "create_console_argument"], [18, 4, 1, "", "environment"], [18, 3, 1, "", "for_each_argument"], [18, 3, 1, "", "get_configuration"], [18, 3, 1, "", "parse_console_arguments"]], "cpl_core.configuration.configuration_abc": [[18, 1, 1, "", "ConfigurationABC"]], "cpl_core.configuration.configuration_abc.ConfigurationABC": [[18, 3, 1, "", "add_configuration"], [18, 3, 1, "", "add_console_argument"], [18, 3, 1, "", "add_environment_variables"], [18, 3, 1, "", "add_json_file"], [18, 4, 1, "", "additional_arguments"], [18, 4, 1, "", "argument_error_function"], [18, 4, 1, "", "arguments"], [18, 3, 1, "", "create_console_argument"], [18, 4, 1, "", "environment"], [18, 3, 1, "", "for_each_argument"], [18, 3, 1, "", "get_configuration"], [18, 3, 1, "", "parse_console_arguments"]], "cpl_core.configuration.configuration_model_abc": [[18, 1, 1, "", "ConfigurationModelABC"], [18, 5, 1, "", "base_func"]], "cpl_core.configuration.configuration_model_abc.ConfigurationModelABC": [[18, 3, 1, "", "from_dict"]], "cpl_core.configuration.configuration_variable_name_enum": [[18, 1, 1, "", "ConfigurationVariableNameEnum"]], "cpl_core.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum": [[18, 2, 1, "", "customer"], [18, 2, 1, "", "environment"], [18, 2, 1, "", "name"], [18, 3, 1, "", "to_list"]], "cpl_core.configuration.executable_argument": [[18, 1, 1, "", "ExecutableArgument"]], "cpl_core.configuration.executable_argument.ExecutableArgument": [[18, 4, 1, "", "executable_type"], [18, 3, 1, "", "run"], [18, 3, 1, "", "set_executable"], [18, 4, 1, "", "validators"]], "cpl_core.configuration.flag_argument": [[18, 1, 1, "", "FlagArgument"]], "cpl_core.configuration.validator_abc": [[18, 1, 1, "", "ValidatorABC"]], "cpl_core.configuration.validator_abc.ValidatorABC": [[18, 3, 1, "", "validate"]], "cpl_core.configuration.variable_argument": [[18, 1, 1, "", "VariableArgument"]], "cpl_core.configuration.variable_argument.VariableArgument": [[18, 3, 1, "", "set_value"], [18, 4, 1, "", "value"], [18, 4, 1, "", "value_token"]], "cpl_core.console": [[19, 1, 1, "", "VersionInfo"], [19, 0, 0, "-", "background_color_enum"], [19, 0, 0, "-", "console"], [19, 0, 0, "-", "console_call"], [19, 0, 0, "-", "foreground_color_enum"], [19, 0, 0, "-", "spinner_thread"]], "cpl_core.console.VersionInfo": [[19, 2, 1, "", "major"], [19, 2, 1, "", "micro"], [19, 2, 1, "", "minor"]], "cpl_core.console.background_color_enum": [[19, 1, 1, "", "BackgroundColorEnum"]], "cpl_core.console.background_color_enum.BackgroundColorEnum": [[19, 2, 1, "", "blue"], [19, 2, 1, "", "cyan"], [19, 2, 1, "", "default"], [19, 2, 1, "", "green"], [19, 2, 1, "", "grey"], [19, 2, 1, "", "magenta"], [19, 2, 1, "", "red"], [19, 2, 1, "", "white"], [19, 2, 1, "", "yellow"]], "cpl_core.console.console": [[19, 1, 1, "", "Console"]], "cpl_core.console.console.Console": [[19, 4, 1, "", "background_color"], [19, 3, 1, "", "banner"], [19, 3, 1, "", "clear"], [19, 3, 1, "", "close"], [19, 3, 1, "", "color_reset"], [19, 3, 1, "", "disable"], [19, 3, 1, "", "enable"], [19, 3, 1, "", "error"], [19, 4, 1, "", "foreground_color"], [19, 3, 1, "", "read"], [19, 3, 1, "", "read_line"], [19, 3, 1, "", "reset_cursor_position"], [19, 3, 1, "", "select"], [19, 3, 1, "", "set_background_color"], [19, 3, 1, "", "set_cursor_position"], [19, 3, 1, "", "set_foreground_color"], [19, 3, 1, "", "set_hold_back"], [19, 3, 1, "", "spinner"], [19, 3, 1, "", "table"], [19, 3, 1, "", "write"], [19, 3, 1, "", "write_at"], [19, 3, 1, "", "write_line"], [19, 3, 1, "", "write_line_at"]], "cpl_core.console.console_call": [[19, 1, 1, "", "ConsoleCall"]], "cpl_core.console.console_call.ConsoleCall": [[19, 4, 1, "", "args"], [19, 4, 1, "", "function"]], "cpl_core.console.foreground_color_enum": [[19, 1, 1, "", "ForegroundColorEnum"]], "cpl_core.console.foreground_color_enum.ForegroundColorEnum": [[19, 2, 1, "", "blue"], [19, 2, 1, "", "cyan"], [19, 2, 1, "", "default"], [19, 2, 1, "", "green"], [19, 2, 1, "", "grey"], [19, 2, 1, "", "magenta"], [19, 2, 1, "", "red"], [19, 2, 1, "", "white"], [19, 2, 1, "", "yellow"]], "cpl_core.console.spinner_thread": [[19, 1, 1, "", "SpinnerThread"]], "cpl_core.console.spinner_thread.SpinnerThread": [[19, 3, 1, "", "exit"], [19, 3, 1, "", "run"], [19, 3, 1, "", "stop_spinning"]], "cpl_core.database": [[20, 1, 1, "", "VersionInfo"], [21, 0, 0, "-", "connection"], [22, 0, 0, "-", "context"], [20, 0, 0, "-", "database_settings"], [20, 0, 0, "-", "database_settings_name_enum"], [20, 0, 0, "-", "table_abc"]], "cpl_core.database.VersionInfo": [[20, 2, 1, "", "major"], [20, 2, 1, "", "micro"], [20, 2, 1, "", "minor"]], "cpl_core.database.connection": [[21, 1, 1, "", "VersionInfo"], [21, 0, 0, "-", "database_connection"], [21, 0, 0, "-", "database_connection_abc"]], "cpl_core.database.connection.VersionInfo": [[21, 2, 1, "", "major"], [21, 2, 1, "", "micro"], [21, 2, 1, "", "minor"]], "cpl_core.database.connection.database_connection": [[21, 1, 1, "", "DatabaseConnection"]], "cpl_core.database.connection.database_connection.DatabaseConnection": [[21, 3, 1, "", "connect"], [21, 4, 1, "", "cursor"], [21, 4, 1, "", "server"]], "cpl_core.database.connection.database_connection_abc": [[21, 1, 1, "", "DatabaseConnectionABC"]], "cpl_core.database.connection.database_connection_abc.DatabaseConnectionABC": [[21, 3, 1, "", "connect"], [21, 4, 1, "", "cursor"], [21, 4, 1, "", "server"]], "cpl_core.database.context": [[22, 1, 1, "", "VersionInfo"], [22, 0, 0, "-", "database_context"], [22, 0, 0, "-", "database_context_abc"]], "cpl_core.database.context.VersionInfo": [[22, 2, 1, "", "major"], [22, 2, 1, "", "micro"], [22, 2, 1, "", "minor"]], "cpl_core.database.context.database_context": [[22, 1, 1, "", "DatabaseContext"]], "cpl_core.database.context.database_context.DatabaseContext": [[22, 3, 1, "", "connect"], [22, 4, 1, "", "cursor"], [22, 3, 1, "", "save_changes"], [22, 3, 1, "", "select"]], "cpl_core.database.context.database_context_abc": [[22, 1, 1, "", "DatabaseContextABC"]], "cpl_core.database.context.database_context_abc.DatabaseContextABC": [[22, 3, 1, "", "connect"], [22, 4, 1, "", "cursor"], [22, 3, 1, "", "save_changes"], [22, 3, 1, "", "select"]], "cpl_core.database.database_settings": [[20, 1, 1, "", "DatabaseSettings"]], "cpl_core.database.database_settings.DatabaseSettings": [[20, 4, 1, "", "auth_plugin"], [20, 4, 1, "", "buffered"], [20, 4, 1, "", "charset"], [20, 4, 1, "", "database"], [20, 4, 1, "", "host"], [20, 4, 1, "", "password"], [20, 4, 1, "", "port"], [20, 4, 1, "", "use_unicode"], [20, 4, 1, "", "user"]], "cpl_core.database.database_settings_name_enum": [[20, 1, 1, "", "DatabaseSettingsNameEnum"]], "cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum": [[20, 2, 1, "", "auth_plugin"], [20, 2, 1, "", "buffered"], [20, 2, 1, "", "charset"], [20, 2, 1, "", "database"], [20, 2, 1, "", "host"], [20, 2, 1, "", "password"], [20, 2, 1, "", "port"], [20, 2, 1, "", "use_unicode"], [20, 2, 1, "", "user"]], "cpl_core.database.table_abc": [[20, 1, 1, "", "TableABC"]], "cpl_core.database.table_abc.TableABC": [[20, 4, 1, "", "created_at"], [20, 4, 1, "", "delete_string"], [20, 4, 1, "", "insert_string"], [20, 4, 1, "", "modified_at"], [20, 4, 1, "", "udpate_string"]], "cpl_core.dependency_injection": [[23, 1, 1, "", "VersionInfo"], [23, 0, 0, "-", "scope"], [23, 0, 0, "-", "scope_abc"], [23, 0, 0, "-", "scope_builder"], [23, 0, 0, "-", "service_collection"], [23, 0, 0, "-", "service_collection_abc"], [23, 0, 0, "-", "service_descriptor"], [23, 0, 0, "-", "service_lifetime_enum"], [23, 0, 0, "-", "service_provider"], [23, 0, 0, "-", "service_provider_abc"]], "cpl_core.dependency_injection.VersionInfo": [[23, 2, 1, "", "major"], [23, 2, 1, "", "micro"], [23, 2, 1, "", "minor"]], "cpl_core.dependency_injection.scope": [[23, 1, 1, "", "Scope"]], "cpl_core.dependency_injection.scope.Scope": [[23, 3, 1, "", "dispose"], [23, 4, 1, "", "service_provider"]], "cpl_core.dependency_injection.scope_abc": [[23, 1, 1, "", "ScopeABC"]], "cpl_core.dependency_injection.scope_abc.ScopeABC": [[23, 3, 1, "", "dispose"], [23, 4, 1, "", "service_provider"]], "cpl_core.dependency_injection.scope_builder": [[23, 1, 1, "", "ScopeBuilder"]], "cpl_core.dependency_injection.scope_builder.ScopeBuilder": [[23, 3, 1, "", "build"]], "cpl_core.dependency_injection.service_collection": [[23, 1, 1, "", "ServiceCollection"]], "cpl_core.dependency_injection.service_collection.ServiceCollection": [[23, 3, 1, "", "add_db_context"], [23, 3, 1, "", "add_logging"], [23, 3, 1, "", "add_pipes"], [23, 3, 1, "", "add_scoped"], [23, 3, 1, "", "add_singleton"], [23, 3, 1, "", "add_transient"], [23, 3, 1, "", "build_service_provider"]], "cpl_core.dependency_injection.service_collection_abc": [[23, 1, 1, "", "ServiceCollectionABC"]], "cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC": [[23, 3, 1, "", "add_db_context"], [23, 3, 1, "", "add_discord"], [23, 3, 1, "", "add_logging"], [23, 3, 1, "", "add_pipes"], [23, 3, 1, "", "add_scoped"], [23, 3, 1, "", "add_singleton"], [23, 3, 1, "", "add_transient"], [23, 3, 1, "", "add_translation"], [23, 3, 1, "", "build_service_provider"]], "cpl_core.dependency_injection.service_descriptor": [[23, 1, 1, "", "ServiceDescriptor"]], "cpl_core.dependency_injection.service_descriptor.ServiceDescriptor": [[23, 4, 1, "", "base_type"], [23, 4, 1, "", "implementation"], [23, 4, 1, "", "lifetime"], [23, 4, 1, "", "service_type"]], "cpl_core.dependency_injection.service_lifetime_enum": [[23, 1, 1, "", "ServiceLifetimeEnum"]], "cpl_core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum": [[23, 2, 1, "", "scoped"], [23, 2, 1, "", "singleton"], [23, 2, 1, "", "transient"]], "cpl_core.dependency_injection.service_provider": [[23, 1, 1, "", "ServiceProvider"]], "cpl_core.dependency_injection.service_provider.ServiceProvider": [[23, 3, 1, "", "build_by_signature"], [23, 3, 1, "", "build_service"], [23, 3, 1, "", "create_scope"], [23, 3, 1, "", "get_service"], [23, 3, 1, "", "get_services"], [23, 3, 1, "", "set_scope"]], "cpl_core.dependency_injection.service_provider_abc": [[23, 1, 1, "", "ServiceProviderABC"]], "cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC": [[23, 3, 1, "", "build_by_signature"], [23, 3, 1, "", "build_service"], [23, 3, 1, "", "create_scope"], [23, 3, 1, "", "get_service"], [23, 3, 1, "", "get_services"], [23, 3, 1, "", "inject"], [23, 3, 1, "", "set_global_provider"], [23, 3, 1, "", "set_scope"]], "cpl_core.environment": [[24, 1, 1, "", "VersionInfo"], [24, 0, 0, "-", "application_environment"], [24, 0, 0, "-", "application_environment_abc"], [24, 0, 0, "-", "environment_name_enum"]], "cpl_core.environment.VersionInfo": [[24, 2, 1, "", "major"], [24, 2, 1, "", "micro"], [24, 2, 1, "", "minor"]], "cpl_core.environment.application_environment": [[24, 1, 1, "", "ApplicationEnvironment"]], "cpl_core.environment.application_environment.ApplicationEnvironment": [[24, 4, 1, "", "application_name"], [24, 4, 1, "", "customer"], [24, 4, 1, "", "date_time_now"], [24, 4, 1, "", "end_time"], [24, 4, 1, "", "environment_name"], [24, 4, 1, "", "host_name"], [24, 4, 1, "", "runtime_directory"], [24, 3, 1, "", "set_runtime_directory"], [24, 3, 1, "", "set_working_directory"], [24, 4, 1, "", "start_time"], [24, 4, 1, "", "working_directory"]], "cpl_core.environment.application_environment_abc": [[24, 1, 1, "", "ApplicationEnvironmentABC"]], "cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC": [[24, 4, 1, "", "application_name"], [24, 4, 1, "", "customer"], [24, 4, 1, "", "date_time_now"], [24, 4, 1, "", "end_time"], [24, 4, 1, "", "environment_name"], [24, 4, 1, "", "host_name"], [24, 4, 1, "", "runtime_directory"], [24, 3, 1, "", "set_runtime_directory"], [24, 3, 1, "", "set_working_directory"], [24, 4, 1, "", "start_time"], [24, 4, 1, "", "working_directory"]], "cpl_core.environment.environment_name_enum": [[24, 1, 1, "", "EnvironmentNameEnum"]], "cpl_core.environment.environment_name_enum.EnvironmentNameEnum": [[24, 2, 1, "", "development"], [24, 2, 1, "", "production"], [24, 2, 1, "", "staging"], [24, 2, 1, "", "testing"]], "cpl_core.logging": [[25, 1, 1, "", "VersionInfo"], [25, 0, 0, "-", "logger_abc"], [25, 0, 0, "-", "logger_service"], [25, 0, 0, "-", "logging_level_enum"], [25, 0, 0, "-", "logging_settings"], [25, 0, 0, "-", "logging_settings_name_enum"]], "cpl_core.logging.VersionInfo": [[25, 2, 1, "", "major"], [25, 2, 1, "", "micro"], [25, 2, 1, "", "minor"]], "cpl_core.logging.logger_abc": [[25, 1, 1, "", "LoggerABC"]], "cpl_core.logging.logger_abc.LoggerABC": [[25, 3, 1, "", "debug"], [25, 3, 1, "", "error"], [25, 3, 1, "", "fatal"], [25, 3, 1, "", "header"], [25, 3, 1, "", "info"], [25, 3, 1, "", "trace"], [25, 3, 1, "", "warn"]], "cpl_core.logging.logger_service": [[25, 1, 1, "", "Logger"]], "cpl_core.logging.logger_service.Logger": [[25, 3, 1, "", "create"], [25, 3, 1, "", "debug"], [25, 3, 1, "", "error"], [25, 3, 1, "", "fatal"], [25, 3, 1, "", "header"], [25, 3, 1, "", "info"], [25, 3, 1, "", "trace"], [25, 3, 1, "", "warn"]], "cpl_core.logging.logging_level_enum": [[25, 1, 1, "", "LoggingLevelEnum"]], "cpl_core.logging.logging_level_enum.LoggingLevelEnum": [[25, 2, 1, "", "DEBUG"], [25, 2, 1, "", "ERROR"], [25, 2, 1, "", "FATAL"], [25, 2, 1, "", "INFO"], [25, 2, 1, "", "OFF"], [25, 2, 1, "", "TRACE"], [25, 2, 1, "", "WARN"]], "cpl_core.logging.logging_settings": [[25, 1, 1, "", "LoggingSettings"]], "cpl_core.logging.logging_settings.LoggingSettings": [[25, 4, 1, "", "console"], [25, 4, 1, "", "filename"], [25, 4, 1, "", "level"], [25, 4, 1, "", "path"]], "cpl_core.logging.logging_settings_name_enum": [[25, 1, 1, "", "LoggingSettingsNameEnum"]], "cpl_core.logging.logging_settings_name_enum.LoggingSettingsNameEnum": [[25, 2, 1, "", "console_level"], [25, 2, 1, "", "file_level"], [25, 2, 1, "", "filename"], [25, 2, 1, "", "path"]], "cpl_core.mailing": [[26, 1, 1, "", "VersionInfo"], [26, 0, 0, "-", "email"], [26, 0, 0, "-", "email_client_abc"], [26, 0, 0, "-", "email_client_service"], [26, 0, 0, "-", "email_client_settings"], [26, 0, 0, "-", "email_client_settings_name_enum"]], "cpl_core.mailing.VersionInfo": [[26, 2, 1, "", "major"], [26, 2, 1, "", "micro"], [26, 2, 1, "", "minor"]], "cpl_core.mailing.email": [[26, 1, 1, "", "EMail"]], "cpl_core.mailing.email.EMail": [[26, 3, 1, "", "add_header"], [26, 3, 1, "", "add_receiver"], [26, 4, 1, "", "body"], [26, 3, 1, "", "check_mail"], [26, 3, 1, "", "get_content"], [26, 4, 1, "", "header"], [26, 4, 1, "", "header_list"], [26, 4, 1, "", "receiver"], [26, 4, 1, "", "receiver_list"], [26, 4, 1, "", "subject"], [26, 4, 1, "", "transceiver"]], "cpl_core.mailing.email_client_abc": [[26, 1, 1, "", "EMailClientABC"]], "cpl_core.mailing.email_client_abc.EMailClientABC": [[26, 3, 1, "", "connect"], [26, 3, 1, "", "send_mail"]], "cpl_core.mailing.email_client_service": [[26, 1, 1, "", "EMailClient"]], "cpl_core.mailing.email_client_service.EMailClient": [[26, 3, 1, "", "connect"], [26, 3, 1, "", "create"], [26, 3, 1, "", "login"], [26, 3, 1, "", "send_mail"]], "cpl_core.mailing.email_client_settings": [[26, 1, 1, "", "EMailClientSettings"]], "cpl_core.mailing.email_client_settings.EMailClientSettings": [[26, 4, 1, "", "credentials"], [26, 4, 1, "", "host"], [26, 4, 1, "", "port"], [26, 4, 1, "", "user_name"]], "cpl_core.mailing.email_client_settings_name_enum": [[26, 1, 1, "", "EMailClientSettingsNameEnum"]], "cpl_core.mailing.email_client_settings_name_enum.EMailClientSettingsNameEnum": [[26, 2, 1, "", "credentials"], [26, 2, 1, "", "host"], [26, 2, 1, "", "port"], [26, 2, 1, "", "user_name"]], "cpl_core.pipes": [[27, 1, 1, "", "VersionInfo"], [27, 0, 0, "-", "bool_pipe"], [27, 0, 0, "-", "first_char_to_lower_pipe"], [27, 0, 0, "-", "first_to_upper_pipe"], [27, 0, 0, "-", "ip_address_pipe"], [27, 0, 0, "-", "pipe_abc"], [27, 0, 0, "-", "to_camel_case_pipe"], [27, 0, 0, "-", "to_snake_case_pipe"], [27, 0, 0, "-", "version_pipe"]], "cpl_core.pipes.VersionInfo": [[27, 2, 1, "", "major"], [27, 2, 1, "", "micro"], [27, 2, 1, "", "minor"]], "cpl_core.pipes.bool_pipe": [[27, 1, 1, "", "BoolPipe"]], "cpl_core.pipes.bool_pipe.BoolPipe": [[27, 3, 1, "", "transform"]], "cpl_core.pipes.first_char_to_lower_pipe": [[27, 1, 1, "", "FirstCharToLowerPipe"]], "cpl_core.pipes.first_char_to_lower_pipe.FirstCharToLowerPipe": [[27, 3, 1, "", "transform"]], "cpl_core.pipes.first_to_upper_pipe": [[27, 1, 1, "", "FirstToUpperPipe"]], "cpl_core.pipes.first_to_upper_pipe.FirstToUpperPipe": [[27, 3, 1, "", "transform"]], "cpl_core.pipes.ip_address_pipe": [[27, 1, 1, "", "IPAddressPipe"]], "cpl_core.pipes.ip_address_pipe.IPAddressPipe": [[27, 3, 1, "", "transform"]], "cpl_core.pipes.pipe_abc": [[27, 1, 1, "", "PipeABC"]], "cpl_core.pipes.pipe_abc.PipeABC": [[27, 3, 1, "", "transform"]], "cpl_core.pipes.to_camel_case_pipe": [[27, 1, 1, "", "ToCamelCasePipe"]], "cpl_core.pipes.to_camel_case_pipe.ToCamelCasePipe": [[27, 3, 1, "", "transform"]], "cpl_core.pipes.to_snake_case_pipe": [[27, 1, 1, "", "ToSnakeCasePipe"]], "cpl_core.pipes.to_snake_case_pipe.ToSnakeCasePipe": [[27, 3, 1, "", "transform"]], "cpl_core.pipes.version_pipe": [[27, 1, 1, "", "VersionPipe"]], "cpl_core.pipes.version_pipe.VersionPipe": [[27, 3, 1, "", "transform"]], "cpl_core.time": [[28, 1, 1, "", "VersionInfo"], [28, 0, 0, "-", "time_format_settings"], [28, 0, 0, "-", "time_format_settings_names_enum"]], "cpl_core.time.VersionInfo": [[28, 2, 1, "", "major"], [28, 2, 1, "", "micro"], [28, 2, 1, "", "minor"]], "cpl_core.time.time_format_settings": [[28, 1, 1, "", "TimeFormatSettings"]], "cpl_core.time.time_format_settings.TimeFormatSettings": [[28, 4, 1, "", "date_format"], [28, 4, 1, "", "date_time_format"], [28, 4, 1, "", "date_time_log_format"], [28, 4, 1, "", "time_format"]], "cpl_core.time.time_format_settings_names_enum": [[28, 1, 1, "", "TimeFormatSettingsNamesEnum"]], "cpl_core.time.time_format_settings_names_enum.TimeFormatSettingsNamesEnum": [[28, 2, 1, "", "date_format"], [28, 2, 1, "", "date_time_format"], [28, 2, 1, "", "date_time_log_format"], [28, 2, 1, "", "time_format"]], "cpl_core.utils": [[29, 1, 1, "", "VersionInfo"], [29, 0, 0, "-", "credential_manager"], [29, 0, 0, "-", "pip"], [29, 0, 0, "-", "string"]], "cpl_core.utils.VersionInfo": [[29, 2, 1, "", "major"], [29, 2, 1, "", "micro"], [29, 2, 1, "", "minor"]], "cpl_core.utils.credential_manager": [[29, 1, 1, "", "CredentialManager"]], "cpl_core.utils.credential_manager.CredentialManager": [[29, 3, 1, "", "build_string"], [29, 3, 1, "", "decrypt"], [29, 3, 1, "", "encrypt"]], "cpl_core.utils.pip": [[29, 1, 1, "", "Pip"]], "cpl_core.utils.pip.Pip": [[29, 3, 1, "", "get_executable"], [29, 3, 1, "", "get_outdated"], [29, 3, 1, "", "get_package"], [29, 3, 1, "", "install"], [29, 3, 1, "", "reset_executable"], [29, 3, 1, "", "set_executable"], [29, 3, 1, "", "uninstall"]], "cpl_core.utils.string": [[29, 1, 1, "", "String"]], "cpl_core.utils.string.String": [[29, 3, 1, "", "convert_to_camel_case"], [29, 3, 1, "", "convert_to_snake_case"], [29, 3, 1, "", "first_to_lower"], [29, 3, 1, "", "first_to_upper"], [29, 3, 1, "", "random_string"]], "cpl_discord": [[31, 0, 0, "-", "application"], [32, 0, 0, "-", "command"], [33, 0, 0, "-", "configuration"], [34, 0, 0, "-", "container"], [30, 0, 0, "-", "discord_event_types_enum"], [35, 0, 0, "-", "events"], [36, 0, 0, "-", "helper"], [37, 0, 0, "-", "service"]], "cpl_discord.application": [[31, 1, 1, "", "VersionInfo"], [31, 0, 0, "-", "discord_bot_application_abc"]], "cpl_discord.application.VersionInfo": [[31, 2, 1, "", "major"], [31, 2, 1, "", "micro"], [31, 2, 1, "", "minor"]], "cpl_discord.application.discord_bot_application_abc": [[31, 1, 1, "", "DiscordBotApplicationABC"]], "cpl_discord.application.discord_bot_application_abc.DiscordBotApplicationABC": [[31, 3, 1, "", "stop_async"]], "cpl_discord.command": [[32, 1, 1, "", "VersionInfo"], [32, 0, 0, "-", "discord_command_abc"], [32, 0, 0, "-", "discord_commands_meta"]], "cpl_discord.command.VersionInfo": [[32, 2, 1, "", "major"], [32, 2, 1, "", "micro"], [32, 2, 1, "", "minor"]], "cpl_discord.command.discord_command_abc": [[32, 1, 1, "", "DiscordCommandABC"]], "cpl_discord.command.discord_commands_meta": [[32, 1, 1, "", "DiscordCogMeta"]], "cpl_discord.configuration": [[33, 1, 1, "", "VersionInfo"], [33, 0, 0, "-", "discord_bot_settings"]], "cpl_discord.configuration.VersionInfo": [[33, 2, 1, "", "major"], [33, 2, 1, "", "micro"], [33, 2, 1, "", "minor"]], "cpl_discord.configuration.discord_bot_settings": [[33, 1, 1, "", "DiscordBotSettings"]], "cpl_discord.configuration.discord_bot_settings.DiscordBotSettings": [[33, 4, 1, "", "prefix"], [33, 4, 1, "", "token"]], "cpl_discord.container": [[34, 1, 1, "", "VersionInfo"], [34, 0, 0, "-", "category_channel"], [34, 0, 0, "-", "container"], [34, 0, 0, "-", "guild"], [34, 0, 0, "-", "member"], [34, 0, 0, "-", "role"], [34, 0, 0, "-", "text_channel"], [34, 0, 0, "-", "thread"], [34, 0, 0, "-", "voice_channel"]], "cpl_discord.container.VersionInfo": [[34, 2, 1, "", "major"], [34, 2, 1, "", "micro"], [34, 2, 1, "", "minor"]], "cpl_discord.container.category_channel": [[34, 1, 1, "", "CategoryChannel"]], "cpl_discord.container.category_channel.CategoryChannel": [[34, 2, 1, "", "category_id"], [34, 2, 1, "", "guild"], [34, 2, 1, "", "id"], [34, 2, 1, "", "name"], [34, 2, 1, "", "nsfw"], [34, 2, 1, "", "position"], [34, 4, 1, "", "text_channels"], [34, 4, 1, "", "voice_channels"]], "cpl_discord.container.container": [[34, 1, 1, "", "Container"]], "cpl_discord.container.guild": [[34, 1, 1, "", "Guild"]], "cpl_discord.container.guild.Guild": [[34, 2, 1, "", "afk_channel"], [34, 2, 1, "", "afk_timeout"], [34, 2, 1, "", "approximate_member_count"], [34, 2, 1, "", "approximate_presence_count"], [34, 4, 1, "", "categories"], [34, 2, 1, "", "default_notifications"], [34, 2, 1, "", "description"], [34, 2, 1, "", "emojis"], [34, 2, 1, "", "explicit_content_filter"], [34, 2, 1, "", "features"], [34, 2, 1, "", "id"], [34, 2, 1, "", "max_members"], [34, 2, 1, "", "max_presences"], [34, 2, 1, "", "max_video_channel_users"], [34, 4, 1, "", "members"], [34, 2, 1, "", "mfa_level"], [34, 2, 1, "", "name"], [34, 2, 1, "", "nsfw_level"], [34, 2, 1, "", "owner_id"], [34, 2, 1, "", "preferred_locale"], [34, 2, 1, "", "premium_progress_bar_enabled"], [34, 2, 1, "", "premium_subscription_count"], [34, 2, 1, "", "premium_tier"], [34, 4, 1, "", "roles"], [34, 2, 1, "", "stickers"], [34, 4, 1, "", "text_channels"], [34, 4, 1, "", "threads"], [34, 2, 1, "", "unavailable"], [34, 2, 1, "", "vanity_url_code"], [34, 2, 1, "", "verification_level"], [34, 4, 1, "", "voice_channels"], [34, 2, 1, "", "widget_enabled"]], "cpl_discord.container.member": [[34, 1, 1, "", "Member"]], "cpl_discord.container.member.Member": [[34, 2, 1, "", "activities"], [34, 2, 1, "", "guild"], [34, 2, 1, "", "joined_at"], [34, 2, 1, "", "nick"], [34, 2, 1, "", "pending"], [34, 2, 1, "", "premium_since"], [34, 4, 1, "", "roles"], [34, 2, 1, "", "timed_out_until"]], "cpl_discord.container.role": [[34, 1, 1, "", "Role"]], "cpl_discord.container.role.Role": [[34, 2, 1, "", "guild"], [34, 2, 1, "", "hoist"], [34, 2, 1, "", "id"], [34, 2, 1, "", "managed"], [34, 4, 1, "", "members"], [34, 2, 1, "", "mentionable"], [34, 2, 1, "", "name"], [34, 2, 1, "", "position"], [34, 2, 1, "", "tags"], [34, 2, 1, "", "unicode_emoji"]], "cpl_discord.container.text_channel": [[34, 1, 1, "", "TextChannel"]], "cpl_discord.container.text_channel.TextChannel": [[34, 2, 1, "", "category_id"], [34, 2, 1, "", "default_auto_archive_duration"], [34, 2, 1, "", "guild"], [34, 2, 1, "", "id"], [34, 2, 1, "", "last_message_id"], [34, 4, 1, "", "members"], [34, 2, 1, "", "name"], [34, 2, 1, "", "nsfw"], [34, 2, 1, "", "position"], [34, 2, 1, "", "slowmode_delay"], [34, 4, 1, "", "threads"], [34, 2, 1, "", "topic"]], "cpl_discord.container.thread": [[34, 1, 1, "", "Thread"]], "cpl_discord.container.thread.Thread": [[34, 2, 1, "", "archive_timestamp"], [34, 2, 1, "", "archived"], [34, 2, 1, "", "archiver_id"], [34, 2, 1, "", "auto_archive_duration"], [34, 2, 1, "", "guild"], [34, 2, 1, "", "id"], [34, 2, 1, "", "invitable"], [34, 2, 1, "", "last_message_id"], [34, 2, 1, "", "locked"], [34, 2, 1, "", "me"], [34, 2, 1, "", "member_count"], [34, 4, 1, "", "members"], [34, 2, 1, "", "message_count"], [34, 2, 1, "", "name"], [34, 2, 1, "", "owner_id"], [34, 2, 1, "", "parent_id"], [34, 2, 1, "", "slowmode_delay"]], "cpl_discord.container.voice_channel": [[34, 1, 1, "", "VoiceChannel"]], "cpl_discord.container.voice_channel.VoiceChannel": [[34, 4, 1, "", "members"]], "cpl_discord.discord_event_types_enum": [[30, 1, 1, "", "DiscordEventTypesEnum"]], "cpl_discord.discord_event_types_enum.DiscordEventTypesEnum": [[30, 2, 1, "", "on_bulk_message_delete"], [30, 2, 1, "", "on_command"], [30, 2, 1, "", "on_command_completion"], [30, 2, 1, "", "on_command_error"], [30, 2, 1, "", "on_connect"], [30, 2, 1, "", "on_disconnect"], [30, 2, 1, "", "on_error"], [30, 2, 1, "", "on_group_join"], [30, 2, 1, "", "on_group_remove"], [30, 2, 1, "", "on_guild_available"], [30, 2, 1, "", "on_guild_channel_create"], [30, 2, 1, "", "on_guild_channel_delete"], [30, 2, 1, "", "on_guild_channel_pins_update"], [30, 2, 1, "", "on_guild_channel_update"], [30, 2, 1, "", "on_guild_emojis_update"], [30, 2, 1, "", "on_guild_integrations_update"], [30, 2, 1, "", "on_guild_join"], [30, 2, 1, "", "on_guild_remove"], [30, 2, 1, "", "on_guild_role_create"], [30, 2, 1, "", "on_guild_role_delete"], [30, 2, 1, "", "on_guild_role_update"], [30, 2, 1, "", "on_guild_unavailable"], [30, 2, 1, "", "on_guild_update"], [30, 2, 1, "", "on_invite_create"], [30, 2, 1, "", "on_invite_delete"], [30, 2, 1, "", "on_member_ban"], [30, 2, 1, "", "on_member_join"], [30, 2, 1, "", "on_member_remove"], [30, 2, 1, "", "on_member_unban"], [30, 2, 1, "", "on_member_update"], [30, 2, 1, "", "on_message"], [30, 2, 1, "", "on_message_delete"], [30, 2, 1, "", "on_message_edit"], [30, 2, 1, "", "on_private_channel_create"], [30, 2, 1, "", "on_private_channel_delete"], [30, 2, 1, "", "on_private_channel_pins_update"], [30, 2, 1, "", "on_private_channel_update"], [30, 2, 1, "", "on_raw_reaction_add"], [30, 2, 1, "", "on_raw_reaction_clear"], [30, 2, 1, "", "on_raw_reaction_clear_emoji"], [30, 2, 1, "", "on_raw_reaction_remove"], [30, 2, 1, "", "on_reaction_add"], [30, 2, 1, "", "on_reaction_clear"], [30, 2, 1, "", "on_reaction_clear_emoji"], [30, 2, 1, "", "on_reaction_remove"], [30, 2, 1, "", "on_ready"], [30, 2, 1, "", "on_resume"], [30, 2, 1, "", "on_scheduled_event_create"], [30, 2, 1, "", "on_scheduled_event_delete"], [30, 2, 1, "", "on_scheduled_event_update"], [30, 2, 1, "", "on_scheduled_event_user_add"], [30, 2, 1, "", "on_scheduled_event_user_remove"], [30, 2, 1, "", "on_typing"], [30, 2, 1, "", "on_user_update"], [30, 2, 1, "", "on_voice_state_update"], [30, 2, 1, "", "on_webhooks_update"]], "cpl_discord.events": [[35, 1, 1, "", "VersionInfo"], [35, 0, 0, "-", "on_bulk_message_delete_abc"], [35, 0, 0, "-", "on_command_abc"], [35, 0, 0, "-", "on_command_completion_abc"], [35, 0, 0, "-", "on_command_error_abc"], [35, 0, 0, "-", "on_connect_abc"], [35, 0, 0, "-", "on_disconnect_abc"], [35, 0, 0, "-", "on_error_abc"], [35, 0, 0, "-", "on_group_join_abc"], [35, 0, 0, "-", "on_group_remove_abc"], [35, 0, 0, "-", "on_guild_available_abc"], [35, 0, 0, "-", "on_guild_channel_create_abc"], [35, 0, 0, "-", "on_guild_channel_delete_abc"], [35, 0, 0, "-", "on_guild_channel_pins_update_abc"], [35, 0, 0, "-", "on_guild_channel_update_abc"], [35, 0, 0, "-", "on_guild_emojis_update_abc"], [35, 0, 0, "-", "on_guild_integrations_update_abc"], [35, 0, 0, "-", "on_guild_join_abc"], [35, 0, 0, "-", "on_guild_remove_abc"], [35, 0, 0, "-", "on_guild_role_create_abc"], [35, 0, 0, "-", "on_guild_role_delete_abc"], [35, 0, 0, "-", "on_guild_role_update_abc"], [35, 0, 0, "-", "on_guild_unavailable_abc"], [35, 0, 0, "-", "on_guild_update_abc"], [35, 0, 0, "-", "on_invite_create_abc"], [35, 0, 0, "-", "on_invite_delete_abc"], [35, 0, 0, "-", "on_member_ban_abc"], [35, 0, 0, "-", "on_member_join_abc"], [35, 0, 0, "-", "on_member_remove_abc"], [35, 0, 0, "-", "on_member_unban_abc"], [35, 0, 0, "-", "on_member_update_abc"], [35, 0, 0, "-", "on_message_abc"], [35, 0, 0, "-", "on_message_delete_abc"], [35, 0, 0, "-", "on_message_edit_abc"], [35, 0, 0, "-", "on_private_channel_create_abc"], [35, 0, 0, "-", "on_private_channel_delete_abc"], [35, 0, 0, "-", "on_private_channel_pins_update_abc"], [35, 0, 0, "-", "on_private_channel_update_abc"], [35, 0, 0, "-", "on_raw_reaction_add_abc"], [35, 0, 0, "-", "on_raw_reaction_clear_abc"], [35, 0, 0, "-", "on_raw_reaction_clear_emoji_abc"], [35, 0, 0, "-", "on_raw_reaction_remove_abc"], [35, 0, 0, "-", "on_reaction_add_abc"], [35, 0, 0, "-", "on_reaction_clear_abc"], [35, 0, 0, "-", "on_reaction_clear_emoji_abc"], [35, 0, 0, "-", "on_reaction_remove_abc"], [35, 0, 0, "-", "on_ready_abc"], [35, 0, 0, "-", "on_resume_abc"], [35, 0, 0, "-", "on_typing_abc"], [35, 0, 0, "-", "on_user_update_abc"], [35, 0, 0, "-", "on_voice_state_update_abc"], [35, 0, 0, "-", "on_webhooks_update_abc"]], "cpl_discord.events.VersionInfo": [[35, 2, 1, "", "major"], [35, 2, 1, "", "micro"], [35, 2, 1, "", "minor"]], "cpl_discord.events.on_bulk_message_delete_abc": [[35, 1, 1, "", "OnBulkMessageDeleteABC"]], "cpl_discord.events.on_bulk_message_delete_abc.OnBulkMessageDeleteABC": [[35, 3, 1, "", "on_bulk_message_delete"]], "cpl_discord.events.on_command_abc": [[35, 1, 1, "", "OnCommandABC"]], "cpl_discord.events.on_command_abc.OnCommandABC": [[35, 3, 1, "", "on_command"]], "cpl_discord.events.on_command_completion_abc": [[35, 1, 1, "", "OnCommandCompletionABC"]], "cpl_discord.events.on_command_completion_abc.OnCommandCompletionABC": [[35, 3, 1, "", "on_command_completion"]], "cpl_discord.events.on_command_error_abc": [[35, 1, 1, "", "OnCommandErrorABC"]], "cpl_discord.events.on_command_error_abc.OnCommandErrorABC": [[35, 3, 1, "", "on_command_error"]], "cpl_discord.events.on_connect_abc": [[35, 1, 1, "", "OnConnectABC"]], "cpl_discord.events.on_connect_abc.OnConnectABC": [[35, 3, 1, "", "on_connect"]], "cpl_discord.events.on_disconnect_abc": [[35, 1, 1, "", "OnDisconnectABC"]], "cpl_discord.events.on_disconnect_abc.OnDisconnectABC": [[35, 3, 1, "", "on_disconnect"]], "cpl_discord.events.on_error_abc": [[35, 1, 1, "", "OnErrorABC"]], "cpl_discord.events.on_error_abc.OnErrorABC": [[35, 3, 1, "", "on_error"]], "cpl_discord.events.on_group_join_abc": [[35, 1, 1, "", "OnGroupJoinABC"]], "cpl_discord.events.on_group_join_abc.OnGroupJoinABC": [[35, 3, 1, "", "on_group_join"]], "cpl_discord.events.on_group_remove_abc": [[35, 1, 1, "", "OnGroupRemoveABC"]], "cpl_discord.events.on_group_remove_abc.OnGroupRemoveABC": [[35, 3, 1, "", "on_group_remove"]], "cpl_discord.events.on_guild_available_abc": [[35, 1, 1, "", "OnGuildAvailableABC"]], "cpl_discord.events.on_guild_available_abc.OnGuildAvailableABC": [[35, 3, 1, "", "on_guild_available"]], "cpl_discord.events.on_guild_channel_create_abc": [[35, 1, 1, "", "OnGuildChannelCreateABC"]], "cpl_discord.events.on_guild_channel_create_abc.OnGuildChannelCreateABC": [[35, 3, 1, "", "on_guild_channel_create"]], "cpl_discord.events.on_guild_channel_delete_abc": [[35, 1, 1, "", "OnGuildChannelDeleteABC"]], "cpl_discord.events.on_guild_channel_delete_abc.OnGuildChannelDeleteABC": [[35, 3, 1, "", "on_guild_channel_delete"]], "cpl_discord.events.on_guild_channel_pins_update_abc": [[35, 1, 1, "", "OnGuildChannelPinsUpdateABC"]], "cpl_discord.events.on_guild_channel_pins_update_abc.OnGuildChannelPinsUpdateABC": [[35, 3, 1, "", "on_guild_channel_pins_update"]], "cpl_discord.events.on_guild_channel_update_abc": [[35, 1, 1, "", "OnGuildChannelUpdateABC"]], "cpl_discord.events.on_guild_channel_update_abc.OnGuildChannelUpdateABC": [[35, 3, 1, "", "on_guild_channel_update"]], "cpl_discord.events.on_guild_emojis_update_abc": [[35, 1, 1, "", "OnGuildEmojisUpdateABC"]], "cpl_discord.events.on_guild_emojis_update_abc.OnGuildEmojisUpdateABC": [[35, 3, 1, "", "on_guild_emojis_update"]], "cpl_discord.events.on_guild_integrations_update_abc": [[35, 1, 1, "", "OnGuildIntegrationsUpdateABC"]], "cpl_discord.events.on_guild_integrations_update_abc.OnGuildIntegrationsUpdateABC": [[35, 3, 1, "", "on_guild_integrations_update"]], "cpl_discord.events.on_guild_join_abc": [[35, 1, 1, "", "OnGuildJoinABC"]], "cpl_discord.events.on_guild_join_abc.OnGuildJoinABC": [[35, 3, 1, "", "on_guild_join"]], "cpl_discord.events.on_guild_remove_abc": [[35, 1, 1, "", "OnGuildRemoveABC"]], "cpl_discord.events.on_guild_remove_abc.OnGuildRemoveABC": [[35, 3, 1, "", "on_guild_remove"]], "cpl_discord.events.on_guild_role_create_abc": [[35, 1, 1, "", "OnGuildRoleCreateABC"]], "cpl_discord.events.on_guild_role_create_abc.OnGuildRoleCreateABC": [[35, 3, 1, "", "on_guild_role_create"]], "cpl_discord.events.on_guild_role_delete_abc": [[35, 1, 1, "", "OnGuildRoleDeleteABC"]], "cpl_discord.events.on_guild_role_delete_abc.OnGuildRoleDeleteABC": [[35, 3, 1, "", "on_guild_role_delete"]], "cpl_discord.events.on_guild_role_update_abc": [[35, 1, 1, "", "OnGuildRoleUpdateABC"]], "cpl_discord.events.on_guild_role_update_abc.OnGuildRoleUpdateABC": [[35, 3, 1, "", "on_guild_role_update"]], "cpl_discord.events.on_guild_unavailable_abc": [[35, 1, 1, "", "OnGuildUnavailableABC"]], "cpl_discord.events.on_guild_unavailable_abc.OnGuildUnavailableABC": [[35, 3, 1, "", "on_guild_unavailable"]], "cpl_discord.events.on_guild_update_abc": [[35, 1, 1, "", "OnGuildUpdateABC"]], "cpl_discord.events.on_guild_update_abc.OnGuildUpdateABC": [[35, 3, 1, "", "on_guild_update"]], "cpl_discord.events.on_invite_create_abc": [[35, 1, 1, "", "OnInviteCreateABC"]], "cpl_discord.events.on_invite_create_abc.OnInviteCreateABC": [[35, 3, 1, "", "on_invite_create"]], "cpl_discord.events.on_invite_delete_abc": [[35, 1, 1, "", "OnInviteDeleteABC"]], "cpl_discord.events.on_invite_delete_abc.OnInviteDeleteABC": [[35, 3, 1, "", "on_invite_delete"]], "cpl_discord.events.on_member_ban_abc": [[35, 1, 1, "", "OnMemberBanABC"]], "cpl_discord.events.on_member_ban_abc.OnMemberBanABC": [[35, 3, 1, "", "on_member_ban"]], "cpl_discord.events.on_member_join_abc": [[35, 1, 1, "", "OnMemberJoinABC"]], "cpl_discord.events.on_member_join_abc.OnMemberJoinABC": [[35, 3, 1, "", "on_member_join"]], "cpl_discord.events.on_member_remove_abc": [[35, 1, 1, "", "OnMemberRemoveABC"]], "cpl_discord.events.on_member_remove_abc.OnMemberRemoveABC": [[35, 3, 1, "", "on_member_remove"]], "cpl_discord.events.on_member_unban_abc": [[35, 1, 1, "", "OnMemberUnbanABC"]], "cpl_discord.events.on_member_unban_abc.OnMemberUnbanABC": [[35, 3, 1, "", "on_member_unban"]], "cpl_discord.events.on_member_update_abc": [[35, 1, 1, "", "OnMemberUpdateABC"]], "cpl_discord.events.on_member_update_abc.OnMemberUpdateABC": [[35, 3, 1, "", "on_member_update"]], "cpl_discord.events.on_message_abc": [[35, 1, 1, "", "OnMessageABC"]], "cpl_discord.events.on_message_abc.OnMessageABC": [[35, 3, 1, "", "on_message"]], "cpl_discord.events.on_message_delete_abc": [[35, 1, 1, "", "OnMessageDeleteABC"]], "cpl_discord.events.on_message_delete_abc.OnMessageDeleteABC": [[35, 3, 1, "", "on_message_delete"]], "cpl_discord.events.on_message_edit_abc": [[35, 1, 1, "", "OnMessageEditABC"]], "cpl_discord.events.on_message_edit_abc.OnMessageEditABC": [[35, 3, 1, "", "on_message_edit"]], "cpl_discord.events.on_private_channel_create_abc": [[35, 1, 1, "", "OnPrivateChannelCreateABC"]], "cpl_discord.events.on_private_channel_create_abc.OnPrivateChannelCreateABC": [[35, 3, 1, "", "on_private_channel_create"]], "cpl_discord.events.on_private_channel_delete_abc": [[35, 1, 1, "", "OnPrivateChannelDeleteABC"]], "cpl_discord.events.on_private_channel_delete_abc.OnPrivateChannelDeleteABC": [[35, 3, 1, "", "on_private_channel_delete"]], "cpl_discord.events.on_private_channel_pins_update_abc": [[35, 1, 1, "", "OnPrivateChannelPinsUpdateABC"]], "cpl_discord.events.on_private_channel_pins_update_abc.OnPrivateChannelPinsUpdateABC": [[35, 3, 1, "", "on_private_channel_pins_update"]], "cpl_discord.events.on_private_channel_update_abc": [[35, 1, 1, "", "OnPrivateChannelUpdateABC"]], "cpl_discord.events.on_private_channel_update_abc.OnPrivateChannelUpdateABC": [[35, 3, 1, "", "on_private_channel_update"]], "cpl_discord.events.on_raw_reaction_add_abc": [[35, 1, 1, "", "OnRawReactionAddABC"]], "cpl_discord.events.on_raw_reaction_add_abc.OnRawReactionAddABC": [[35, 3, 1, "", "on_raw_reaction_add"]], "cpl_discord.events.on_raw_reaction_clear_abc": [[35, 1, 1, "", "OnRawReactionClearABC"]], "cpl_discord.events.on_raw_reaction_clear_abc.OnRawReactionClearABC": [[35, 3, 1, "", "on_raw_reaction_clear"]], "cpl_discord.events.on_raw_reaction_clear_emoji_abc": [[35, 1, 1, "", "OnRawReactionClearEmojiABC"]], "cpl_discord.events.on_raw_reaction_clear_emoji_abc.OnRawReactionClearEmojiABC": [[35, 3, 1, "", "on_raw_reaction_clear_emoji"]], "cpl_discord.events.on_raw_reaction_remove_abc": [[35, 1, 1, "", "OnRawReactionRemoveABC"]], "cpl_discord.events.on_raw_reaction_remove_abc.OnRawReactionRemoveABC": [[35, 3, 1, "", "on_raw_reaction_remove"]], "cpl_discord.events.on_reaction_add_abc": [[35, 1, 1, "", "OnReactionAddABC"]], "cpl_discord.events.on_reaction_add_abc.OnReactionAddABC": [[35, 3, 1, "", "on_reaction_add"]], "cpl_discord.events.on_reaction_clear_abc": [[35, 1, 1, "", "OnReactionClearABC"]], "cpl_discord.events.on_reaction_clear_abc.OnReactionClearABC": [[35, 3, 1, "", "on_reaction_clear"]], "cpl_discord.events.on_reaction_clear_emoji_abc": [[35, 1, 1, "", "OnReactionClearEmojiABC"]], "cpl_discord.events.on_reaction_clear_emoji_abc.OnReactionClearEmojiABC": [[35, 3, 1, "", "on_reaction_clear_emoji"]], "cpl_discord.events.on_reaction_remove_abc": [[35, 1, 1, "", "OnReactionRemoveABC"]], "cpl_discord.events.on_reaction_remove_abc.OnReactionRemoveABC": [[35, 3, 1, "", "on_reaction_remove"]], "cpl_discord.events.on_ready_abc": [[35, 1, 1, "", "OnReadyABC"]], "cpl_discord.events.on_ready_abc.OnReadyABC": [[35, 3, 1, "", "on_ready"]], "cpl_discord.events.on_resume_abc": [[35, 1, 1, "", "OnResumeABC"]], "cpl_discord.events.on_resume_abc.OnResumeABC": [[35, 3, 1, "", "on_resume"]], "cpl_discord.events.on_typing_abc": [[35, 1, 1, "", "OnTypingABC"]], "cpl_discord.events.on_typing_abc.OnTypingABC": [[35, 3, 1, "", "on_typing"]], "cpl_discord.events.on_user_update_abc": [[35, 1, 1, "", "OnUserUpdateABC"]], "cpl_discord.events.on_user_update_abc.OnUserUpdateABC": [[35, 3, 1, "", "on_user_update"]], "cpl_discord.events.on_voice_state_update_abc": [[35, 1, 1, "", "OnVoiceStateUpdateABC"]], "cpl_discord.events.on_voice_state_update_abc.OnVoiceStateUpdateABC": [[35, 3, 1, "", "on_voice_state_update"]], "cpl_discord.events.on_webhooks_update_abc": [[35, 1, 1, "", "OnWebhooksUpdateABC"]], "cpl_discord.events.on_webhooks_update_abc.OnWebhooksUpdateABC": [[35, 3, 1, "", "on_webhooks_update"]], "cpl_discord.helper": [[36, 1, 1, "", "VersionInfo"], [36, 0, 0, "-", "to_containers_converter"]], "cpl_discord.helper.VersionInfo": [[36, 2, 1, "", "major"], [36, 2, 1, "", "micro"], [36, 2, 1, "", "minor"]], "cpl_discord.helper.to_containers_converter": [[36, 1, 1, "", "ToContainersConverter"]], "cpl_discord.helper.to_containers_converter.ToContainersConverter": [[36, 3, 1, "", "convert"]], "cpl_discord.service": [[37, 1, 1, "", "VersionInfo"], [37, 0, 0, "-", "command_error_handler_service"], [37, 0, 0, "-", "discord_bot_service"], [37, 0, 0, "-", "discord_bot_service_abc"], [37, 0, 0, "-", "discord_collection"], [37, 0, 0, "-", "discord_collection_abc"], [37, 0, 0, "-", "discord_service"], [37, 0, 0, "-", "discord_service_abc"]], "cpl_discord.service.VersionInfo": [[37, 2, 1, "", "major"], [37, 2, 1, "", "micro"], [37, 2, 1, "", "minor"]], "cpl_discord.service.command_error_handler_service": [[37, 1, 1, "", "CommandErrorHandlerService"]], "cpl_discord.service.command_error_handler_service.CommandErrorHandlerService": [[37, 3, 1, "", "on_command_error"]], "cpl_discord.service.discord_bot_service": [[37, 1, 1, "", "DiscordBotService"]], "cpl_discord.service.discord_bot_service.DiscordBotService": [[37, 4, 1, "", "guilds"], [37, 3, 1, "", "on_ready"], [37, 3, 1, "", "start_async"], [37, 3, 1, "", "stop_async"]], "cpl_discord.service.discord_bot_service_abc": [[37, 1, 1, "", "DiscordBotServiceABC"]], "cpl_discord.service.discord_bot_service_abc.DiscordBotServiceABC": [[37, 4, 1, "", "guilds"], [37, 3, 1, "", "on_ready"], [37, 3, 1, "", "start_async"], [37, 3, 1, "", "stop_async"]], "cpl_discord.service.discord_collection": [[37, 1, 1, "", "DiscordCollection"]], "cpl_discord.service.discord_collection.DiscordCollection": [[37, 3, 1, "", "add_command"], [37, 3, 1, "", "add_event"], [37, 3, 1, "", "get_commands"], [37, 3, 1, "", "get_events_by_base"]], "cpl_discord.service.discord_collection_abc": [[37, 1, 1, "", "DiscordCollectionABC"]], "cpl_discord.service.discord_collection_abc.DiscordCollectionABC": [[37, 3, 1, "", "add_command"], [37, 3, 1, "", "add_event"], [37, 3, 1, "", "get_commands"], [37, 3, 1, "", "get_events_by_base"]], "cpl_discord.service.discord_service": [[37, 1, 1, "", "DiscordService"]], "cpl_discord.service.discord_service.DiscordService": [[37, 3, 1, "", "init"], [37, 3, 1, "", "on_bulk_message_delete"], [37, 3, 1, "", "on_command"], [37, 3, 1, "", "on_command_completion"], [37, 3, 1, "", "on_command_error"], [37, 3, 1, "", "on_connect"], [37, 3, 1, "", "on_disconnect"], [37, 3, 1, "", "on_error"], [37, 3, 1, "", "on_group_join"], [37, 3, 1, "", "on_group_remove"], [37, 3, 1, "", "on_guild_available"], [37, 3, 1, "", "on_guild_channel_create"], [37, 3, 1, "", "on_guild_channel_delete"], [37, 3, 1, "", "on_guild_channel_pins_update"], [37, 3, 1, "", "on_guild_channel_update"], [37, 3, 1, "", "on_guild_emojis_update"], [37, 3, 1, "", "on_guild_integrations_update"], [37, 3, 1, "", "on_guild_join"], [37, 3, 1, "", "on_guild_remove"], [37, 3, 1, "", "on_guild_role_create"], [37, 3, 1, "", "on_guild_role_delete"], [37, 3, 1, "", "on_guild_role_update"], [37, 3, 1, "", "on_guild_unavailable"], [37, 3, 1, "", "on_guild_update"], [37, 3, 1, "", "on_invite_create"], [37, 3, 1, "", "on_invite_delete"], [37, 3, 1, "", "on_member_ban"], [37, 3, 1, "", "on_member_join"], [37, 3, 1, "", "on_member_remove"], [37, 3, 1, "", "on_member_unban"], [37, 3, 1, "", "on_member_update"], [37, 3, 1, "", "on_message"], [37, 3, 1, "", "on_message_delete"], [37, 3, 1, "", "on_message_edit"], [37, 3, 1, "", "on_private_channel_create"], [37, 3, 1, "", "on_private_channel_delete"], [37, 3, 1, "", "on_private_channel_pins_update"], [37, 3, 1, "", "on_private_channel_update"], [37, 3, 1, "", "on_raw_reaction_add"], [37, 3, 1, "", "on_raw_reaction_clear"], [37, 3, 1, "", "on_raw_reaction_clear_emoji"], [37, 3, 1, "", "on_raw_reaction_remove"], [37, 3, 1, "", "on_reaction_add"], [37, 3, 1, "", "on_reaction_clear"], [37, 3, 1, "", "on_reaction_clear_emoji"], [37, 3, 1, "", "on_reaction_remove"], [37, 3, 1, "", "on_ready"], [37, 3, 1, "", "on_resume"], [37, 3, 1, "", "on_scheduled_event_create"], [37, 3, 1, "", "on_scheduled_event_delete"], [37, 3, 1, "", "on_scheduled_event_update"], [37, 3, 1, "", "on_scheduled_event_user_add"], [37, 3, 1, "", "on_scheduled_event_user_remove"], [37, 3, 1, "", "on_typing"], [37, 3, 1, "", "on_user_update"], [37, 3, 1, "", "on_voice_state_update"], [37, 3, 1, "", "on_webhooks_update"]], "cpl_discord.service.discord_service_abc": [[37, 1, 1, "", "DiscordServiceABC"]], "cpl_discord.service.discord_service_abc.DiscordServiceABC": [[37, 3, 1, "", "init"], [37, 3, 1, "", "on_bulk_message_delete"], [37, 3, 1, "", "on_command"], [37, 3, 1, "", "on_command_completion"], [37, 3, 1, "", "on_command_error"], [37, 3, 1, "", "on_connect"], [37, 3, 1, "", "on_disconnect"], [37, 3, 1, "", "on_error"], [37, 3, 1, "", "on_group_join"], [37, 3, 1, "", "on_group_remove"], [37, 3, 1, "", "on_guild_available"], [37, 3, 1, "", "on_guild_channel_create"], [37, 3, 1, "", "on_guild_channel_delete"], [37, 3, 1, "", "on_guild_channel_pins_update"], [37, 3, 1, "", "on_guild_channel_update"], [37, 3, 1, "", "on_guild_emojis_update"], [37, 3, 1, "", "on_guild_integrations_update"], [37, 3, 1, "", "on_guild_join"], [37, 3, 1, "", "on_guild_remove"], [37, 3, 1, "", "on_guild_role_create"], [37, 3, 1, "", "on_guild_role_delete"], [37, 3, 1, "", "on_guild_role_update"], [37, 3, 1, "", "on_guild_unavailable"], [37, 3, 1, "", "on_guild_update"], [37, 3, 1, "", "on_invite_create"], [37, 3, 1, "", "on_invite_delete"], [37, 3, 1, "", "on_member_ban"], [37, 3, 1, "", "on_member_join"], [37, 3, 1, "", "on_member_remove"], [37, 3, 1, "", "on_member_unban"], [37, 3, 1, "", "on_member_update"], [37, 3, 1, "", "on_message"], [37, 3, 1, "", "on_message_delete"], [37, 3, 1, "", "on_message_edit"], [37, 3, 1, "", "on_private_channel_create"], [37, 3, 1, "", "on_private_channel_delete"], [37, 3, 1, "", "on_private_channel_pins_update"], [37, 3, 1, "", "on_private_channel_update"], [37, 3, 1, "", "on_reaction_add"], [37, 3, 1, "", "on_reaction_clear"], [37, 3, 1, "", "on_reaction_clear_emoji"], [37, 3, 1, "", "on_reaction_remove"], [37, 3, 1, "", "on_ready"], [37, 3, 1, "", "on_resume"], [37, 3, 1, "", "on_typing"], [37, 3, 1, "", "on_user_update"], [37, 3, 1, "", "on_voice_state_update"], [37, 3, 1, "", "on_webhooks_update"]], "cpl_query": [[39, 0, 0, "-", "base"], [40, 0, 0, "-", "enumerable"], [41, 0, 0, "-", "extension"], [42, 0, 0, "-", "iterable"]], "cpl_query.base": [[39, 1, 1, "", "VersionInfo"], [39, 0, 0, "-", "default_lambda"], [39, 0, 0, "-", "ordered_queryable"], [39, 0, 0, "-", "ordered_queryable_abc"], [39, 0, 0, "-", "queryable_abc"], [39, 0, 0, "-", "sequence"]], "cpl_query.base.VersionInfo": [[39, 2, 1, "", "major"], [39, 2, 1, "", "micro"], [39, 2, 1, "", "minor"]], "cpl_query.base.default_lambda": [[39, 5, 1, "", "default_lambda"]], "cpl_query.base.ordered_queryable": [[39, 1, 1, "", "OrderedQueryable"]], "cpl_query.base.ordered_queryable.OrderedQueryable": [[39, 3, 1, "", "then_by"], [39, 3, 1, "", "then_by_descending"]], "cpl_query.base.ordered_queryable_abc": [[39, 1, 1, "", "OrderedQueryableABC"]], "cpl_query.base.ordered_queryable_abc.OrderedQueryableABC": [[39, 3, 1, "", "then_by"], [39, 3, 1, "", "then_by_descending"]], "cpl_query.base.queryable_abc": [[39, 1, 1, "", "QueryableABC"]], "cpl_query.base.queryable_abc.QueryableABC": [[39, 3, 1, "", "all"], [39, 3, 1, "", "any"], [39, 3, 1, "", "average"], [39, 3, 1, "", "contains"], [39, 3, 1, "", "count"], [39, 3, 1, "", "distinct"], [39, 3, 1, "", "element_at"], [39, 3, 1, "", "element_at_or_default"], [39, 3, 1, "", "first"], [39, 3, 1, "", "first_or_default"], [39, 3, 1, "", "for_each"], [39, 3, 1, "", "group_by"], [39, 3, 1, "", "last"], [39, 3, 1, "", "last_or_default"], [39, 3, 1, "", "max"], [39, 3, 1, "", "median"], [39, 3, 1, "", "min"], [39, 3, 1, "", "order_by"], [39, 3, 1, "", "order_by_descending"], [39, 3, 1, "", "reverse"], [39, 3, 1, "", "select"], [39, 3, 1, "", "select_many"], [39, 3, 1, "", "single"], [39, 3, 1, "", "single_or_default"], [39, 3, 1, "", "skip"], [39, 3, 1, "", "skip_last"], [39, 3, 1, "", "split"], [39, 3, 1, "", "sum"], [39, 3, 1, "", "take"], [39, 3, 1, "", "take_last"], [39, 3, 1, "", "where"]], "cpl_query.base.sequence": [[39, 1, 1, "", "Sequence"]], "cpl_query.base.sequence.Sequence": [[39, 3, 1, "", "copy"], [39, 3, 1, "", "empty"], [39, 3, 1, "", "index_of"], [39, 3, 1, "", "range"], [39, 3, 1, "", "to_list"], [39, 4, 1, "", "type"]], "cpl_query.enumerable": [[40, 1, 1, "", "VersionInfo"], [40, 0, 0, "-", "enumerable"], [40, 0, 0, "-", "enumerable_abc"]], "cpl_query.enumerable.VersionInfo": [[40, 2, 1, "", "major"], [40, 2, 1, "", "micro"], [40, 2, 1, "", "minor"]], "cpl_query.enumerable.enumerable": [[40, 1, 1, "", "Enumerable"]], "cpl_query.enumerable.enumerable_abc": [[40, 1, 1, "", "EnumerableABC"]], "cpl_query.enumerable.enumerable_abc.EnumerableABC": [[40, 3, 1, "", "to_iterable"]], "cpl_query.extension": [[41, 1, 1, "", "VersionInfo"], [41, 0, 0, "-", "list"]], "cpl_query.extension.VersionInfo": [[41, 2, 1, "", "major"], [41, 2, 1, "", "micro"], [41, 2, 1, "", "minor"]], "cpl_query.extension.list": [[41, 1, 1, "", "List"]], "cpl_query.extension.list.List": [[41, 3, 1, "", "to_enumerable"], [41, 3, 1, "", "to_iterable"]], "cpl_query.iterable": [[42, 1, 1, "", "VersionInfo"], [42, 0, 0, "-", "iterable"], [42, 0, 0, "-", "iterable_abc"]], "cpl_query.iterable.VersionInfo": [[42, 2, 1, "", "major"], [42, 2, 1, "", "micro"], [42, 2, 1, "", "minor"]], "cpl_query.iterable.iterable": [[42, 1, 1, "", "Iterable"]], "cpl_query.iterable.iterable_abc": [[42, 1, 1, "", "IterableABC"]], "cpl_query.iterable.iterable_abc.IterableABC": [[42, 3, 1, "", "add"], [42, 3, 1, "", "append"], [42, 3, 1, "", "extend"], [42, 3, 1, "", "remove"], [42, 3, 1, "", "remove_at"], [42, 3, 1, "", "to_enumerable"]], "cpl_translation": [[43, 0, 0, "-", "translate_pipe"], [43, 0, 0, "-", "translation_service"], [43, 0, 0, "-", "translation_service_abc"], [43, 0, 0, "-", "translation_settings"]], "cpl_translation.translate_pipe": [[43, 1, 1, "", "TranslatePipe"]], "cpl_translation.translate_pipe.TranslatePipe": [[43, 3, 1, "", "transform"]], "cpl_translation.translation_service": [[43, 1, 1, "", "TranslationService"]], "cpl_translation.translation_service.TranslationService": [[43, 3, 1, "", "load"], [43, 3, 1, "", "load_by_settings"], [43, 3, 1, "", "set_default_lang"], [43, 3, 1, "", "set_lang"], [43, 3, 1, "", "translate"]], "cpl_translation.translation_service_abc": [[43, 1, 1, "", "TranslationServiceABC"]], "cpl_translation.translation_service_abc.TranslationServiceABC": [[43, 3, 1, "", "load"], [43, 3, 1, "", "load_by_settings"], [43, 3, 1, "", "set_default_lang"], [43, 3, 1, "", "set_lang"], [43, 3, 1, "", "translate"]], "cpl_translation.translation_settings": [[43, 1, 1, "", "TranslationSettings"]], "cpl_translation.translation_settings.TranslationSettings": [[43, 4, 1, "", "default_language"], [43, 4, 1, "", "languages"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:attribute", "3": "py:method", "4": "py:property", "5": "py:function"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "attribute", "Python attribute"], "3": ["py", "method", "Python method"], "4": ["py", "property", "Python property"], "5": ["py", "function", "Python function"]}, "titleterms": {"contribut": 0, "cpl": [0, 2, 3, 4, 5, 6, 7, 9, 10, 11, 12, 13, 14, 15, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 31, 32, 33, 34, 35, 36, 37, 39, 40, 41, 42, 46, 47, 49, 60], "found": 0, "bug": 0, "featur": [0, 46, 47], "request": 0, "submiss": 0, "guidelin": 0, "submit": 0, "an": 0, "issu": 0, "pull": 0, "review": 0, "address": 0, "feedback": 0, "code": 0, "rule": 0, "licens": 0, "cli": [1, 8, 50], "refer": [1, 8, 16, 30, 38, 43], "add": 2, "content": [2, 3, 4, 5, 6, 7, 8, 9, 10, 13, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 31, 32, 33, 34, 35, 36, 37, 39, 40, 41, 42, 44, 49, 50, 60], "descript": [2, 3, 4, 5, 6, 7, 9, 10, 13], "argument": [2, 4, 5, 6, 10, 13, 54], "flag": [2, 6, 7, 10, 13, 14], "build": 3, "gener": [4, 60], "schemat": [4, 8, 60], "help": 5, "instal": [6, 50], "new": [7, 60], "project": [7, 49, 60], "type": [7, 60], "overview": [8, 47], "command": [8, 32], "tabl": [8, 44, 49, 50], "basic": 8, "workflow": 8, "languag": 8, "syntax": 8, "rel": 8, "path": 8, "publish": 9, "remov": 10, "run": 11, "start": [12, 45, 49, 50], "uninstal": 13, "updat": 14, "version": 15, "api": 16, "cpl_core": [17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 53], "applic": [17, 31, 56], "packag": [17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 31, 32, 33, 34, 35, 36, 37, 39, 40, 41, 42, 48, 50], "submodul": [17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 31, 32, 33, 34, 35, 36, 37, 39, 40, 41, 42], "application_abc": 17, "modul": [17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 39, 40, 41, 42], "application_build": 17, "application_builder_abc": 17, "application_extension_abc": 17, "startup_abc": 17, "startup_extension_abc": 17, "core": [17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29], "configur": [18, 33], "argument_abc": 18, "argument_build": 18, "argument_executable_abc": 18, "argument_type_enum": 18, "configuration_abc": 18, "configuration_model_abc": 18, "configuration_variable_name_enum": 18, "executable_argu": 18, "flag_argu": 18, "validator_abc": 18, "variable_argu": 18, "consol": [19, 50, 53, 54], "background_color_enum": 19, "console_cal": 19, "foreground_color_enum": 19, "spinner_thread": 19, "databas": [20, 21, 22], "subpackag": 20, "database_set": 20, "database_settings_name_enum": 20, "table_abc": 20, "connect": 21, "database_connect": 21, "database_connection_abc": 21, "context": 22, "database_context": 22, "database_context_abc": 22, "dependency_inject": 23, "scope": 23, "scope_abc": 23, "scope_build": 23, "service_collect": 23, "service_collection_abc": 23, "service_descriptor": 23, "service_lifetime_enum": 23, "service_provid": 23, "paramet": [23, 39], "return": [23, 39], "service_provider_abc": 23, "environ": [24, 50], "application_environ": 24, "application_environment_abc": 24, "environment_name_enum": 24, "log": 25, "logger_abc": 25, "logger_servic": 25, "logging_level_enum": 25, "logging_set": 25, "logging_settings_name_enum": 25, "mail": [26, 59], "email": 26, "email_client_abc": 26, "email_client_servic": 26, "email_client_set": 26, "email_client_settings_name_enum": 26, "pipe": 27, "bool_pip": 27, "first_char_to_lower_pip": 27, "first_to_upper_pip": 27, "ip_address_pip": 27, "pipe_abc": 27, "to_camel_case_pip": 27, "to_snake_case_pip": 27, "version_pip": 27, "time": 28, "time_format_set": 28, "time_format_settings_names_enum": 28, "util": 29, "credential_manag": 29, "pip": 29, "string": 29, "discord": [30, 31, 32, 33, 34, 35, 36, 37], "cpl_discord": [30, 31, 32, 33, 34, 35, 36, 37], "discord_event_types_enum": 30, "discord_bot_application_abc": 31, "discord_command_abc": 32, "discord_commands_meta": 32, "discord_bot_set": 33, "contain": 34, "category_channel": 34, "guild": 34, "member": 34, "role": 34, "text_channel": 34, "thread": 34, "voice_channel": 34, "event": 35, "on_bulk_message_delete_abc": 35, "on_command_abc": 35, "on_command_completion_abc": 35, "on_command_error_abc": 35, "on_connect_abc": 35, "on_disconnect_abc": 35, "on_error_abc": 35, "on_group_join_abc": 35, "on_group_remove_abc": 35, "on_guild_available_abc": 35, "on_guild_channel_create_abc": 35, "on_guild_channel_delete_abc": 35, "on_guild_channel_pins_update_abc": 35, "on_guild_channel_update_abc": 35, "on_guild_emojis_update_abc": 35, "on_guild_integrations_update_abc": 35, "on_guild_join_abc": 35, "on_guild_remove_abc": 35, "on_guild_role_create_abc": 35, "on_guild_role_delete_abc": 35, "on_guild_role_update_abc": 35, "on_guild_unavailable_abc": 35, "on_guild_update_abc": 35, "on_invite_create_abc": 35, "on_invite_delete_abc": 35, "on_member_ban_abc": 35, "on_member_join_abc": 35, "on_member_remove_abc": 35, "on_member_unban_abc": 35, "on_member_update_abc": 35, "on_message_abc": 35, "on_message_delete_abc": 35, "on_message_edit_abc": 35, "on_private_channel_create_abc": 35, "on_private_channel_delete_abc": 35, "on_private_channel_pins_update_abc": 35, "on_private_channel_update_abc": 35, "on_raw_reaction_add_abc": 35, "on_raw_reaction_clear_abc": 35, "on_raw_reaction_clear_emoji_abc": 35, "on_raw_reaction_remove_abc": 35, "on_reaction_add_abc": 35, "on_reaction_clear_abc": 35, "on_reaction_clear_emoji_abc": 35, "on_reaction_remove_abc": 35, "on_ready_abc": 35, "on_resume_abc": 35, "on_typing_abc": 35, "on_user_update_abc": 35, "on_voice_state_update_abc": 35, "on_webhooks_update_abc": 35, "helper": 36, "to_containers_convert": 36, "servic": 37, "command_error_handler_servic": 37, "discord_bot_servic": 37, "discord_bot_service_abc": 37, "discord_collect": 37, "discord_collection_abc": 37, "discord_servic": 37, "discord_service_abc": 37, "queri": [38, 39, 40, 41, 42, 50], "cpl_queri": [39, 40, 41, 42], "base": 39, "default_lambda": 39, "ordered_query": 39, "ordered_queryable_abc": 39, "queryable_abc": 39, "rais": 39, "sequenc": 39, "enumer": 40, "enumerable_abc": 40, "extens": 41, "list": 41, "iter": 42, "iterable_abc": 42, "translat": 43, "cpl_translat": 43, "translate_pip": 43, "translation_servic": 43, "translation_service_abc": 43, "translation_set": 43, "deprec": 44, "configurationmodelabc": 44, "from_dict": 44, "method": 44, "get": [45, 49], "introduct": [46, 47], "doc": [46, 47], "manual": 46, "explor": 47, "prerequisit": [49, 50, 60], "creat": [49, 50, 55], "menu": 49, "what": [49, 50], "": [49, 50], "next": [49, 50], "set": 50, "up": 50, "local": 50, "workspac": 50, "initi": 50, "app": 50, "librari": 50, "tutori": 51, "us": [52, 53, 58, 60], "appset": 52, "json": 52, "come": [52, 53, 54, 55, 56, 57, 58, 59], "soon": [52, 53, 54, 55, 56, 57, 58, 59], "handl": 54, "startup": [55, 57], "class": 55, "extend": [56, 57], "builtin": 58, "logger": 58, "send": 59, "g": 60, "n": 60, "templat": 60}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx": 57}, "alltitles": {"Contributing to CPL": [[0, "contributing-to-cpl"]], "Found a Bug?": [[0, "found-a-bug"]], "Feature Request": [[0, "feature-request"]], "Submission Guidelines": [[0, "submission-guidelines"]], "Submitting an Issue": [[0, "submitting-an-issue"]], "Submitting a Pull Request": [[0, "submitting-a-pull-request"]], "Reviewing a Pull Request": [[0, "reviewing-a-pull-request"]], "Addressing review feedback": [[0, "addressing-review-feedback"]], "Coding Rules": [[0, "coding-rules"]], "License": [[0, "license"]], "CLI reference": [[1, "cli-reference"]], "cpl add": [[2, "cpl-add"]], "Contents": [[2, "contents"], [3, "contents"], [4, "contents"], [5, "contents"], [6, "contents"], [7, "contents"], [9, "contents"], [10, "contents"], [13, "contents"], [60, "contents"]], "Description": [[2, "description"], [3, "description"], [4, "description"], [5, "description"], [6, "description"], [7, "description"], [9, "description"], [10, "description"], [13, "description"]], "Arguments": [[2, "arguments"], [4, "arguments"], [5, "arguments"], [6, "arguments"], [10, "arguments"], [13, "arguments"]], "Flags": [[2, "flags"], [6, "flags"], [7, "flags"], [10, "flags"], [13, "flags"], [14, "flags"]], "cpl build": [[3, "cpl-build"]], "cpl generate": [[4, "cpl-generate"]], "Schematics": [[4, "schematics"], [8, "schematics"]], "cpl help": [[5, "cpl-help"]], "cpl install": [[6, "cpl-install"]], "cpl new": [[7, "cpl-new"]], "Project types": [[7, "project-types"]], "CLI Overview and Command Reference": [[8, "cli-overview-and-command-reference"]], "Table of Contents": [[8, "table-of-contents"], [44, "table-of-contents"], [49, "table-of-contents"], [50, "table-of-contents"]], "Basic workflow": [[8, "basic-workflow"]], "CLI command-language syntax": [[8, "cli-command-language-syntax"]], "Relative paths": [[8, "relative-paths"]], "Command overview": [[8, "command-overview"]], "cpl publish": [[9, "cpl-publish"]], "cpl remove": [[10, "cpl-remove"]], "cpl run": [[11, "cpl-run"]], "cpl start": [[12, "cpl-start"]], "cpl uninstall": [[13, "cpl-uninstall"]], "cpl update": [[14, "cpl-update"]], "cpl version": [[15, "cpl-version"]], "API reference": [[16, "api-reference"]], "cpl_core.application package": [[17, "cpl-core-application-package"]], "Submodules": [[17, "submodules"], [18, "submodules"], [19, "submodules"], [20, "submodules"], [21, "submodules"], [22, "submodules"], [23, "submodules"], [24, "submodules"], [25, "submodules"], [26, "submodules"], [27, "submodules"], [28, "submodules"], [29, "submodules"], [31, "submodules"], [32, "submodules"], [33, "submodules"], [34, "submodules"], [35, "submodules"], [36, "submodules"], [37, "submodules"], [39, "submodules"], [40, "submodules"], [41, "submodules"], [42, "submodules"]], "cpl_core.application.application_abc module": [[17, "module-cpl_core.application.application_abc"]], "cpl_core.application.application_builder module": [[17, "module-cpl_core.application.application_builder"]], "cpl_core.application.application_builder_abc module": [[17, "module-cpl_core.application.application_builder_abc"]], "cpl_core.application.application_extension_abc module": [[17, "module-cpl_core.application.application_extension_abc"]], "cpl_core.application.startup_abc module": [[17, "module-cpl_core.application.startup_abc"]], "cpl_core.application.startup_extension_abc module": [[17, "module-cpl_core.application.startup_extension_abc"]], "Module contents": [[17, "module-cpl_core.application"], [18, "module-cpl_core.configuration"], [19, "module-cpl_core.console"], [20, "module-cpl_core.database"], [21, "module-cpl_core.database.connection"], [22, "module-cpl_core.database.context"], [23, "module-cpl_core.dependency_injection"], [24, "module-cpl_core.environment"], [25, "module-cpl_core.logging"], [26, "module-cpl_core.mailing"], [27, "module-cpl_core.pipes"], [28, "module-cpl_core.time"], [29, "module-cpl_core.utils"], [31, "module-cpl_discord.application"], [32, "module-cpl_discord.command"], [33, "module-cpl_discord.configuration"], [34, "module-cpl_discord.container"], [35, "module-cpl_discord.events"], [36, "module-cpl_discord.helper"], [37, "module-cpl_discord.service"], [39, "module-cpl_query.base"], [40, "module-cpl_query.enumerable"], [41, "module-cpl_query.extension"], [42, "module-cpl_query.iterable"]], "cpl-core CPL core": [[17, "cpl-core-cpl-core"], [18, "cpl-core-cpl-core"], [19, "cpl-core-cpl-core"], [20, "cpl-core-cpl-core"], [21, "cpl-core-cpl-core"], [22, "cpl-core-cpl-core"], [23, "cpl-core-cpl-core"], [24, "cpl-core-cpl-core"], [25, "cpl-core-cpl-core"], [26, "cpl-core-cpl-core"], [27, "cpl-core-cpl-core"], [28, "cpl-core-cpl-core"], [29, "cpl-core-cpl-core"]], "cpl_core.configuration package": [[18, "cpl-core-configuration-package"]], "cpl_core.configuration.argument_abc module": [[18, "module-cpl_core.configuration.argument_abc"]], "cpl_core.configuration.argument_builder module": [[18, "module-cpl_core.configuration.argument_builder"]], "cpl_core.configuration.argument_executable_abc module": [[18, "module-cpl_core.configuration.argument_executable_abc"]], "cpl_core.configuration.argument_type_enum module": [[18, "module-cpl_core.configuration.argument_type_enum"]], "cpl_core.configuration.configuration module": [[18, "module-cpl_core.configuration.configuration"]], "cpl_core.configuration.configuration_abc module": [[18, "module-cpl_core.configuration.configuration_abc"]], "cpl_core.configuration.configuration_model_abc module": [[18, "module-cpl_core.configuration.configuration_model_abc"]], "cpl_core.configuration.configuration_variable_name_enum module": [[18, "module-cpl_core.configuration.configuration_variable_name_enum"]], "cpl_core.configuration.executable_argument module": [[18, "module-cpl_core.configuration.executable_argument"]], "cpl_core.configuration.flag_argument module": [[18, "module-cpl_core.configuration.flag_argument"]], "cpl_core.configuration.validator_abc module": [[18, "module-cpl_core.configuration.validator_abc"]], "cpl_core.configuration.variable_argument module": [[18, "module-cpl_core.configuration.variable_argument"]], "cpl_core.console package": [[19, "cpl-core-console-package"]], "cpl_core.console.background_color_enum module": [[19, "module-cpl_core.console.background_color_enum"]], "cpl_core.console.console module": [[19, "module-cpl_core.console.console"]], "cpl_core.console.console_call module": [[19, "module-cpl_core.console.console_call"]], "cpl_core.console.foreground_color_enum module": [[19, "module-cpl_core.console.foreground_color_enum"]], "cpl_core.console.spinner_thread module": [[19, "module-cpl_core.console.spinner_thread"]], "cpl_core.database package": [[20, "cpl-core-database-package"]], "Subpackages": [[20, "subpackages"]], "cpl_core.database.database_settings module": [[20, "module-cpl_core.database.database_settings"]], "cpl_core.database.database_settings_name_enum module": [[20, "module-cpl_core.database.database_settings_name_enum"]], "cpl_core.database.table_abc module": [[20, "module-cpl_core.database.table_abc"]], "cpl_core.database.connection package": [[21, "cpl-core-database-connection-package"]], "cpl_core.database.connection.database_connection module": [[21, "module-cpl_core.database.connection.database_connection"]], "cpl_core.database.connection.database_connection_abc module": [[21, "module-cpl_core.database.connection.database_connection_abc"]], "cpl_core.database.context package": [[22, "cpl-core-database-context-package"]], "cpl_core.database.context.database_context module": [[22, "module-cpl_core.database.context.database_context"]], "cpl_core.database.context.database_context_abc module": [[22, "module-cpl_core.database.context.database_context_abc"]], "cpl_core.dependency_injection package": [[23, "cpl-core-dependency-injection-package"]], "cpl_core.dependency_injection.scope module": [[23, "module-cpl_core.dependency_injection.scope"]], "cpl_core.dependency_injection.scope_abc module": [[23, "module-cpl_core.dependency_injection.scope_abc"]], "cpl_core.dependency_injection.scope_builder module": [[23, "module-cpl_core.dependency_injection.scope_builder"]], "cpl_core.dependency_injection.service_collection module": [[23, "module-cpl_core.dependency_injection.service_collection"]], "cpl_core.dependency_injection.service_collection_abc module": [[23, "module-cpl_core.dependency_injection.service_collection_abc"]], "cpl_core.dependency_injection.service_descriptor module": [[23, "module-cpl_core.dependency_injection.service_descriptor"]], "cpl_core.dependency_injection.service_lifetime_enum module": [[23, "module-cpl_core.dependency_injection.service_lifetime_enum"]], "cpl_core.dependency_injection.service_provider module": [[23, "module-cpl_core.dependency_injection.service_provider"]], "Parameter": [[23, "parameter"], [23, "id1"], [23, "id3"], [23, "id5"], [23, "id7"], [23, "id8"], [23, "id11"], [23, "id13"], [23, "id15"], [23, "id17"], [39, "parameter"], [39, "id1"], [39, "id3"], [39, "id5"], [39, "id7"], [39, "id9"], [39, "id11"], [39, "id13"], [39, "id17"], [39, "id21"], [39, "id24"], [39, "id26"], [39, "id28"], [39, "id35"], [39, "id37"], [39, "id39"], [39, "id41"], [39, "id43"], [39, "id45"], [39, "id47"]], "Returns": [[23, "returns"], [23, "id2"], [23, "id4"], [23, "id6"], [23, "id9"], [23, "id10"], [23, "id12"], [23, "id14"], [23, "id16"], [39, "returns"], [39, "id2"], [39, "id4"], [39, "id6"], [39, "id8"], [39, "id10"], [39, "id12"], [39, "id14"], [39, "id15"], [39, "id16"], [39, "id18"], [39, "id19"], [39, "id20"], [39, "id22"], [39, "id23"], [39, "id25"], [39, "id27"], [39, "id29"], [39, "id30"], [39, "id31"], [39, "id32"], [39, "id33"], [39, "id34"], [39, "id36"], [39, "id38"], [39, "id40"], [39, "id42"], [39, "id44"], [39, "id46"], [39, "id48"]], "cpl_core.dependency_injection.service_provider_abc module": [[23, "module-cpl_core.dependency_injection.service_provider_abc"]], "cpl_core.environment package": [[24, "cpl-core-environment-package"]], "cpl_core.environment.application_environment module": [[24, "module-cpl_core.environment.application_environment"]], "cpl_core.environment.application_environment_abc module": [[24, "module-cpl_core.environment.application_environment_abc"]], "cpl_core.environment.environment_name_enum module": [[24, "module-cpl_core.environment.environment_name_enum"]], "cpl_core.logging package": [[25, "cpl-core-logging-package"]], "cpl_core.logging.logger_abc module": [[25, "module-cpl_core.logging.logger_abc"]], "cpl_core.logging.logger_service module": [[25, "module-cpl_core.logging.logger_service"]], "cpl_core.logging.logging_level_enum module": [[25, "module-cpl_core.logging.logging_level_enum"]], "cpl_core.logging.logging_settings module": [[25, "module-cpl_core.logging.logging_settings"]], "cpl_core.logging.logging_settings_name_enum module": [[25, "module-cpl_core.logging.logging_settings_name_enum"]], "cpl_core.mailing package": [[26, "cpl-core-mailing-package"]], "cpl_core.mailing.email module": [[26, "module-cpl_core.mailing.email"]], "cpl_core.mailing.email_client_abc module": [[26, "module-cpl_core.mailing.email_client_abc"]], "cpl_core.mailing.email_client_service module": [[26, "module-cpl_core.mailing.email_client_service"]], "cpl_core.mailing.email_client_settings module": [[26, "module-cpl_core.mailing.email_client_settings"]], "cpl_core.mailing.email_client_settings_name_enum module": [[26, "module-cpl_core.mailing.email_client_settings_name_enum"]], "cpl_core.pipes package": [[27, "cpl-core-pipes-package"]], "cpl_core.pipes.bool_pipe module": [[27, "module-cpl_core.pipes.bool_pipe"]], "cpl_core.pipes.first_char_to_lower_pipe module": [[27, "module-cpl_core.pipes.first_char_to_lower_pipe"]], "cpl_core.pipes.first_to_upper_pipe module": [[27, "module-cpl_core.pipes.first_to_upper_pipe"]], "cpl_core.pipes.ip_address_pipe module": [[27, "module-cpl_core.pipes.ip_address_pipe"]], "cpl_core.pipes.pipe_abc module": [[27, "module-cpl_core.pipes.pipe_abc"]], "cpl_core.pipes.to_camel_case_pipe module": [[27, "module-cpl_core.pipes.to_camel_case_pipe"]], "cpl_core.pipes.to_snake_case_pipe module": [[27, "module-cpl_core.pipes.to_snake_case_pipe"]], "cpl_core.pipes.version_pipe module": [[27, "module-cpl_core.pipes.version_pipe"]], "cpl_core.time package": [[28, "cpl-core-time-package"]], "cpl_core.time.time_format_settings module": [[28, "module-cpl_core.time.time_format_settings"]], "cpl_core.time.time_format_settings_names_enum module": [[28, "module-cpl_core.time.time_format_settings_names_enum"]], "cpl_core.utils package": [[29, "cpl-core-utils-package"]], "cpl_core.utils.credential_manager module": [[29, "module-cpl_core.utils.credential_manager"]], "cpl_core.utils.pip module": [[29, "module-cpl_core.utils.pip"]], "cpl_core.utils.string module": [[29, "module-cpl_core.utils.string"]], "Discord Reference": [[30, "discord-reference"]], "cpl_discord.discord_event_types_enum module": [[30, "module-cpl_discord.discord_event_types_enum"]], "cpl_discord.application package": [[31, "cpl-discord-application-package"]], "cpl_discord.application.discord_bot_application_abc module": [[31, "module-cpl_discord.application.discord_bot_application_abc"]], "cpl-discord CPL Discord": [[31, "cpl-discord-cpl-discord"], [32, "cpl-discord-cpl-discord"], [33, "cpl-discord-cpl-discord"], [34, "cpl-discord-cpl-discord"], [35, "cpl-discord-cpl-discord"], [36, "cpl-discord-cpl-discord"], [37, "cpl-discord-cpl-discord"]], "cpl_discord.command package": [[32, "cpl-discord-command-package"]], "cpl_discord.command.discord_command_abc module": [[32, "module-cpl_discord.command.discord_command_abc"]], "cpl_discord.command.discord_commands_meta module": [[32, "module-cpl_discord.command.discord_commands_meta"]], "cpl_discord.configuration package": [[33, "cpl-discord-configuration-package"]], "cpl_discord.configuration.discord_bot_settings module": [[33, "module-cpl_discord.configuration.discord_bot_settings"]], "cpl_discord.container package": [[34, "cpl-discord-container-package"]], "cpl_discord.container.category_channel module": [[34, "module-cpl_discord.container.category_channel"]], "cpl_discord.container.container module": [[34, "module-cpl_discord.container.container"]], "cpl_discord.container.guild module": [[34, "module-cpl_discord.container.guild"]], "cpl_discord.container.member module": [[34, "module-cpl_discord.container.member"]], "cpl_discord.container.role module": [[34, "module-cpl_discord.container.role"]], "cpl_discord.container.text_channel module": [[34, "module-cpl_discord.container.text_channel"]], "cpl_discord.container.thread module": [[34, "module-cpl_discord.container.thread"]], "cpl_discord.container.voice_channel module": [[34, "module-cpl_discord.container.voice_channel"]], "cpl_discord.events package": [[35, "cpl-discord-events-package"]], "cpl_discord.events.on_bulk_message_delete_abc module": [[35, "module-cpl_discord.events.on_bulk_message_delete_abc"]], "cpl_discord.events.on_command_abc module": [[35, "module-cpl_discord.events.on_command_abc"]], "cpl_discord.events.on_command_completion_abc module": [[35, "module-cpl_discord.events.on_command_completion_abc"]], "cpl_discord.events.on_command_error_abc module": [[35, "module-cpl_discord.events.on_command_error_abc"]], "cpl_discord.events.on_connect_abc module": [[35, "module-cpl_discord.events.on_connect_abc"]], "cpl_discord.events.on_disconnect_abc module": [[35, "module-cpl_discord.events.on_disconnect_abc"]], "cpl_discord.events.on_error_abc module": [[35, "module-cpl_discord.events.on_error_abc"]], "cpl_discord.events.on_group_join_abc module": [[35, "module-cpl_discord.events.on_group_join_abc"]], "cpl_discord.events.on_group_remove_abc module": [[35, "module-cpl_discord.events.on_group_remove_abc"]], "cpl_discord.events.on_guild_available_abc module": [[35, "module-cpl_discord.events.on_guild_available_abc"]], "cpl_discord.events.on_guild_channel_create_abc module": [[35, "module-cpl_discord.events.on_guild_channel_create_abc"]], "cpl_discord.events.on_guild_channel_delete_abc module": [[35, "module-cpl_discord.events.on_guild_channel_delete_abc"]], "cpl_discord.events.on_guild_channel_pins_update_abc module": [[35, "module-cpl_discord.events.on_guild_channel_pins_update_abc"]], "cpl_discord.events.on_guild_channel_update_abc module": [[35, "module-cpl_discord.events.on_guild_channel_update_abc"]], "cpl_discord.events.on_guild_emojis_update_abc module": [[35, "module-cpl_discord.events.on_guild_emojis_update_abc"]], "cpl_discord.events.on_guild_integrations_update_abc module": [[35, "module-cpl_discord.events.on_guild_integrations_update_abc"]], "cpl_discord.events.on_guild_join_abc module": [[35, "module-cpl_discord.events.on_guild_join_abc"]], "cpl_discord.events.on_guild_remove_abc module": [[35, "module-cpl_discord.events.on_guild_remove_abc"]], "cpl_discord.events.on_guild_role_create_abc module": [[35, "module-cpl_discord.events.on_guild_role_create_abc"]], "cpl_discord.events.on_guild_role_delete_abc module": [[35, "module-cpl_discord.events.on_guild_role_delete_abc"]], "cpl_discord.events.on_guild_role_update_abc module": [[35, "module-cpl_discord.events.on_guild_role_update_abc"]], "cpl_discord.events.on_guild_unavailable_abc module": [[35, "module-cpl_discord.events.on_guild_unavailable_abc"]], "cpl_discord.events.on_guild_update_abc module": [[35, "module-cpl_discord.events.on_guild_update_abc"]], "cpl_discord.events.on_invite_create_abc module": [[35, "module-cpl_discord.events.on_invite_create_abc"]], "cpl_discord.events.on_invite_delete_abc module": [[35, "module-cpl_discord.events.on_invite_delete_abc"]], "cpl_discord.events.on_member_ban_abc module": [[35, "module-cpl_discord.events.on_member_ban_abc"]], "cpl_discord.events.on_member_join_abc module": [[35, "module-cpl_discord.events.on_member_join_abc"]], "cpl_discord.events.on_member_remove_abc module": [[35, "module-cpl_discord.events.on_member_remove_abc"]], "cpl_discord.events.on_member_unban_abc module": [[35, "module-cpl_discord.events.on_member_unban_abc"]], "cpl_discord.events.on_member_update_abc module": [[35, "module-cpl_discord.events.on_member_update_abc"]], "cpl_discord.events.on_message_abc module": [[35, "module-cpl_discord.events.on_message_abc"]], "cpl_discord.events.on_message_delete_abc module": [[35, "module-cpl_discord.events.on_message_delete_abc"]], "cpl_discord.events.on_message_edit_abc module": [[35, "module-cpl_discord.events.on_message_edit_abc"]], "cpl_discord.events.on_private_channel_create_abc module": [[35, "module-cpl_discord.events.on_private_channel_create_abc"]], "cpl_discord.events.on_private_channel_delete_abc module": [[35, "module-cpl_discord.events.on_private_channel_delete_abc"]], "cpl_discord.events.on_private_channel_pins_update_abc module": [[35, "module-cpl_discord.events.on_private_channel_pins_update_abc"]], "cpl_discord.events.on_private_channel_update_abc module": [[35, "module-cpl_discord.events.on_private_channel_update_abc"]], "cpl_discord.events.on_raw_reaction_add_abc module": [[35, "module-cpl_discord.events.on_raw_reaction_add_abc"]], "cpl_discord.events.on_raw_reaction_clear_abc module": [[35, "module-cpl_discord.events.on_raw_reaction_clear_abc"]], "cpl_discord.events.on_raw_reaction_clear_emoji_abc module": [[35, "module-cpl_discord.events.on_raw_reaction_clear_emoji_abc"]], "cpl_discord.events.on_raw_reaction_remove_abc module": [[35, "module-cpl_discord.events.on_raw_reaction_remove_abc"]], "cpl_discord.events.on_reaction_add_abc module": [[35, "module-cpl_discord.events.on_reaction_add_abc"]], "cpl_discord.events.on_reaction_clear_abc module": [[35, "module-cpl_discord.events.on_reaction_clear_abc"]], "cpl_discord.events.on_reaction_clear_emoji_abc module": [[35, "module-cpl_discord.events.on_reaction_clear_emoji_abc"]], "cpl_discord.events.on_reaction_remove_abc module": [[35, "module-cpl_discord.events.on_reaction_remove_abc"]], "cpl_discord.events.on_ready_abc module": [[35, "module-cpl_discord.events.on_ready_abc"]], "cpl_discord.events.on_resume_abc module": [[35, "module-cpl_discord.events.on_resume_abc"]], "cpl_discord.events.on_typing_abc module": [[35, "module-cpl_discord.events.on_typing_abc"]], "cpl_discord.events.on_user_update_abc module": [[35, "module-cpl_discord.events.on_user_update_abc"]], "cpl_discord.events.on_voice_state_update_abc module": [[35, "module-cpl_discord.events.on_voice_state_update_abc"]], "cpl_discord.events.on_webhooks_update_abc module": [[35, "module-cpl_discord.events.on_webhooks_update_abc"]], "cpl_discord.helper package": [[36, "cpl-discord-helper-package"]], "cpl_discord.helper.to_containers_converter module": [[36, "module-cpl_discord.helper.to_containers_converter"]], "cpl_discord.service package": [[37, "cpl-discord-service-package"]], "cpl_discord.service.command_error_handler_service module": [[37, "module-cpl_discord.service.command_error_handler_service"]], "cpl_discord.service.discord_bot_service module": [[37, "module-cpl_discord.service.discord_bot_service"]], "cpl_discord.service.discord_bot_service_abc module": [[37, "module-cpl_discord.service.discord_bot_service_abc"]], "cpl_discord.service.discord_collection module": [[37, "module-cpl_discord.service.discord_collection"]], "cpl_discord.service.discord_collection_abc module": [[37, "module-cpl_discord.service.discord_collection_abc"]], "cpl_discord.service.discord_service module": [[37, "module-cpl_discord.service.discord_service"]], "cpl_discord.service.discord_service_abc module": [[37, "module-cpl_discord.service.discord_service_abc"]], "Query reference": [[38, "query-reference"]], "cpl_query.base package": [[39, "cpl-query-base-package"]], "cpl_query.base.default_lambda module": [[39, "module-cpl_query.base.default_lambda"]], "cpl_query.base.ordered_queryable module": [[39, "module-cpl_query.base.ordered_queryable"]], "cpl_query.base.ordered_queryable_abc module": [[39, "module-cpl_query.base.ordered_queryable_abc"]], "cpl_query.base.queryable_abc module": [[39, "module-cpl_query.base.queryable_abc"]], "Raises": [[39, "raises"]], "cpl_query.base.sequence module": [[39, "module-cpl_query.base.sequence"]], "cpl-query CPL Queries": [[39, "cpl-query-cpl-queries"], [40, "cpl-query-cpl-queries"], [41, "cpl-query-cpl-queries"], [42, "cpl-query-cpl-queries"]], "cpl_query.enumerable package": [[40, "cpl-query-enumerable-package"]], "cpl_query.enumerable.enumerable module": [[40, "module-cpl_query.enumerable.enumerable"]], "cpl_query.enumerable.enumerable_abc module": [[40, "module-cpl_query.enumerable.enumerable_abc"]], "cpl_query.extension package": [[41, "cpl-query-extension-package"]], "cpl_query.extension.list module": [[41, "module-cpl_query.extension.list"]], "cpl_query.iterable package": [[42, "cpl-query-iterable-package"]], "cpl_query.iterable.iterable module": [[42, "module-cpl_query.iterable.iterable"]], "cpl_query.iterable.iterable_abc module": [[42, "module-cpl_query.iterable.iterable_abc"]], "Translation reference": [[43, "translation-reference"]], "cpl_translation.translate_pipe": [[43, "module-cpl_translation.translate_pipe"]], "cpl_translation.translation_service": [[43, "module-cpl_translation.translation_service"]], "cpl_translation.translation_service_abc": [[43, "module-cpl_translation.translation_service_abc"]], "cpl_translation.translation_settings": [[43, "module-cpl_translation.translation_settings"]], "Deprecated": [[44, "deprecated"]], "ConfigurationModelABC from_dict method": [[44, "configurationmodelabc-from-dict-method"]], "Getting started": [[45, "getting-started"]], "Introduction to the CPL Docs": [[46, "introduction-to-the-cpl-docs"], [47, "introduction-to-the-cpl-docs"]], "Features": [[46, "features"]], "Manuals": [[46, "manuals"]], "Feature overview": [[47, "feature-overview"]], "Explore": [[47, "explore"]], "Packages": [[48, "packages"]], "Getting started with CPL": [[49, "getting-started-with-cpl"]], "Prerequisites": [[49, "prerequisites"], [50, "prerequisites"], [60, "prerequisites"]], "Create the project": [[49, "create-the-project"]], "Create a menu": [[49, "create-a-menu"]], "What\u2019s next": [[49, "what-s-next"], [50, "what-s-next"]], "Setting up the local environment and workspace": [[50, "setting-up-the-local-environment-and-workspace"]], "Install the package": [[50, "install-the-package"]], "Install the CLI": [[50, "install-the-cli"]], "Install the query": [[50, "install-the-query"]], "Create initial console app": [[50, "create-initial-console-app"]], "Create initial library": [[50, "create-initial-library"]], "Start the app": [[50, "start-the-app"]], "Tutorials": [[51, "tutorials"]], "Using appsettings.json": [[52, "using-appsettings-json"]], "Coming soon": [[52, "coming-soon"], [53, "coming-soon"], [54, "coming-soon"], [55, "coming-soon"], [56, "coming-soon"], [57, "coming-soon"], [58, "coming-soon"], [59, "coming-soon"]], "Use cpl_core.console.Console": [[53, "use-cpl-core-console-console"]], "Handle console arguments": [[54, "handle-console-arguments"]], "Create startup class": [[55, "create-startup-class"]], "Extend application": [[56, "extend-application"]], "Extend startup": [[57, "extend-startup"]], "Use builtin logger": [[58, "use-builtin-logger"]], "Send mails": [[59, "send-mails"]], "Using cpl g & cpl n templating": [[60, "using-cpl-g-cpl-n-templating"]], "cpl generate schematics": [[60, "cpl-generate-schematics"]], "cpl new project types": [[60, "cpl-new-project-types"]]}, "indexentries": {"applicationabc (class in cpl_core.application.application_abc)": [[17, "cpl_core.application.application_abc.ApplicationABC"]], "applicationbuilder (class in cpl_core.application.application_builder)": [[17, "cpl_core.application.application_builder.ApplicationBuilder"]], "applicationbuilderabc (class in cpl_core.application.application_builder_abc)": [[17, "cpl_core.application.application_builder_abc.ApplicationBuilderABC"]], "applicationextensionabc (class in cpl_core.application.application_extension_abc)": [[17, "cpl_core.application.application_extension_abc.ApplicationExtensionABC"]], "startupabc (class in cpl_core.application.startup_abc)": [[17, "cpl_core.application.startup_abc.StartupABC"]], "startupextensionabc (class in cpl_core.application.startup_extension_abc)": [[17, "cpl_core.application.startup_extension_abc.StartupExtensionABC"]], "versioninfo (class in cpl_core.application)": [[17, "cpl_core.application.VersionInfo"]], "build() (cpl_core.application.application_builder.applicationbuilder method)": [[17, "cpl_core.application.application_builder.ApplicationBuilder.build"]], "build() (cpl_core.application.application_builder_abc.applicationbuilderabc method)": [[17, "cpl_core.application.application_builder_abc.ApplicationBuilderABC.build"]], "build_async() (cpl_core.application.application_builder.applicationbuilder method)": [[17, "cpl_core.application.application_builder.ApplicationBuilder.build_async"]], "build_async() (cpl_core.application.application_builder_abc.applicationbuilderabc method)": [[17, "cpl_core.application.application_builder_abc.ApplicationBuilderABC.build_async"]], "configure() (cpl_core.application.application_abc.applicationabc method)": [[17, "cpl_core.application.application_abc.ApplicationABC.configure"]], "configure_configuration() (cpl_core.application.startup_abc.startupabc method)": [[17, "cpl_core.application.startup_abc.StartupABC.configure_configuration"]], "configure_configuration() (cpl_core.application.startup_extension_abc.startupextensionabc method)": [[17, "cpl_core.application.startup_extension_abc.StartupExtensionABC.configure_configuration"]], "configure_services() (cpl_core.application.startup_abc.startupabc method)": [[17, "cpl_core.application.startup_abc.StartupABC.configure_services"]], "configure_services() (cpl_core.application.startup_extension_abc.startupextensionabc method)": [[17, "cpl_core.application.startup_extension_abc.StartupExtensionABC.configure_services"]], "cpl_core.application": [[17, "module-cpl_core.application"]], "cpl_core.application.application_abc": [[17, "module-cpl_core.application.application_abc"]], "cpl_core.application.application_builder": [[17, "module-cpl_core.application.application_builder"]], "cpl_core.application.application_builder_abc": [[17, "module-cpl_core.application.application_builder_abc"]], "cpl_core.application.application_extension_abc": [[17, "module-cpl_core.application.application_extension_abc"]], "cpl_core.application.startup_abc": [[17, "module-cpl_core.application.startup_abc"]], "cpl_core.application.startup_extension_abc": [[17, "module-cpl_core.application.startup_extension_abc"]], "main() (cpl_core.application.application_abc.applicationabc method)": [[17, "cpl_core.application.application_abc.ApplicationABC.main"]], "major (cpl_core.application.versioninfo attribute)": [[17, "cpl_core.application.VersionInfo.major"]], "micro (cpl_core.application.versioninfo attribute)": [[17, "cpl_core.application.VersionInfo.micro"]], "minor (cpl_core.application.versioninfo attribute)": [[17, "cpl_core.application.VersionInfo.minor"]], "module": [[17, "module-cpl_core.application"], [17, "module-cpl_core.application.application_abc"], [17, "module-cpl_core.application.application_builder"], [17, "module-cpl_core.application.application_builder_abc"], [17, "module-cpl_core.application.application_extension_abc"], [17, "module-cpl_core.application.startup_abc"], [17, "module-cpl_core.application.startup_extension_abc"], [18, "module-cpl_core.configuration"], [18, "module-cpl_core.configuration.argument_abc"], [18, "module-cpl_core.configuration.argument_builder"], [18, "module-cpl_core.configuration.argument_executable_abc"], [18, "module-cpl_core.configuration.argument_type_enum"], [18, "module-cpl_core.configuration.configuration"], [18, "module-cpl_core.configuration.configuration_abc"], [18, "module-cpl_core.configuration.configuration_model_abc"], [18, "module-cpl_core.configuration.configuration_variable_name_enum"], [18, "module-cpl_core.configuration.executable_argument"], [18, "module-cpl_core.configuration.flag_argument"], [18, "module-cpl_core.configuration.validator_abc"], [18, "module-cpl_core.configuration.variable_argument"], [19, "module-cpl_core.console"], [19, "module-cpl_core.console.background_color_enum"], [19, "module-cpl_core.console.console"], [19, "module-cpl_core.console.console_call"], [19, "module-cpl_core.console.foreground_color_enum"], [19, "module-cpl_core.console.spinner_thread"], [20, "module-cpl_core.database"], [20, "module-cpl_core.database.database_settings"], [20, "module-cpl_core.database.database_settings_name_enum"], [20, "module-cpl_core.database.table_abc"], [21, "module-cpl_core.database.connection"], [21, "module-cpl_core.database.connection.database_connection"], [21, "module-cpl_core.database.connection.database_connection_abc"], [22, "module-cpl_core.database.context"], [22, "module-cpl_core.database.context.database_context"], [22, "module-cpl_core.database.context.database_context_abc"], [23, "module-cpl_core.dependency_injection"], [23, "module-cpl_core.dependency_injection.scope"], [23, "module-cpl_core.dependency_injection.scope_abc"], [23, "module-cpl_core.dependency_injection.scope_builder"], [23, "module-cpl_core.dependency_injection.service_collection"], [23, "module-cpl_core.dependency_injection.service_collection_abc"], [23, "module-cpl_core.dependency_injection.service_descriptor"], [23, "module-cpl_core.dependency_injection.service_lifetime_enum"], [23, "module-cpl_core.dependency_injection.service_provider"], [23, "module-cpl_core.dependency_injection.service_provider_abc"], [24, "module-cpl_core.environment"], [24, "module-cpl_core.environment.application_environment"], [24, "module-cpl_core.environment.application_environment_abc"], [24, "module-cpl_core.environment.environment_name_enum"], [25, "module-cpl_core.logging"], [25, "module-cpl_core.logging.logger_abc"], [25, "module-cpl_core.logging.logger_service"], [25, "module-cpl_core.logging.logging_level_enum"], [25, "module-cpl_core.logging.logging_settings"], [25, "module-cpl_core.logging.logging_settings_name_enum"], [26, "module-cpl_core.mailing"], [26, "module-cpl_core.mailing.email"], [26, "module-cpl_core.mailing.email_client_abc"], [26, "module-cpl_core.mailing.email_client_service"], [26, "module-cpl_core.mailing.email_client_settings"], [26, "module-cpl_core.mailing.email_client_settings_name_enum"], [27, "module-cpl_core.pipes"], [27, "module-cpl_core.pipes.bool_pipe"], [27, "module-cpl_core.pipes.first_char_to_lower_pipe"], [27, "module-cpl_core.pipes.first_to_upper_pipe"], [27, "module-cpl_core.pipes.ip_address_pipe"], [27, "module-cpl_core.pipes.pipe_abc"], [27, "module-cpl_core.pipes.to_camel_case_pipe"], [27, "module-cpl_core.pipes.to_snake_case_pipe"], [27, "module-cpl_core.pipes.version_pipe"], [28, "module-cpl_core.time"], [28, "module-cpl_core.time.time_format_settings"], [28, "module-cpl_core.time.time_format_settings_names_enum"], [29, "module-cpl_core.utils"], [29, "module-cpl_core.utils.credential_manager"], [29, "module-cpl_core.utils.pip"], [29, "module-cpl_core.utils.string"], [30, "module-cpl_discord.discord_event_types_enum"], [31, "module-cpl_discord.application"], [31, "module-cpl_discord.application.discord_bot_application_abc"], [32, "module-cpl_discord.command"], [32, "module-cpl_discord.command.discord_command_abc"], [32, "module-cpl_discord.command.discord_commands_meta"], [33, "module-cpl_discord.configuration"], [33, "module-cpl_discord.configuration.discord_bot_settings"], [34, "module-cpl_discord.container"], [34, "module-cpl_discord.container.category_channel"], [34, "module-cpl_discord.container.container"], [34, "module-cpl_discord.container.guild"], [34, "module-cpl_discord.container.member"], [34, "module-cpl_discord.container.role"], [34, "module-cpl_discord.container.text_channel"], [34, "module-cpl_discord.container.thread"], [34, "module-cpl_discord.container.voice_channel"], [35, "module-cpl_discord.events"], [35, "module-cpl_discord.events.on_bulk_message_delete_abc"], [35, "module-cpl_discord.events.on_command_abc"], [35, "module-cpl_discord.events.on_command_completion_abc"], [35, "module-cpl_discord.events.on_command_error_abc"], [35, "module-cpl_discord.events.on_connect_abc"], [35, "module-cpl_discord.events.on_disconnect_abc"], [35, "module-cpl_discord.events.on_error_abc"], [35, "module-cpl_discord.events.on_group_join_abc"], [35, "module-cpl_discord.events.on_group_remove_abc"], [35, "module-cpl_discord.events.on_guild_available_abc"], [35, "module-cpl_discord.events.on_guild_channel_create_abc"], [35, "module-cpl_discord.events.on_guild_channel_delete_abc"], [35, "module-cpl_discord.events.on_guild_channel_pins_update_abc"], [35, "module-cpl_discord.events.on_guild_channel_update_abc"], [35, "module-cpl_discord.events.on_guild_emojis_update_abc"], [35, "module-cpl_discord.events.on_guild_integrations_update_abc"], [35, "module-cpl_discord.events.on_guild_join_abc"], [35, "module-cpl_discord.events.on_guild_remove_abc"], [35, "module-cpl_discord.events.on_guild_role_create_abc"], [35, "module-cpl_discord.events.on_guild_role_delete_abc"], [35, "module-cpl_discord.events.on_guild_role_update_abc"], [35, "module-cpl_discord.events.on_guild_unavailable_abc"], [35, "module-cpl_discord.events.on_guild_update_abc"], [35, "module-cpl_discord.events.on_invite_create_abc"], [35, "module-cpl_discord.events.on_invite_delete_abc"], [35, "module-cpl_discord.events.on_member_ban_abc"], [35, "module-cpl_discord.events.on_member_join_abc"], [35, "module-cpl_discord.events.on_member_remove_abc"], [35, "module-cpl_discord.events.on_member_unban_abc"], [35, "module-cpl_discord.events.on_member_update_abc"], [35, "module-cpl_discord.events.on_message_abc"], [35, "module-cpl_discord.events.on_message_delete_abc"], [35, "module-cpl_discord.events.on_message_edit_abc"], [35, "module-cpl_discord.events.on_private_channel_create_abc"], [35, "module-cpl_discord.events.on_private_channel_delete_abc"], [35, "module-cpl_discord.events.on_private_channel_pins_update_abc"], [35, "module-cpl_discord.events.on_private_channel_update_abc"], [35, "module-cpl_discord.events.on_raw_reaction_add_abc"], [35, "module-cpl_discord.events.on_raw_reaction_clear_abc"], [35, "module-cpl_discord.events.on_raw_reaction_clear_emoji_abc"], [35, "module-cpl_discord.events.on_raw_reaction_remove_abc"], [35, "module-cpl_discord.events.on_reaction_add_abc"], [35, "module-cpl_discord.events.on_reaction_clear_abc"], [35, "module-cpl_discord.events.on_reaction_clear_emoji_abc"], [35, "module-cpl_discord.events.on_reaction_remove_abc"], [35, "module-cpl_discord.events.on_ready_abc"], [35, "module-cpl_discord.events.on_resume_abc"], [35, "module-cpl_discord.events.on_typing_abc"], [35, "module-cpl_discord.events.on_user_update_abc"], [35, "module-cpl_discord.events.on_voice_state_update_abc"], [35, "module-cpl_discord.events.on_webhooks_update_abc"], [36, "module-cpl_discord.helper"], [36, "module-cpl_discord.helper.to_containers_converter"], [37, "module-cpl_discord.service"], [37, "module-cpl_discord.service.command_error_handler_service"], [37, "module-cpl_discord.service.discord_bot_service"], [37, "module-cpl_discord.service.discord_bot_service_abc"], [37, "module-cpl_discord.service.discord_collection"], [37, "module-cpl_discord.service.discord_collection_abc"], [37, "module-cpl_discord.service.discord_service"], [37, "module-cpl_discord.service.discord_service_abc"], [39, "module-cpl_query.base"], [39, "module-cpl_query.base.default_lambda"], [39, "module-cpl_query.base.ordered_queryable"], [39, "module-cpl_query.base.ordered_queryable_abc"], [39, "module-cpl_query.base.queryable_abc"], [39, "module-cpl_query.base.sequence"], [40, "module-cpl_query.enumerable"], [40, "module-cpl_query.enumerable.enumerable"], [40, "module-cpl_query.enumerable.enumerable_abc"], [41, "module-cpl_query.extension"], [41, "module-cpl_query.extension.list"], [42, "module-cpl_query.iterable"], [42, "module-cpl_query.iterable.iterable"], [42, "module-cpl_query.iterable.iterable_abc"], [43, "module-cpl_translation.translate_pipe"], [43, "module-cpl_translation.translation_service"], [43, "module-cpl_translation.translation_service_abc"], [43, "module-cpl_translation.translation_settings"]], "run() (cpl_core.application.application_abc.applicationabc method)": [[17, "cpl_core.application.application_abc.ApplicationABC.run"]], "run() (cpl_core.application.application_extension_abc.applicationextensionabc method)": [[17, "cpl_core.application.application_extension_abc.ApplicationExtensionABC.run"]], "run_async() (cpl_core.application.application_abc.applicationabc method)": [[17, "cpl_core.application.application_abc.ApplicationABC.run_async"]], "use_extension() (cpl_core.application.application_builder.applicationbuilder method)": [[17, "cpl_core.application.application_builder.ApplicationBuilder.use_extension"]], "use_startup() (cpl_core.application.application_builder.applicationbuilder method)": [[17, "cpl_core.application.application_builder.ApplicationBuilder.use_startup"]], "use_startup() (cpl_core.application.application_builder_abc.applicationbuilderabc method)": [[17, "cpl_core.application.application_builder_abc.ApplicationBuilderABC.use_startup"]], "argumentabc (class in cpl_core.configuration.argument_abc)": [[18, "cpl_core.configuration.argument_abc.ArgumentABC"]], "argumentbuilder (class in cpl_core.configuration.argument_builder)": [[18, "cpl_core.configuration.argument_builder.ArgumentBuilder"]], "argumentexecutableabc (class in cpl_core.configuration.argument_executable_abc)": [[18, "cpl_core.configuration.argument_executable_abc.ArgumentExecutableABC"]], "argumenttypeenum (class in cpl_core.configuration.argument_type_enum)": [[18, "cpl_core.configuration.argument_type_enum.ArgumentTypeEnum"]], "configuration (class in cpl_core.configuration.configuration)": [[18, "cpl_core.configuration.configuration.Configuration"]], "configurationabc (class in cpl_core.configuration.configuration_abc)": [[18, "cpl_core.configuration.configuration_abc.ConfigurationABC"]], "configurationmodelabc (class in cpl_core.configuration.configuration_model_abc)": [[18, "cpl_core.configuration.configuration_model_abc.ConfigurationModelABC"]], "configurationvariablenameenum (class in cpl_core.configuration.configuration_variable_name_enum)": [[18, "cpl_core.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum"]], "executable (cpl_core.configuration.argument_type_enum.argumenttypeenum attribute)": [[18, "cpl_core.configuration.argument_type_enum.ArgumentTypeEnum.Executable"]], "executableargument (class in cpl_core.configuration.executable_argument)": [[18, "cpl_core.configuration.executable_argument.ExecutableArgument"]], "flag (cpl_core.configuration.argument_type_enum.argumenttypeenum attribute)": [[18, "cpl_core.configuration.argument_type_enum.ArgumentTypeEnum.Flag"]], "flagargument (class in cpl_core.configuration.flag_argument)": [[18, "cpl_core.configuration.flag_argument.FlagArgument"]], "validatorabc (class in cpl_core.configuration.validator_abc)": [[18, "cpl_core.configuration.validator_abc.ValidatorABC"]], "variable (cpl_core.configuration.argument_type_enum.argumenttypeenum attribute)": [[18, "cpl_core.configuration.argument_type_enum.ArgumentTypeEnum.Variable"]], "variableargument (class in cpl_core.configuration.variable_argument)": [[18, "cpl_core.configuration.variable_argument.VariableArgument"]], "versioninfo (class in cpl_core.configuration)": [[18, "cpl_core.configuration.VersionInfo"]], "add_configuration() (cpl_core.configuration.configuration.configuration method)": [[18, "cpl_core.configuration.configuration.Configuration.add_configuration"]], "add_configuration() (cpl_core.configuration.configuration_abc.configurationabc method)": [[18, "cpl_core.configuration.configuration_abc.ConfigurationABC.add_configuration"]], "add_console_argument() (cpl_core.configuration.argument_abc.argumentabc method)": [[18, "cpl_core.configuration.argument_abc.ArgumentABC.add_console_argument"]], "add_console_argument() (cpl_core.configuration.configuration.configuration method)": [[18, "cpl_core.configuration.configuration.Configuration.add_console_argument"]], "add_console_argument() (cpl_core.configuration.configuration_abc.configurationabc method)": [[18, "cpl_core.configuration.configuration_abc.ConfigurationABC.add_console_argument"]], "add_environment_variables() (cpl_core.configuration.configuration.configuration method)": [[18, "cpl_core.configuration.configuration.Configuration.add_environment_variables"]], "add_environment_variables() (cpl_core.configuration.configuration_abc.configurationabc method)": [[18, "cpl_core.configuration.configuration_abc.ConfigurationABC.add_environment_variables"]], "add_json_file() (cpl_core.configuration.configuration.configuration method)": [[18, "cpl_core.configuration.configuration.Configuration.add_json_file"]], "add_json_file() (cpl_core.configuration.configuration_abc.configurationabc method)": [[18, "cpl_core.configuration.configuration_abc.ConfigurationABC.add_json_file"]], "additional_arguments (cpl_core.configuration.configuration.configuration property)": [[18, "cpl_core.configuration.configuration.Configuration.additional_arguments"]], "additional_arguments (cpl_core.configuration.configuration_abc.configurationabc property)": [[18, "cpl_core.configuration.configuration_abc.ConfigurationABC.additional_arguments"]], "aliases (cpl_core.configuration.argument_abc.argumentabc property)": [[18, "cpl_core.configuration.argument_abc.ArgumentABC.aliases"]], "argument_error_function (cpl_core.configuration.configuration.configuration property)": [[18, "cpl_core.configuration.configuration.Configuration.argument_error_function"]], "argument_error_function (cpl_core.configuration.configuration_abc.configurationabc property)": [[18, "cpl_core.configuration.configuration_abc.ConfigurationABC.argument_error_function"]], "arguments (cpl_core.configuration.configuration.configuration property)": [[18, "cpl_core.configuration.configuration.Configuration.arguments"]], "arguments (cpl_core.configuration.configuration_abc.configurationabc property)": [[18, "cpl_core.configuration.configuration_abc.ConfigurationABC.arguments"]], "base_func() (in module cpl_core.configuration.configuration_model_abc)": [[18, "cpl_core.configuration.configuration_model_abc.base_func"]], "build_argument() (cpl_core.configuration.argument_builder.argumentbuilder static method)": [[18, "cpl_core.configuration.argument_builder.ArgumentBuilder.build_argument"]], "console_arguments (cpl_core.configuration.argument_abc.argumentabc property)": [[18, "cpl_core.configuration.argument_abc.ArgumentABC.console_arguments"]], "cpl_core.configuration": [[18, "module-cpl_core.configuration"]], "cpl_core.configuration.argument_abc": [[18, "module-cpl_core.configuration.argument_abc"]], "cpl_core.configuration.argument_builder": [[18, "module-cpl_core.configuration.argument_builder"]], "cpl_core.configuration.argument_executable_abc": [[18, "module-cpl_core.configuration.argument_executable_abc"]], "cpl_core.configuration.argument_type_enum": [[18, "module-cpl_core.configuration.argument_type_enum"]], "cpl_core.configuration.configuration": [[18, "module-cpl_core.configuration.configuration"]], "cpl_core.configuration.configuration_abc": [[18, "module-cpl_core.configuration.configuration_abc"]], "cpl_core.configuration.configuration_model_abc": [[18, "module-cpl_core.configuration.configuration_model_abc"]], "cpl_core.configuration.configuration_variable_name_enum": [[18, "module-cpl_core.configuration.configuration_variable_name_enum"]], "cpl_core.configuration.executable_argument": [[18, "module-cpl_core.configuration.executable_argument"]], "cpl_core.configuration.flag_argument": [[18, "module-cpl_core.configuration.flag_argument"]], "cpl_core.configuration.validator_abc": [[18, "module-cpl_core.configuration.validator_abc"]], "cpl_core.configuration.variable_argument": [[18, "module-cpl_core.configuration.variable_argument"]], "create_console_argument() (cpl_core.configuration.configuration.configuration method)": [[18, "cpl_core.configuration.configuration.Configuration.create_console_argument"]], "create_console_argument() (cpl_core.configuration.configuration_abc.configurationabc method)": [[18, "cpl_core.configuration.configuration_abc.ConfigurationABC.create_console_argument"]], "customer (cpl_core.configuration.configuration_variable_name_enum.configurationvariablenameenum attribute)": [[18, "cpl_core.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum.customer"]], "environment (cpl_core.configuration.configuration.configuration property)": [[18, "cpl_core.configuration.configuration.Configuration.environment"]], "environment (cpl_core.configuration.configuration_abc.configurationabc property)": [[18, "cpl_core.configuration.configuration_abc.ConfigurationABC.environment"]], "environment (cpl_core.configuration.configuration_variable_name_enum.configurationvariablenameenum attribute)": [[18, "cpl_core.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum.environment"]], "executable_type (cpl_core.configuration.executable_argument.executableargument property)": [[18, "cpl_core.configuration.executable_argument.ExecutableArgument.executable_type"]], "for_each_argument() (cpl_core.configuration.configuration.configuration method)": [[18, "cpl_core.configuration.configuration.Configuration.for_each_argument"]], "for_each_argument() (cpl_core.configuration.configuration_abc.configurationabc method)": [[18, "cpl_core.configuration.configuration_abc.ConfigurationABC.for_each_argument"]], "from_dict() (cpl_core.configuration.configuration_model_abc.configurationmodelabc method)": [[18, "cpl_core.configuration.configuration_model_abc.ConfigurationModelABC.from_dict"]], "get_configuration() (cpl_core.configuration.configuration.configuration method)": [[18, "cpl_core.configuration.configuration.Configuration.get_configuration"]], "get_configuration() (cpl_core.configuration.configuration_abc.configurationabc method)": [[18, "cpl_core.configuration.configuration_abc.ConfigurationABC.get_configuration"]], "major (cpl_core.configuration.versioninfo attribute)": [[18, "cpl_core.configuration.VersionInfo.major"]], "micro (cpl_core.configuration.versioninfo attribute)": [[18, "cpl_core.configuration.VersionInfo.micro"]], "minor (cpl_core.configuration.versioninfo attribute)": [[18, "cpl_core.configuration.VersionInfo.minor"]], "name (cpl_core.configuration.argument_abc.argumentabc property)": [[18, "cpl_core.configuration.argument_abc.ArgumentABC.name"]], "name (cpl_core.configuration.configuration_variable_name_enum.configurationvariablenameenum attribute)": [[18, "cpl_core.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum.name"]], "parse_console_arguments() (cpl_core.configuration.configuration.configuration method)": [[18, "cpl_core.configuration.configuration.Configuration.parse_console_arguments"]], "parse_console_arguments() (cpl_core.configuration.configuration_abc.configurationabc method)": [[18, "cpl_core.configuration.configuration_abc.ConfigurationABC.parse_console_arguments"]], "prevent_next_executable (cpl_core.configuration.argument_abc.argumentabc property)": [[18, "cpl_core.configuration.argument_abc.ArgumentABC.prevent_next_executable"]], "run() (cpl_core.configuration.argument_executable_abc.argumentexecutableabc method)": [[18, "cpl_core.configuration.argument_executable_abc.ArgumentExecutableABC.run"]], "run() (cpl_core.configuration.executable_argument.executableargument method)": [[18, "cpl_core.configuration.executable_argument.ExecutableArgument.run"]], "set_executable() (cpl_core.configuration.executable_argument.executableargument method)": [[18, "cpl_core.configuration.executable_argument.ExecutableArgument.set_executable"]], "set_value() (cpl_core.configuration.variable_argument.variableargument method)": [[18, "cpl_core.configuration.variable_argument.VariableArgument.set_value"]], "to_list() (cpl_core.configuration.configuration_variable_name_enum.configurationvariablenameenum static method)": [[18, "cpl_core.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum.to_list"]], "token (cpl_core.configuration.argument_abc.argumentabc property)": [[18, "cpl_core.configuration.argument_abc.ArgumentABC.token"]], "validate() (cpl_core.configuration.validator_abc.validatorabc method)": [[18, "cpl_core.configuration.validator_abc.ValidatorABC.validate"]], "validators (cpl_core.configuration.executable_argument.executableargument property)": [[18, "cpl_core.configuration.executable_argument.ExecutableArgument.validators"]], "value (cpl_core.configuration.variable_argument.variableargument property)": [[18, "cpl_core.configuration.variable_argument.VariableArgument.value"]], "value_token (cpl_core.configuration.variable_argument.variableargument property)": [[18, "cpl_core.configuration.variable_argument.VariableArgument.value_token"]], "backgroundcolorenum (class in cpl_core.console.background_color_enum)": [[19, "cpl_core.console.background_color_enum.BackgroundColorEnum"]], "console (class in cpl_core.console.console)": [[19, "cpl_core.console.console.Console"]], "consolecall (class in cpl_core.console.console_call)": [[19, "cpl_core.console.console_call.ConsoleCall"]], "foregroundcolorenum (class in cpl_core.console.foreground_color_enum)": [[19, "cpl_core.console.foreground_color_enum.ForegroundColorEnum"]], "spinnerthread (class in cpl_core.console.spinner_thread)": [[19, "cpl_core.console.spinner_thread.SpinnerThread"]], "versioninfo (class in cpl_core.console)": [[19, "cpl_core.console.VersionInfo"]], "args (cpl_core.console.console_call.consolecall property)": [[19, "cpl_core.console.console_call.ConsoleCall.args"]], "background_color (cpl_core.console.console.console property)": [[19, "cpl_core.console.console.Console.background_color"]], "banner() (cpl_core.console.console.console class method)": [[19, "cpl_core.console.console.Console.banner"]], "blue (cpl_core.console.background_color_enum.backgroundcolorenum attribute)": [[19, "cpl_core.console.background_color_enum.BackgroundColorEnum.blue"]], "blue (cpl_core.console.foreground_color_enum.foregroundcolorenum attribute)": [[19, "cpl_core.console.foreground_color_enum.ForegroundColorEnum.blue"]], "clear() (cpl_core.console.console.console class method)": [[19, "cpl_core.console.console.Console.clear"]], "close() (cpl_core.console.console.console class method)": [[19, "cpl_core.console.console.Console.close"]], "color_reset() (cpl_core.console.console.console class method)": [[19, "cpl_core.console.console.Console.color_reset"]], "cpl_core.console": [[19, "module-cpl_core.console"]], "cpl_core.console.background_color_enum": [[19, "module-cpl_core.console.background_color_enum"]], "cpl_core.console.console": [[19, "module-cpl_core.console.console"]], "cpl_core.console.console_call": [[19, "module-cpl_core.console.console_call"]], "cpl_core.console.foreground_color_enum": [[19, "module-cpl_core.console.foreground_color_enum"]], "cpl_core.console.spinner_thread": [[19, "module-cpl_core.console.spinner_thread"]], "cyan (cpl_core.console.background_color_enum.backgroundcolorenum attribute)": [[19, "cpl_core.console.background_color_enum.BackgroundColorEnum.cyan"]], "cyan (cpl_core.console.foreground_color_enum.foregroundcolorenum attribute)": [[19, "cpl_core.console.foreground_color_enum.ForegroundColorEnum.cyan"]], "default (cpl_core.console.background_color_enum.backgroundcolorenum attribute)": [[19, "cpl_core.console.background_color_enum.BackgroundColorEnum.default"]], "default (cpl_core.console.foreground_color_enum.foregroundcolorenum attribute)": [[19, "cpl_core.console.foreground_color_enum.ForegroundColorEnum.default"]], "disable() (cpl_core.console.console.console class method)": [[19, "cpl_core.console.console.Console.disable"]], "enable() (cpl_core.console.console.console class method)": [[19, "cpl_core.console.console.Console.enable"]], "error() (cpl_core.console.console.console class method)": [[19, "cpl_core.console.console.Console.error"]], "exit() (cpl_core.console.spinner_thread.spinnerthread method)": [[19, "cpl_core.console.spinner_thread.SpinnerThread.exit"]], "foreground_color (cpl_core.console.console.console property)": [[19, "cpl_core.console.console.Console.foreground_color"]], "function (cpl_core.console.console_call.consolecall property)": [[19, "cpl_core.console.console_call.ConsoleCall.function"]], "green (cpl_core.console.background_color_enum.backgroundcolorenum attribute)": [[19, "cpl_core.console.background_color_enum.BackgroundColorEnum.green"]], "green (cpl_core.console.foreground_color_enum.foregroundcolorenum attribute)": [[19, "cpl_core.console.foreground_color_enum.ForegroundColorEnum.green"]], "grey (cpl_core.console.background_color_enum.backgroundcolorenum attribute)": [[19, "cpl_core.console.background_color_enum.BackgroundColorEnum.grey"]], "grey (cpl_core.console.foreground_color_enum.foregroundcolorenum attribute)": [[19, "cpl_core.console.foreground_color_enum.ForegroundColorEnum.grey"]], "magenta (cpl_core.console.background_color_enum.backgroundcolorenum attribute)": [[19, "cpl_core.console.background_color_enum.BackgroundColorEnum.magenta"]], "magenta (cpl_core.console.foreground_color_enum.foregroundcolorenum attribute)": [[19, "cpl_core.console.foreground_color_enum.ForegroundColorEnum.magenta"]], "major (cpl_core.console.versioninfo attribute)": [[19, "cpl_core.console.VersionInfo.major"]], "micro (cpl_core.console.versioninfo attribute)": [[19, "cpl_core.console.VersionInfo.micro"]], "minor (cpl_core.console.versioninfo attribute)": [[19, "cpl_core.console.VersionInfo.minor"]], "read() (cpl_core.console.console.console class method)": [[19, "cpl_core.console.console.Console.read"]], "read_line() (cpl_core.console.console.console class method)": [[19, "cpl_core.console.console.Console.read_line"]], "red (cpl_core.console.background_color_enum.backgroundcolorenum attribute)": [[19, "cpl_core.console.background_color_enum.BackgroundColorEnum.red"]], "red (cpl_core.console.foreground_color_enum.foregroundcolorenum attribute)": [[19, "cpl_core.console.foreground_color_enum.ForegroundColorEnum.red"]], "reset_cursor_position() (cpl_core.console.console.console class method)": [[19, "cpl_core.console.console.Console.reset_cursor_position"]], "run() (cpl_core.console.spinner_thread.spinnerthread method)": [[19, "cpl_core.console.spinner_thread.SpinnerThread.run"]], "select() (cpl_core.console.console.console class method)": [[19, "cpl_core.console.console.Console.select"]], "set_background_color() (cpl_core.console.console.console class method)": [[19, "cpl_core.console.console.Console.set_background_color"]], "set_cursor_position() (cpl_core.console.console.console class method)": [[19, "cpl_core.console.console.Console.set_cursor_position"]], "set_foreground_color() (cpl_core.console.console.console class method)": [[19, "cpl_core.console.console.Console.set_foreground_color"]], "set_hold_back() (cpl_core.console.console.console class method)": [[19, "cpl_core.console.console.Console.set_hold_back"]], "spinner() (cpl_core.console.console.console class method)": [[19, "cpl_core.console.console.Console.spinner"]], "stop_spinning() (cpl_core.console.spinner_thread.spinnerthread method)": [[19, "cpl_core.console.spinner_thread.SpinnerThread.stop_spinning"]], "table() (cpl_core.console.console.console class method)": [[19, "cpl_core.console.console.Console.table"]], "white (cpl_core.console.background_color_enum.backgroundcolorenum attribute)": [[19, "cpl_core.console.background_color_enum.BackgroundColorEnum.white"]], "white (cpl_core.console.foreground_color_enum.foregroundcolorenum attribute)": [[19, "cpl_core.console.foreground_color_enum.ForegroundColorEnum.white"]], "write() (cpl_core.console.console.console class method)": [[19, "cpl_core.console.console.Console.write"]], "write_at() (cpl_core.console.console.console class method)": [[19, "cpl_core.console.console.Console.write_at"]], "write_line() (cpl_core.console.console.console class method)": [[19, "cpl_core.console.console.Console.write_line"]], "write_line_at() (cpl_core.console.console.console class method)": [[19, "cpl_core.console.console.Console.write_line_at"]], "yellow (cpl_core.console.background_color_enum.backgroundcolorenum attribute)": [[19, "cpl_core.console.background_color_enum.BackgroundColorEnum.yellow"]], "yellow (cpl_core.console.foreground_color_enum.foregroundcolorenum attribute)": [[19, "cpl_core.console.foreground_color_enum.ForegroundColorEnum.yellow"]], "databasesettings (class in cpl_core.database.database_settings)": [[20, "cpl_core.database.database_settings.DatabaseSettings"]], "databasesettingsnameenum (class in cpl_core.database.database_settings_name_enum)": [[20, "cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum"]], "tableabc (class in cpl_core.database.table_abc)": [[20, "cpl_core.database.table_abc.TableABC"]], "versioninfo (class in cpl_core.database)": [[20, "cpl_core.database.VersionInfo"]], "auth_plugin (cpl_core.database.database_settings.databasesettings property)": [[20, "cpl_core.database.database_settings.DatabaseSettings.auth_plugin"]], "auth_plugin (cpl_core.database.database_settings_name_enum.databasesettingsnameenum attribute)": [[20, "cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.auth_plugin"]], "buffered (cpl_core.database.database_settings.databasesettings property)": [[20, "cpl_core.database.database_settings.DatabaseSettings.buffered"]], "buffered (cpl_core.database.database_settings_name_enum.databasesettingsnameenum attribute)": [[20, "cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.buffered"]], "charset (cpl_core.database.database_settings.databasesettings property)": [[20, "cpl_core.database.database_settings.DatabaseSettings.charset"]], "charset (cpl_core.database.database_settings_name_enum.databasesettingsnameenum attribute)": [[20, "cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.charset"]], "cpl_core.database": [[20, "module-cpl_core.database"]], "cpl_core.database.database_settings": [[20, "module-cpl_core.database.database_settings"]], "cpl_core.database.database_settings_name_enum": [[20, "module-cpl_core.database.database_settings_name_enum"]], "cpl_core.database.table_abc": [[20, "module-cpl_core.database.table_abc"]], "created_at (cpl_core.database.table_abc.tableabc property)": [[20, "cpl_core.database.table_abc.TableABC.created_at"]], "database (cpl_core.database.database_settings.databasesettings property)": [[20, "cpl_core.database.database_settings.DatabaseSettings.database"]], "database (cpl_core.database.database_settings_name_enum.databasesettingsnameenum attribute)": [[20, "cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.database"]], "delete_string (cpl_core.database.table_abc.tableabc property)": [[20, "cpl_core.database.table_abc.TableABC.delete_string"]], "host (cpl_core.database.database_settings.databasesettings property)": [[20, "cpl_core.database.database_settings.DatabaseSettings.host"]], "host (cpl_core.database.database_settings_name_enum.databasesettingsnameenum attribute)": [[20, "cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.host"]], "insert_string (cpl_core.database.table_abc.tableabc property)": [[20, "cpl_core.database.table_abc.TableABC.insert_string"]], "major (cpl_core.database.versioninfo attribute)": [[20, "cpl_core.database.VersionInfo.major"]], "micro (cpl_core.database.versioninfo attribute)": [[20, "cpl_core.database.VersionInfo.micro"]], "minor (cpl_core.database.versioninfo attribute)": [[20, "cpl_core.database.VersionInfo.minor"]], "modified_at (cpl_core.database.table_abc.tableabc property)": [[20, "cpl_core.database.table_abc.TableABC.modified_at"]], "password (cpl_core.database.database_settings.databasesettings property)": [[20, "cpl_core.database.database_settings.DatabaseSettings.password"]], "password (cpl_core.database.database_settings_name_enum.databasesettingsnameenum attribute)": [[20, "cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.password"]], "port (cpl_core.database.database_settings.databasesettings property)": [[20, "cpl_core.database.database_settings.DatabaseSettings.port"]], "port (cpl_core.database.database_settings_name_enum.databasesettingsnameenum attribute)": [[20, "cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.port"]], "udpate_string (cpl_core.database.table_abc.tableabc property)": [[20, "cpl_core.database.table_abc.TableABC.udpate_string"]], "use_unicode (cpl_core.database.database_settings.databasesettings property)": [[20, "cpl_core.database.database_settings.DatabaseSettings.use_unicode"]], "use_unicode (cpl_core.database.database_settings_name_enum.databasesettingsnameenum attribute)": [[20, "cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.use_unicode"]], "user (cpl_core.database.database_settings.databasesettings property)": [[20, "cpl_core.database.database_settings.DatabaseSettings.user"]], "user (cpl_core.database.database_settings_name_enum.databasesettingsnameenum attribute)": [[20, "cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.user"]], "databaseconnection (class in cpl_core.database.connection.database_connection)": [[21, "cpl_core.database.connection.database_connection.DatabaseConnection"]], "databaseconnectionabc (class in cpl_core.database.connection.database_connection_abc)": [[21, "cpl_core.database.connection.database_connection_abc.DatabaseConnectionABC"]], "versioninfo (class in cpl_core.database.connection)": [[21, "cpl_core.database.connection.VersionInfo"]], "connect() (cpl_core.database.connection.database_connection.databaseconnection method)": [[21, "cpl_core.database.connection.database_connection.DatabaseConnection.connect"]], "connect() (cpl_core.database.connection.database_connection_abc.databaseconnectionabc method)": [[21, "cpl_core.database.connection.database_connection_abc.DatabaseConnectionABC.connect"]], "cpl_core.database.connection": [[21, "module-cpl_core.database.connection"]], "cpl_core.database.connection.database_connection": [[21, "module-cpl_core.database.connection.database_connection"]], "cpl_core.database.connection.database_connection_abc": [[21, "module-cpl_core.database.connection.database_connection_abc"]], "cursor (cpl_core.database.connection.database_connection.databaseconnection property)": [[21, "cpl_core.database.connection.database_connection.DatabaseConnection.cursor"]], "cursor (cpl_core.database.connection.database_connection_abc.databaseconnectionabc property)": [[21, "cpl_core.database.connection.database_connection_abc.DatabaseConnectionABC.cursor"]], "major (cpl_core.database.connection.versioninfo attribute)": [[21, "cpl_core.database.connection.VersionInfo.major"]], "micro (cpl_core.database.connection.versioninfo attribute)": [[21, "cpl_core.database.connection.VersionInfo.micro"]], "minor (cpl_core.database.connection.versioninfo attribute)": [[21, "cpl_core.database.connection.VersionInfo.minor"]], "server (cpl_core.database.connection.database_connection.databaseconnection property)": [[21, "cpl_core.database.connection.database_connection.DatabaseConnection.server"]], "server (cpl_core.database.connection.database_connection_abc.databaseconnectionabc property)": [[21, "cpl_core.database.connection.database_connection_abc.DatabaseConnectionABC.server"]], "databasecontext (class in cpl_core.database.context.database_context)": [[22, "cpl_core.database.context.database_context.DatabaseContext"]], "databasecontextabc (class in cpl_core.database.context.database_context_abc)": [[22, "cpl_core.database.context.database_context_abc.DatabaseContextABC"]], "versioninfo (class in cpl_core.database.context)": [[22, "cpl_core.database.context.VersionInfo"]], "connect() (cpl_core.database.context.database_context.databasecontext method)": [[22, "cpl_core.database.context.database_context.DatabaseContext.connect"]], "connect() (cpl_core.database.context.database_context_abc.databasecontextabc method)": [[22, "cpl_core.database.context.database_context_abc.DatabaseContextABC.connect"]], "cpl_core.database.context": [[22, "module-cpl_core.database.context"]], "cpl_core.database.context.database_context": [[22, "module-cpl_core.database.context.database_context"]], "cpl_core.database.context.database_context_abc": [[22, "module-cpl_core.database.context.database_context_abc"]], "cursor (cpl_core.database.context.database_context.databasecontext property)": [[22, "cpl_core.database.context.database_context.DatabaseContext.cursor"]], "cursor (cpl_core.database.context.database_context_abc.databasecontextabc property)": [[22, "cpl_core.database.context.database_context_abc.DatabaseContextABC.cursor"]], "major (cpl_core.database.context.versioninfo attribute)": [[22, "cpl_core.database.context.VersionInfo.major"]], "micro (cpl_core.database.context.versioninfo attribute)": [[22, "cpl_core.database.context.VersionInfo.micro"]], "minor (cpl_core.database.context.versioninfo attribute)": [[22, "cpl_core.database.context.VersionInfo.minor"]], "save_changes() (cpl_core.database.context.database_context.databasecontext method)": [[22, "cpl_core.database.context.database_context.DatabaseContext.save_changes"]], "save_changes() (cpl_core.database.context.database_context_abc.databasecontextabc method)": [[22, "cpl_core.database.context.database_context_abc.DatabaseContextABC.save_changes"]], "select() (cpl_core.database.context.database_context.databasecontext method)": [[22, "cpl_core.database.context.database_context.DatabaseContext.select"]], "select() (cpl_core.database.context.database_context_abc.databasecontextabc method)": [[22, "cpl_core.database.context.database_context_abc.DatabaseContextABC.select"]], "scope (class in cpl_core.dependency_injection.scope)": [[23, "cpl_core.dependency_injection.scope.Scope"]], "scopeabc (class in cpl_core.dependency_injection.scope_abc)": [[23, "cpl_core.dependency_injection.scope_abc.ScopeABC"]], "scopebuilder (class in cpl_core.dependency_injection.scope_builder)": [[23, "cpl_core.dependency_injection.scope_builder.ScopeBuilder"]], "servicecollection (class in cpl_core.dependency_injection.service_collection)": [[23, "cpl_core.dependency_injection.service_collection.ServiceCollection"]], "servicecollectionabc (class in cpl_core.dependency_injection.service_collection_abc)": [[23, "cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC"]], "servicedescriptor (class in cpl_core.dependency_injection.service_descriptor)": [[23, "cpl_core.dependency_injection.service_descriptor.ServiceDescriptor"]], "servicelifetimeenum (class in cpl_core.dependency_injection.service_lifetime_enum)": [[23, "cpl_core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum"]], "serviceprovider (class in cpl_core.dependency_injection.service_provider)": [[23, "cpl_core.dependency_injection.service_provider.ServiceProvider"]], "serviceproviderabc (class in cpl_core.dependency_injection.service_provider_abc)": [[23, "cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC"]], "versioninfo (class in cpl_core.dependency_injection)": [[23, "cpl_core.dependency_injection.VersionInfo"]], "add_db_context() (cpl_core.dependency_injection.service_collection.servicecollection method)": [[23, "cpl_core.dependency_injection.service_collection.ServiceCollection.add_db_context"]], "add_db_context() (cpl_core.dependency_injection.service_collection_abc.servicecollectionabc method)": [[23, "cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_db_context"]], "add_discord() (cpl_core.dependency_injection.service_collection_abc.servicecollectionabc method)": [[23, "cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_discord"]], "add_logging() (cpl_core.dependency_injection.service_collection.servicecollection method)": [[23, "cpl_core.dependency_injection.service_collection.ServiceCollection.add_logging"]], "add_logging() (cpl_core.dependency_injection.service_collection_abc.servicecollectionabc method)": [[23, "cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_logging"]], "add_pipes() (cpl_core.dependency_injection.service_collection.servicecollection method)": [[23, "cpl_core.dependency_injection.service_collection.ServiceCollection.add_pipes"]], "add_pipes() (cpl_core.dependency_injection.service_collection_abc.servicecollectionabc method)": [[23, "cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_pipes"]], "add_scoped() (cpl_core.dependency_injection.service_collection.servicecollection method)": [[23, "cpl_core.dependency_injection.service_collection.ServiceCollection.add_scoped"]], "add_scoped() (cpl_core.dependency_injection.service_collection_abc.servicecollectionabc method)": [[23, "cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_scoped"]], "add_singleton() (cpl_core.dependency_injection.service_collection.servicecollection method)": [[23, "cpl_core.dependency_injection.service_collection.ServiceCollection.add_singleton"]], "add_singleton() (cpl_core.dependency_injection.service_collection_abc.servicecollectionabc method)": [[23, "cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_singleton"]], "add_transient() (cpl_core.dependency_injection.service_collection.servicecollection method)": [[23, "cpl_core.dependency_injection.service_collection.ServiceCollection.add_transient"]], "add_transient() (cpl_core.dependency_injection.service_collection_abc.servicecollectionabc method)": [[23, "cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_transient"]], "add_translation() (cpl_core.dependency_injection.service_collection_abc.servicecollectionabc method)": [[23, "cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_translation"]], "base_type (cpl_core.dependency_injection.service_descriptor.servicedescriptor property)": [[23, "cpl_core.dependency_injection.service_descriptor.ServiceDescriptor.base_type"]], "build() (cpl_core.dependency_injection.scope_builder.scopebuilder method)": [[23, "cpl_core.dependency_injection.scope_builder.ScopeBuilder.build"]], "build_by_signature() (cpl_core.dependency_injection.service_provider.serviceprovider method)": [[23, "cpl_core.dependency_injection.service_provider.ServiceProvider.build_by_signature"]], "build_by_signature() (cpl_core.dependency_injection.service_provider_abc.serviceproviderabc method)": [[23, "cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC.build_by_signature"]], "build_service() (cpl_core.dependency_injection.service_provider.serviceprovider method)": [[23, "cpl_core.dependency_injection.service_provider.ServiceProvider.build_service"]], "build_service() (cpl_core.dependency_injection.service_provider_abc.serviceproviderabc method)": [[23, "cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC.build_service"]], "build_service_provider() (cpl_core.dependency_injection.service_collection.servicecollection method)": [[23, "cpl_core.dependency_injection.service_collection.ServiceCollection.build_service_provider"]], "build_service_provider() (cpl_core.dependency_injection.service_collection_abc.servicecollectionabc method)": [[23, "cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC.build_service_provider"]], "cpl_core.dependency_injection": [[23, "module-cpl_core.dependency_injection"]], "cpl_core.dependency_injection.scope": [[23, "module-cpl_core.dependency_injection.scope"]], "cpl_core.dependency_injection.scope_abc": [[23, "module-cpl_core.dependency_injection.scope_abc"]], "cpl_core.dependency_injection.scope_builder": [[23, "module-cpl_core.dependency_injection.scope_builder"]], "cpl_core.dependency_injection.service_collection": [[23, "module-cpl_core.dependency_injection.service_collection"]], "cpl_core.dependency_injection.service_collection_abc": [[23, "module-cpl_core.dependency_injection.service_collection_abc"]], "cpl_core.dependency_injection.service_descriptor": [[23, "module-cpl_core.dependency_injection.service_descriptor"]], "cpl_core.dependency_injection.service_lifetime_enum": [[23, "module-cpl_core.dependency_injection.service_lifetime_enum"]], "cpl_core.dependency_injection.service_provider": [[23, "module-cpl_core.dependency_injection.service_provider"]], "cpl_core.dependency_injection.service_provider_abc": [[23, "module-cpl_core.dependency_injection.service_provider_abc"]], "create_scope() (cpl_core.dependency_injection.service_provider.serviceprovider method)": [[23, "cpl_core.dependency_injection.service_provider.ServiceProvider.create_scope"]], "create_scope() (cpl_core.dependency_injection.service_provider_abc.serviceproviderabc method)": [[23, "cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC.create_scope"]], "dispose() (cpl_core.dependency_injection.scope.scope method)": [[23, "cpl_core.dependency_injection.scope.Scope.dispose"]], "dispose() (cpl_core.dependency_injection.scope_abc.scopeabc method)": [[23, "cpl_core.dependency_injection.scope_abc.ScopeABC.dispose"]], "get_service() (cpl_core.dependency_injection.service_provider.serviceprovider method)": [[23, "cpl_core.dependency_injection.service_provider.ServiceProvider.get_service"]], "get_service() (cpl_core.dependency_injection.service_provider_abc.serviceproviderabc method)": [[23, "cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC.get_service"]], "get_services() (cpl_core.dependency_injection.service_provider.serviceprovider method)": [[23, "cpl_core.dependency_injection.service_provider.ServiceProvider.get_services"]], "get_services() (cpl_core.dependency_injection.service_provider_abc.serviceproviderabc method)": [[23, "cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC.get_services"]], "implementation (cpl_core.dependency_injection.service_descriptor.servicedescriptor property)": [[23, "cpl_core.dependency_injection.service_descriptor.ServiceDescriptor.implementation"]], "inject() (cpl_core.dependency_injection.service_provider_abc.serviceproviderabc class method)": [[23, "cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC.inject"]], "lifetime (cpl_core.dependency_injection.service_descriptor.servicedescriptor property)": [[23, "cpl_core.dependency_injection.service_descriptor.ServiceDescriptor.lifetime"]], "major (cpl_core.dependency_injection.versioninfo attribute)": [[23, "cpl_core.dependency_injection.VersionInfo.major"]], "micro (cpl_core.dependency_injection.versioninfo attribute)": [[23, "cpl_core.dependency_injection.VersionInfo.micro"]], "minor (cpl_core.dependency_injection.versioninfo attribute)": [[23, "cpl_core.dependency_injection.VersionInfo.minor"]], "scoped (cpl_core.dependency_injection.service_lifetime_enum.servicelifetimeenum attribute)": [[23, "cpl_core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum.scoped"]], "service_provider (cpl_core.dependency_injection.scope.scope property)": [[23, "cpl_core.dependency_injection.scope.Scope.service_provider"]], "service_provider (cpl_core.dependency_injection.scope_abc.scopeabc property)": [[23, "cpl_core.dependency_injection.scope_abc.ScopeABC.service_provider"]], "service_type (cpl_core.dependency_injection.service_descriptor.servicedescriptor property)": [[23, "cpl_core.dependency_injection.service_descriptor.ServiceDescriptor.service_type"]], "set_global_provider() (cpl_core.dependency_injection.service_provider_abc.serviceproviderabc class method)": [[23, "cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC.set_global_provider"]], "set_scope() (cpl_core.dependency_injection.service_provider.serviceprovider method)": [[23, "cpl_core.dependency_injection.service_provider.ServiceProvider.set_scope"]], "set_scope() (cpl_core.dependency_injection.service_provider_abc.serviceproviderabc method)": [[23, "cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC.set_scope"]], "singleton (cpl_core.dependency_injection.service_lifetime_enum.servicelifetimeenum attribute)": [[23, "cpl_core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum.singleton"]], "transient (cpl_core.dependency_injection.service_lifetime_enum.servicelifetimeenum attribute)": [[23, "cpl_core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum.transient"]], "applicationenvironment (class in cpl_core.environment.application_environment)": [[24, "cpl_core.environment.application_environment.ApplicationEnvironment"]], "applicationenvironmentabc (class in cpl_core.environment.application_environment_abc)": [[24, "cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC"]], "environmentnameenum (class in cpl_core.environment.environment_name_enum)": [[24, "cpl_core.environment.environment_name_enum.EnvironmentNameEnum"]], "versioninfo (class in cpl_core.environment)": [[24, "cpl_core.environment.VersionInfo"]], "application_name (cpl_core.environment.application_environment.applicationenvironment property)": [[24, "cpl_core.environment.application_environment.ApplicationEnvironment.application_name"]], "application_name (cpl_core.environment.application_environment_abc.applicationenvironmentabc property)": [[24, "cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC.application_name"]], "cpl_core.environment": [[24, "module-cpl_core.environment"]], "cpl_core.environment.application_environment": [[24, "module-cpl_core.environment.application_environment"]], "cpl_core.environment.application_environment_abc": [[24, "module-cpl_core.environment.application_environment_abc"]], "cpl_core.environment.environment_name_enum": [[24, "module-cpl_core.environment.environment_name_enum"]], "customer (cpl_core.environment.application_environment.applicationenvironment property)": [[24, "cpl_core.environment.application_environment.ApplicationEnvironment.customer"]], "customer (cpl_core.environment.application_environment_abc.applicationenvironmentabc property)": [[24, "cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC.customer"]], "date_time_now (cpl_core.environment.application_environment.applicationenvironment property)": [[24, "cpl_core.environment.application_environment.ApplicationEnvironment.date_time_now"]], "date_time_now (cpl_core.environment.application_environment_abc.applicationenvironmentabc property)": [[24, "cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC.date_time_now"]], "development (cpl_core.environment.environment_name_enum.environmentnameenum attribute)": [[24, "cpl_core.environment.environment_name_enum.EnvironmentNameEnum.development"]], "end_time (cpl_core.environment.application_environment.applicationenvironment property)": [[24, "cpl_core.environment.application_environment.ApplicationEnvironment.end_time"]], "end_time (cpl_core.environment.application_environment_abc.applicationenvironmentabc property)": [[24, "cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC.end_time"]], "environment_name (cpl_core.environment.application_environment.applicationenvironment property)": [[24, "cpl_core.environment.application_environment.ApplicationEnvironment.environment_name"]], "environment_name (cpl_core.environment.application_environment_abc.applicationenvironmentabc property)": [[24, "cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC.environment_name"]], "host_name (cpl_core.environment.application_environment.applicationenvironment property)": [[24, "cpl_core.environment.application_environment.ApplicationEnvironment.host_name"]], "host_name (cpl_core.environment.application_environment_abc.applicationenvironmentabc property)": [[24, "cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC.host_name"]], "major (cpl_core.environment.versioninfo attribute)": [[24, "cpl_core.environment.VersionInfo.major"]], "micro (cpl_core.environment.versioninfo attribute)": [[24, "cpl_core.environment.VersionInfo.micro"]], "minor (cpl_core.environment.versioninfo attribute)": [[24, "cpl_core.environment.VersionInfo.minor"]], "production (cpl_core.environment.environment_name_enum.environmentnameenum attribute)": [[24, "cpl_core.environment.environment_name_enum.EnvironmentNameEnum.production"]], "runtime_directory (cpl_core.environment.application_environment.applicationenvironment property)": [[24, "cpl_core.environment.application_environment.ApplicationEnvironment.runtime_directory"]], "runtime_directory (cpl_core.environment.application_environment_abc.applicationenvironmentabc property)": [[24, "cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC.runtime_directory"]], "set_runtime_directory() (cpl_core.environment.application_environment.applicationenvironment method)": [[24, "cpl_core.environment.application_environment.ApplicationEnvironment.set_runtime_directory"]], "set_runtime_directory() (cpl_core.environment.application_environment_abc.applicationenvironmentabc method)": [[24, "cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC.set_runtime_directory"]], "set_working_directory() (cpl_core.environment.application_environment.applicationenvironment method)": [[24, "cpl_core.environment.application_environment.ApplicationEnvironment.set_working_directory"]], "set_working_directory() (cpl_core.environment.application_environment_abc.applicationenvironmentabc method)": [[24, "cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC.set_working_directory"]], "staging (cpl_core.environment.environment_name_enum.environmentnameenum attribute)": [[24, "cpl_core.environment.environment_name_enum.EnvironmentNameEnum.staging"]], "start_time (cpl_core.environment.application_environment.applicationenvironment property)": [[24, "cpl_core.environment.application_environment.ApplicationEnvironment.start_time"]], "start_time (cpl_core.environment.application_environment_abc.applicationenvironmentabc property)": [[24, "cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC.start_time"]], "testing (cpl_core.environment.environment_name_enum.environmentnameenum attribute)": [[24, "cpl_core.environment.environment_name_enum.EnvironmentNameEnum.testing"]], "working_directory (cpl_core.environment.application_environment.applicationenvironment property)": [[24, "cpl_core.environment.application_environment.ApplicationEnvironment.working_directory"]], "working_directory (cpl_core.environment.application_environment_abc.applicationenvironmentabc property)": [[24, "cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC.working_directory"]], "debug (cpl_core.logging.logging_level_enum.logginglevelenum attribute)": [[25, "cpl_core.logging.logging_level_enum.LoggingLevelEnum.DEBUG"]], "error (cpl_core.logging.logging_level_enum.logginglevelenum attribute)": [[25, "cpl_core.logging.logging_level_enum.LoggingLevelEnum.ERROR"]], "fatal (cpl_core.logging.logging_level_enum.logginglevelenum attribute)": [[25, "cpl_core.logging.logging_level_enum.LoggingLevelEnum.FATAL"]], "info (cpl_core.logging.logging_level_enum.logginglevelenum attribute)": [[25, "cpl_core.logging.logging_level_enum.LoggingLevelEnum.INFO"]], "logger (class in cpl_core.logging.logger_service)": [[25, "cpl_core.logging.logger_service.Logger"]], "loggerabc (class in cpl_core.logging.logger_abc)": [[25, "cpl_core.logging.logger_abc.LoggerABC"]], "logginglevelenum (class in cpl_core.logging.logging_level_enum)": [[25, "cpl_core.logging.logging_level_enum.LoggingLevelEnum"]], "loggingsettings (class in cpl_core.logging.logging_settings)": [[25, "cpl_core.logging.logging_settings.LoggingSettings"]], "loggingsettingsnameenum (class in cpl_core.logging.logging_settings_name_enum)": [[25, "cpl_core.logging.logging_settings_name_enum.LoggingSettingsNameEnum"]], "off (cpl_core.logging.logging_level_enum.logginglevelenum attribute)": [[25, "cpl_core.logging.logging_level_enum.LoggingLevelEnum.OFF"]], "trace (cpl_core.logging.logging_level_enum.logginglevelenum attribute)": [[25, "cpl_core.logging.logging_level_enum.LoggingLevelEnum.TRACE"]], "versioninfo (class in cpl_core.logging)": [[25, "cpl_core.logging.VersionInfo"]], "warn (cpl_core.logging.logging_level_enum.logginglevelenum attribute)": [[25, "cpl_core.logging.logging_level_enum.LoggingLevelEnum.WARN"]], "console (cpl_core.logging.logging_settings.loggingsettings property)": [[25, "cpl_core.logging.logging_settings.LoggingSettings.console"]], "console_level (cpl_core.logging.logging_settings_name_enum.loggingsettingsnameenum attribute)": [[25, "cpl_core.logging.logging_settings_name_enum.LoggingSettingsNameEnum.console_level"]], "cpl_core.logging": [[25, "module-cpl_core.logging"]], "cpl_core.logging.logger_abc": [[25, "module-cpl_core.logging.logger_abc"]], "cpl_core.logging.logger_service": [[25, "module-cpl_core.logging.logger_service"]], "cpl_core.logging.logging_level_enum": [[25, "module-cpl_core.logging.logging_level_enum"]], "cpl_core.logging.logging_settings": [[25, "module-cpl_core.logging.logging_settings"]], "cpl_core.logging.logging_settings_name_enum": [[25, "module-cpl_core.logging.logging_settings_name_enum"]], "create() (cpl_core.logging.logger_service.logger method)": [[25, "cpl_core.logging.logger_service.Logger.create"]], "debug() (cpl_core.logging.logger_abc.loggerabc method)": [[25, "cpl_core.logging.logger_abc.LoggerABC.debug"]], "debug() (cpl_core.logging.logger_service.logger method)": [[25, "cpl_core.logging.logger_service.Logger.debug"]], "error() (cpl_core.logging.logger_abc.loggerabc method)": [[25, "cpl_core.logging.logger_abc.LoggerABC.error"]], "error() (cpl_core.logging.logger_service.logger method)": [[25, "cpl_core.logging.logger_service.Logger.error"]], "fatal() (cpl_core.logging.logger_abc.loggerabc method)": [[25, "cpl_core.logging.logger_abc.LoggerABC.fatal"]], "fatal() (cpl_core.logging.logger_service.logger method)": [[25, "cpl_core.logging.logger_service.Logger.fatal"]], "file_level (cpl_core.logging.logging_settings_name_enum.loggingsettingsnameenum attribute)": [[25, "cpl_core.logging.logging_settings_name_enum.LoggingSettingsNameEnum.file_level"]], "filename (cpl_core.logging.logging_settings.loggingsettings property)": [[25, "cpl_core.logging.logging_settings.LoggingSettings.filename"]], "filename (cpl_core.logging.logging_settings_name_enum.loggingsettingsnameenum attribute)": [[25, "cpl_core.logging.logging_settings_name_enum.LoggingSettingsNameEnum.filename"]], "header() (cpl_core.logging.logger_abc.loggerabc method)": [[25, "cpl_core.logging.logger_abc.LoggerABC.header"]], "header() (cpl_core.logging.logger_service.logger method)": [[25, "cpl_core.logging.logger_service.Logger.header"]], "info() (cpl_core.logging.logger_abc.loggerabc method)": [[25, "cpl_core.logging.logger_abc.LoggerABC.info"]], "info() (cpl_core.logging.logger_service.logger method)": [[25, "cpl_core.logging.logger_service.Logger.info"]], "level (cpl_core.logging.logging_settings.loggingsettings property)": [[25, "cpl_core.logging.logging_settings.LoggingSettings.level"]], "major (cpl_core.logging.versioninfo attribute)": [[25, "cpl_core.logging.VersionInfo.major"]], "micro (cpl_core.logging.versioninfo attribute)": [[25, "cpl_core.logging.VersionInfo.micro"]], "minor (cpl_core.logging.versioninfo attribute)": [[25, "cpl_core.logging.VersionInfo.minor"]], "path (cpl_core.logging.logging_settings.loggingsettings property)": [[25, "cpl_core.logging.logging_settings.LoggingSettings.path"]], "path (cpl_core.logging.logging_settings_name_enum.loggingsettingsnameenum attribute)": [[25, "cpl_core.logging.logging_settings_name_enum.LoggingSettingsNameEnum.path"]], "trace() (cpl_core.logging.logger_abc.loggerabc method)": [[25, "cpl_core.logging.logger_abc.LoggerABC.trace"]], "trace() (cpl_core.logging.logger_service.logger method)": [[25, "cpl_core.logging.logger_service.Logger.trace"]], "warn() (cpl_core.logging.logger_abc.loggerabc method)": [[25, "cpl_core.logging.logger_abc.LoggerABC.warn"]], "warn() (cpl_core.logging.logger_service.logger method)": [[25, "cpl_core.logging.logger_service.Logger.warn"]], "email (class in cpl_core.mailing.email)": [[26, "cpl_core.mailing.email.EMail"]], "emailclient (class in cpl_core.mailing.email_client_service)": [[26, "cpl_core.mailing.email_client_service.EMailClient"]], "emailclientabc (class in cpl_core.mailing.email_client_abc)": [[26, "cpl_core.mailing.email_client_abc.EMailClientABC"]], "emailclientsettings (class in cpl_core.mailing.email_client_settings)": [[26, "cpl_core.mailing.email_client_settings.EMailClientSettings"]], "emailclientsettingsnameenum (class in cpl_core.mailing.email_client_settings_name_enum)": [[26, "cpl_core.mailing.email_client_settings_name_enum.EMailClientSettingsNameEnum"]], "versioninfo (class in cpl_core.mailing)": [[26, "cpl_core.mailing.VersionInfo"]], "add_header() (cpl_core.mailing.email.email method)": [[26, "cpl_core.mailing.email.EMail.add_header"]], "add_receiver() (cpl_core.mailing.email.email method)": [[26, "cpl_core.mailing.email.EMail.add_receiver"]], "body (cpl_core.mailing.email.email property)": [[26, "cpl_core.mailing.email.EMail.body"]], "check_mail() (cpl_core.mailing.email.email static method)": [[26, "cpl_core.mailing.email.EMail.check_mail"]], "connect() (cpl_core.mailing.email_client_abc.emailclientabc method)": [[26, "cpl_core.mailing.email_client_abc.EMailClientABC.connect"]], "connect() (cpl_core.mailing.email_client_service.emailclient method)": [[26, "cpl_core.mailing.email_client_service.EMailClient.connect"]], "cpl_core.mailing": [[26, "module-cpl_core.mailing"]], "cpl_core.mailing.email": [[26, "module-cpl_core.mailing.email"]], "cpl_core.mailing.email_client_abc": [[26, "module-cpl_core.mailing.email_client_abc"]], "cpl_core.mailing.email_client_service": [[26, "module-cpl_core.mailing.email_client_service"]], "cpl_core.mailing.email_client_settings": [[26, "module-cpl_core.mailing.email_client_settings"]], "cpl_core.mailing.email_client_settings_name_enum": [[26, "module-cpl_core.mailing.email_client_settings_name_enum"]], "create() (cpl_core.mailing.email_client_service.emailclient method)": [[26, "cpl_core.mailing.email_client_service.EMailClient.create"]], "credentials (cpl_core.mailing.email_client_settings.emailclientsettings property)": [[26, "cpl_core.mailing.email_client_settings.EMailClientSettings.credentials"]], "credentials (cpl_core.mailing.email_client_settings_name_enum.emailclientsettingsnameenum attribute)": [[26, "cpl_core.mailing.email_client_settings_name_enum.EMailClientSettingsNameEnum.credentials"]], "get_content() (cpl_core.mailing.email.email method)": [[26, "cpl_core.mailing.email.EMail.get_content"]], "header (cpl_core.mailing.email.email property)": [[26, "cpl_core.mailing.email.EMail.header"]], "header_list (cpl_core.mailing.email.email property)": [[26, "cpl_core.mailing.email.EMail.header_list"]], "host (cpl_core.mailing.email_client_settings.emailclientsettings property)": [[26, "cpl_core.mailing.email_client_settings.EMailClientSettings.host"]], "host (cpl_core.mailing.email_client_settings_name_enum.emailclientsettingsnameenum attribute)": [[26, "cpl_core.mailing.email_client_settings_name_enum.EMailClientSettingsNameEnum.host"]], "login() (cpl_core.mailing.email_client_service.emailclient method)": [[26, "cpl_core.mailing.email_client_service.EMailClient.login"]], "major (cpl_core.mailing.versioninfo attribute)": [[26, "cpl_core.mailing.VersionInfo.major"]], "micro (cpl_core.mailing.versioninfo attribute)": [[26, "cpl_core.mailing.VersionInfo.micro"]], "minor (cpl_core.mailing.versioninfo attribute)": [[26, "cpl_core.mailing.VersionInfo.minor"]], "port (cpl_core.mailing.email_client_settings.emailclientsettings property)": [[26, "cpl_core.mailing.email_client_settings.EMailClientSettings.port"]], "port (cpl_core.mailing.email_client_settings_name_enum.emailclientsettingsnameenum attribute)": [[26, "cpl_core.mailing.email_client_settings_name_enum.EMailClientSettingsNameEnum.port"]], "receiver (cpl_core.mailing.email.email property)": [[26, "cpl_core.mailing.email.EMail.receiver"]], "receiver_list (cpl_core.mailing.email.email property)": [[26, "cpl_core.mailing.email.EMail.receiver_list"]], "send_mail() (cpl_core.mailing.email_client_abc.emailclientabc method)": [[26, "cpl_core.mailing.email_client_abc.EMailClientABC.send_mail"]], "send_mail() (cpl_core.mailing.email_client_service.emailclient method)": [[26, "cpl_core.mailing.email_client_service.EMailClient.send_mail"]], "subject (cpl_core.mailing.email.email property)": [[26, "cpl_core.mailing.email.EMail.subject"]], "transceiver (cpl_core.mailing.email.email property)": [[26, "cpl_core.mailing.email.EMail.transceiver"]], "user_name (cpl_core.mailing.email_client_settings.emailclientsettings property)": [[26, "cpl_core.mailing.email_client_settings.EMailClientSettings.user_name"]], "user_name (cpl_core.mailing.email_client_settings_name_enum.emailclientsettingsnameenum attribute)": [[26, "cpl_core.mailing.email_client_settings_name_enum.EMailClientSettingsNameEnum.user_name"]], "boolpipe (class in cpl_core.pipes.bool_pipe)": [[27, "cpl_core.pipes.bool_pipe.BoolPipe"]], "firstchartolowerpipe (class in cpl_core.pipes.first_char_to_lower_pipe)": [[27, "cpl_core.pipes.first_char_to_lower_pipe.FirstCharToLowerPipe"]], "firsttoupperpipe (class in cpl_core.pipes.first_to_upper_pipe)": [[27, "cpl_core.pipes.first_to_upper_pipe.FirstToUpperPipe"]], "ipaddresspipe (class in cpl_core.pipes.ip_address_pipe)": [[27, "cpl_core.pipes.ip_address_pipe.IPAddressPipe"]], "pipeabc (class in cpl_core.pipes.pipe_abc)": [[27, "cpl_core.pipes.pipe_abc.PipeABC"]], "tocamelcasepipe (class in cpl_core.pipes.to_camel_case_pipe)": [[27, "cpl_core.pipes.to_camel_case_pipe.ToCamelCasePipe"]], "tosnakecasepipe (class in cpl_core.pipes.to_snake_case_pipe)": [[27, "cpl_core.pipes.to_snake_case_pipe.ToSnakeCasePipe"]], "versioninfo (class in cpl_core.pipes)": [[27, "cpl_core.pipes.VersionInfo"]], "versionpipe (class in cpl_core.pipes.version_pipe)": [[27, "cpl_core.pipes.version_pipe.VersionPipe"]], "cpl_core.pipes": [[27, "module-cpl_core.pipes"]], "cpl_core.pipes.bool_pipe": [[27, "module-cpl_core.pipes.bool_pipe"]], "cpl_core.pipes.first_char_to_lower_pipe": [[27, "module-cpl_core.pipes.first_char_to_lower_pipe"]], "cpl_core.pipes.first_to_upper_pipe": [[27, "module-cpl_core.pipes.first_to_upper_pipe"]], "cpl_core.pipes.ip_address_pipe": [[27, "module-cpl_core.pipes.ip_address_pipe"]], "cpl_core.pipes.pipe_abc": [[27, "module-cpl_core.pipes.pipe_abc"]], "cpl_core.pipes.to_camel_case_pipe": [[27, "module-cpl_core.pipes.to_camel_case_pipe"]], "cpl_core.pipes.to_snake_case_pipe": [[27, "module-cpl_core.pipes.to_snake_case_pipe"]], "cpl_core.pipes.version_pipe": [[27, "module-cpl_core.pipes.version_pipe"]], "major (cpl_core.pipes.versioninfo attribute)": [[27, "cpl_core.pipes.VersionInfo.major"]], "micro (cpl_core.pipes.versioninfo attribute)": [[27, "cpl_core.pipes.VersionInfo.micro"]], "minor (cpl_core.pipes.versioninfo attribute)": [[27, "cpl_core.pipes.VersionInfo.minor"]], "transform() (cpl_core.pipes.bool_pipe.boolpipe method)": [[27, "cpl_core.pipes.bool_pipe.BoolPipe.transform"]], "transform() (cpl_core.pipes.first_char_to_lower_pipe.firstchartolowerpipe method)": [[27, "cpl_core.pipes.first_char_to_lower_pipe.FirstCharToLowerPipe.transform"]], "transform() (cpl_core.pipes.first_to_upper_pipe.firsttoupperpipe method)": [[27, "cpl_core.pipes.first_to_upper_pipe.FirstToUpperPipe.transform"]], "transform() (cpl_core.pipes.ip_address_pipe.ipaddresspipe method)": [[27, "cpl_core.pipes.ip_address_pipe.IPAddressPipe.transform"]], "transform() (cpl_core.pipes.pipe_abc.pipeabc method)": [[27, "cpl_core.pipes.pipe_abc.PipeABC.transform"]], "transform() (cpl_core.pipes.to_camel_case_pipe.tocamelcasepipe method)": [[27, "cpl_core.pipes.to_camel_case_pipe.ToCamelCasePipe.transform"]], "transform() (cpl_core.pipes.to_snake_case_pipe.tosnakecasepipe method)": [[27, "cpl_core.pipes.to_snake_case_pipe.ToSnakeCasePipe.transform"]], "transform() (cpl_core.pipes.version_pipe.versionpipe method)": [[27, "cpl_core.pipes.version_pipe.VersionPipe.transform"]], "timeformatsettings (class in cpl_core.time.time_format_settings)": [[28, "cpl_core.time.time_format_settings.TimeFormatSettings"]], "timeformatsettingsnamesenum (class in cpl_core.time.time_format_settings_names_enum)": [[28, "cpl_core.time.time_format_settings_names_enum.TimeFormatSettingsNamesEnum"]], "versioninfo (class in cpl_core.time)": [[28, "cpl_core.time.VersionInfo"]], "cpl_core.time": [[28, "module-cpl_core.time"]], "cpl_core.time.time_format_settings": [[28, "module-cpl_core.time.time_format_settings"]], "cpl_core.time.time_format_settings_names_enum": [[28, "module-cpl_core.time.time_format_settings_names_enum"]], "date_format (cpl_core.time.time_format_settings.timeformatsettings property)": [[28, "cpl_core.time.time_format_settings.TimeFormatSettings.date_format"]], "date_format (cpl_core.time.time_format_settings_names_enum.timeformatsettingsnamesenum attribute)": [[28, "cpl_core.time.time_format_settings_names_enum.TimeFormatSettingsNamesEnum.date_format"]], "date_time_format (cpl_core.time.time_format_settings.timeformatsettings property)": [[28, "cpl_core.time.time_format_settings.TimeFormatSettings.date_time_format"]], "date_time_format (cpl_core.time.time_format_settings_names_enum.timeformatsettingsnamesenum attribute)": [[28, "cpl_core.time.time_format_settings_names_enum.TimeFormatSettingsNamesEnum.date_time_format"]], "date_time_log_format (cpl_core.time.time_format_settings.timeformatsettings property)": [[28, "cpl_core.time.time_format_settings.TimeFormatSettings.date_time_log_format"]], "date_time_log_format (cpl_core.time.time_format_settings_names_enum.timeformatsettingsnamesenum attribute)": [[28, "cpl_core.time.time_format_settings_names_enum.TimeFormatSettingsNamesEnum.date_time_log_format"]], "major (cpl_core.time.versioninfo attribute)": [[28, "cpl_core.time.VersionInfo.major"]], "micro (cpl_core.time.versioninfo attribute)": [[28, "cpl_core.time.VersionInfo.micro"]], "minor (cpl_core.time.versioninfo attribute)": [[28, "cpl_core.time.VersionInfo.minor"]], "time_format (cpl_core.time.time_format_settings.timeformatsettings property)": [[28, "cpl_core.time.time_format_settings.TimeFormatSettings.time_format"]], "time_format (cpl_core.time.time_format_settings_names_enum.timeformatsettingsnamesenum attribute)": [[28, "cpl_core.time.time_format_settings_names_enum.TimeFormatSettingsNamesEnum.time_format"]], "credentialmanager (class in cpl_core.utils.credential_manager)": [[29, "cpl_core.utils.credential_manager.CredentialManager"]], "pip (class in cpl_core.utils.pip)": [[29, "cpl_core.utils.pip.Pip"]], "string (class in cpl_core.utils.string)": [[29, "cpl_core.utils.string.String"]], "versioninfo (class in cpl_core.utils)": [[29, "cpl_core.utils.VersionInfo"]], "build_string() (cpl_core.utils.credential_manager.credentialmanager static method)": [[29, "cpl_core.utils.credential_manager.CredentialManager.build_string"]], "convert_to_camel_case() (cpl_core.utils.string.string static method)": [[29, "cpl_core.utils.string.String.convert_to_camel_case"]], "convert_to_snake_case() (cpl_core.utils.string.string static method)": [[29, "cpl_core.utils.string.String.convert_to_snake_case"]], "cpl_core.utils": [[29, "module-cpl_core.utils"]], "cpl_core.utils.credential_manager": [[29, "module-cpl_core.utils.credential_manager"]], "cpl_core.utils.pip": [[29, "module-cpl_core.utils.pip"]], "cpl_core.utils.string": [[29, "module-cpl_core.utils.string"]], "decrypt() (cpl_core.utils.credential_manager.credentialmanager static method)": [[29, "cpl_core.utils.credential_manager.CredentialManager.decrypt"]], "encrypt() (cpl_core.utils.credential_manager.credentialmanager static method)": [[29, "cpl_core.utils.credential_manager.CredentialManager.encrypt"]], "first_to_lower() (cpl_core.utils.string.string static method)": [[29, "cpl_core.utils.string.String.first_to_lower"]], "first_to_upper() (cpl_core.utils.string.string static method)": [[29, "cpl_core.utils.string.String.first_to_upper"]], "get_executable() (cpl_core.utils.pip.pip class method)": [[29, "cpl_core.utils.pip.Pip.get_executable"]], "get_outdated() (cpl_core.utils.pip.pip class method)": [[29, "cpl_core.utils.pip.Pip.get_outdated"]], "get_package() (cpl_core.utils.pip.pip class method)": [[29, "cpl_core.utils.pip.Pip.get_package"]], "install() (cpl_core.utils.pip.pip class method)": [[29, "cpl_core.utils.pip.Pip.install"]], "major (cpl_core.utils.versioninfo attribute)": [[29, "cpl_core.utils.VersionInfo.major"]], "micro (cpl_core.utils.versioninfo attribute)": [[29, "cpl_core.utils.VersionInfo.micro"]], "minor (cpl_core.utils.versioninfo attribute)": [[29, "cpl_core.utils.VersionInfo.minor"]], "random_string() (cpl_core.utils.string.string static method)": [[29, "cpl_core.utils.string.String.random_string"]], "reset_executable() (cpl_core.utils.pip.pip class method)": [[29, "cpl_core.utils.pip.Pip.reset_executable"]], "set_executable() (cpl_core.utils.pip.pip class method)": [[29, "cpl_core.utils.pip.Pip.set_executable"]], "uninstall() (cpl_core.utils.pip.pip class method)": [[29, "cpl_core.utils.pip.Pip.uninstall"]], "discordeventtypesenum (class in cpl_discord.discord_event_types_enum)": [[30, "cpl_discord.discord_event_types_enum.DiscordEventTypesEnum"]], "cpl_discord.discord_event_types_enum": [[30, "module-cpl_discord.discord_event_types_enum"]], "on_bulk_message_delete (cpl_discord.discord_event_types_enum.discordeventtypesenum attribute)": [[30, "cpl_discord.discord_event_types_enum.DiscordEventTypesEnum.on_bulk_message_delete"]], "on_command (cpl_discord.discord_event_types_enum.discordeventtypesenum attribute)": [[30, "cpl_discord.discord_event_types_enum.DiscordEventTypesEnum.on_command"]], "on_command_completion (cpl_discord.discord_event_types_enum.discordeventtypesenum attribute)": [[30, "cpl_discord.discord_event_types_enum.DiscordEventTypesEnum.on_command_completion"]], "on_command_error (cpl_discord.discord_event_types_enum.discordeventtypesenum attribute)": [[30, "cpl_discord.discord_event_types_enum.DiscordEventTypesEnum.on_command_error"]], "on_connect (cpl_discord.discord_event_types_enum.discordeventtypesenum attribute)": [[30, "cpl_discord.discord_event_types_enum.DiscordEventTypesEnum.on_connect"]], "on_disconnect (cpl_discord.discord_event_types_enum.discordeventtypesenum attribute)": [[30, "cpl_discord.discord_event_types_enum.DiscordEventTypesEnum.on_disconnect"]], "on_error (cpl_discord.discord_event_types_enum.discordeventtypesenum attribute)": [[30, "cpl_discord.discord_event_types_enum.DiscordEventTypesEnum.on_error"]], "on_group_join (cpl_discord.discord_event_types_enum.discordeventtypesenum attribute)": [[30, "cpl_discord.discord_event_types_enum.DiscordEventTypesEnum.on_group_join"]], "on_group_remove (cpl_discord.discord_event_types_enum.discordeventtypesenum attribute)": [[30, "cpl_discord.discord_event_types_enum.DiscordEventTypesEnum.on_group_remove"]], "on_guild_available (cpl_discord.discord_event_types_enum.discordeventtypesenum attribute)": [[30, "cpl_discord.discord_event_types_enum.DiscordEventTypesEnum.on_guild_available"]], "on_guild_channel_create (cpl_discord.discord_event_types_enum.discordeventtypesenum attribute)": [[30, "cpl_discord.discord_event_types_enum.DiscordEventTypesEnum.on_guild_channel_create"]], "on_guild_channel_delete (cpl_discord.discord_event_types_enum.discordeventtypesenum attribute)": [[30, "cpl_discord.discord_event_types_enum.DiscordEventTypesEnum.on_guild_channel_delete"]], "on_guild_channel_pins_update (cpl_discord.discord_event_types_enum.discordeventtypesenum attribute)": [[30, "cpl_discord.discord_event_types_enum.DiscordEventTypesEnum.on_guild_channel_pins_update"]], "on_guild_channel_update (cpl_discord.discord_event_types_enum.discordeventtypesenum attribute)": [[30, "cpl_discord.discord_event_types_enum.DiscordEventTypesEnum.on_guild_channel_update"]], "on_guild_emojis_update (cpl_discord.discord_event_types_enum.discordeventtypesenum attribute)": [[30, "cpl_discord.discord_event_types_enum.DiscordEventTypesEnum.on_guild_emojis_update"]], "on_guild_integrations_update (cpl_discord.discord_event_types_enum.discordeventtypesenum attribute)": [[30, "cpl_discord.discord_event_types_enum.DiscordEventTypesEnum.on_guild_integrations_update"]], "on_guild_join (cpl_discord.discord_event_types_enum.discordeventtypesenum attribute)": [[30, "cpl_discord.discord_event_types_enum.DiscordEventTypesEnum.on_guild_join"]], "on_guild_remove (cpl_discord.discord_event_types_enum.discordeventtypesenum attribute)": [[30, "cpl_discord.discord_event_types_enum.DiscordEventTypesEnum.on_guild_remove"]], "on_guild_role_create (cpl_discord.discord_event_types_enum.discordeventtypesenum attribute)": [[30, "cpl_discord.discord_event_types_enum.DiscordEventTypesEnum.on_guild_role_create"]], "on_guild_role_delete (cpl_discord.discord_event_types_enum.discordeventtypesenum attribute)": [[30, "cpl_discord.discord_event_types_enum.DiscordEventTypesEnum.on_guild_role_delete"]], "on_guild_role_update (cpl_discord.discord_event_types_enum.discordeventtypesenum attribute)": [[30, "cpl_discord.discord_event_types_enum.DiscordEventTypesEnum.on_guild_role_update"]], "on_guild_unavailable (cpl_discord.discord_event_types_enum.discordeventtypesenum attribute)": [[30, "cpl_discord.discord_event_types_enum.DiscordEventTypesEnum.on_guild_unavailable"]], "on_guild_update (cpl_discord.discord_event_types_enum.discordeventtypesenum attribute)": [[30, "cpl_discord.discord_event_types_enum.DiscordEventTypesEnum.on_guild_update"]], "on_invite_create (cpl_discord.discord_event_types_enum.discordeventtypesenum attribute)": [[30, "cpl_discord.discord_event_types_enum.DiscordEventTypesEnum.on_invite_create"]], "on_invite_delete (cpl_discord.discord_event_types_enum.discordeventtypesenum attribute)": [[30, "cpl_discord.discord_event_types_enum.DiscordEventTypesEnum.on_invite_delete"]], "on_member_ban (cpl_discord.discord_event_types_enum.discordeventtypesenum attribute)": [[30, "cpl_discord.discord_event_types_enum.DiscordEventTypesEnum.on_member_ban"]], "on_member_join (cpl_discord.discord_event_types_enum.discordeventtypesenum attribute)": [[30, "cpl_discord.discord_event_types_enum.DiscordEventTypesEnum.on_member_join"]], "on_member_remove (cpl_discord.discord_event_types_enum.discordeventtypesenum attribute)": [[30, "cpl_discord.discord_event_types_enum.DiscordEventTypesEnum.on_member_remove"]], "on_member_unban (cpl_discord.discord_event_types_enum.discordeventtypesenum attribute)": [[30, "cpl_discord.discord_event_types_enum.DiscordEventTypesEnum.on_member_unban"]], "on_member_update (cpl_discord.discord_event_types_enum.discordeventtypesenum attribute)": [[30, "cpl_discord.discord_event_types_enum.DiscordEventTypesEnum.on_member_update"]], "on_message (cpl_discord.discord_event_types_enum.discordeventtypesenum attribute)": [[30, "cpl_discord.discord_event_types_enum.DiscordEventTypesEnum.on_message"]], "on_message_delete (cpl_discord.discord_event_types_enum.discordeventtypesenum attribute)": [[30, "cpl_discord.discord_event_types_enum.DiscordEventTypesEnum.on_message_delete"]], "on_message_edit (cpl_discord.discord_event_types_enum.discordeventtypesenum attribute)": [[30, "cpl_discord.discord_event_types_enum.DiscordEventTypesEnum.on_message_edit"]], "on_private_channel_create (cpl_discord.discord_event_types_enum.discordeventtypesenum attribute)": [[30, "cpl_discord.discord_event_types_enum.DiscordEventTypesEnum.on_private_channel_create"]], "on_private_channel_delete (cpl_discord.discord_event_types_enum.discordeventtypesenum attribute)": [[30, "cpl_discord.discord_event_types_enum.DiscordEventTypesEnum.on_private_channel_delete"]], "on_private_channel_pins_update (cpl_discord.discord_event_types_enum.discordeventtypesenum attribute)": [[30, "cpl_discord.discord_event_types_enum.DiscordEventTypesEnum.on_private_channel_pins_update"]], "on_private_channel_update (cpl_discord.discord_event_types_enum.discordeventtypesenum attribute)": [[30, "cpl_discord.discord_event_types_enum.DiscordEventTypesEnum.on_private_channel_update"]], "on_raw_reaction_add (cpl_discord.discord_event_types_enum.discordeventtypesenum attribute)": [[30, "cpl_discord.discord_event_types_enum.DiscordEventTypesEnum.on_raw_reaction_add"]], "on_raw_reaction_clear (cpl_discord.discord_event_types_enum.discordeventtypesenum attribute)": [[30, "cpl_discord.discord_event_types_enum.DiscordEventTypesEnum.on_raw_reaction_clear"]], "on_raw_reaction_clear_emoji (cpl_discord.discord_event_types_enum.discordeventtypesenum attribute)": [[30, "cpl_discord.discord_event_types_enum.DiscordEventTypesEnum.on_raw_reaction_clear_emoji"]], "on_raw_reaction_remove (cpl_discord.discord_event_types_enum.discordeventtypesenum attribute)": [[30, "cpl_discord.discord_event_types_enum.DiscordEventTypesEnum.on_raw_reaction_remove"]], "on_reaction_add (cpl_discord.discord_event_types_enum.discordeventtypesenum attribute)": [[30, "cpl_discord.discord_event_types_enum.DiscordEventTypesEnum.on_reaction_add"]], "on_reaction_clear (cpl_discord.discord_event_types_enum.discordeventtypesenum attribute)": [[30, "cpl_discord.discord_event_types_enum.DiscordEventTypesEnum.on_reaction_clear"]], "on_reaction_clear_emoji (cpl_discord.discord_event_types_enum.discordeventtypesenum attribute)": [[30, "cpl_discord.discord_event_types_enum.DiscordEventTypesEnum.on_reaction_clear_emoji"]], "on_reaction_remove (cpl_discord.discord_event_types_enum.discordeventtypesenum attribute)": [[30, "cpl_discord.discord_event_types_enum.DiscordEventTypesEnum.on_reaction_remove"]], "on_ready (cpl_discord.discord_event_types_enum.discordeventtypesenum attribute)": [[30, "cpl_discord.discord_event_types_enum.DiscordEventTypesEnum.on_ready"]], "on_resume (cpl_discord.discord_event_types_enum.discordeventtypesenum attribute)": [[30, "cpl_discord.discord_event_types_enum.DiscordEventTypesEnum.on_resume"]], "on_scheduled_event_create (cpl_discord.discord_event_types_enum.discordeventtypesenum attribute)": [[30, "cpl_discord.discord_event_types_enum.DiscordEventTypesEnum.on_scheduled_event_create"]], "on_scheduled_event_delete (cpl_discord.discord_event_types_enum.discordeventtypesenum attribute)": [[30, "cpl_discord.discord_event_types_enum.DiscordEventTypesEnum.on_scheduled_event_delete"]], "on_scheduled_event_update (cpl_discord.discord_event_types_enum.discordeventtypesenum attribute)": [[30, "cpl_discord.discord_event_types_enum.DiscordEventTypesEnum.on_scheduled_event_update"]], "on_scheduled_event_user_add (cpl_discord.discord_event_types_enum.discordeventtypesenum attribute)": [[30, "cpl_discord.discord_event_types_enum.DiscordEventTypesEnum.on_scheduled_event_user_add"]], "on_scheduled_event_user_remove (cpl_discord.discord_event_types_enum.discordeventtypesenum attribute)": [[30, "cpl_discord.discord_event_types_enum.DiscordEventTypesEnum.on_scheduled_event_user_remove"]], "on_typing (cpl_discord.discord_event_types_enum.discordeventtypesenum attribute)": [[30, "cpl_discord.discord_event_types_enum.DiscordEventTypesEnum.on_typing"]], "on_user_update (cpl_discord.discord_event_types_enum.discordeventtypesenum attribute)": [[30, "cpl_discord.discord_event_types_enum.DiscordEventTypesEnum.on_user_update"]], "on_voice_state_update (cpl_discord.discord_event_types_enum.discordeventtypesenum attribute)": [[30, "cpl_discord.discord_event_types_enum.DiscordEventTypesEnum.on_voice_state_update"]], "on_webhooks_update (cpl_discord.discord_event_types_enum.discordeventtypesenum attribute)": [[30, "cpl_discord.discord_event_types_enum.DiscordEventTypesEnum.on_webhooks_update"]], "discordbotapplicationabc (class in cpl_discord.application.discord_bot_application_abc)": [[31, "cpl_discord.application.discord_bot_application_abc.DiscordBotApplicationABC"]], "versioninfo (class in cpl_discord.application)": [[31, "cpl_discord.application.VersionInfo"]], "cpl_discord.application": [[31, "module-cpl_discord.application"]], "cpl_discord.application.discord_bot_application_abc": [[31, "module-cpl_discord.application.discord_bot_application_abc"]], "major (cpl_discord.application.versioninfo attribute)": [[31, "cpl_discord.application.VersionInfo.major"]], "micro (cpl_discord.application.versioninfo attribute)": [[31, "cpl_discord.application.VersionInfo.micro"]], "minor (cpl_discord.application.versioninfo attribute)": [[31, "cpl_discord.application.VersionInfo.minor"]], "stop_async() (cpl_discord.application.discord_bot_application_abc.discordbotapplicationabc method)": [[31, "cpl_discord.application.discord_bot_application_abc.DiscordBotApplicationABC.stop_async"]], "discordcogmeta (class in cpl_discord.command.discord_commands_meta)": [[32, "cpl_discord.command.discord_commands_meta.DiscordCogMeta"]], "discordcommandabc (class in cpl_discord.command.discord_command_abc)": [[32, "cpl_discord.command.discord_command_abc.DiscordCommandABC"]], "versioninfo (class in cpl_discord.command)": [[32, "cpl_discord.command.VersionInfo"]], "cpl_discord.command": [[32, "module-cpl_discord.command"]], "cpl_discord.command.discord_command_abc": [[32, "module-cpl_discord.command.discord_command_abc"]], "cpl_discord.command.discord_commands_meta": [[32, "module-cpl_discord.command.discord_commands_meta"]], "major (cpl_discord.command.versioninfo attribute)": [[32, "cpl_discord.command.VersionInfo.major"]], "micro (cpl_discord.command.versioninfo attribute)": [[32, "cpl_discord.command.VersionInfo.micro"]], "minor (cpl_discord.command.versioninfo attribute)": [[32, "cpl_discord.command.VersionInfo.minor"]], "discordbotsettings (class in cpl_discord.configuration.discord_bot_settings)": [[33, "cpl_discord.configuration.discord_bot_settings.DiscordBotSettings"]], "versioninfo (class in cpl_discord.configuration)": [[33, "cpl_discord.configuration.VersionInfo"]], "cpl_discord.configuration": [[33, "module-cpl_discord.configuration"]], "cpl_discord.configuration.discord_bot_settings": [[33, "module-cpl_discord.configuration.discord_bot_settings"]], "major (cpl_discord.configuration.versioninfo attribute)": [[33, "cpl_discord.configuration.VersionInfo.major"]], "micro (cpl_discord.configuration.versioninfo attribute)": [[33, "cpl_discord.configuration.VersionInfo.micro"]], "minor (cpl_discord.configuration.versioninfo attribute)": [[33, "cpl_discord.configuration.VersionInfo.minor"]], "prefix (cpl_discord.configuration.discord_bot_settings.discordbotsettings property)": [[33, "cpl_discord.configuration.discord_bot_settings.DiscordBotSettings.prefix"]], "token (cpl_discord.configuration.discord_bot_settings.discordbotsettings property)": [[33, "cpl_discord.configuration.discord_bot_settings.DiscordBotSettings.token"]], "categorychannel (class in cpl_discord.container.category_channel)": [[34, "cpl_discord.container.category_channel.CategoryChannel"]], "container (class in cpl_discord.container.container)": [[34, "cpl_discord.container.container.Container"]], "guild (class in cpl_discord.container.guild)": [[34, "cpl_discord.container.guild.Guild"]], "member (class in cpl_discord.container.member)": [[34, "cpl_discord.container.member.Member"]], "role (class in cpl_discord.container.role)": [[34, "cpl_discord.container.role.Role"]], "textchannel (class in cpl_discord.container.text_channel)": [[34, "cpl_discord.container.text_channel.TextChannel"]], "thread (class in cpl_discord.container.thread)": [[34, "cpl_discord.container.thread.Thread"]], "versioninfo (class in cpl_discord.container)": [[34, "cpl_discord.container.VersionInfo"]], "voicechannel (class in cpl_discord.container.voice_channel)": [[34, "cpl_discord.container.voice_channel.VoiceChannel"]], "activities (cpl_discord.container.member.member attribute)": [[34, "cpl_discord.container.member.Member.activities"]], "afk_channel (cpl_discord.container.guild.guild attribute)": [[34, "cpl_discord.container.guild.Guild.afk_channel"]], "afk_timeout (cpl_discord.container.guild.guild attribute)": [[34, "cpl_discord.container.guild.Guild.afk_timeout"]], "approximate_member_count (cpl_discord.container.guild.guild attribute)": [[34, "cpl_discord.container.guild.Guild.approximate_member_count"]], "approximate_presence_count (cpl_discord.container.guild.guild attribute)": [[34, "cpl_discord.container.guild.Guild.approximate_presence_count"]], "archive_timestamp (cpl_discord.container.thread.thread attribute)": [[34, "cpl_discord.container.thread.Thread.archive_timestamp"]], "archived (cpl_discord.container.thread.thread attribute)": [[34, "cpl_discord.container.thread.Thread.archived"]], "archiver_id (cpl_discord.container.thread.thread attribute)": [[34, "cpl_discord.container.thread.Thread.archiver_id"]], "auto_archive_duration (cpl_discord.container.thread.thread attribute)": [[34, "cpl_discord.container.thread.Thread.auto_archive_duration"]], "categories (cpl_discord.container.guild.guild property)": [[34, "cpl_discord.container.guild.Guild.categories"]], "category_id (cpl_discord.container.category_channel.categorychannel attribute)": [[34, "cpl_discord.container.category_channel.CategoryChannel.category_id"]], "category_id (cpl_discord.container.text_channel.textchannel attribute)": [[34, "cpl_discord.container.text_channel.TextChannel.category_id"]], "cpl_discord.container": [[34, "module-cpl_discord.container"]], "cpl_discord.container.category_channel": [[34, "module-cpl_discord.container.category_channel"]], "cpl_discord.container.container": [[34, "module-cpl_discord.container.container"]], "cpl_discord.container.guild": [[34, "module-cpl_discord.container.guild"]], "cpl_discord.container.member": [[34, "module-cpl_discord.container.member"]], "cpl_discord.container.role": [[34, "module-cpl_discord.container.role"]], "cpl_discord.container.text_channel": [[34, "module-cpl_discord.container.text_channel"]], "cpl_discord.container.thread": [[34, "module-cpl_discord.container.thread"]], "cpl_discord.container.voice_channel": [[34, "module-cpl_discord.container.voice_channel"]], "default_auto_archive_duration (cpl_discord.container.text_channel.textchannel attribute)": [[34, "cpl_discord.container.text_channel.TextChannel.default_auto_archive_duration"]], "default_notifications (cpl_discord.container.guild.guild attribute)": [[34, "cpl_discord.container.guild.Guild.default_notifications"]], "description (cpl_discord.container.guild.guild attribute)": [[34, "cpl_discord.container.guild.Guild.description"]], "emojis (cpl_discord.container.guild.guild attribute)": [[34, "cpl_discord.container.guild.Guild.emojis"]], "explicit_content_filter (cpl_discord.container.guild.guild attribute)": [[34, "cpl_discord.container.guild.Guild.explicit_content_filter"]], "features (cpl_discord.container.guild.guild attribute)": [[34, "cpl_discord.container.guild.Guild.features"]], "guild (cpl_discord.container.category_channel.categorychannel attribute)": [[34, "cpl_discord.container.category_channel.CategoryChannel.guild"]], "guild (cpl_discord.container.member.member attribute)": [[34, "cpl_discord.container.member.Member.guild"]], "guild (cpl_discord.container.role.role attribute)": [[34, "cpl_discord.container.role.Role.guild"]], "guild (cpl_discord.container.text_channel.textchannel attribute)": [[34, "cpl_discord.container.text_channel.TextChannel.guild"]], "guild (cpl_discord.container.thread.thread attribute)": [[34, "cpl_discord.container.thread.Thread.guild"]], "hoist (cpl_discord.container.role.role attribute)": [[34, "cpl_discord.container.role.Role.hoist"]], "id (cpl_discord.container.category_channel.categorychannel attribute)": [[34, "cpl_discord.container.category_channel.CategoryChannel.id"]], "id (cpl_discord.container.guild.guild attribute)": [[34, "cpl_discord.container.guild.Guild.id"]], "id (cpl_discord.container.role.role attribute)": [[34, "cpl_discord.container.role.Role.id"]], "id (cpl_discord.container.text_channel.textchannel attribute)": [[34, "cpl_discord.container.text_channel.TextChannel.id"]], "id (cpl_discord.container.thread.thread attribute)": [[34, "cpl_discord.container.thread.Thread.id"]], "invitable (cpl_discord.container.thread.thread attribute)": [[34, "cpl_discord.container.thread.Thread.invitable"]], "joined_at (cpl_discord.container.member.member attribute)": [[34, "cpl_discord.container.member.Member.joined_at"]], "last_message_id (cpl_discord.container.text_channel.textchannel attribute)": [[34, "cpl_discord.container.text_channel.TextChannel.last_message_id"]], "last_message_id (cpl_discord.container.thread.thread attribute)": [[34, "cpl_discord.container.thread.Thread.last_message_id"]], "locked (cpl_discord.container.thread.thread attribute)": [[34, "cpl_discord.container.thread.Thread.locked"]], "major (cpl_discord.container.versioninfo attribute)": [[34, "cpl_discord.container.VersionInfo.major"]], "managed (cpl_discord.container.role.role attribute)": [[34, "cpl_discord.container.role.Role.managed"]], "max_members (cpl_discord.container.guild.guild attribute)": [[34, "cpl_discord.container.guild.Guild.max_members"]], "max_presences (cpl_discord.container.guild.guild attribute)": [[34, "cpl_discord.container.guild.Guild.max_presences"]], "max_video_channel_users (cpl_discord.container.guild.guild attribute)": [[34, "cpl_discord.container.guild.Guild.max_video_channel_users"]], "me (cpl_discord.container.thread.thread attribute)": [[34, "cpl_discord.container.thread.Thread.me"]], "member_count (cpl_discord.container.thread.thread attribute)": [[34, "cpl_discord.container.thread.Thread.member_count"]], "members (cpl_discord.container.guild.guild property)": [[34, "cpl_discord.container.guild.Guild.members"]], "members (cpl_discord.container.role.role property)": [[34, "cpl_discord.container.role.Role.members"]], "members (cpl_discord.container.text_channel.textchannel property)": [[34, "cpl_discord.container.text_channel.TextChannel.members"]], "members (cpl_discord.container.thread.thread property)": [[34, "cpl_discord.container.thread.Thread.members"]], "members (cpl_discord.container.voice_channel.voicechannel property)": [[34, "cpl_discord.container.voice_channel.VoiceChannel.members"]], "mentionable (cpl_discord.container.role.role attribute)": [[34, "cpl_discord.container.role.Role.mentionable"]], "message_count (cpl_discord.container.thread.thread attribute)": [[34, "cpl_discord.container.thread.Thread.message_count"]], "mfa_level (cpl_discord.container.guild.guild attribute)": [[34, "cpl_discord.container.guild.Guild.mfa_level"]], "micro (cpl_discord.container.versioninfo attribute)": [[34, "cpl_discord.container.VersionInfo.micro"]], "minor (cpl_discord.container.versioninfo attribute)": [[34, "cpl_discord.container.VersionInfo.minor"]], "name (cpl_discord.container.category_channel.categorychannel attribute)": [[34, "cpl_discord.container.category_channel.CategoryChannel.name"]], "name (cpl_discord.container.guild.guild attribute)": [[34, "cpl_discord.container.guild.Guild.name"]], "name (cpl_discord.container.role.role attribute)": [[34, "cpl_discord.container.role.Role.name"]], "name (cpl_discord.container.text_channel.textchannel attribute)": [[34, "cpl_discord.container.text_channel.TextChannel.name"]], "name (cpl_discord.container.thread.thread attribute)": [[34, "cpl_discord.container.thread.Thread.name"]], "nick (cpl_discord.container.member.member attribute)": [[34, "cpl_discord.container.member.Member.nick"]], "nsfw (cpl_discord.container.category_channel.categorychannel attribute)": [[34, "cpl_discord.container.category_channel.CategoryChannel.nsfw"]], "nsfw (cpl_discord.container.text_channel.textchannel attribute)": [[34, "cpl_discord.container.text_channel.TextChannel.nsfw"]], "nsfw_level (cpl_discord.container.guild.guild attribute)": [[34, "cpl_discord.container.guild.Guild.nsfw_level"]], "owner_id (cpl_discord.container.guild.guild attribute)": [[34, "cpl_discord.container.guild.Guild.owner_id"]], "owner_id (cpl_discord.container.thread.thread attribute)": [[34, "cpl_discord.container.thread.Thread.owner_id"]], "parent_id (cpl_discord.container.thread.thread attribute)": [[34, "cpl_discord.container.thread.Thread.parent_id"]], "pending (cpl_discord.container.member.member attribute)": [[34, "cpl_discord.container.member.Member.pending"]], "position (cpl_discord.container.category_channel.categorychannel attribute)": [[34, "cpl_discord.container.category_channel.CategoryChannel.position"]], "position (cpl_discord.container.role.role attribute)": [[34, "cpl_discord.container.role.Role.position"]], "position (cpl_discord.container.text_channel.textchannel attribute)": [[34, "cpl_discord.container.text_channel.TextChannel.position"]], "preferred_locale (cpl_discord.container.guild.guild attribute)": [[34, "cpl_discord.container.guild.Guild.preferred_locale"]], "premium_progress_bar_enabled (cpl_discord.container.guild.guild attribute)": [[34, "cpl_discord.container.guild.Guild.premium_progress_bar_enabled"]], "premium_since (cpl_discord.container.member.member attribute)": [[34, "cpl_discord.container.member.Member.premium_since"]], "premium_subscription_count (cpl_discord.container.guild.guild attribute)": [[34, "cpl_discord.container.guild.Guild.premium_subscription_count"]], "premium_tier (cpl_discord.container.guild.guild attribute)": [[34, "cpl_discord.container.guild.Guild.premium_tier"]], "roles (cpl_discord.container.guild.guild property)": [[34, "cpl_discord.container.guild.Guild.roles"]], "roles (cpl_discord.container.member.member property)": [[34, "cpl_discord.container.member.Member.roles"]], "slowmode_delay (cpl_discord.container.text_channel.textchannel attribute)": [[34, "cpl_discord.container.text_channel.TextChannel.slowmode_delay"]], "slowmode_delay (cpl_discord.container.thread.thread attribute)": [[34, "cpl_discord.container.thread.Thread.slowmode_delay"]], "stickers (cpl_discord.container.guild.guild attribute)": [[34, "cpl_discord.container.guild.Guild.stickers"]], "tags (cpl_discord.container.role.role attribute)": [[34, "cpl_discord.container.role.Role.tags"]], "text_channels (cpl_discord.container.category_channel.categorychannel property)": [[34, "cpl_discord.container.category_channel.CategoryChannel.text_channels"]], "text_channels (cpl_discord.container.guild.guild property)": [[34, "cpl_discord.container.guild.Guild.text_channels"]], "threads (cpl_discord.container.guild.guild property)": [[34, "cpl_discord.container.guild.Guild.threads"]], "threads (cpl_discord.container.text_channel.textchannel property)": [[34, "cpl_discord.container.text_channel.TextChannel.threads"]], "timed_out_until (cpl_discord.container.member.member attribute)": [[34, "cpl_discord.container.member.Member.timed_out_until"]], "topic (cpl_discord.container.text_channel.textchannel attribute)": [[34, "cpl_discord.container.text_channel.TextChannel.topic"]], "unavailable (cpl_discord.container.guild.guild attribute)": [[34, "cpl_discord.container.guild.Guild.unavailable"]], "unicode_emoji (cpl_discord.container.role.role attribute)": [[34, "cpl_discord.container.role.Role.unicode_emoji"]], "vanity_url_code (cpl_discord.container.guild.guild attribute)": [[34, "cpl_discord.container.guild.Guild.vanity_url_code"]], "verification_level (cpl_discord.container.guild.guild attribute)": [[34, "cpl_discord.container.guild.Guild.verification_level"]], "voice_channels (cpl_discord.container.category_channel.categorychannel property)": [[34, "cpl_discord.container.category_channel.CategoryChannel.voice_channels"]], "voice_channels (cpl_discord.container.guild.guild property)": [[34, "cpl_discord.container.guild.Guild.voice_channels"]], "widget_enabled (cpl_discord.container.guild.guild attribute)": [[34, "cpl_discord.container.guild.Guild.widget_enabled"]], "onbulkmessagedeleteabc (class in cpl_discord.events.on_bulk_message_delete_abc)": [[35, "cpl_discord.events.on_bulk_message_delete_abc.OnBulkMessageDeleteABC"]], "oncommandabc (class in cpl_discord.events.on_command_abc)": [[35, "cpl_discord.events.on_command_abc.OnCommandABC"]], "oncommandcompletionabc (class in cpl_discord.events.on_command_completion_abc)": [[35, "cpl_discord.events.on_command_completion_abc.OnCommandCompletionABC"]], "oncommanderrorabc (class in cpl_discord.events.on_command_error_abc)": [[35, "cpl_discord.events.on_command_error_abc.OnCommandErrorABC"]], "onconnectabc (class in cpl_discord.events.on_connect_abc)": [[35, "cpl_discord.events.on_connect_abc.OnConnectABC"]], "ondisconnectabc (class in cpl_discord.events.on_disconnect_abc)": [[35, "cpl_discord.events.on_disconnect_abc.OnDisconnectABC"]], "onerrorabc (class in cpl_discord.events.on_error_abc)": [[35, "cpl_discord.events.on_error_abc.OnErrorABC"]], "ongroupjoinabc (class in cpl_discord.events.on_group_join_abc)": [[35, "cpl_discord.events.on_group_join_abc.OnGroupJoinABC"]], "ongroupremoveabc (class in cpl_discord.events.on_group_remove_abc)": [[35, "cpl_discord.events.on_group_remove_abc.OnGroupRemoveABC"]], "onguildavailableabc (class in cpl_discord.events.on_guild_available_abc)": [[35, "cpl_discord.events.on_guild_available_abc.OnGuildAvailableABC"]], "onguildchannelcreateabc (class in cpl_discord.events.on_guild_channel_create_abc)": [[35, "cpl_discord.events.on_guild_channel_create_abc.OnGuildChannelCreateABC"]], "onguildchanneldeleteabc (class in cpl_discord.events.on_guild_channel_delete_abc)": [[35, "cpl_discord.events.on_guild_channel_delete_abc.OnGuildChannelDeleteABC"]], "onguildchannelpinsupdateabc (class in cpl_discord.events.on_guild_channel_pins_update_abc)": [[35, "cpl_discord.events.on_guild_channel_pins_update_abc.OnGuildChannelPinsUpdateABC"]], "onguildchannelupdateabc (class in cpl_discord.events.on_guild_channel_update_abc)": [[35, "cpl_discord.events.on_guild_channel_update_abc.OnGuildChannelUpdateABC"]], "onguildemojisupdateabc (class in cpl_discord.events.on_guild_emojis_update_abc)": [[35, "cpl_discord.events.on_guild_emojis_update_abc.OnGuildEmojisUpdateABC"]], "onguildintegrationsupdateabc (class in cpl_discord.events.on_guild_integrations_update_abc)": [[35, "cpl_discord.events.on_guild_integrations_update_abc.OnGuildIntegrationsUpdateABC"]], "onguildjoinabc (class in cpl_discord.events.on_guild_join_abc)": [[35, "cpl_discord.events.on_guild_join_abc.OnGuildJoinABC"]], "onguildremoveabc (class in cpl_discord.events.on_guild_remove_abc)": [[35, "cpl_discord.events.on_guild_remove_abc.OnGuildRemoveABC"]], "onguildrolecreateabc (class in cpl_discord.events.on_guild_role_create_abc)": [[35, "cpl_discord.events.on_guild_role_create_abc.OnGuildRoleCreateABC"]], "onguildroledeleteabc (class in cpl_discord.events.on_guild_role_delete_abc)": [[35, "cpl_discord.events.on_guild_role_delete_abc.OnGuildRoleDeleteABC"]], "onguildroleupdateabc (class in cpl_discord.events.on_guild_role_update_abc)": [[35, "cpl_discord.events.on_guild_role_update_abc.OnGuildRoleUpdateABC"]], "onguildunavailableabc (class in cpl_discord.events.on_guild_unavailable_abc)": [[35, "cpl_discord.events.on_guild_unavailable_abc.OnGuildUnavailableABC"]], "onguildupdateabc (class in cpl_discord.events.on_guild_update_abc)": [[35, "cpl_discord.events.on_guild_update_abc.OnGuildUpdateABC"]], "oninvitecreateabc (class in cpl_discord.events.on_invite_create_abc)": [[35, "cpl_discord.events.on_invite_create_abc.OnInviteCreateABC"]], "oninvitedeleteabc (class in cpl_discord.events.on_invite_delete_abc)": [[35, "cpl_discord.events.on_invite_delete_abc.OnInviteDeleteABC"]], "onmemberbanabc (class in cpl_discord.events.on_member_ban_abc)": [[35, "cpl_discord.events.on_member_ban_abc.OnMemberBanABC"]], "onmemberjoinabc (class in cpl_discord.events.on_member_join_abc)": [[35, "cpl_discord.events.on_member_join_abc.OnMemberJoinABC"]], "onmemberremoveabc (class in cpl_discord.events.on_member_remove_abc)": [[35, "cpl_discord.events.on_member_remove_abc.OnMemberRemoveABC"]], "onmemberunbanabc (class in cpl_discord.events.on_member_unban_abc)": [[35, "cpl_discord.events.on_member_unban_abc.OnMemberUnbanABC"]], "onmemberupdateabc (class in cpl_discord.events.on_member_update_abc)": [[35, "cpl_discord.events.on_member_update_abc.OnMemberUpdateABC"]], "onmessageabc (class in cpl_discord.events.on_message_abc)": [[35, "cpl_discord.events.on_message_abc.OnMessageABC"]], "onmessagedeleteabc (class in cpl_discord.events.on_message_delete_abc)": [[35, "cpl_discord.events.on_message_delete_abc.OnMessageDeleteABC"]], "onmessageeditabc (class in cpl_discord.events.on_message_edit_abc)": [[35, "cpl_discord.events.on_message_edit_abc.OnMessageEditABC"]], "onprivatechannelcreateabc (class in cpl_discord.events.on_private_channel_create_abc)": [[35, "cpl_discord.events.on_private_channel_create_abc.OnPrivateChannelCreateABC"]], "onprivatechanneldeleteabc (class in cpl_discord.events.on_private_channel_delete_abc)": [[35, "cpl_discord.events.on_private_channel_delete_abc.OnPrivateChannelDeleteABC"]], "onprivatechannelpinsupdateabc (class in cpl_discord.events.on_private_channel_pins_update_abc)": [[35, "cpl_discord.events.on_private_channel_pins_update_abc.OnPrivateChannelPinsUpdateABC"]], "onprivatechannelupdateabc (class in cpl_discord.events.on_private_channel_update_abc)": [[35, "cpl_discord.events.on_private_channel_update_abc.OnPrivateChannelUpdateABC"]], "onrawreactionaddabc (class in cpl_discord.events.on_raw_reaction_add_abc)": [[35, "cpl_discord.events.on_raw_reaction_add_abc.OnRawReactionAddABC"]], "onrawreactionclearabc (class in cpl_discord.events.on_raw_reaction_clear_abc)": [[35, "cpl_discord.events.on_raw_reaction_clear_abc.OnRawReactionClearABC"]], "onrawreactionclearemojiabc (class in cpl_discord.events.on_raw_reaction_clear_emoji_abc)": [[35, "cpl_discord.events.on_raw_reaction_clear_emoji_abc.OnRawReactionClearEmojiABC"]], "onrawreactionremoveabc (class in cpl_discord.events.on_raw_reaction_remove_abc)": [[35, "cpl_discord.events.on_raw_reaction_remove_abc.OnRawReactionRemoveABC"]], "onreactionaddabc (class in cpl_discord.events.on_reaction_add_abc)": [[35, "cpl_discord.events.on_reaction_add_abc.OnReactionAddABC"]], "onreactionclearabc (class in cpl_discord.events.on_reaction_clear_abc)": [[35, "cpl_discord.events.on_reaction_clear_abc.OnReactionClearABC"]], "onreactionclearemojiabc (class in cpl_discord.events.on_reaction_clear_emoji_abc)": [[35, "cpl_discord.events.on_reaction_clear_emoji_abc.OnReactionClearEmojiABC"]], "onreactionremoveabc (class in cpl_discord.events.on_reaction_remove_abc)": [[35, "cpl_discord.events.on_reaction_remove_abc.OnReactionRemoveABC"]], "onreadyabc (class in cpl_discord.events.on_ready_abc)": [[35, "cpl_discord.events.on_ready_abc.OnReadyABC"]], "onresumeabc (class in cpl_discord.events.on_resume_abc)": [[35, "cpl_discord.events.on_resume_abc.OnResumeABC"]], "ontypingabc (class in cpl_discord.events.on_typing_abc)": [[35, "cpl_discord.events.on_typing_abc.OnTypingABC"]], "onuserupdateabc (class in cpl_discord.events.on_user_update_abc)": [[35, "cpl_discord.events.on_user_update_abc.OnUserUpdateABC"]], "onvoicestateupdateabc (class in cpl_discord.events.on_voice_state_update_abc)": [[35, "cpl_discord.events.on_voice_state_update_abc.OnVoiceStateUpdateABC"]], "onwebhooksupdateabc (class in cpl_discord.events.on_webhooks_update_abc)": [[35, "cpl_discord.events.on_webhooks_update_abc.OnWebhooksUpdateABC"]], "versioninfo (class in cpl_discord.events)": [[35, "cpl_discord.events.VersionInfo"]], "cpl_discord.events": [[35, "module-cpl_discord.events"]], "cpl_discord.events.on_bulk_message_delete_abc": [[35, "module-cpl_discord.events.on_bulk_message_delete_abc"]], "cpl_discord.events.on_command_abc": [[35, "module-cpl_discord.events.on_command_abc"]], "cpl_discord.events.on_command_completion_abc": [[35, "module-cpl_discord.events.on_command_completion_abc"]], "cpl_discord.events.on_command_error_abc": [[35, "module-cpl_discord.events.on_command_error_abc"]], "cpl_discord.events.on_connect_abc": [[35, "module-cpl_discord.events.on_connect_abc"]], "cpl_discord.events.on_disconnect_abc": [[35, "module-cpl_discord.events.on_disconnect_abc"]], "cpl_discord.events.on_error_abc": [[35, "module-cpl_discord.events.on_error_abc"]], "cpl_discord.events.on_group_join_abc": [[35, "module-cpl_discord.events.on_group_join_abc"]], "cpl_discord.events.on_group_remove_abc": [[35, "module-cpl_discord.events.on_group_remove_abc"]], "cpl_discord.events.on_guild_available_abc": [[35, "module-cpl_discord.events.on_guild_available_abc"]], "cpl_discord.events.on_guild_channel_create_abc": [[35, "module-cpl_discord.events.on_guild_channel_create_abc"]], "cpl_discord.events.on_guild_channel_delete_abc": [[35, "module-cpl_discord.events.on_guild_channel_delete_abc"]], "cpl_discord.events.on_guild_channel_pins_update_abc": [[35, "module-cpl_discord.events.on_guild_channel_pins_update_abc"]], "cpl_discord.events.on_guild_channel_update_abc": [[35, "module-cpl_discord.events.on_guild_channel_update_abc"]], "cpl_discord.events.on_guild_emojis_update_abc": [[35, "module-cpl_discord.events.on_guild_emojis_update_abc"]], "cpl_discord.events.on_guild_integrations_update_abc": [[35, "module-cpl_discord.events.on_guild_integrations_update_abc"]], "cpl_discord.events.on_guild_join_abc": [[35, "module-cpl_discord.events.on_guild_join_abc"]], "cpl_discord.events.on_guild_remove_abc": [[35, "module-cpl_discord.events.on_guild_remove_abc"]], "cpl_discord.events.on_guild_role_create_abc": [[35, "module-cpl_discord.events.on_guild_role_create_abc"]], "cpl_discord.events.on_guild_role_delete_abc": [[35, "module-cpl_discord.events.on_guild_role_delete_abc"]], "cpl_discord.events.on_guild_role_update_abc": [[35, "module-cpl_discord.events.on_guild_role_update_abc"]], "cpl_discord.events.on_guild_unavailable_abc": [[35, "module-cpl_discord.events.on_guild_unavailable_abc"]], "cpl_discord.events.on_guild_update_abc": [[35, "module-cpl_discord.events.on_guild_update_abc"]], "cpl_discord.events.on_invite_create_abc": [[35, "module-cpl_discord.events.on_invite_create_abc"]], "cpl_discord.events.on_invite_delete_abc": [[35, "module-cpl_discord.events.on_invite_delete_abc"]], "cpl_discord.events.on_member_ban_abc": [[35, "module-cpl_discord.events.on_member_ban_abc"]], "cpl_discord.events.on_member_join_abc": [[35, "module-cpl_discord.events.on_member_join_abc"]], "cpl_discord.events.on_member_remove_abc": [[35, "module-cpl_discord.events.on_member_remove_abc"]], "cpl_discord.events.on_member_unban_abc": [[35, "module-cpl_discord.events.on_member_unban_abc"]], "cpl_discord.events.on_member_update_abc": [[35, "module-cpl_discord.events.on_member_update_abc"]], "cpl_discord.events.on_message_abc": [[35, "module-cpl_discord.events.on_message_abc"]], "cpl_discord.events.on_message_delete_abc": [[35, "module-cpl_discord.events.on_message_delete_abc"]], "cpl_discord.events.on_message_edit_abc": [[35, "module-cpl_discord.events.on_message_edit_abc"]], "cpl_discord.events.on_private_channel_create_abc": [[35, "module-cpl_discord.events.on_private_channel_create_abc"]], "cpl_discord.events.on_private_channel_delete_abc": [[35, "module-cpl_discord.events.on_private_channel_delete_abc"]], "cpl_discord.events.on_private_channel_pins_update_abc": [[35, "module-cpl_discord.events.on_private_channel_pins_update_abc"]], "cpl_discord.events.on_private_channel_update_abc": [[35, "module-cpl_discord.events.on_private_channel_update_abc"]], "cpl_discord.events.on_raw_reaction_add_abc": [[35, "module-cpl_discord.events.on_raw_reaction_add_abc"]], "cpl_discord.events.on_raw_reaction_clear_abc": [[35, "module-cpl_discord.events.on_raw_reaction_clear_abc"]], "cpl_discord.events.on_raw_reaction_clear_emoji_abc": [[35, "module-cpl_discord.events.on_raw_reaction_clear_emoji_abc"]], "cpl_discord.events.on_raw_reaction_remove_abc": [[35, "module-cpl_discord.events.on_raw_reaction_remove_abc"]], "cpl_discord.events.on_reaction_add_abc": [[35, "module-cpl_discord.events.on_reaction_add_abc"]], "cpl_discord.events.on_reaction_clear_abc": [[35, "module-cpl_discord.events.on_reaction_clear_abc"]], "cpl_discord.events.on_reaction_clear_emoji_abc": [[35, "module-cpl_discord.events.on_reaction_clear_emoji_abc"]], "cpl_discord.events.on_reaction_remove_abc": [[35, "module-cpl_discord.events.on_reaction_remove_abc"]], "cpl_discord.events.on_ready_abc": [[35, "module-cpl_discord.events.on_ready_abc"]], "cpl_discord.events.on_resume_abc": [[35, "module-cpl_discord.events.on_resume_abc"]], "cpl_discord.events.on_typing_abc": [[35, "module-cpl_discord.events.on_typing_abc"]], "cpl_discord.events.on_user_update_abc": [[35, "module-cpl_discord.events.on_user_update_abc"]], "cpl_discord.events.on_voice_state_update_abc": [[35, "module-cpl_discord.events.on_voice_state_update_abc"]], "cpl_discord.events.on_webhooks_update_abc": [[35, "module-cpl_discord.events.on_webhooks_update_abc"]], "major (cpl_discord.events.versioninfo attribute)": [[35, "cpl_discord.events.VersionInfo.major"]], "micro (cpl_discord.events.versioninfo attribute)": [[35, "cpl_discord.events.VersionInfo.micro"]], "minor (cpl_discord.events.versioninfo attribute)": [[35, "cpl_discord.events.VersionInfo.minor"]], "on_bulk_message_delete() (cpl_discord.events.on_bulk_message_delete_abc.onbulkmessagedeleteabc method)": [[35, "cpl_discord.events.on_bulk_message_delete_abc.OnBulkMessageDeleteABC.on_bulk_message_delete"]], "on_command() (cpl_discord.events.on_command_abc.oncommandabc method)": [[35, "cpl_discord.events.on_command_abc.OnCommandABC.on_command"]], "on_command_completion() (cpl_discord.events.on_command_completion_abc.oncommandcompletionabc method)": [[35, "cpl_discord.events.on_command_completion_abc.OnCommandCompletionABC.on_command_completion"]], "on_command_error() (cpl_discord.events.on_command_error_abc.oncommanderrorabc method)": [[35, "cpl_discord.events.on_command_error_abc.OnCommandErrorABC.on_command_error"]], "on_connect() (cpl_discord.events.on_connect_abc.onconnectabc method)": [[35, "cpl_discord.events.on_connect_abc.OnConnectABC.on_connect"]], "on_disconnect() (cpl_discord.events.on_disconnect_abc.ondisconnectabc method)": [[35, "cpl_discord.events.on_disconnect_abc.OnDisconnectABC.on_disconnect"]], "on_error() (cpl_discord.events.on_error_abc.onerrorabc method)": [[35, "cpl_discord.events.on_error_abc.OnErrorABC.on_error"]], "on_group_join() (cpl_discord.events.on_group_join_abc.ongroupjoinabc method)": [[35, "cpl_discord.events.on_group_join_abc.OnGroupJoinABC.on_group_join"]], "on_group_remove() (cpl_discord.events.on_group_remove_abc.ongroupremoveabc method)": [[35, "cpl_discord.events.on_group_remove_abc.OnGroupRemoveABC.on_group_remove"]], "on_guild_available() (cpl_discord.events.on_guild_available_abc.onguildavailableabc method)": [[35, "cpl_discord.events.on_guild_available_abc.OnGuildAvailableABC.on_guild_available"]], "on_guild_channel_create() (cpl_discord.events.on_guild_channel_create_abc.onguildchannelcreateabc method)": [[35, "cpl_discord.events.on_guild_channel_create_abc.OnGuildChannelCreateABC.on_guild_channel_create"]], "on_guild_channel_delete() (cpl_discord.events.on_guild_channel_delete_abc.onguildchanneldeleteabc method)": [[35, "cpl_discord.events.on_guild_channel_delete_abc.OnGuildChannelDeleteABC.on_guild_channel_delete"]], "on_guild_channel_pins_update() (cpl_discord.events.on_guild_channel_pins_update_abc.onguildchannelpinsupdateabc method)": [[35, "cpl_discord.events.on_guild_channel_pins_update_abc.OnGuildChannelPinsUpdateABC.on_guild_channel_pins_update"]], "on_guild_channel_update() (cpl_discord.events.on_guild_channel_update_abc.onguildchannelupdateabc method)": [[35, "cpl_discord.events.on_guild_channel_update_abc.OnGuildChannelUpdateABC.on_guild_channel_update"]], "on_guild_emojis_update() (cpl_discord.events.on_guild_emojis_update_abc.onguildemojisupdateabc method)": [[35, "cpl_discord.events.on_guild_emojis_update_abc.OnGuildEmojisUpdateABC.on_guild_emojis_update"]], "on_guild_integrations_update() (cpl_discord.events.on_guild_integrations_update_abc.onguildintegrationsupdateabc method)": [[35, "cpl_discord.events.on_guild_integrations_update_abc.OnGuildIntegrationsUpdateABC.on_guild_integrations_update"]], "on_guild_join() (cpl_discord.events.on_guild_join_abc.onguildjoinabc method)": [[35, "cpl_discord.events.on_guild_join_abc.OnGuildJoinABC.on_guild_join"]], "on_guild_remove() (cpl_discord.events.on_guild_remove_abc.onguildremoveabc method)": [[35, "cpl_discord.events.on_guild_remove_abc.OnGuildRemoveABC.on_guild_remove"]], "on_guild_role_create() (cpl_discord.events.on_guild_role_create_abc.onguildrolecreateabc method)": [[35, "cpl_discord.events.on_guild_role_create_abc.OnGuildRoleCreateABC.on_guild_role_create"]], "on_guild_role_delete() (cpl_discord.events.on_guild_role_delete_abc.onguildroledeleteabc method)": [[35, "cpl_discord.events.on_guild_role_delete_abc.OnGuildRoleDeleteABC.on_guild_role_delete"]], "on_guild_role_update() (cpl_discord.events.on_guild_role_update_abc.onguildroleupdateabc method)": [[35, "cpl_discord.events.on_guild_role_update_abc.OnGuildRoleUpdateABC.on_guild_role_update"]], "on_guild_unavailable() (cpl_discord.events.on_guild_unavailable_abc.onguildunavailableabc method)": [[35, "cpl_discord.events.on_guild_unavailable_abc.OnGuildUnavailableABC.on_guild_unavailable"]], "on_guild_update() (cpl_discord.events.on_guild_update_abc.onguildupdateabc method)": [[35, "cpl_discord.events.on_guild_update_abc.OnGuildUpdateABC.on_guild_update"]], "on_invite_create() (cpl_discord.events.on_invite_create_abc.oninvitecreateabc method)": [[35, "cpl_discord.events.on_invite_create_abc.OnInviteCreateABC.on_invite_create"]], "on_invite_delete() (cpl_discord.events.on_invite_delete_abc.oninvitedeleteabc method)": [[35, "cpl_discord.events.on_invite_delete_abc.OnInviteDeleteABC.on_invite_delete"]], "on_member_ban() (cpl_discord.events.on_member_ban_abc.onmemberbanabc method)": [[35, "cpl_discord.events.on_member_ban_abc.OnMemberBanABC.on_member_ban"]], "on_member_join() (cpl_discord.events.on_member_join_abc.onmemberjoinabc method)": [[35, "cpl_discord.events.on_member_join_abc.OnMemberJoinABC.on_member_join"]], "on_member_remove() (cpl_discord.events.on_member_remove_abc.onmemberremoveabc method)": [[35, "cpl_discord.events.on_member_remove_abc.OnMemberRemoveABC.on_member_remove"]], "on_member_unban() (cpl_discord.events.on_member_unban_abc.onmemberunbanabc method)": [[35, "cpl_discord.events.on_member_unban_abc.OnMemberUnbanABC.on_member_unban"]], "on_member_update() (cpl_discord.events.on_member_update_abc.onmemberupdateabc method)": [[35, "cpl_discord.events.on_member_update_abc.OnMemberUpdateABC.on_member_update"]], "on_message() (cpl_discord.events.on_message_abc.onmessageabc method)": [[35, "cpl_discord.events.on_message_abc.OnMessageABC.on_message"]], "on_message_delete() (cpl_discord.events.on_message_delete_abc.onmessagedeleteabc method)": [[35, "cpl_discord.events.on_message_delete_abc.OnMessageDeleteABC.on_message_delete"]], "on_message_edit() (cpl_discord.events.on_message_edit_abc.onmessageeditabc method)": [[35, "cpl_discord.events.on_message_edit_abc.OnMessageEditABC.on_message_edit"]], "on_private_channel_create() (cpl_discord.events.on_private_channel_create_abc.onprivatechannelcreateabc method)": [[35, "cpl_discord.events.on_private_channel_create_abc.OnPrivateChannelCreateABC.on_private_channel_create"]], "on_private_channel_delete() (cpl_discord.events.on_private_channel_delete_abc.onprivatechanneldeleteabc method)": [[35, "cpl_discord.events.on_private_channel_delete_abc.OnPrivateChannelDeleteABC.on_private_channel_delete"]], "on_private_channel_pins_update() (cpl_discord.events.on_private_channel_pins_update_abc.onprivatechannelpinsupdateabc method)": [[35, "cpl_discord.events.on_private_channel_pins_update_abc.OnPrivateChannelPinsUpdateABC.on_private_channel_pins_update"]], "on_private_channel_update() (cpl_discord.events.on_private_channel_update_abc.onprivatechannelupdateabc method)": [[35, "cpl_discord.events.on_private_channel_update_abc.OnPrivateChannelUpdateABC.on_private_channel_update"]], "on_raw_reaction_add() (cpl_discord.events.on_raw_reaction_add_abc.onrawreactionaddabc method)": [[35, "cpl_discord.events.on_raw_reaction_add_abc.OnRawReactionAddABC.on_raw_reaction_add"]], "on_raw_reaction_clear() (cpl_discord.events.on_raw_reaction_clear_abc.onrawreactionclearabc method)": [[35, "cpl_discord.events.on_raw_reaction_clear_abc.OnRawReactionClearABC.on_raw_reaction_clear"]], "on_raw_reaction_clear_emoji() (cpl_discord.events.on_raw_reaction_clear_emoji_abc.onrawreactionclearemojiabc method)": [[35, "cpl_discord.events.on_raw_reaction_clear_emoji_abc.OnRawReactionClearEmojiABC.on_raw_reaction_clear_emoji"]], "on_raw_reaction_remove() (cpl_discord.events.on_raw_reaction_remove_abc.onrawreactionremoveabc method)": [[35, "cpl_discord.events.on_raw_reaction_remove_abc.OnRawReactionRemoveABC.on_raw_reaction_remove"]], "on_reaction_add() (cpl_discord.events.on_reaction_add_abc.onreactionaddabc method)": [[35, "cpl_discord.events.on_reaction_add_abc.OnReactionAddABC.on_reaction_add"]], "on_reaction_clear() (cpl_discord.events.on_reaction_clear_abc.onreactionclearabc method)": [[35, "cpl_discord.events.on_reaction_clear_abc.OnReactionClearABC.on_reaction_clear"]], "on_reaction_clear_emoji() (cpl_discord.events.on_reaction_clear_emoji_abc.onreactionclearemojiabc method)": [[35, "cpl_discord.events.on_reaction_clear_emoji_abc.OnReactionClearEmojiABC.on_reaction_clear_emoji"]], "on_reaction_remove() (cpl_discord.events.on_reaction_remove_abc.onreactionremoveabc method)": [[35, "cpl_discord.events.on_reaction_remove_abc.OnReactionRemoveABC.on_reaction_remove"]], "on_ready() (cpl_discord.events.on_ready_abc.onreadyabc method)": [[35, "cpl_discord.events.on_ready_abc.OnReadyABC.on_ready"]], "on_resume() (cpl_discord.events.on_resume_abc.onresumeabc method)": [[35, "cpl_discord.events.on_resume_abc.OnResumeABC.on_resume"]], "on_typing() (cpl_discord.events.on_typing_abc.ontypingabc method)": [[35, "cpl_discord.events.on_typing_abc.OnTypingABC.on_typing"]], "on_user_update() (cpl_discord.events.on_user_update_abc.onuserupdateabc method)": [[35, "cpl_discord.events.on_user_update_abc.OnUserUpdateABC.on_user_update"]], "on_voice_state_update() (cpl_discord.events.on_voice_state_update_abc.onvoicestateupdateabc method)": [[35, "cpl_discord.events.on_voice_state_update_abc.OnVoiceStateUpdateABC.on_voice_state_update"]], "on_webhooks_update() (cpl_discord.events.on_webhooks_update_abc.onwebhooksupdateabc method)": [[35, "cpl_discord.events.on_webhooks_update_abc.OnWebhooksUpdateABC.on_webhooks_update"]], "tocontainersconverter (class in cpl_discord.helper.to_containers_converter)": [[36, "cpl_discord.helper.to_containers_converter.ToContainersConverter"]], "versioninfo (class in cpl_discord.helper)": [[36, "cpl_discord.helper.VersionInfo"]], "convert() (cpl_discord.helper.to_containers_converter.tocontainersconverter static method)": [[36, "cpl_discord.helper.to_containers_converter.ToContainersConverter.convert"]], "cpl_discord.helper": [[36, "module-cpl_discord.helper"]], "cpl_discord.helper.to_containers_converter": [[36, "module-cpl_discord.helper.to_containers_converter"]], "major (cpl_discord.helper.versioninfo attribute)": [[36, "cpl_discord.helper.VersionInfo.major"]], "micro (cpl_discord.helper.versioninfo attribute)": [[36, "cpl_discord.helper.VersionInfo.micro"]], "minor (cpl_discord.helper.versioninfo attribute)": [[36, "cpl_discord.helper.VersionInfo.minor"]], "commanderrorhandlerservice (class in cpl_discord.service.command_error_handler_service)": [[37, "cpl_discord.service.command_error_handler_service.CommandErrorHandlerService"]], "discordbotservice (class in cpl_discord.service.discord_bot_service)": [[37, "cpl_discord.service.discord_bot_service.DiscordBotService"]], "discordbotserviceabc (class in cpl_discord.service.discord_bot_service_abc)": [[37, "cpl_discord.service.discord_bot_service_abc.DiscordBotServiceABC"]], "discordcollection (class in cpl_discord.service.discord_collection)": [[37, "cpl_discord.service.discord_collection.DiscordCollection"]], "discordcollectionabc (class in cpl_discord.service.discord_collection_abc)": [[37, "cpl_discord.service.discord_collection_abc.DiscordCollectionABC"]], "discordservice (class in cpl_discord.service.discord_service)": [[37, "cpl_discord.service.discord_service.DiscordService"]], "discordserviceabc (class in cpl_discord.service.discord_service_abc)": [[37, "cpl_discord.service.discord_service_abc.DiscordServiceABC"]], "versioninfo (class in cpl_discord.service)": [[37, "cpl_discord.service.VersionInfo"]], "add_command() (cpl_discord.service.discord_collection.discordcollection method)": [[37, "cpl_discord.service.discord_collection.DiscordCollection.add_command"]], "add_command() (cpl_discord.service.discord_collection_abc.discordcollectionabc method)": [[37, "cpl_discord.service.discord_collection_abc.DiscordCollectionABC.add_command"]], "add_event() (cpl_discord.service.discord_collection.discordcollection method)": [[37, "cpl_discord.service.discord_collection.DiscordCollection.add_event"]], "add_event() (cpl_discord.service.discord_collection_abc.discordcollectionabc method)": [[37, "cpl_discord.service.discord_collection_abc.DiscordCollectionABC.add_event"]], "cpl_discord.service": [[37, "module-cpl_discord.service"]], "cpl_discord.service.command_error_handler_service": [[37, "module-cpl_discord.service.command_error_handler_service"]], "cpl_discord.service.discord_bot_service": [[37, "module-cpl_discord.service.discord_bot_service"]], "cpl_discord.service.discord_bot_service_abc": [[37, "module-cpl_discord.service.discord_bot_service_abc"]], "cpl_discord.service.discord_collection": [[37, "module-cpl_discord.service.discord_collection"]], "cpl_discord.service.discord_collection_abc": [[37, "module-cpl_discord.service.discord_collection_abc"]], "cpl_discord.service.discord_service": [[37, "module-cpl_discord.service.discord_service"]], "cpl_discord.service.discord_service_abc": [[37, "module-cpl_discord.service.discord_service_abc"]], "get_commands() (cpl_discord.service.discord_collection.discordcollection method)": [[37, "cpl_discord.service.discord_collection.DiscordCollection.get_commands"]], "get_commands() (cpl_discord.service.discord_collection_abc.discordcollectionabc method)": [[37, "cpl_discord.service.discord_collection_abc.DiscordCollectionABC.get_commands"]], "get_events_by_base() (cpl_discord.service.discord_collection.discordcollection method)": [[37, "cpl_discord.service.discord_collection.DiscordCollection.get_events_by_base"]], "get_events_by_base() (cpl_discord.service.discord_collection_abc.discordcollectionabc method)": [[37, "cpl_discord.service.discord_collection_abc.DiscordCollectionABC.get_events_by_base"]], "guilds (cpl_discord.service.discord_bot_service.discordbotservice property)": [[37, "cpl_discord.service.discord_bot_service.DiscordBotService.guilds"]], "guilds (cpl_discord.service.discord_bot_service_abc.discordbotserviceabc property)": [[37, "cpl_discord.service.discord_bot_service_abc.DiscordBotServiceABC.guilds"]], "init() (cpl_discord.service.discord_service.discordservice method)": [[37, "cpl_discord.service.discord_service.DiscordService.init"]], "init() (cpl_discord.service.discord_service_abc.discordserviceabc method)": [[37, "cpl_discord.service.discord_service_abc.DiscordServiceABC.init"]], "major (cpl_discord.service.versioninfo attribute)": [[37, "cpl_discord.service.VersionInfo.major"]], "micro (cpl_discord.service.versioninfo attribute)": [[37, "cpl_discord.service.VersionInfo.micro"]], "minor (cpl_discord.service.versioninfo attribute)": [[37, "cpl_discord.service.VersionInfo.minor"]], "on_bulk_message_delete() (cpl_discord.service.discord_service.discordservice method)": [[37, "cpl_discord.service.discord_service.DiscordService.on_bulk_message_delete"]], "on_bulk_message_delete() (cpl_discord.service.discord_service_abc.discordserviceabc method)": [[37, "cpl_discord.service.discord_service_abc.DiscordServiceABC.on_bulk_message_delete"]], "on_command() (cpl_discord.service.discord_service.discordservice method)": [[37, "cpl_discord.service.discord_service.DiscordService.on_command"]], "on_command() (cpl_discord.service.discord_service_abc.discordserviceabc method)": [[37, "cpl_discord.service.discord_service_abc.DiscordServiceABC.on_command"]], "on_command_completion() (cpl_discord.service.discord_service.discordservice method)": [[37, "cpl_discord.service.discord_service.DiscordService.on_command_completion"]], "on_command_completion() (cpl_discord.service.discord_service_abc.discordserviceabc method)": [[37, "cpl_discord.service.discord_service_abc.DiscordServiceABC.on_command_completion"]], "on_command_error() (cpl_discord.service.command_error_handler_service.commanderrorhandlerservice method)": [[37, "cpl_discord.service.command_error_handler_service.CommandErrorHandlerService.on_command_error"]], "on_command_error() (cpl_discord.service.discord_service.discordservice method)": [[37, "cpl_discord.service.discord_service.DiscordService.on_command_error"]], "on_command_error() (cpl_discord.service.discord_service_abc.discordserviceabc method)": [[37, "cpl_discord.service.discord_service_abc.DiscordServiceABC.on_command_error"]], "on_connect() (cpl_discord.service.discord_service.discordservice method)": [[37, "cpl_discord.service.discord_service.DiscordService.on_connect"]], "on_connect() (cpl_discord.service.discord_service_abc.discordserviceabc method)": [[37, "cpl_discord.service.discord_service_abc.DiscordServiceABC.on_connect"]], "on_disconnect() (cpl_discord.service.discord_service.discordservice method)": [[37, "cpl_discord.service.discord_service.DiscordService.on_disconnect"]], "on_disconnect() (cpl_discord.service.discord_service_abc.discordserviceabc method)": [[37, "cpl_discord.service.discord_service_abc.DiscordServiceABC.on_disconnect"]], "on_error() (cpl_discord.service.discord_service.discordservice method)": [[37, "cpl_discord.service.discord_service.DiscordService.on_error"]], "on_error() (cpl_discord.service.discord_service_abc.discordserviceabc method)": [[37, "cpl_discord.service.discord_service_abc.DiscordServiceABC.on_error"]], "on_group_join() (cpl_discord.service.discord_service.discordservice method)": [[37, "cpl_discord.service.discord_service.DiscordService.on_group_join"]], "on_group_join() (cpl_discord.service.discord_service_abc.discordserviceabc method)": [[37, "cpl_discord.service.discord_service_abc.DiscordServiceABC.on_group_join"]], "on_group_remove() (cpl_discord.service.discord_service.discordservice method)": [[37, "cpl_discord.service.discord_service.DiscordService.on_group_remove"]], "on_group_remove() (cpl_discord.service.discord_service_abc.discordserviceabc method)": [[37, "cpl_discord.service.discord_service_abc.DiscordServiceABC.on_group_remove"]], "on_guild_available() (cpl_discord.service.discord_service.discordservice method)": [[37, "cpl_discord.service.discord_service.DiscordService.on_guild_available"]], "on_guild_available() (cpl_discord.service.discord_service_abc.discordserviceabc method)": [[37, "cpl_discord.service.discord_service_abc.DiscordServiceABC.on_guild_available"]], "on_guild_channel_create() (cpl_discord.service.discord_service.discordservice method)": [[37, "cpl_discord.service.discord_service.DiscordService.on_guild_channel_create"]], "on_guild_channel_create() (cpl_discord.service.discord_service_abc.discordserviceabc method)": [[37, "cpl_discord.service.discord_service_abc.DiscordServiceABC.on_guild_channel_create"]], "on_guild_channel_delete() (cpl_discord.service.discord_service.discordservice method)": [[37, "cpl_discord.service.discord_service.DiscordService.on_guild_channel_delete"]], "on_guild_channel_delete() (cpl_discord.service.discord_service_abc.discordserviceabc method)": [[37, "cpl_discord.service.discord_service_abc.DiscordServiceABC.on_guild_channel_delete"]], "on_guild_channel_pins_update() (cpl_discord.service.discord_service.discordservice method)": [[37, "cpl_discord.service.discord_service.DiscordService.on_guild_channel_pins_update"]], "on_guild_channel_pins_update() (cpl_discord.service.discord_service_abc.discordserviceabc method)": [[37, "cpl_discord.service.discord_service_abc.DiscordServiceABC.on_guild_channel_pins_update"]], "on_guild_channel_update() (cpl_discord.service.discord_service.discordservice method)": [[37, "cpl_discord.service.discord_service.DiscordService.on_guild_channel_update"]], "on_guild_channel_update() (cpl_discord.service.discord_service_abc.discordserviceabc method)": [[37, "cpl_discord.service.discord_service_abc.DiscordServiceABC.on_guild_channel_update"]], "on_guild_emojis_update() (cpl_discord.service.discord_service.discordservice method)": [[37, "cpl_discord.service.discord_service.DiscordService.on_guild_emojis_update"]], "on_guild_emojis_update() (cpl_discord.service.discord_service_abc.discordserviceabc method)": [[37, "cpl_discord.service.discord_service_abc.DiscordServiceABC.on_guild_emojis_update"]], "on_guild_integrations_update() (cpl_discord.service.discord_service.discordservice method)": [[37, "cpl_discord.service.discord_service.DiscordService.on_guild_integrations_update"]], "on_guild_integrations_update() (cpl_discord.service.discord_service_abc.discordserviceabc method)": [[37, "cpl_discord.service.discord_service_abc.DiscordServiceABC.on_guild_integrations_update"]], "on_guild_join() (cpl_discord.service.discord_service.discordservice method)": [[37, "cpl_discord.service.discord_service.DiscordService.on_guild_join"]], "on_guild_join() (cpl_discord.service.discord_service_abc.discordserviceabc method)": [[37, "cpl_discord.service.discord_service_abc.DiscordServiceABC.on_guild_join"]], "on_guild_remove() (cpl_discord.service.discord_service.discordservice method)": [[37, "cpl_discord.service.discord_service.DiscordService.on_guild_remove"]], "on_guild_remove() (cpl_discord.service.discord_service_abc.discordserviceabc method)": [[37, "cpl_discord.service.discord_service_abc.DiscordServiceABC.on_guild_remove"]], "on_guild_role_create() (cpl_discord.service.discord_service.discordservice method)": [[37, "cpl_discord.service.discord_service.DiscordService.on_guild_role_create"]], "on_guild_role_create() (cpl_discord.service.discord_service_abc.discordserviceabc method)": [[37, "cpl_discord.service.discord_service_abc.DiscordServiceABC.on_guild_role_create"]], "on_guild_role_delete() (cpl_discord.service.discord_service.discordservice method)": [[37, "cpl_discord.service.discord_service.DiscordService.on_guild_role_delete"]], "on_guild_role_delete() (cpl_discord.service.discord_service_abc.discordserviceabc method)": [[37, "cpl_discord.service.discord_service_abc.DiscordServiceABC.on_guild_role_delete"]], "on_guild_role_update() (cpl_discord.service.discord_service.discordservice method)": [[37, "cpl_discord.service.discord_service.DiscordService.on_guild_role_update"]], "on_guild_role_update() (cpl_discord.service.discord_service_abc.discordserviceabc method)": [[37, "cpl_discord.service.discord_service_abc.DiscordServiceABC.on_guild_role_update"]], "on_guild_unavailable() (cpl_discord.service.discord_service.discordservice method)": [[37, "cpl_discord.service.discord_service.DiscordService.on_guild_unavailable"]], "on_guild_unavailable() (cpl_discord.service.discord_service_abc.discordserviceabc method)": [[37, "cpl_discord.service.discord_service_abc.DiscordServiceABC.on_guild_unavailable"]], "on_guild_update() (cpl_discord.service.discord_service.discordservice method)": [[37, "cpl_discord.service.discord_service.DiscordService.on_guild_update"]], "on_guild_update() (cpl_discord.service.discord_service_abc.discordserviceabc method)": [[37, "cpl_discord.service.discord_service_abc.DiscordServiceABC.on_guild_update"]], "on_invite_create() (cpl_discord.service.discord_service.discordservice method)": [[37, "cpl_discord.service.discord_service.DiscordService.on_invite_create"]], "on_invite_create() (cpl_discord.service.discord_service_abc.discordserviceabc method)": [[37, "cpl_discord.service.discord_service_abc.DiscordServiceABC.on_invite_create"]], "on_invite_delete() (cpl_discord.service.discord_service.discordservice method)": [[37, "cpl_discord.service.discord_service.DiscordService.on_invite_delete"]], "on_invite_delete() (cpl_discord.service.discord_service_abc.discordserviceabc method)": [[37, "cpl_discord.service.discord_service_abc.DiscordServiceABC.on_invite_delete"]], "on_member_ban() (cpl_discord.service.discord_service.discordservice method)": [[37, "cpl_discord.service.discord_service.DiscordService.on_member_ban"]], "on_member_ban() (cpl_discord.service.discord_service_abc.discordserviceabc method)": [[37, "cpl_discord.service.discord_service_abc.DiscordServiceABC.on_member_ban"]], "on_member_join() (cpl_discord.service.discord_service.discordservice method)": [[37, "cpl_discord.service.discord_service.DiscordService.on_member_join"]], "on_member_join() (cpl_discord.service.discord_service_abc.discordserviceabc method)": [[37, "cpl_discord.service.discord_service_abc.DiscordServiceABC.on_member_join"]], "on_member_remove() (cpl_discord.service.discord_service.discordservice method)": [[37, "cpl_discord.service.discord_service.DiscordService.on_member_remove"]], "on_member_remove() (cpl_discord.service.discord_service_abc.discordserviceabc method)": [[37, "cpl_discord.service.discord_service_abc.DiscordServiceABC.on_member_remove"]], "on_member_unban() (cpl_discord.service.discord_service.discordservice method)": [[37, "cpl_discord.service.discord_service.DiscordService.on_member_unban"]], "on_member_unban() (cpl_discord.service.discord_service_abc.discordserviceabc method)": [[37, "cpl_discord.service.discord_service_abc.DiscordServiceABC.on_member_unban"]], "on_member_update() (cpl_discord.service.discord_service.discordservice method)": [[37, "cpl_discord.service.discord_service.DiscordService.on_member_update"]], "on_member_update() (cpl_discord.service.discord_service_abc.discordserviceabc method)": [[37, "cpl_discord.service.discord_service_abc.DiscordServiceABC.on_member_update"]], "on_message() (cpl_discord.service.discord_service.discordservice method)": [[37, "cpl_discord.service.discord_service.DiscordService.on_message"]], "on_message() (cpl_discord.service.discord_service_abc.discordserviceabc method)": [[37, "cpl_discord.service.discord_service_abc.DiscordServiceABC.on_message"]], "on_message_delete() (cpl_discord.service.discord_service.discordservice method)": [[37, "cpl_discord.service.discord_service.DiscordService.on_message_delete"]], "on_message_delete() (cpl_discord.service.discord_service_abc.discordserviceabc method)": [[37, "cpl_discord.service.discord_service_abc.DiscordServiceABC.on_message_delete"]], "on_message_edit() (cpl_discord.service.discord_service.discordservice method)": [[37, "cpl_discord.service.discord_service.DiscordService.on_message_edit"]], "on_message_edit() (cpl_discord.service.discord_service_abc.discordserviceabc method)": [[37, "cpl_discord.service.discord_service_abc.DiscordServiceABC.on_message_edit"]], "on_private_channel_create() (cpl_discord.service.discord_service.discordservice method)": [[37, "cpl_discord.service.discord_service.DiscordService.on_private_channel_create"]], "on_private_channel_create() (cpl_discord.service.discord_service_abc.discordserviceabc method)": [[37, "cpl_discord.service.discord_service_abc.DiscordServiceABC.on_private_channel_create"]], "on_private_channel_delete() (cpl_discord.service.discord_service.discordservice method)": [[37, "cpl_discord.service.discord_service.DiscordService.on_private_channel_delete"]], "on_private_channel_delete() (cpl_discord.service.discord_service_abc.discordserviceabc method)": [[37, "cpl_discord.service.discord_service_abc.DiscordServiceABC.on_private_channel_delete"]], "on_private_channel_pins_update() (cpl_discord.service.discord_service.discordservice method)": [[37, "cpl_discord.service.discord_service.DiscordService.on_private_channel_pins_update"]], "on_private_channel_pins_update() (cpl_discord.service.discord_service_abc.discordserviceabc method)": [[37, "cpl_discord.service.discord_service_abc.DiscordServiceABC.on_private_channel_pins_update"]], "on_private_channel_update() (cpl_discord.service.discord_service.discordservice method)": [[37, "cpl_discord.service.discord_service.DiscordService.on_private_channel_update"]], "on_private_channel_update() (cpl_discord.service.discord_service_abc.discordserviceabc method)": [[37, "cpl_discord.service.discord_service_abc.DiscordServiceABC.on_private_channel_update"]], "on_raw_reaction_add() (cpl_discord.service.discord_service.discordservice method)": [[37, "cpl_discord.service.discord_service.DiscordService.on_raw_reaction_add"]], "on_raw_reaction_clear() (cpl_discord.service.discord_service.discordservice method)": [[37, "cpl_discord.service.discord_service.DiscordService.on_raw_reaction_clear"]], "on_raw_reaction_clear_emoji() (cpl_discord.service.discord_service.discordservice method)": [[37, "cpl_discord.service.discord_service.DiscordService.on_raw_reaction_clear_emoji"]], "on_raw_reaction_remove() (cpl_discord.service.discord_service.discordservice method)": [[37, "cpl_discord.service.discord_service.DiscordService.on_raw_reaction_remove"]], "on_reaction_add() (cpl_discord.service.discord_service.discordservice method)": [[37, "cpl_discord.service.discord_service.DiscordService.on_reaction_add"]], "on_reaction_add() (cpl_discord.service.discord_service_abc.discordserviceabc method)": [[37, "cpl_discord.service.discord_service_abc.DiscordServiceABC.on_reaction_add"]], "on_reaction_clear() (cpl_discord.service.discord_service.discordservice method)": [[37, "cpl_discord.service.discord_service.DiscordService.on_reaction_clear"]], "on_reaction_clear() (cpl_discord.service.discord_service_abc.discordserviceabc method)": [[37, "cpl_discord.service.discord_service_abc.DiscordServiceABC.on_reaction_clear"]], "on_reaction_clear_emoji() (cpl_discord.service.discord_service.discordservice method)": [[37, "cpl_discord.service.discord_service.DiscordService.on_reaction_clear_emoji"]], "on_reaction_clear_emoji() (cpl_discord.service.discord_service_abc.discordserviceabc method)": [[37, "cpl_discord.service.discord_service_abc.DiscordServiceABC.on_reaction_clear_emoji"]], "on_reaction_remove() (cpl_discord.service.discord_service.discordservice method)": [[37, "cpl_discord.service.discord_service.DiscordService.on_reaction_remove"]], "on_reaction_remove() (cpl_discord.service.discord_service_abc.discordserviceabc method)": [[37, "cpl_discord.service.discord_service_abc.DiscordServiceABC.on_reaction_remove"]], "on_ready() (cpl_discord.service.discord_bot_service.discordbotservice method)": [[37, "cpl_discord.service.discord_bot_service.DiscordBotService.on_ready"]], "on_ready() (cpl_discord.service.discord_bot_service_abc.discordbotserviceabc method)": [[37, "cpl_discord.service.discord_bot_service_abc.DiscordBotServiceABC.on_ready"]], "on_ready() (cpl_discord.service.discord_service.discordservice method)": [[37, "cpl_discord.service.discord_service.DiscordService.on_ready"]], "on_ready() (cpl_discord.service.discord_service_abc.discordserviceabc method)": [[37, "cpl_discord.service.discord_service_abc.DiscordServiceABC.on_ready"]], "on_resume() (cpl_discord.service.discord_service.discordservice method)": [[37, "cpl_discord.service.discord_service.DiscordService.on_resume"]], "on_resume() (cpl_discord.service.discord_service_abc.discordserviceabc method)": [[37, "cpl_discord.service.discord_service_abc.DiscordServiceABC.on_resume"]], "on_scheduled_event_create() (cpl_discord.service.discord_service.discordservice method)": [[37, "cpl_discord.service.discord_service.DiscordService.on_scheduled_event_create"]], "on_scheduled_event_delete() (cpl_discord.service.discord_service.discordservice method)": [[37, "cpl_discord.service.discord_service.DiscordService.on_scheduled_event_delete"]], "on_scheduled_event_update() (cpl_discord.service.discord_service.discordservice method)": [[37, "cpl_discord.service.discord_service.DiscordService.on_scheduled_event_update"]], "on_scheduled_event_user_add() (cpl_discord.service.discord_service.discordservice method)": [[37, "cpl_discord.service.discord_service.DiscordService.on_scheduled_event_user_add"]], "on_scheduled_event_user_remove() (cpl_discord.service.discord_service.discordservice method)": [[37, "cpl_discord.service.discord_service.DiscordService.on_scheduled_event_user_remove"]], "on_typing() (cpl_discord.service.discord_service.discordservice method)": [[37, "cpl_discord.service.discord_service.DiscordService.on_typing"]], "on_typing() (cpl_discord.service.discord_service_abc.discordserviceabc method)": [[37, "cpl_discord.service.discord_service_abc.DiscordServiceABC.on_typing"]], "on_user_update() (cpl_discord.service.discord_service.discordservice method)": [[37, "cpl_discord.service.discord_service.DiscordService.on_user_update"]], "on_user_update() (cpl_discord.service.discord_service_abc.discordserviceabc method)": [[37, "cpl_discord.service.discord_service_abc.DiscordServiceABC.on_user_update"]], "on_voice_state_update() (cpl_discord.service.discord_service.discordservice method)": [[37, "cpl_discord.service.discord_service.DiscordService.on_voice_state_update"]], "on_voice_state_update() (cpl_discord.service.discord_service_abc.discordserviceabc method)": [[37, "cpl_discord.service.discord_service_abc.DiscordServiceABC.on_voice_state_update"]], "on_webhooks_update() (cpl_discord.service.discord_service.discordservice method)": [[37, "cpl_discord.service.discord_service.DiscordService.on_webhooks_update"]], "on_webhooks_update() (cpl_discord.service.discord_service_abc.discordserviceabc method)": [[37, "cpl_discord.service.discord_service_abc.DiscordServiceABC.on_webhooks_update"]], "start_async() (cpl_discord.service.discord_bot_service.discordbotservice method)": [[37, "cpl_discord.service.discord_bot_service.DiscordBotService.start_async"]], "start_async() (cpl_discord.service.discord_bot_service_abc.discordbotserviceabc method)": [[37, "cpl_discord.service.discord_bot_service_abc.DiscordBotServiceABC.start_async"]], "stop_async() (cpl_discord.service.discord_bot_service.discordbotservice method)": [[37, "cpl_discord.service.discord_bot_service.DiscordBotService.stop_async"]], "stop_async() (cpl_discord.service.discord_bot_service_abc.discordbotserviceabc method)": [[37, "cpl_discord.service.discord_bot_service_abc.DiscordBotServiceABC.stop_async"]], "orderedqueryable (class in cpl_query.base.ordered_queryable)": [[39, "cpl_query.base.ordered_queryable.OrderedQueryable"]], "orderedqueryableabc (class in cpl_query.base.ordered_queryable_abc)": [[39, "cpl_query.base.ordered_queryable_abc.OrderedQueryableABC"]], "queryableabc (class in cpl_query.base.queryable_abc)": [[39, "cpl_query.base.queryable_abc.QueryableABC"]], "sequence (class in cpl_query.base.sequence)": [[39, "cpl_query.base.sequence.Sequence"]], "versioninfo (class in cpl_query.base)": [[39, "cpl_query.base.VersionInfo"]], "all() (cpl_query.base.queryable_abc.queryableabc method)": [[39, "cpl_query.base.queryable_abc.QueryableABC.all"]], "any() (cpl_query.base.queryable_abc.queryableabc method)": [[39, "cpl_query.base.queryable_abc.QueryableABC.any"]], "average() (cpl_query.base.queryable_abc.queryableabc method)": [[39, "cpl_query.base.queryable_abc.QueryableABC.average"]], "contains() (cpl_query.base.queryable_abc.queryableabc method)": [[39, "cpl_query.base.queryable_abc.QueryableABC.contains"]], "copy() (cpl_query.base.sequence.sequence method)": [[39, "cpl_query.base.sequence.Sequence.copy"]], "count() (cpl_query.base.queryable_abc.queryableabc method)": [[39, "cpl_query.base.queryable_abc.QueryableABC.count"]], "cpl_query.base": [[39, "module-cpl_query.base"]], "cpl_query.base.default_lambda": [[39, "module-cpl_query.base.default_lambda"]], "cpl_query.base.ordered_queryable": [[39, "module-cpl_query.base.ordered_queryable"]], "cpl_query.base.ordered_queryable_abc": [[39, "module-cpl_query.base.ordered_queryable_abc"]], "cpl_query.base.queryable_abc": [[39, "module-cpl_query.base.queryable_abc"]], "cpl_query.base.sequence": [[39, "module-cpl_query.base.sequence"]], "default_lambda() (in module cpl_query.base.default_lambda)": [[39, "cpl_query.base.default_lambda.default_lambda"]], "distinct() (cpl_query.base.queryable_abc.queryableabc method)": [[39, "cpl_query.base.queryable_abc.QueryableABC.distinct"]], "element_at() (cpl_query.base.queryable_abc.queryableabc method)": [[39, "cpl_query.base.queryable_abc.QueryableABC.element_at"]], "element_at_or_default() (cpl_query.base.queryable_abc.queryableabc method)": [[39, "cpl_query.base.queryable_abc.QueryableABC.element_at_or_default"]], "empty() (cpl_query.base.sequence.sequence class method)": [[39, "cpl_query.base.sequence.Sequence.empty"]], "first() (cpl_query.base.queryable_abc.queryableabc method)": [[39, "cpl_query.base.queryable_abc.QueryableABC.first"]], "first_or_default() (cpl_query.base.queryable_abc.queryableabc method)": [[39, "cpl_query.base.queryable_abc.QueryableABC.first_or_default"]], "for_each() (cpl_query.base.queryable_abc.queryableabc method)": [[39, "cpl_query.base.queryable_abc.QueryableABC.for_each"]], "group_by() (cpl_query.base.queryable_abc.queryableabc method)": [[39, "cpl_query.base.queryable_abc.QueryableABC.group_by"]], "index_of() (cpl_query.base.sequence.sequence method)": [[39, "cpl_query.base.sequence.Sequence.index_of"]], "last() (cpl_query.base.queryable_abc.queryableabc method)": [[39, "cpl_query.base.queryable_abc.QueryableABC.last"]], "last_or_default() (cpl_query.base.queryable_abc.queryableabc method)": [[39, "cpl_query.base.queryable_abc.QueryableABC.last_or_default"]], "major (cpl_query.base.versioninfo attribute)": [[39, "cpl_query.base.VersionInfo.major"]], "max() (cpl_query.base.queryable_abc.queryableabc method)": [[39, "cpl_query.base.queryable_abc.QueryableABC.max"]], "median() (cpl_query.base.queryable_abc.queryableabc method)": [[39, "cpl_query.base.queryable_abc.QueryableABC.median"]], "micro (cpl_query.base.versioninfo attribute)": [[39, "cpl_query.base.VersionInfo.micro"]], "min() (cpl_query.base.queryable_abc.queryableabc method)": [[39, "cpl_query.base.queryable_abc.QueryableABC.min"]], "minor (cpl_query.base.versioninfo attribute)": [[39, "cpl_query.base.VersionInfo.minor"]], "order_by() (cpl_query.base.queryable_abc.queryableabc method)": [[39, "cpl_query.base.queryable_abc.QueryableABC.order_by"]], "order_by_descending() (cpl_query.base.queryable_abc.queryableabc method)": [[39, "cpl_query.base.queryable_abc.QueryableABC.order_by_descending"]], "range() (cpl_query.base.sequence.sequence class method)": [[39, "cpl_query.base.sequence.Sequence.range"]], "reverse() (cpl_query.base.queryable_abc.queryableabc method)": [[39, "cpl_query.base.queryable_abc.QueryableABC.reverse"]], "select() (cpl_query.base.queryable_abc.queryableabc method)": [[39, "cpl_query.base.queryable_abc.QueryableABC.select"]], "select_many() (cpl_query.base.queryable_abc.queryableabc method)": [[39, "cpl_query.base.queryable_abc.QueryableABC.select_many"]], "single() (cpl_query.base.queryable_abc.queryableabc method)": [[39, "cpl_query.base.queryable_abc.QueryableABC.single"]], "single_or_default() (cpl_query.base.queryable_abc.queryableabc method)": [[39, "cpl_query.base.queryable_abc.QueryableABC.single_or_default"]], "skip() (cpl_query.base.queryable_abc.queryableabc method)": [[39, "cpl_query.base.queryable_abc.QueryableABC.skip"]], "skip_last() (cpl_query.base.queryable_abc.queryableabc method)": [[39, "cpl_query.base.queryable_abc.QueryableABC.skip_last"]], "split() (cpl_query.base.queryable_abc.queryableabc method)": [[39, "cpl_query.base.queryable_abc.QueryableABC.split"]], "sum() (cpl_query.base.queryable_abc.queryableabc method)": [[39, "cpl_query.base.queryable_abc.QueryableABC.sum"]], "take() (cpl_query.base.queryable_abc.queryableabc method)": [[39, "cpl_query.base.queryable_abc.QueryableABC.take"]], "take_last() (cpl_query.base.queryable_abc.queryableabc method)": [[39, "cpl_query.base.queryable_abc.QueryableABC.take_last"]], "then_by() (cpl_query.base.ordered_queryable.orderedqueryable method)": [[39, "cpl_query.base.ordered_queryable.OrderedQueryable.then_by"]], "then_by() (cpl_query.base.ordered_queryable_abc.orderedqueryableabc method)": [[39, "cpl_query.base.ordered_queryable_abc.OrderedQueryableABC.then_by"]], "then_by_descending() (cpl_query.base.ordered_queryable.orderedqueryable method)": [[39, "cpl_query.base.ordered_queryable.OrderedQueryable.then_by_descending"]], "then_by_descending() (cpl_query.base.ordered_queryable_abc.orderedqueryableabc method)": [[39, "cpl_query.base.ordered_queryable_abc.OrderedQueryableABC.then_by_descending"]], "to_list() (cpl_query.base.sequence.sequence method)": [[39, "cpl_query.base.sequence.Sequence.to_list"]], "type (cpl_query.base.sequence.sequence property)": [[39, "cpl_query.base.sequence.Sequence.type"]], "where() (cpl_query.base.queryable_abc.queryableabc method)": [[39, "cpl_query.base.queryable_abc.QueryableABC.where"]], "enumerable (class in cpl_query.enumerable.enumerable)": [[40, "cpl_query.enumerable.enumerable.Enumerable"]], "enumerableabc (class in cpl_query.enumerable.enumerable_abc)": [[40, "cpl_query.enumerable.enumerable_abc.EnumerableABC"]], "versioninfo (class in cpl_query.enumerable)": [[40, "cpl_query.enumerable.VersionInfo"]], "cpl_query.enumerable": [[40, "module-cpl_query.enumerable"]], "cpl_query.enumerable.enumerable": [[40, "module-cpl_query.enumerable.enumerable"]], "cpl_query.enumerable.enumerable_abc": [[40, "module-cpl_query.enumerable.enumerable_abc"]], "major (cpl_query.enumerable.versioninfo attribute)": [[40, "cpl_query.enumerable.VersionInfo.major"]], "micro (cpl_query.enumerable.versioninfo attribute)": [[40, "cpl_query.enumerable.VersionInfo.micro"]], "minor (cpl_query.enumerable.versioninfo attribute)": [[40, "cpl_query.enumerable.VersionInfo.minor"]], "to_iterable() (cpl_query.enumerable.enumerable_abc.enumerableabc method)": [[40, "cpl_query.enumerable.enumerable_abc.EnumerableABC.to_iterable"]], "list (class in cpl_query.extension.list)": [[41, "cpl_query.extension.list.List"]], "versioninfo (class in cpl_query.extension)": [[41, "cpl_query.extension.VersionInfo"]], "cpl_query.extension": [[41, "module-cpl_query.extension"]], "cpl_query.extension.list": [[41, "module-cpl_query.extension.list"]], "major (cpl_query.extension.versioninfo attribute)": [[41, "cpl_query.extension.VersionInfo.major"]], "micro (cpl_query.extension.versioninfo attribute)": [[41, "cpl_query.extension.VersionInfo.micro"]], "minor (cpl_query.extension.versioninfo attribute)": [[41, "cpl_query.extension.VersionInfo.minor"]], "to_enumerable() (cpl_query.extension.list.list method)": [[41, "cpl_query.extension.list.List.to_enumerable"]], "to_iterable() (cpl_query.extension.list.list method)": [[41, "cpl_query.extension.list.List.to_iterable"]], "iterable (class in cpl_query.iterable.iterable)": [[42, "cpl_query.iterable.iterable.Iterable"]], "iterableabc (class in cpl_query.iterable.iterable_abc)": [[42, "cpl_query.iterable.iterable_abc.IterableABC"]], "versioninfo (class in cpl_query.iterable)": [[42, "cpl_query.iterable.VersionInfo"]], "add() (cpl_query.iterable.iterable_abc.iterableabc method)": [[42, "cpl_query.iterable.iterable_abc.IterableABC.add"]], "append() (cpl_query.iterable.iterable_abc.iterableabc method)": [[42, "cpl_query.iterable.iterable_abc.IterableABC.append"]], "cpl_query.iterable": [[42, "module-cpl_query.iterable"]], "cpl_query.iterable.iterable": [[42, "module-cpl_query.iterable.iterable"]], "cpl_query.iterable.iterable_abc": [[42, "module-cpl_query.iterable.iterable_abc"]], "extend() (cpl_query.iterable.iterable_abc.iterableabc method)": [[42, "cpl_query.iterable.iterable_abc.IterableABC.extend"]], "major (cpl_query.iterable.versioninfo attribute)": [[42, "cpl_query.iterable.VersionInfo.major"]], "micro (cpl_query.iterable.versioninfo attribute)": [[42, "cpl_query.iterable.VersionInfo.micro"]], "minor (cpl_query.iterable.versioninfo attribute)": [[42, "cpl_query.iterable.VersionInfo.minor"]], "remove() (cpl_query.iterable.iterable_abc.iterableabc method)": [[42, "cpl_query.iterable.iterable_abc.IterableABC.remove"]], "remove_at() (cpl_query.iterable.iterable_abc.iterableabc method)": [[42, "cpl_query.iterable.iterable_abc.IterableABC.remove_at"]], "to_enumerable() (cpl_query.iterable.iterable_abc.iterableabc method)": [[42, "cpl_query.iterable.iterable_abc.IterableABC.to_enumerable"]], "translatepipe (class in cpl_translation.translate_pipe)": [[43, "cpl_translation.translate_pipe.TranslatePipe"]], "translationservice (class in cpl_translation.translation_service)": [[43, "cpl_translation.translation_service.TranslationService"]], "translationserviceabc (class in cpl_translation.translation_service_abc)": [[43, "cpl_translation.translation_service_abc.TranslationServiceABC"]], "translationsettings (class in cpl_translation.translation_settings)": [[43, "cpl_translation.translation_settings.TranslationSettings"]], "cpl_translation.translate_pipe": [[43, "module-cpl_translation.translate_pipe"]], "cpl_translation.translation_service": [[43, "module-cpl_translation.translation_service"]], "cpl_translation.translation_service_abc": [[43, "module-cpl_translation.translation_service_abc"]], "cpl_translation.translation_settings": [[43, "module-cpl_translation.translation_settings"]], "default_language (cpl_translation.translation_settings.translationsettings property)": [[43, "cpl_translation.translation_settings.TranslationSettings.default_language"]], "languages (cpl_translation.translation_settings.translationsettings property)": [[43, "cpl_translation.translation_settings.TranslationSettings.languages"]], "load() (cpl_translation.translation_service.translationservice method)": [[43, "cpl_translation.translation_service.TranslationService.load"]], "load() (cpl_translation.translation_service_abc.translationserviceabc method)": [[43, "cpl_translation.translation_service_abc.TranslationServiceABC.load"]], "load_by_settings() (cpl_translation.translation_service.translationservice method)": [[43, "cpl_translation.translation_service.TranslationService.load_by_settings"]], "load_by_settings() (cpl_translation.translation_service_abc.translationserviceabc method)": [[43, "cpl_translation.translation_service_abc.TranslationServiceABC.load_by_settings"]], "set_default_lang() (cpl_translation.translation_service.translationservice method)": [[43, "cpl_translation.translation_service.TranslationService.set_default_lang"]], "set_default_lang() (cpl_translation.translation_service_abc.translationserviceabc method)": [[43, "cpl_translation.translation_service_abc.TranslationServiceABC.set_default_lang"]], "set_lang() (cpl_translation.translation_service.translationservice method)": [[43, "cpl_translation.translation_service.TranslationService.set_lang"]], "set_lang() (cpl_translation.translation_service_abc.translationserviceabc method)": [[43, "cpl_translation.translation_service_abc.TranslationServiceABC.set_lang"]], "transform() (cpl_translation.translate_pipe.translatepipe method)": [[43, "cpl_translation.translate_pipe.TranslatePipe.transform"]], "translate() (cpl_translation.translation_service.translationservice method)": [[43, "cpl_translation.translation_service.TranslationService.translate"]], "translate() (cpl_translation.translation_service_abc.translationserviceabc method)": [[43, "cpl_translation.translation_service_abc.TranslationServiceABC.translate"]]}}) \ No newline at end of file diff --git a/docs/build/html/setup.html b/docs/build/html/setup.html deleted file mode 100644 index 29bef6ca..00000000 --- a/docs/build/html/setup.html +++ /dev/null @@ -1,236 +0,0 @@ - - - - - - - Setting up the local environment and workspace — Common Python Library documentation - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

Setting up the local environment and workspace

-
-

Table of Contents

-
    -

  1. Prerequisites

    2. -

  2. Install the package

    3. -

  3. Install the CLI

    4. -

  4. Install the query

    5. -

  5. Create a initial application

    6. -

  6. Create a initial library

    7. -

  7. Start the application

    8. -

  8. What’s next

    9. -
-
-
-

Prerequisites

-

To get most out of this tutorial you should already have a basic understanding of the following.

- -

Also you need to have the following installed.

- -
-
-

Install the package

-

To install the package, open a terminal window and run the following command:

-
pip install cpl-core --extra-index-url https://pip.sh-edraft.de
-
-
-
-
-

Install the CLI

-

You use the CPL CLI to create projects, generate application and library code. You also use the CLI to build and publish your python packages.

-

To install the CLI, open a terminal window and run the following command:

-
pip install cpl-cli --extra-index-url https://pip.sh-edraft.de
-
-
-
-
-

Install the query

-

To install the package, open a terminal window and run the following command:

-
pip install cpl-query --extra-index-url https://pip.sh-edraft.de
-
-
-
-
-

Create initial console app

-

You develop apps and packages in the context of an CPL project which is defined in an cpl_core.json.

-
    -

  1. Run the CLI command cpl new console and provide the name my-app, as shown here:

    -
    cpl new console my-app
-
    -
    -
    2. -

  2. The cpl new command prompts you for information about features to include in the initial app. Decline the defaults by enter ‘n’ and press the Enter key.

    3. -
-

The CLI create a new workspace and a simple ‘Hello World’ app, ready to run.

-
-
-

Create initial library

-

You develop apps and packages in the context of an CPL project which is defined in an cpl_core.json.

-
    -

  1. Run the CLI command cpl new library and provide the name my-lib, as shown here:

    -
    cpl new library my-lib
-
    -
    -
    2. -

  2. The cpl new command prompts you for information about features to include in the initial library. Decline the defaults by enter ‘n’ and press the Enter key.

    3. -
-

The CLI create a new workspace and a simple ‘Hello World’ library with CLI, ready to run.

-
-
-

Start the app

-

The CLI includes a live development server, so that you can run your app locally.

-
    -

  1. Open a terminal window

    2. -

  2. To navigate to your project workspace, run the following command:

    -
    cd /path/to/project/name
-
    -
    -
    3. -

  3. To run the app run:

    -
    cpl start
-
    -
    -
    4. -
-

The cpl start command launches the server, watches your source files, and restarts the app as you make chnages to thoses source files.

-

If your installation and setup was successful, you should see a output similar to the following:

-
Hello World
-
-
-
-
-

What’s next

-
    -

  • To learn more about the CPL CLI, see the CLI Overview

    • -

  • Fore more informations about the Pyhton files generated by cpl new, see New Command

    • -
- -
-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/build/html/tutorials.appsettings.html b/docs/build/html/tutorials.appsettings.html deleted file mode 100644 index dabce50c..00000000 --- a/docs/build/html/tutorials.appsettings.html +++ /dev/null @@ -1,140 +0,0 @@ - - - - - - - Using appsettings.json — Common Python Library documentation - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

Using appsettings.json

-
-

Coming soon

-
-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/build/html/tutorials.console-arguments.html b/docs/build/html/tutorials.console-arguments.html deleted file mode 100644 index 6aa8d6d9..00000000 --- a/docs/build/html/tutorials.console-arguments.html +++ /dev/null @@ -1,140 +0,0 @@ - - - - - - - Handle console arguments — Common Python Library documentation - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

Handle console arguments

-
-

Coming soon

-
-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/build/html/tutorials.console.html b/docs/build/html/tutorials.console.html deleted file mode 100644 index 2105607e..00000000 --- a/docs/build/html/tutorials.console.html +++ /dev/null @@ -1,140 +0,0 @@ - - - - - - - Use cpl_core.console.Console — Common Python Library documentation - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

Use cpl_core.console.Console

-
-

Coming soon

-
-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/build/html/tutorials.create-startup.html b/docs/build/html/tutorials.create-startup.html deleted file mode 100644 index 65fce620..00000000 --- a/docs/build/html/tutorials.create-startup.html +++ /dev/null @@ -1,140 +0,0 @@ - - - - - - - Create startup class — Common Python Library documentation - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

Create startup class

-
-

Coming soon

-
-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/build/html/tutorials.extend-application.html b/docs/build/html/tutorials.extend-application.html deleted file mode 100644 index 485c4371..00000000 --- a/docs/build/html/tutorials.extend-application.html +++ /dev/null @@ -1,140 +0,0 @@ - - - - - - - Extend application — Common Python Library documentation - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

Extend application

-
-

Coming soon

-
-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/build/html/tutorials.extend-startup.html b/docs/build/html/tutorials.extend-startup.html deleted file mode 100644 index d0d4d4bc..00000000 --- a/docs/build/html/tutorials.extend-startup.html +++ /dev/null @@ -1,140 +0,0 @@ - - - - - - - Extend startup — Common Python Library documentation - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

Extend startup

-
-

Coming soon

-
-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/build/html/tutorials.html b/docs/build/html/tutorials.html deleted file mode 100644 index c1319732..00000000 --- a/docs/build/html/tutorials.html +++ /dev/null @@ -1,176 +0,0 @@ - - - - - - - Tutorials — Common Python Library documentation - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
- -
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/build/html/tutorials.logging.html b/docs/build/html/tutorials.logging.html deleted file mode 100644 index 545bf27b..00000000 --- a/docs/build/html/tutorials.logging.html +++ /dev/null @@ -1,140 +0,0 @@ - - - - - - - Use builtin logger — Common Python Library documentation - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

Use builtin logger

-
-

Coming soon

-
-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/build/html/tutorials.mail.html b/docs/build/html/tutorials.mail.html deleted file mode 100644 index 3ce1325a..00000000 --- a/docs/build/html/tutorials.mail.html +++ /dev/null @@ -1,140 +0,0 @@ - - - - - - - Send mails — Common Python Library documentation - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

Send mails

-
-

Coming soon

-
-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/build/html/tutorials.templating.html b/docs/build/html/tutorials.templating.html deleted file mode 100644 index 3611dde9..00000000 --- a/docs/build/html/tutorials.templating.html +++ /dev/null @@ -1,309 +0,0 @@ - - - - - - - Using cpl g & cpl n templating — Common Python Library documentation - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

Using cpl g & cpl n templating

-
-

Contents

- -
-
-

Prerequisites

-

Create a folder called .cpl

-
-
-

cpl generate schematics

-

Create a file which begins with schematic_your_schematic.py. -A schematic template is detected by starting with schematic_ and endswith .py.

-

You should replace your_schematic with an appropriate name of your schematic. For example, we will choose Enum. -Attention: It is important that you do not overwrite templates by creating a file or class with the same name.

-

In the template create a class with the name of your schematic. For example:

-
from cpl_cli.abc.generate_schematic_abc import GenerateSchematicABC
-
-
-class Enum(GenerateSchematicABC):
-
-    def __init__(self, *args: str):
-        GenerateSchematicABC.__init__(self, *args)
-
-    def get_code(self) -> str:
-        import textwrap
-        code = textwrap.dedent("""\
-        from enum import Enum
-        
-        
-        class $Name(Enum):
-        
-            atr = 0
-        """)
-        return self.build_code_str(code, Name=self._class_name)
-
-    @classmethod
-    def register(cls):
-        GenerateSchematicABC.register(
-            cls,
-            'enum',
-            ['e', 'E']
-        )
-
-
-
-

You can test it by calling cpl g --help your schematic should be listed as available.

-
-
-

cpl new project types

-

The project templating is a little more complex and is therefore divided into several files. -First of all, for information, it is very important not to overwrite any existing files or classes!

-

Template structure explained by the example of the internal type console:

-
- project_console.py
-- project_file_license.py
-- project_file_appsettings.py
-- project_file.py
-- project_file_readme.py
-- project_file_code_main.py
-- project_file_code_startup.py
-- project_file_code_application.py
-
-
-

Here the template project_console.py defines how a console project has to look like when it is generated. Here is the code to illustrate this:

-
from cpl_cli.abc.project_type_abc import ProjectTypeABC
-from cpl_cli.configuration import WorkspaceSettings
-from cpl_core.utils import String
-
-
-class Console(ProjectTypeABC):
-
-    def __init__(
-            self,
-            base_path: str,
-            project_name: str,
-            workspace: WorkspaceSettings,
-            use_application_api: bool,
-            use_startup: bool,
-            use_service_providing: bool,
-            use_async: bool,
-            project_file_data: dict,
-    ):
-        from project_file import ProjectFile
-        from project_file_appsettings import ProjectFileAppsettings
-        from project_file_code_application import ProjectFileApplication
-        from project_file_code_main import ProjectFileMain
-        from project_file_code_startup import ProjectFileStartup
-        from project_file_readme import ProjectFileReadme
-        from project_file_license import ProjectFileLicense
-        from schematic_init import Init
-
-        ProjectTypeABC.__init__(self, base_path, project_name, workspace, use_application_api, use_startup, use_service_providing, use_async, project_file_data)
-
-        project_path = f'{base_path}{String.convert_to_snake_case(project_name.split("/")[-1])}/'
-
-        self.add_template(ProjectFile(project_name.split('/')[-1], project_path, project_file_data))
-        if workspace is None:
-            self.add_template(ProjectFileLicense(''))
-            self.add_template(ProjectFileReadme(''))
-            self.add_template(Init('', 'init', f'{base_path}tests/'))
-
-        self.add_template(Init('', 'init', project_path))
-        self.add_template(ProjectFileAppsettings(project_path))
-
-        if use_application_api:
-            self.add_template(ProjectFileApplication(project_path, use_application_api, use_startup, use_service_providing, use_async))
-
-        if use_startup:
-            self.add_template(ProjectFileStartup(project_path, use_application_api, use_startup, use_service_providing, use_async))
-
-        self.add_template(ProjectFileMain(project_name.split('/')[-1], project_path, use_application_api, use_startup, use_service_providing, use_async))
-
-
-

The class must be named exactly as the project type should be named. It is also checked on the initial letter of the class as alias. -Now create a class for normal files which inherits from FileTemplateABC and a class for code files which inherits from CodeFileTemplateABC.

-

For example:

-

project_file_code_startup.py:

-
from cpl_cli.abc.code_file_template_abc import CodeFileTemplateABC
-
-
-class ProjectFileStartup(CodeFileTemplateABC):
-
-    def __init__(self, path: str, use_application_api: bool, use_startup: bool, use_service_providing: bool, use_async: bool):
-        CodeFileTemplateABC.__init__(self, 'startup', path, '', use_application_api, use_startup, use_service_providing, use_async)
-
-    def get_code(self) -> str:
-        import textwrap
-
-        return textwrap.dedent("""\
-        from cpl_core.application import StartupABC
-        from cpl_core.configuration import ConfigurationABC
-        from cpl_core.dependency_injection import ServiceProviderABC, ServiceCollectionABC
-        from cpl_core.environment import ApplicationEnvironment
-        
-        
-        class Startup(StartupABC):
-        
-            def __init__(self):
-                StartupABC.__init__(self)
-        
-            def configure_configuration(self, configuration: ConfigurationABC, environment: ApplicationEnvironment) -> ConfigurationABC:
-                return configuration
-        
-            def configure_services(self, services: ServiceCollectionABC, environment: ApplicationEnvironment) -> ServiceProviderABC:
-                return services.build_service_provider()
-        """)
-
-
-

project_file.py:

-
import json
-
-from cpl_cli.abc.file_template_abc import FileTemplateABC
-
-
-class ProjectFile(FileTemplateABC):
-
-    def __init__(self, name: str, path: str, code: dict):
-        FileTemplateABC.__init__(self, '', path, '{}')
-        self._name = f'{name}.json'
-        self._code = code
-
-    def get_code(self) -> str:
-        return json.dumps(self._code, indent=2)
-
-
-
-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/make.bat b/docs/make.bat deleted file mode 100644 index 6247f7e2..00000000 --- a/docs/make.bat +++ /dev/null @@ -1,35 +0,0 @@ -@ECHO OFF - -pushd %~dp0 - -REM Command file for Sphinx documentation - -if "%SPHINXBUILD%" == "" ( - set SPHINXBUILD=sphinx-build -) -set SOURCEDIR=source -set BUILDDIR=build - -if "%1" == "" goto help - -%SPHINXBUILD% >NUL 2>NUL -if errorlevel 9009 ( - echo. - echo.The 'sphinx-build' command was not found. Make sure you have Sphinx - echo.installed, then set the SPHINXBUILD environment variable to point - echo.to the full path of the 'sphinx-build' executable. Alternatively you - echo.may add the Sphinx directory to PATH. - echo. - echo.If you don't have Sphinx installed, grab it from - echo.http://sphinx-doc.org/ - exit /b 1 -) - -%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% -goto end - -:help -%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% - -:end -popd diff --git a/docs/source/conf.py b/docs/source/conf.py deleted file mode 100644 index 464c691e..00000000 --- a/docs/source/conf.py +++ /dev/null @@ -1,62 +0,0 @@ -# Configuration file for the Sphinx documentation builder. -# -# This file only contains a selection of the most common options. For a full -# list see the documentation: -# https://www.sphinx-doc.org/en/master/usage/configuration.html - -# -- Path setup -------------------------------------------------------------- - -# If extensions (ors to document with autodoc) are in another directory, -# add these directories to sys.path here. If the directory is relative to the -# documentation root, use os.path.abspath to make it absolute, like shown here. -# -# import os -# import sys -# sys.path.insert(0, os.path.abspath('.')) -import os -import sys - -sys.path.insert(0, os.path.abspath("../../src/")) - -# -- Project information ----------------------------------------------------- - -project = "Common Python Library" -copyright = "2021 - 2023, Sven Heidemann" -author = "Sven Heidemann" - -# -- General configuration --------------------------------------------------- - -# Add any Sphinx extension names here, as strings. They can be -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom -# ones. -extensions = [ - "sphinx.ext.autodoc", - "sphinx_rtd_theme", - "myst_parser", -] - -source_suffix = { - ".md": "markdown", - ".txt": "markdown", - ".rst": "restructuredtext", -} - -# Add any paths that contain templates here, relative to this directory. -templates_path = ["_templates"] - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -# This pattern also affects html_static_path and html_extra_path. -exclude_patterns = ["cpl_cli/templates/*", "cpl_cli/*", "tests", "cpl_query/tests/*", "tests/*"] - -# -- Options for HTML output ------------------------------------------------- - -# The theme to use for HTML and HTML Help pages. See the documentation for -# a list of builtin themes. - -html_theme = "sphinx_rtd_theme" - -# Add any paths that contain custom static files (such as style sheets) here, -# relative to this directory. They are copied after the builtin static files, -# so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ["_static"] diff --git a/docs/source/contributing.md b/docs/source/contributing.md deleted file mode 100644 index 249c41d6..00000000 --- a/docs/source/contributing.md +++ /dev/null @@ -1,111 +0,0 @@ -# Contributing to CPL - -We would love for you to contribute to CPL and help make it even better than it is today! As a contributor, here are the guidelines we would like you to follow: - -- [Issuses and Bugs](#found-a-bug) -- [Feature Request](#feature-request) -- [Submission Guidelines](#submission-guidelines) -- [Coding Rules](#coding-rules) -- [License](#license) - -## Found a Bug? - -If you find a bug in the source code, you can help us by [submitting an issue](#submitting-an-issue) to our [Gitea Repository][gitea-repo]. Even better, you can [submit a Pull Request](#submitting-a-pull-request) with a fix. - -## Feature Request - -You can request a new feature by submitting an issue to our [Gitea Repository][gitea-repo]. If you would like to implement a new feature, please consider the size of the change in order to determine the right steps to proceed: - -For a Major Feature, first open an issue and outline your proposal so that it can be discussed. This process allows us to better coordinate our efforts, prevent duplication of work, and help you to craft the change so that it is successfully accepted into the project. - -Note: Adding a new topic to the documentation, or significantly re-writing a topic, counts as a major feature. - -Small Features can be crafted and directly submitted as a [Pull Request](#submit-pr). - -## Submission Guidelines - -### Submitting an Issue - -Before you submit an issue, please search the issue tracker, maybe an issue for your problem already exists and the discussion might inform you of workarounds readily available. - -We want to fix all the issues as soon as possible, but before fixing a bug we need to reproduce and confirm it. In order to reproduce bugs, we require that you provide a minimal reproduction. Having a minimal reproducible scenario gives us a wealth of important information without going back and forth to you with additional questions. - -A minimal reproduction allows us to quickly confirm a bug (or point out a coding problem) as well as confirm that we are fixing the right problem. - -We require a minimal reproduction to save maintainers' time and ultimately be able to fix more bugs. Often, developers find coding problems themselves while preparing a minimal reproduction. We understand that sometimes it might be hard to extract essential bits of code from a larger codebase but we really need to isolate the problem before we can fix it. - -Unfortunately, we are not able to investigate / fix bugs without a minimal reproduction, so if we don't hear back from you, we are going to close an issue that doesn't have enough info to be reproduced. - -### Submitting a Pull Request - -Before you submit your Pull Request (PR) consider the following guidelines: - -1. Search the [repository][gitea-repo] for an open or closed PR that relates to your submission. You don't want to duplicate existing efforts. - -2. Be sure that an issue describes the problem you're fixing, or documents the design for the feature you'd like to add. Discussing the design upfront helps to ensure that we're ready to accept your work. - -3. Fork the sh-edraft.de/cpl repo. - -4. In your forked repository, make your changes in a new git branch: - - ```sh - git checkout -b my-fix-branch master - ``` - -5. Create your patch, including appropriate test cases. - - - -6. Commit your changes. - - ```sh - git commit --all - ``` - - Note: the optional commit ```-a``` command line option will automatically "add" and "rm" edited files. - -7. Push your branch to the [repository][gitea-repo]: - - ```sh - git push origin my-fix-branch - ``` - -8. In Gitea, send a pull request to cpl:master - -### Reviewing a Pull Request - -The sh-edraft.de team reserves the right not to accept pull requests from community members who haven't been good citizens of the community. Such behavior includes not following the CPL [coding rules](#coding-rules) and applies within or outside of CPL managed channels. - -#### Addressing review feedback - -If we ask for changes via code reviews then: - -1. Make the required updates to the code. - -2. Create a fixup commit and push to your repository (this will update your Pull Request): - - ```sh - git commit --all --fixup HEAD - git push - ``` - -That's it! Thank you for your contribution! - -## Coding Rules - -To ensure consistency throughout the source code, keep these rules in mind as you are working: - -- All features or bug fixes must be tested by one or more unit-tests. - -- All public API methods must be documented. - -- We follow [PEP 8 -- Style Guide for Python Code](https://www.python.org/dev/peps/pep-0008/). - -## License - -By contributing, you agree that your contributions will be licensed under its MIT License. -See [LICENSE](https://git.sh-edraft.de/sh-edraft.de/cpl/src/branch/master/LICENSE) - - -[gitea-repo]: https://git.sh-edraft.de/sh-edraft.de/sh_cpl/ -[coding-rules]: / diff --git a/docs/source/cpl_cli.add.md b/docs/source/cpl_cli.add.md deleted file mode 100644 index 119359fa..00000000 --- a/docs/source/cpl_cli.add.md +++ /dev/null @@ -1,32 +0,0 @@ -# cpl add - -## Contents - -- [Description](#description) -- [Arguments](#arguments) -- [Flags](#flags) - -Removes a project from workspace. - -cpl **add** *<source-project>* *<target-project>*
-cpl **a** *<source-project>* *<target-project>*
-cpl **A** *<source-project>* *<target-project>* - -## Description - -Adds a project reference to given project. - -If you call the command in a CPL workspace, you can use the project names. Otherwise the paths of the projects must be specified. - -## Arguments - -| Argument | Description | Value type | -|------------------------|:----------------------------------------------------------:|:----------:| -| `````` | Name of the project to which the reference has to be added | ```str``` | -| `````` | Name of the project to be referenced | ```str``` | - -## Flags - -| Argument | Description | -|------------------|:------------------------------------------:| -| ```--simulate``` | Specifies whether the command is simulated | \ No newline at end of file diff --git a/docs/source/cpl_cli.build.md b/docs/source/cpl_cli.build.md deleted file mode 100644 index 8fdf31b8..00000000 --- a/docs/source/cpl_cli.build.md +++ /dev/null @@ -1,26 +0,0 @@ -# cpl build - -## Contents - -- [Description](#description) - - -Copies an python app into an output directory named build/ at the given output path. Must be executed within a CPL workspace or project directory - -cpl **build**
-cpl **b**
-cpl **B** - -## Description - -The command can be used to build a project of type "console" or "library". - -The build command copies all included source files to the output directory. You can run the source files in the output directory directly. - -The command is used to prepare the source files for the publish command or to copy them to an target for execution. - - diff --git a/docs/source/cpl_cli.generate.md b/docs/source/cpl_cli.generate.md deleted file mode 100644 index 6dc285a0..00000000 --- a/docs/source/cpl_cli.generate.md +++ /dev/null @@ -1,43 +0,0 @@ -# cpl generate - -## Contents - -- [Description](#description) -- [Arguments](#arguments) -- [Schematics](#schematics) - -Generate a file based on schematic. - -cpl **generate** *<schematic>* *<name>*
-cpl **g** *<schematic>* *<name>*
-cpl **G** *<schematic>* *<name>* - -## Description - -Generates files based on a schematic. - -You can define custom schematics by creating templates in a ```.cpl``` folder. - -## Arguments - -| Argument | Description | Value type | -|-------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------:|:-------------:| -| `````` | The schematic to generate. | ```str``` | -| `````` | The name of the generated file. | ```str``` | -| ```--base``` | First element of path will be used as base-path not 'src'. For example: 'cpl g c test/Test' will be created at ```src/test/``` with --base it would be ```test/``` | ```str``` | - -## Schematics - -| Schematic | Description | Arguments | -|-----------------|:--------------------------------------:|:------------:| -| ```abc``` | Abstract base class | `````` | -| ```class``` | Class | `````` | -| ```enum``` | Enum class | `````` | -| ```pipe``` | Pipe class | `````` | -| ```service``` | Service class | `````` | -| ```settings``` | [Configmodel](cpl_core.configuration) | `````` | -| ```test``` | Test class | `````` | -| ```thread``` | Thread class | `````` | -| ```validator``` | Validator class | `````` | -| ```command``` | Discord bot command class | `````` | -| ```event``` | Discord bot event class | `````` | diff --git a/docs/source/cpl_cli.help.md b/docs/source/cpl_cli.help.md deleted file mode 100644 index 533c108c..00000000 --- a/docs/source/cpl_cli.help.md +++ /dev/null @@ -1,22 +0,0 @@ -# cpl help - -## Contents - -- [Description](#description) -- [Arguments](#arguments) - -Lists available command and their short descriptions. - -cpl **help** *<command>*
-cpl **h** *<command>*
-cpl **H** *<command>* - -## Description - -Lists available command and their short descriptions. - -## Arguments - -| Argument | Description | Value type | -| ----------------- |:-----------------------------:|:-------------:| -| `````` | Shows a help message for this command in the console. | ```str``` | diff --git a/docs/source/cpl_cli.install.md b/docs/source/cpl_cli.install.md deleted file mode 100644 index 29a293cf..00000000 --- a/docs/source/cpl_cli.install.md +++ /dev/null @@ -1,31 +0,0 @@ -# cpl install - -## Contents - -- [Description](#description) -- [Arguments](#arguments) - -Installs given package via pip - -cpl **install** *<package>*
-cpl **i** *<package>*
-cpl **I** *<package>* - -## Description - -Install given package to project via pip. -Without given package it will install the depedencies of the CPL project your in. - -## Arguments - -| Argument | Description | Value type | -|-----------------|:----------------------:|:----------:| -| `````` | The package to install | ```str``` | - -## Flags - -| Argument | Description | -|------------------|:----------------------------------------------------:| -| ```--dev``` | Specifies whether the command is in development mode | -| ```--virtual``` | Specifies whether the command is virtual mode | -| ```--simulate``` | Specifies whether the command is simulated | diff --git a/docs/source/cpl_cli.new.md b/docs/source/cpl_cli.new.md deleted file mode 100644 index 1301c1ad..00000000 --- a/docs/source/cpl_cli.new.md +++ /dev/null @@ -1,45 +0,0 @@ -# cpl new - -## Contents - -- [Description](#description) -- [Arguments](#arguments) -- [Project types](#project-types) - -Generates a workspace and initial project or add a project to workspace. - -cpl **new** *<type>* *<name>*
-cpl **n** *<type>* *<name>*
-cpl **N** *<type>* *<name>* - -## Description - -Generates a workspace and initial project or add a project to workspace. - -You can define custom project types by creating templates in a ```.cpl``` folder. - -If the command is running in a CPL workspace, it will add the new project to the workspace. - -| Argument | Description | Value type | -|--------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------:|:----------:| -| `````` | The type of the project, see [types](#project-types) | ```str``` | -| `````` | The name of the project | ```str``` | -| ```--base``` | First element of path will be used as base-path not 'src'. For example: 'cpl g c test/Test' will be created at ```src/test/``` with --base it would be ```test/``` | ```str``` | - -## Project types - -| Project type | Description | -|---------------|:----------------------------:| -| ```console``` | A simple console application | -| ```library``` | A package | - -## Flags - -| Argument | Description | -|---------------------------|:-------------------------------------------:| -| ```--async``` | Specifies whether async is used | -| ```--application-base``` | Specifies whether application base is used | -| ```--startup``` | Specifies whether startup is used | -| ```--service-providing``` | Specifies whether service-providing is used | -| ```--nothing``` | Specifies whether nothing is used | -| ```--venv``` | Specifies whether venv is used | diff --git a/docs/source/cpl_cli.overview.md b/docs/source/cpl_cli.overview.md deleted file mode 100644 index 1116b4ba..00000000 --- a/docs/source/cpl_cli.overview.md +++ /dev/null @@ -1,53 +0,0 @@ -# CLI Overview and Command Reference - -## Table of Contents - -1. [Install CPL](setup#install-the-package) -2. [Install CPL CLI](setup#install-the-cli) -3. [Basic workflow](#basic-workflow) -4. [CLI command-language syntax](#cli-command-language-syntax) -5. [Command overview](#command-overview) - -## Basic workflow - -To create, build, and serve a new, basic CPL project on a development server, go to the parent directory of your new workspace use the following commands: - -```sh -cpl new console my-first-project -cd my-first-project -cpl start -``` - -In the terminal you will the output of the app. - -## CLI command-language syntax - -```cpl``` commandNameOrAlias requiredArg ```[optionalsArgs]``` - -- Most commands, and some options, have aliases. Aliases are shown in the syntax statement for each command. -- Arguments are not prefixed. - -### Relative paths - -Options that specify files can be given as absolute paths, or as paths relative to the current working directory, which is generally either the workspace or project root. - -### Schematics - -The cpl generate command takes as an argument the artifact to be generated. In addition to any general options, each artifact defines its own options in a schematic. Schematic options are supplied to the command in the same format as immediate command options. - -## Command overview - -| Command | Alias | Description | -| ----------------------------- |:-------------:|:----------------:| -| [add](cpl_cli.add) | a or a | Adds a project reference to given project. -| [build](cpl_cli.build) | b or B | Prepares files for publish into an output directory named dist/ at the given output path. Must be executed from within a workspace directory. -| [generate](cpl_cli.generate) | g or G | Generate a new file. -| [help](cpl_cli.help) | h or H | Lists available command and their short descriptions. -| [install](cpl_cli.install) | i or I | With argument installs packages to project, without argument installs project dependencies. -| [new](cpl_cli.new) | n or N | Creates new CPL project. -| [publish](cpl_cli.publish) | p or P | Prepares files for publish into an output directory named dist/ at the given output path and executes ```setup.py```. Must be executed from within a library workspace directory. -| [remove](cpl_cli.remove) | r or R | Removes a project from workspace. -| [start](cpl_cli.start) | s or S | Starts CPL project, restarting on file changes. -| [uninstall](cpl_cli.uninstall) | ui or UI | Uninstalls packages from project. -| [update](cpl_cli.update) | u or U | Update CPL and project dependencies. -| [version](cpl_cli.version) | v or V | Outputs CPL CLI version. diff --git a/docs/source/cpl_cli.publish.md b/docs/source/cpl_cli.publish.md deleted file mode 100644 index ead7aebb..00000000 --- a/docs/source/cpl_cli.publish.md +++ /dev/null @@ -1,27 +0,0 @@ -# cpl publish - -## Contents - -- [Description](#description) - - -Prepares files for publish into an output directory named dist/ at the given output path and executes ```setup.py```. - -cpl **publish**
-cpl **p**
-cpl **P** - -## Description - -The command can be used to publish a project of type "console" or "library". - -The publish command builds the source files and then creates an ```setup.py``` with data from ```cpl_core.json```. -The command executes the ```setup.py``` and removes all source files with the ```setup.py``` from the 'publish/' directory. - -Generated files of ```setup.py``` are in the 'publish/setup/' directory. - - \ No newline at end of file diff --git a/docs/source/cpl_cli.remove.md b/docs/source/cpl_cli.remove.md deleted file mode 100644 index a4a9fbf2..00000000 --- a/docs/source/cpl_cli.remove.md +++ /dev/null @@ -1,30 +0,0 @@ -# cpl remove - -## Contents - -- [Description](#description) -- [Arguments](#arguments) - -Removes a project from workspace. - -cpl **remove** *<project>*
-cpl **r** *<project>*
-cpl **R** *<project>* - -## Description - -Removes a project reference and the files from workspace. - -If you call the command in a CPL workspace, you can use the project names. Otherwise the paths of the projects must be specified. - -## Arguments - -| Argument | Description | Value type | -|-----------------|:---------------------------------:|:----------:| -| `````` | The name of the project to delete | ```str``` | - -## Flags - -| Argument | Description | -|------------------|:----------------------------------------------------:| -| ```--simulate``` | Specifies whether the command is simulated | diff --git a/docs/source/cpl_cli.rst b/docs/source/cpl_cli.rst deleted file mode 100644 index e0ca1832..00000000 --- a/docs/source/cpl_cli.rst +++ /dev/null @@ -1,20 +0,0 @@ -CLI reference -============= - -.. toctree:: - :maxdepth: 4 - - cpl_cli.overview - cpl_cli.add - cpl_cli.build - cpl_cli.generate - cpl_cli.help - cpl_cli.install - cpl_cli.new - cpl_cli.publish - cpl_cli.remove - cpl_cli.run - cpl_cli.start - cpl_cli.uninstall - cpl_cli.update - cpl_cli.version \ No newline at end of file diff --git a/docs/source/cpl_cli.run.md b/docs/source/cpl_cli.run.md deleted file mode 100644 index 5782a7a4..00000000 --- a/docs/source/cpl_cli.run.md +++ /dev/null @@ -1,12 +0,0 @@ -# cpl run - -Starts your application once. - -cpl **run**
-cpl **r**
-cpl **R** - -| Argument | Description | Value type | -|-----------------|:----------------------------------------------------------------------------------------------------:|:----------:| -| `````` | Optional parameter to specify which project to start, if not set default project will be started. | ```str``` | -| ```--dev``` | To run the project from source and not from dist after build. | ```str``` | \ No newline at end of file diff --git a/docs/source/cpl_cli.start.md b/docs/source/cpl_cli.start.md deleted file mode 100644 index 961feef1..00000000 --- a/docs/source/cpl_cli.start.md +++ /dev/null @@ -1,11 +0,0 @@ -# cpl start - -Starts your application, restarting on file changes. - -cpl **start**
-cpl **s**
-cpl **S** - -| Argument | Description | Value type | -|-----------------|:----------------------------------------------------------------------------------------------------:|:----------:| -| ```--dev``` | To run the project from source and not from dist after build. | ```str``` | \ No newline at end of file diff --git a/docs/source/cpl_cli.uninstall.md b/docs/source/cpl_cli.uninstall.md deleted file mode 100644 index a87c1320..00000000 --- a/docs/source/cpl_cli.uninstall.md +++ /dev/null @@ -1,30 +0,0 @@ -# cpl uninstall - -## Contents - -- [Description](#description) -- [Arguments](#arguments) - -Uninstalls given package via pip - -cpl **uninstall** *<package>*
-cpl **ui** *<package>*
-cpl **UI** *<package>* - -## Description - -Uninstall given package from project via pip. - -## Arguments - -| Argument | Description | Value type | -|-----------------|:------------------------:|:----------:| -| `````` | The package to uninstall | ```str``` | - -## Flags - -| Argument | Description | -|------------------|:----------------------------------------------------:| -| ```--dev``` | Specifies whether the command is in development mode | -| ```--virtual``` | Specifies whether the command is virtual mode | -| ```--simulate``` | Specifies whether the command is simulated | diff --git a/docs/source/cpl_cli.update.md b/docs/source/cpl_cli.update.md deleted file mode 100644 index 0bbcb72a..00000000 --- a/docs/source/cpl_cli.update.md +++ /dev/null @@ -1,13 +0,0 @@ -# cpl update - -Updates the CPL and project dependencies. - -cpl **update**
-cpl **u**
-cpl **U** - -## Flags - -| Argument | Description | -|------------------|:----------------------------------------------------:| -| ```--simulate``` | Specifies whether the command is simulated | diff --git a/docs/source/cpl_cli.version.md b/docs/source/cpl_cli.version.md deleted file mode 100644 index 4c8fcbe4..00000000 --- a/docs/source/cpl_cli.version.md +++ /dev/null @@ -1,7 +0,0 @@ -# cpl version - -Lists the version of CPL, CPL CLI and all installed packages from pip. - -cpl **version**
-cpl **v**
-cpl **V** diff --git a/docs/source/cpl_core.application.rst b/docs/source/cpl_core.application.rst deleted file mode 100644 index bcdcbc20..00000000 --- a/docs/source/cpl_core.application.rst +++ /dev/null @@ -1,61 +0,0 @@ -cpl\_core.application package -============================= - -Submodules ----------- - -cpl\_core.application.application\_abc module ---------------------------------------------- - -.. automodule:: cpl_core.application.application_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.application.application\_builder module -------------------------------------------------- - -.. automodule:: cpl_core.application.application_builder - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.application.application\_builder\_abc module ------------------------------------------------------- - -.. automodule:: cpl_core.application.application_builder_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.application.application\_extension\_abc module --------------------------------------------------------- - -.. automodule:: cpl_core.application.application_extension_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.application.startup\_abc module ------------------------------------------ - -.. automodule:: cpl_core.application.startup_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.application.startup\_extension\_abc module ----------------------------------------------------- - -.. automodule:: cpl_core.application.startup_extension_abc - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: cpl_core.application - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/source/cpl_core.configuration.rst b/docs/source/cpl_core.configuration.rst deleted file mode 100644 index 708c4ea6..00000000 --- a/docs/source/cpl_core.configuration.rst +++ /dev/null @@ -1,109 +0,0 @@ -cpl\_core.configuration package -=============================== - -Submodules ----------- - -cpl\_core.configuration.argument\_abc module --------------------------------------------- - -.. automodule:: cpl_core.configuration.argument_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.configuration.argument\_builder module ------------------------------------------------- - -.. automodule:: cpl_core.configuration.argument_builder - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.configuration.argument\_executable\_abc module --------------------------------------------------------- - -.. automodule:: cpl_core.configuration.argument_executable_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.configuration.argument\_type\_enum module ---------------------------------------------------- - -.. automodule:: cpl_core.configuration.argument_type_enum - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.configuration.configuration module --------------------------------------------- - -.. automodule:: cpl_core.configuration.configuration - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.configuration.configuration\_abc module -------------------------------------------------- - -.. automodule:: cpl_core.configuration.configuration_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.configuration.configuration\_model\_abc module --------------------------------------------------------- - -.. automodule:: cpl_core.configuration.configuration_model_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.configuration.configuration\_variable\_name\_enum module ------------------------------------------------------------------- - -.. automodule:: cpl_core.configuration.configuration_variable_name_enum - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.configuration.executable\_argument module ---------------------------------------------------- - -.. automodule:: cpl_core.configuration.executable_argument - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.configuration.flag\_argument module ---------------------------------------------- - -.. automodule:: cpl_core.configuration.flag_argument - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.configuration.validator\_abc module ---------------------------------------------- - -.. automodule:: cpl_core.configuration.validator_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.configuration.variable\_argument module -------------------------------------------------- - -.. automodule:: cpl_core.configuration.variable_argument - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: cpl_core.configuration - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/source/cpl_core.console.rst b/docs/source/cpl_core.console.rst deleted file mode 100644 index b14cc8c8..00000000 --- a/docs/source/cpl_core.console.rst +++ /dev/null @@ -1,53 +0,0 @@ -cpl\_core.console package -========================= - -Submodules ----------- - -cpl\_core.console.background\_color\_enum module ------------------------------------------------- - -.. automodule:: cpl_core.console.background_color_enum - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.console.console module --------------------------------- - -.. automodule:: cpl_core.console.console - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.console.console\_call module --------------------------------------- - -.. automodule:: cpl_core.console.console_call - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.console.foreground\_color\_enum module ------------------------------------------------- - -.. automodule:: cpl_core.console.foreground_color_enum - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.console.spinner\_thread module ----------------------------------------- - -.. automodule:: cpl_core.console.spinner_thread - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: cpl_core.console - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/source/cpl_core.database.connection.rst b/docs/source/cpl_core.database.connection.rst deleted file mode 100644 index 86ec3966..00000000 --- a/docs/source/cpl_core.database.connection.rst +++ /dev/null @@ -1,29 +0,0 @@ -cpl\_core.database.connection package -===================================== - -Submodules ----------- - -cpl\_core.database.connection.database\_connection module ---------------------------------------------------------- - -.. automodule:: cpl_core.database.connection.database_connection - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.database.connection.database\_connection\_abc module --------------------------------------------------------------- - -.. automodule:: cpl_core.database.connection.database_connection_abc - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: cpl_core.database.connection - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/source/cpl_core.database.context.rst b/docs/source/cpl_core.database.context.rst deleted file mode 100644 index a17353d7..00000000 --- a/docs/source/cpl_core.database.context.rst +++ /dev/null @@ -1,29 +0,0 @@ -cpl\_core.database.context package -================================== - -Submodules ----------- - -cpl\_core.database.context.database\_context module ---------------------------------------------------- - -.. automodule:: cpl_core.database.context.database_context - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.database.context.database\_context\_abc module --------------------------------------------------------- - -.. automodule:: cpl_core.database.context.database_context_abc - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: cpl_core.database.context - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/source/cpl_core.database.rst b/docs/source/cpl_core.database.rst deleted file mode 100644 index c5fbcffb..00000000 --- a/docs/source/cpl_core.database.rst +++ /dev/null @@ -1,46 +0,0 @@ -cpl\_core.database package -========================== - -Subpackages ------------ - -.. toctree:: - :maxdepth: 4 - - cpl_core.database.connection - cpl_core.database.context - -Submodules ----------- - -cpl\_core.database.database\_settings module --------------------------------------------- - -.. automodule:: cpl_core.database.database_settings - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.database.database\_settings\_name\_enum module --------------------------------------------------------- - -.. automodule:: cpl_core.database.database_settings_name_enum - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.database.table\_abc module ------------------------------------- - -.. automodule:: cpl_core.database.table_abc - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: cpl_core.database - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/source/cpl_core.dependency_injection.rst b/docs/source/cpl_core.dependency_injection.rst deleted file mode 100644 index 4e951d6e..00000000 --- a/docs/source/cpl_core.dependency_injection.rst +++ /dev/null @@ -1,85 +0,0 @@ -cpl\_core.dependency\_injection package -======================================= - -Submodules ----------- - -cpl\_core.dependency\_injection.scope module --------------------------------------------- - -.. automodule:: cpl_core.dependency_injection.scope - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.dependency\_injection.scope\_abc module -------------------------------------------------- - -.. automodule:: cpl_core.dependency_injection.scope_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.dependency\_injection.scope\_builder module ------------------------------------------------------ - -.. automodule:: cpl_core.dependency_injection.scope_builder - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.dependency\_injection.service\_collection module ----------------------------------------------------------- - -.. automodule:: cpl_core.dependency_injection.service_collection - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.dependency\_injection.service\_collection\_abc module ---------------------------------------------------------------- - -.. automodule:: cpl_core.dependency_injection.service_collection_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.dependency\_injection.service\_descriptor module ----------------------------------------------------------- - -.. automodule:: cpl_core.dependency_injection.service_descriptor - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.dependency\_injection.service\_lifetime\_enum module --------------------------------------------------------------- - -.. automodule:: cpl_core.dependency_injection.service_lifetime_enum - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.dependency\_injection.service\_provider module --------------------------------------------------------- - -.. automodule:: cpl_core.dependency_injection.service_provider - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.dependency\_injection.service\_provider\_abc module -------------------------------------------------------------- - -.. automodule:: cpl_core.dependency_injection.service_provider_abc - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: cpl_core.dependency_injection - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/source/cpl_core.environment.rst b/docs/source/cpl_core.environment.rst deleted file mode 100644 index 84eaedde..00000000 --- a/docs/source/cpl_core.environment.rst +++ /dev/null @@ -1,37 +0,0 @@ -cpl\_core.environment package -============================= - -Submodules ----------- - -cpl\_core.environment.application\_environment module ------------------------------------------------------ - -.. automodule:: cpl_core.environment.application_environment - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.environment.application\_environment\_abc module ----------------------------------------------------------- - -.. automodule:: cpl_core.environment.application_environment_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.environment.environment\_name\_enum module ----------------------------------------------------- - -.. automodule:: cpl_core.environment.environment_name_enum - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: cpl_core.environment - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/source/cpl_core.logging.rst b/docs/source/cpl_core.logging.rst deleted file mode 100644 index 6f36754d..00000000 --- a/docs/source/cpl_core.logging.rst +++ /dev/null @@ -1,53 +0,0 @@ -cpl\_core.logging package -========================= - -Submodules ----------- - -cpl\_core.logging.logger\_abc module ------------------------------------- - -.. automodule:: cpl_core.logging.logger_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.logging.logger\_service module ----------------------------------------- - -.. automodule:: cpl_core.logging.logger_service - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.logging.logging\_level\_enum module ---------------------------------------------- - -.. automodule:: cpl_core.logging.logging_level_enum - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.logging.logging\_settings module ------------------------------------------- - -.. automodule:: cpl_core.logging.logging_settings - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.logging.logging\_settings\_name\_enum module ------------------------------------------------------- - -.. automodule:: cpl_core.logging.logging_settings_name_enum - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: cpl_core.logging - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/source/cpl_core.mailing.rst b/docs/source/cpl_core.mailing.rst deleted file mode 100644 index 323e167c..00000000 --- a/docs/source/cpl_core.mailing.rst +++ /dev/null @@ -1,53 +0,0 @@ -cpl\_core.mailing package -========================= - -Submodules ----------- - -cpl\_core.mailing.email module ------------------------------- - -.. automodule:: cpl_core.mailing.email - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.mailing.email\_client\_abc module -------------------------------------------- - -.. automodule:: cpl_core.mailing.email_client_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.mailing.email\_client\_service module ------------------------------------------------ - -.. automodule:: cpl_core.mailing.email_client_service - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.mailing.email\_client\_settings module ------------------------------------------------- - -.. automodule:: cpl_core.mailing.email_client_settings - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.mailing.email\_client\_settings\_name\_enum module ------------------------------------------------------------- - -.. automodule:: cpl_core.mailing.email_client_settings_name_enum - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: cpl_core.mailing - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/source/cpl_core.pipes.rst b/docs/source/cpl_core.pipes.rst deleted file mode 100644 index cc061b15..00000000 --- a/docs/source/cpl_core.pipes.rst +++ /dev/null @@ -1,77 +0,0 @@ -cpl\_core.pipes package -======================= - -Submodules ----------- - -cpl\_core.pipes.bool\_pipe module ---------------------------------- - -.. automodule:: cpl_core.pipes.bool_pipe - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.pipes.first\_char\_to\_lower\_pipe module ---------------------------------------------------- - -.. automodule:: cpl_core.pipes.first_char_to_lower_pipe - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.pipes.first\_to\_upper\_pipe module ---------------------------------------------- - -.. automodule:: cpl_core.pipes.first_to_upper_pipe - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.pipes.ip\_address\_pipe module ----------------------------------------- - -.. automodule:: cpl_core.pipes.ip_address_pipe - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.pipes.pipe\_abc module --------------------------------- - -.. automodule:: cpl_core.pipes.pipe_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.pipes.to\_camel\_case\_pipe module --------------------------------------------- - -.. automodule:: cpl_core.pipes.to_camel_case_pipe - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.pipes.to\_snake\_case\_pipe module --------------------------------------------- - -.. automodule:: cpl_core.pipes.to_snake_case_pipe - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.pipes.version\_pipe module ------------------------------------- - -.. automodule:: cpl_core.pipes.version_pipe - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: cpl_core.pipes - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/source/cpl_core.rst b/docs/source/cpl_core.rst deleted file mode 100644 index f238136a..00000000 --- a/docs/source/cpl_core.rst +++ /dev/null @@ -1,18 +0,0 @@ -API reference -============= - -.. toctree:: - :maxdepth: 4 - - cpl_core.application - cpl_core.configuration - cpl_core.console - cpl_core.database - cpl_core.dependency_injection - cpl_core.environment - cpl_core.logging - cpl_core.mailing - cpl_core.pipes - cpl_core.time - cpl_core.utils - diff --git a/docs/source/cpl_core.time.rst b/docs/source/cpl_core.time.rst deleted file mode 100644 index 4ecce6ec..00000000 --- a/docs/source/cpl_core.time.rst +++ /dev/null @@ -1,29 +0,0 @@ -cpl\_core.time package -====================== - -Submodules ----------- - -cpl\_core.time.time\_format\_settings module --------------------------------------------- - -.. automodule:: cpl_core.time.time_format_settings - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.time.time\_format\_settings\_names\_enum module ---------------------------------------------------------- - -.. automodule:: cpl_core.time.time_format_settings_names_enum - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: cpl_core.time - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/source/cpl_core.utils.rst b/docs/source/cpl_core.utils.rst deleted file mode 100644 index 6318a1de..00000000 --- a/docs/source/cpl_core.utils.rst +++ /dev/null @@ -1,37 +0,0 @@ -cpl\_core.utils package -======================= - -Submodules ----------- - -cpl\_core.utils.credential\_manager module ------------------------------------------- - -.. automodule:: cpl_core.utils.credential_manager - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.utils.pip module --------------------------- - -.. automodule:: cpl_core.utils.pip - :members: - :undoc-members: - :show-inheritance: - -cpl\_core.utils.string module ------------------------------ - -.. automodule:: cpl_core.utils.string - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: cpl_core.utils - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/source/cpl_discord.application.rst b/docs/source/cpl_discord.application.rst deleted file mode 100644 index 3ce2c948..00000000 --- a/docs/source/cpl_discord.application.rst +++ /dev/null @@ -1,21 +0,0 @@ -cpl\_discord.application package -================================ - -Submodules ----------- - -cpl\_discord.application.discord\_bot\_application\_abc module --------------------------------------------------------------- - -.. automodule:: cpl_discord.application.discord_bot_application_abc - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: cpl_discord.application - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/source/cpl_discord.command.rst b/docs/source/cpl_discord.command.rst deleted file mode 100644 index ca0bb5a5..00000000 --- a/docs/source/cpl_discord.command.rst +++ /dev/null @@ -1,29 +0,0 @@ -cpl\_discord.command package -============================ - -Submodules ----------- - -cpl\_discord.command.discord\_command\_abc module -------------------------------------------------- - -.. automodule:: cpl_discord.command.discord_command_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.command.discord\_commands\_meta module ---------------------------------------------------- - -.. automodule:: cpl_discord.command.discord_commands_meta - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: cpl_discord.command - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/source/cpl_discord.configuration.rst b/docs/source/cpl_discord.configuration.rst deleted file mode 100644 index 47cda9ed..00000000 --- a/docs/source/cpl_discord.configuration.rst +++ /dev/null @@ -1,21 +0,0 @@ -cpl\_discord.configuration package -================================== - -Submodules ----------- - -cpl\_discord.configuration.discord\_bot\_settings module --------------------------------------------------------- - -.. automodule:: cpl_discord.configuration.discord_bot_settings - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: cpl_discord.configuration - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/source/cpl_discord.container.rst b/docs/source/cpl_discord.container.rst deleted file mode 100644 index 44b70a52..00000000 --- a/docs/source/cpl_discord.container.rst +++ /dev/null @@ -1,77 +0,0 @@ -cpl\_discord.container package -============================== - -Submodules ----------- - -cpl\_discord.container.category\_channel module ------------------------------------------------ - -.. automodule:: cpl_discord.container.category_channel - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.container.container module ---------------------------------------- - -.. automodule:: cpl_discord.container.container - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.container.guild module ------------------------------------ - -.. automodule:: cpl_discord.container.guild - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.container.member module ------------------------------------- - -.. automodule:: cpl_discord.container.member - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.container.role module ----------------------------------- - -.. automodule:: cpl_discord.container.role - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.container.text\_channel module -------------------------------------------- - -.. automodule:: cpl_discord.container.text_channel - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.container.thread module ------------------------------------- - -.. automodule:: cpl_discord.container.thread - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.container.voice\_channel module --------------------------------------------- - -.. automodule:: cpl_discord.container.voice_channel - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: cpl_discord.container - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/source/cpl_discord.events.rst b/docs/source/cpl_discord.events.rst deleted file mode 100644 index 290111c1..00000000 --- a/docs/source/cpl_discord.events.rst +++ /dev/null @@ -1,421 +0,0 @@ -cpl\_discord.events package -=========================== - -Submodules ----------- - -cpl\_discord.events.on\_bulk\_message\_delete\_abc module ---------------------------------------------------------- - -.. automodule:: cpl_discord.events.on_bulk_message_delete_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_command\_abc module -------------------------------------------- - -.. automodule:: cpl_discord.events.on_command_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_command\_completion\_abc module -------------------------------------------------------- - -.. automodule:: cpl_discord.events.on_command_completion_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_command\_error\_abc module --------------------------------------------------- - -.. automodule:: cpl_discord.events.on_command_error_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_connect\_abc module -------------------------------------------- - -.. automodule:: cpl_discord.events.on_connect_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_disconnect\_abc module ----------------------------------------------- - -.. automodule:: cpl_discord.events.on_disconnect_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_error\_abc module ------------------------------------------ - -.. automodule:: cpl_discord.events.on_error_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_group\_join\_abc module ------------------------------------------------ - -.. automodule:: cpl_discord.events.on_group_join_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_group\_remove\_abc module -------------------------------------------------- - -.. automodule:: cpl_discord.events.on_group_remove_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_guild\_available\_abc module ----------------------------------------------------- - -.. automodule:: cpl_discord.events.on_guild_available_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_guild\_channel\_create\_abc module ----------------------------------------------------------- - -.. automodule:: cpl_discord.events.on_guild_channel_create_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_guild\_channel\_delete\_abc module ----------------------------------------------------------- - -.. automodule:: cpl_discord.events.on_guild_channel_delete_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_guild\_channel\_pins\_update\_abc module ----------------------------------------------------------------- - -.. automodule:: cpl_discord.events.on_guild_channel_pins_update_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_guild\_channel\_update\_abc module ----------------------------------------------------------- - -.. automodule:: cpl_discord.events.on_guild_channel_update_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_guild\_emojis\_update\_abc module ---------------------------------------------------------- - -.. automodule:: cpl_discord.events.on_guild_emojis_update_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_guild\_integrations\_update\_abc module ---------------------------------------------------------------- - -.. automodule:: cpl_discord.events.on_guild_integrations_update_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_guild\_join\_abc module ------------------------------------------------ - -.. automodule:: cpl_discord.events.on_guild_join_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_guild\_remove\_abc module -------------------------------------------------- - -.. automodule:: cpl_discord.events.on_guild_remove_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_guild\_role\_create\_abc module -------------------------------------------------------- - -.. automodule:: cpl_discord.events.on_guild_role_create_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_guild\_role\_delete\_abc module -------------------------------------------------------- - -.. automodule:: cpl_discord.events.on_guild_role_delete_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_guild\_role\_update\_abc module -------------------------------------------------------- - -.. automodule:: cpl_discord.events.on_guild_role_update_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_guild\_unavailable\_abc module ------------------------------------------------------- - -.. automodule:: cpl_discord.events.on_guild_unavailable_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_guild\_update\_abc module -------------------------------------------------- - -.. automodule:: cpl_discord.events.on_guild_update_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_invite\_create\_abc module --------------------------------------------------- - -.. automodule:: cpl_discord.events.on_invite_create_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_invite\_delete\_abc module --------------------------------------------------- - -.. automodule:: cpl_discord.events.on_invite_delete_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_member\_ban\_abc module ------------------------------------------------ - -.. automodule:: cpl_discord.events.on_member_ban_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_member\_join\_abc module ------------------------------------------------- - -.. automodule:: cpl_discord.events.on_member_join_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_member\_remove\_abc module --------------------------------------------------- - -.. automodule:: cpl_discord.events.on_member_remove_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_member\_unban\_abc module -------------------------------------------------- - -.. automodule:: cpl_discord.events.on_member_unban_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_member\_update\_abc module --------------------------------------------------- - -.. automodule:: cpl_discord.events.on_member_update_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_message\_abc module -------------------------------------------- - -.. automodule:: cpl_discord.events.on_message_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_message\_delete\_abc module ---------------------------------------------------- - -.. automodule:: cpl_discord.events.on_message_delete_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_message\_edit\_abc module -------------------------------------------------- - -.. automodule:: cpl_discord.events.on_message_edit_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_private\_channel\_create\_abc module ------------------------------------------------------------- - -.. automodule:: cpl_discord.events.on_private_channel_create_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_private\_channel\_delete\_abc module ------------------------------------------------------------- - -.. automodule:: cpl_discord.events.on_private_channel_delete_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_private\_channel\_pins\_update\_abc module ------------------------------------------------------------------- - -.. automodule:: cpl_discord.events.on_private_channel_pins_update_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_private\_channel\_update\_abc module ------------------------------------------------------------- - -.. automodule:: cpl_discord.events.on_private_channel_update_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_raw\_reaction\_add\_abc module ------------------------------------------------------- - -.. automodule:: cpl_discord.events.on_raw_reaction_add_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_raw\_reaction\_clear\_abc module --------------------------------------------------------- - -.. automodule:: cpl_discord.events.on_raw_reaction_clear_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_raw\_reaction\_clear\_emoji\_abc module ---------------------------------------------------------------- - -.. automodule:: cpl_discord.events.on_raw_reaction_clear_emoji_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_raw\_reaction\_remove\_abc module ---------------------------------------------------------- - -.. automodule:: cpl_discord.events.on_raw_reaction_remove_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_reaction\_add\_abc module -------------------------------------------------- - -.. automodule:: cpl_discord.events.on_reaction_add_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_reaction\_clear\_abc module ---------------------------------------------------- - -.. automodule:: cpl_discord.events.on_reaction_clear_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_reaction\_clear\_emoji\_abc module ----------------------------------------------------------- - -.. automodule:: cpl_discord.events.on_reaction_clear_emoji_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_reaction\_remove\_abc module ----------------------------------------------------- - -.. automodule:: cpl_discord.events.on_reaction_remove_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_ready\_abc module ------------------------------------------ - -.. automodule:: cpl_discord.events.on_ready_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_resume\_abc module ------------------------------------------- - -.. automodule:: cpl_discord.events.on_resume_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_typing\_abc module ------------------------------------------- - -.. automodule:: cpl_discord.events.on_typing_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_user\_update\_abc module ------------------------------------------------- - -.. automodule:: cpl_discord.events.on_user_update_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_voice\_state\_update\_abc module --------------------------------------------------------- - -.. automodule:: cpl_discord.events.on_voice_state_update_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.events.on\_webhooks\_update\_abc module ----------------------------------------------------- - -.. automodule:: cpl_discord.events.on_webhooks_update_abc - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: cpl_discord.events - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/source/cpl_discord.helper.rst b/docs/source/cpl_discord.helper.rst deleted file mode 100644 index fab914ae..00000000 --- a/docs/source/cpl_discord.helper.rst +++ /dev/null @@ -1,21 +0,0 @@ -cpl\_discord.helper package -=========================== - -Submodules ----------- - -cpl\_discord.helper.to\_containers\_converter module ----------------------------------------------------- - -.. automodule:: cpl_discord.helper.to_containers_converter - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: cpl_discord.helper - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/source/cpl_discord.rst b/docs/source/cpl_discord.rst deleted file mode 100644 index 94735451..00000000 --- a/docs/source/cpl_discord.rst +++ /dev/null @@ -1,21 +0,0 @@ -Discord Reference -==================== - -.. toctree:: - :maxdepth: 4 - - cpl_discord.application - cpl_discord.command - cpl_discord.configuration - cpl_discord.container - cpl_discord.events - cpl_discord.helper - cpl_discord.service - -cpl\_discord.discord\_event\_types\_enum module ------------------------------------------------ - -.. automodule:: cpl_discord.discord_event_types_enum - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/source/cpl_discord.service.rst b/docs/source/cpl_discord.service.rst deleted file mode 100644 index 13527b5b..00000000 --- a/docs/source/cpl_discord.service.rst +++ /dev/null @@ -1,69 +0,0 @@ -cpl\_discord.service package -============================ - -Submodules ----------- - -cpl\_discord.service.command\_error\_handler\_service module ------------------------------------------------------------- - -.. automodule:: cpl_discord.service.command_error_handler_service - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.service.discord\_bot\_service module -------------------------------------------------- - -.. automodule:: cpl_discord.service.discord_bot_service - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.service.discord\_bot\_service\_abc module ------------------------------------------------------- - -.. automodule:: cpl_discord.service.discord_bot_service_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.service.discord\_collection module ------------------------------------------------ - -.. automodule:: cpl_discord.service.discord_collection - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.service.discord\_collection\_abc module ----------------------------------------------------- - -.. automodule:: cpl_discord.service.discord_collection_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.service.discord\_service module --------------------------------------------- - -.. automodule:: cpl_discord.service.discord_service - :members: - :undoc-members: - :show-inheritance: - -cpl\_discord.service.discord\_service\_abc module -------------------------------------------------- - -.. automodule:: cpl_discord.service.discord_service_abc - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: cpl_discord.service - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/source/cpl_query.base.rst b/docs/source/cpl_query.base.rst deleted file mode 100644 index 34fc9962..00000000 --- a/docs/source/cpl_query.base.rst +++ /dev/null @@ -1,53 +0,0 @@ -cpl\_query.base package -======================= - -Submodules ----------- - -cpl\_query.base.default\_lambda module --------------------------------------- - -.. automodule:: cpl_query.base.default_lambda - :members: - :undoc-members: - :show-inheritance: - -cpl\_query.base.ordered\_queryable module ------------------------------------------ - -.. automodule:: cpl_query.base.ordered_queryable - :members: - :undoc-members: - :show-inheritance: - -cpl\_query.base.ordered\_queryable\_abc module ----------------------------------------------- - -.. automodule:: cpl_query.base.ordered_queryable_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_query.base.queryable\_abc module -------------------------------------- - -.. automodule:: cpl_query.base.queryable_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_query.base.sequence module -------------------------------- - -.. automodule:: cpl_query.base.sequence - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: cpl_query.base - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/source/cpl_query.enumerable.rst b/docs/source/cpl_query.enumerable.rst deleted file mode 100644 index 6c4d6a18..00000000 --- a/docs/source/cpl_query.enumerable.rst +++ /dev/null @@ -1,29 +0,0 @@ -cpl\_query.enumerable package -============================= - -Submodules ----------- - -cpl\_query.enumerable.enumerable module ---------------------------------------- - -.. automodule:: cpl_query.enumerable.enumerable - :members: - :undoc-members: - :show-inheritance: - -cpl\_query.enumerable.enumerable\_abc module --------------------------------------------- - -.. automodule:: cpl_query.enumerable.enumerable_abc - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: cpl_query.enumerable - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/source/cpl_query.extension.rst b/docs/source/cpl_query.extension.rst deleted file mode 100644 index 4579c6e1..00000000 --- a/docs/source/cpl_query.extension.rst +++ /dev/null @@ -1,21 +0,0 @@ -cpl\_query.extension package -============================ - -Submodules ----------- - -cpl\_query.extension.list module --------------------------------- - -.. automodule:: cpl_query.extension.list - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: cpl_query.extension - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/source/cpl_query.iterable.rst b/docs/source/cpl_query.iterable.rst deleted file mode 100644 index 07ea0c19..00000000 --- a/docs/source/cpl_query.iterable.rst +++ /dev/null @@ -1,29 +0,0 @@ -cpl\_query.iterable package -=========================== - -Submodules ----------- - -cpl\_query.iterable.iterable module ------------------------------------ - -.. automodule:: cpl_query.iterable.iterable - :members: - :undoc-members: - :show-inheritance: - -cpl\_query.iterable.iterable\_abc module ----------------------------------------- - -.. automodule:: cpl_query.iterable.iterable_abc - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: cpl_query.iterable - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/source/cpl_query.rst b/docs/source/cpl_query.rst deleted file mode 100644 index 5812cc73..00000000 --- a/docs/source/cpl_query.rst +++ /dev/null @@ -1,10 +0,0 @@ -Query reference -=============== - -.. toctree:: - :maxdepth: 4 - - cpl_query.base - cpl_query.enumerable - cpl_query.extension - cpl_query.iterable diff --git a/docs/source/cpl_translation.rst b/docs/source/cpl_translation.rst deleted file mode 100644 index 365356e8..00000000 --- a/docs/source/cpl_translation.rst +++ /dev/null @@ -1,34 +0,0 @@ -Translation reference -======================== - -cpl\_translation.translate\_pipe ---------------------------------------- - -.. automodule:: cpl_translation.translate_pipe - :members: - :undoc-members: - :show-inheritance: - -cpl\_translation.translation\_service --------------------------------------------- - -.. automodule:: cpl_translation.translation_service - :members: - :undoc-members: - :show-inheritance: - -cpl\_translation.translation\_service\_abc -------------------------------------------------- - -.. automodule:: cpl_translation.translation_service_abc - :members: - :undoc-members: - :show-inheritance: - -cpl\_translation.translation\_settings ---------------------------------------------- - -.. automodule:: cpl_translation.translation_settings - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/source/deprecated.md b/docs/source/deprecated.md deleted file mode 100644 index b73a77ab..00000000 --- a/docs/source/deprecated.md +++ /dev/null @@ -1,69 +0,0 @@ -# Deprecated - -## Table of Contents - -1. [ConfigurationModelABC.from_dict](#ConfigurationModelABC-from_dict-method) - -## ConfigurationModelABC from_dict method - -We now process the configuration models directly in the configuration by recursive parameter parsing. - -The JSONProcessor now goes through the JSON and the arguments of the __init__ and links the attributes by name from the -JSON and the name of the keyword argument. -Now, based on the type, either simply assigns the value. With a ``dict`` the processor is called recursively and so the -JSON is processed further. This way nested ConfigurationModels can be processed. - -For this the code must be adapted as follows: - -From this: - -```sh -class VersionSettings(ConfigurationModelABC): - - def __init__(self): - ConfigurationModelABC.__init__(self) - - self.major: Optional[str] = "0" - self.minor: Optional[str] = "0" - self.micro: Optional[str] = "0" - - def from_dict(self, settings: dict): - self.major = settings["Major"] - self.minor = settings["Minor"] - micro = settings["Micro"] - if micro != '': - self.micro = micro -``` - -To this: - -```sh -class VersionSettings(ConfigurationModelABC): - def __init__(self, major: str = None, minor: str = None, micro: str = None): - ConfigurationModelABC.__init__(self) - - self.major: Optional[str] = major - self.minor: Optional[str] = minor - self.micro: Optional[str] = micro if micro != "" else None -``` - -This makes the [from_dict](#from_dict) function obsolete. - -A few rules must be observed: - -- Only simple types can be processed -
- Wrong: ```dict[str, str]``` -
- Correct: ```dict``` -
-
- Incorrect: ```list[str]``` -
- Correct: ```list``` - -- The arguments must be optional, i.e. created as kwargs -
- Incorrect: ```def __init__(self, x: int, y: int)``` -
- Correct: ```def __init__(self, x: int = None, y: int = None)``` \ No newline at end of file diff --git a/docs/source/getting_started.rst b/docs/source/getting_started.rst deleted file mode 100644 index 22dc00e9..00000000 --- a/docs/source/getting_started.rst +++ /dev/null @@ -1,10 +0,0 @@ -Getting started -=============== - -.. toctree:: - :maxdepth: 4 - - quickstart - setup - tutorials - diff --git a/docs/source/images/ide-emulate.png b/docs/source/images/ide-emulate.png deleted file mode 100644 index 3c6f5a6b..00000000 Binary files a/docs/source/images/ide-emulate.png and /dev/null differ diff --git a/docs/source/images/ide-src.png b/docs/source/images/ide-src.png deleted file mode 100644 index f778cd46..00000000 Binary files a/docs/source/images/ide-src.png and /dev/null differ diff --git a/docs/source/images/ide.png b/docs/source/images/ide.png deleted file mode 100644 index 18370cd8..00000000 Binary files a/docs/source/images/ide.png and /dev/null differ diff --git a/docs/source/index.rst b/docs/source/index.rst deleted file mode 100644 index 9b6e6056..00000000 --- a/docs/source/index.rst +++ /dev/null @@ -1,95 +0,0 @@ -.. Common Python Library documentation master file, created by - sphinx-quickstart on Wed Apr 14 10:25:36 2021. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -Introduction to the CPL Docs -============================ - -The Common Python Library (CPL) is a package for python and a development platform meant to help you create simple and efficient server and desktop applications. - -This CPL docs help you learn, understand and use the package. From your first application to complex apps for enterprises. - - -Features --------- -- cpl-core - - Expandable - - Application base - - Standardized application classes - - Application object builder - - Application extension classes - - Startup classes - - Startup extension classes - - Configuration - - Configure via object mapped JSON - - Console argument handling - - Console class for in and output - - Banner - - Spinner - - Options (menu) - - Table - - Write - - Write_at - - Write_line - - Write_line_at - - Dependency injection - - Service lifetimes: singleton, scoped and transient - - Providing of application environment - - Environment (development, staging, testing, production) - - Appname - - Customer - - Hostname - - Runtime directory - - Working directory - - Logging - - Standardized logger - - Log-level (FATAL, ERROR, WARN, INFO, DEBUG & TRACE) - - Mail handling - - Send mails - - Pipe classes - - Convert input - - Utils - - Credential manager - - Encryption via BASE64 - - PIP wrapper class based on subprocess - - Run pip commands - - String converter to different variants - - to_lower_case - - to_camel_case - - ... -- cpl-cli - - Expandle - - Code generation - - Package managing - - Build & Publishing -- cpl-discord - - Utils for discord.py - - Connector between cpl-core and discord.py - - Prepared services for dependency injection -- cpl-query - - Python list extensions - - Functions for sorting and filtering - - Like linq from C# but in python xD -- cpl-translate - - Generic translations - - Prepared translation service and translate pipe - - Get translation from JSON files key dot.key notation - -Manuals ---------- - -These pages go into great detail about everything the Library can do. - -.. toctree:: - :maxdepth: 1 - - introduction - getting_started - contributing - deprecated - cpl_cli - cpl_core - cpl_discord - cpl_query - cpl_translation diff --git a/docs/source/introduction.md b/docs/source/introduction.md deleted file mode 100644 index 33d31430..00000000 --- a/docs/source/introduction.md +++ /dev/null @@ -1,60 +0,0 @@ -# Introduction to the CPL Docs - -The Common Python Library (CPL) is a package for python and a development platform meant to help you create simple and efficient server and desktop applications. - -This CPL docs help you learn, understand and use the package. From your first application to complex apps for enterprises. - -## Feature overview - -- Expandle -- Application base - - Standardized application classes - - Application object builder - - Application extension classes - - Startup classes - - Startup extension classes -- Configuration - - Configure via object mapped JSON - - Console argument handling -- Console class for in and output - - Banner - - Spinner - - Options (menu) - - Table - - Write - - Write_at - - Write_line - - Write_line_at -- Dependency injection - - Service lifetimes: singleton, scoped and transient -- Providing of application environment - - Environment (development, staging, testing, production) - - Appname - - Customer - - Hostname - - Runtime directory - - Working directory -- Logging - - Standardized logger - - Log-level (FATAL, ERROR, WARN, INFO, DEBUG & TRACE) -- Mail handling - - Send mails -- Pipe classes - - Convert input -- Utils - - Credential manager - - Encryption via BASE64 - - PIP wrapper class based on subprocess - - Run pip commands - - String converter to different variants - - to_lower_case - - to_camel_case - - ... - -## Explore - -- [Getting started](quickstart) -- [Setup](setup) -- [API Reference](cpl_core) -- [CLI Reference](cpl_cli.overview) -- [Query Reference](cpl_query) diff --git a/docs/source/modules.rst b/docs/source/modules.rst deleted file mode 100644 index 49bd8182..00000000 --- a/docs/source/modules.rst +++ /dev/null @@ -1,11 +0,0 @@ -Packages -======== - -.. toctree:: - :maxdepth: 4 - - cpl_cli - cpl_core - cpl_discord - cpl_query - cpl_translation diff --git a/docs/source/quickstart.md b/docs/source/quickstart.md deleted file mode 100644 index ef5b6693..00000000 --- a/docs/source/quickstart.md +++ /dev/null @@ -1,210 +0,0 @@ -# Getting started with CPL - -Welcome to CPL! - -This tutorial introduces you to the essentials of the CPL package by walking through building an console based app. - -## Table of Contents - -1. [Prerequisites](#prerequisites) -2. [Create the project](#create-the-project) -3. [Create a menu](#create-a-menu) -4. [What's next](#whats-next) - -## Prerequisites - -To get most out of this tutorial you should already have a basic understanding of the following. - -- [Python][python] - -Also you need to have the following installed. - -- [Python][python] -- [Pip][pip-url] -- [CPL](setup) -- [CPL-CLI](setup) - -## Create the project - -To create the sample project to the following: - -1. Open a terminal -2. Run - - ```sh - cpl new console sample-project - ``` - -3. We don't want to use Application base or Dependency injection: - - ```sh - Do you want to use application base? (y/n) n - - Do you want to use service providing? (y/n) n - ``` - - The ouput should look like this: - - ```sh - Creating sample-project/LICENSE done - Creating sample-project/README.md done - Creating sample-project/src/tests/__init__.py done - Creating sample-project/appsettings.json done - Creating sample-project/src/sample-project/__init__.py done - Creating sample-project/src/sample-projectmain.py done - ``` - -4. Open the project with an IDE like VS Code or PyCharm - - ![IDE](images/ide.png) - -5. Set the 'src' directory as source folder - - ![IDE set src folder](images/ide-src.png) - -6. Run the application - - You should see an output like: - - ```sh - Hello World - ``` - -7. In PyCharm you have to enable ```Emulate terminal in output console```! - - ![IDE emulate console](images/ide-emulate.png) - -## Create a menu - -1. Open the 'sample-project/main.py' - -2. Change 'Hello World' to 'Password generator:' in line 5 - -3. Add ```Console.select``` as follows: - - ```py - from cpl_core.console import Console - - - def main(): - Console.write_line('Password generator:') - options = [ - 'Only lower case', - 'Only upper case', - 'Lower and upper case' - 'Exit' - ] - option = Console.select('>', 'Select option: ', options) - - - if __name__ == '__main__': - main() - - ``` - -4. Get Id of the selected option: - - ```py - index = options.index(option) - ``` - -5. Create the generate function as follows: - - ```py - def generate_password(letters: str, length: int) -> str: - return ''.join(random.choice(letters) for i in range(length)) - ``` - - Add imports: - - ```py - import random - import string - ``` - -6. Get length of the password: - - ```py - length = int(Console.read('Length: ')) - ``` - -7. Validate the selected option: - - ```py - index = options.index(option) - letters = '' - - if index == 0: - letters = string.ascii_lowercase - elif index == 1: - letters = string.ascii_uppercase - elif index == 2: - letters = string.ascii_letters - elif index == len(options) - 1: - exit() - ``` - -8. Print the generated password: - - ```py - Console.write_line('Password: ', generate_password(letters, length)) - ``` - -9. The full 'sample-project/main.py': - - ```py - import random - import string - - from cpl_core.console import Console - - - def generate_password(letters: str, length: int) -> str: - return ''.join(random.choice(letters) for i in range(length)) - - - def main(): - Console.write_line('Password generator:') - options = [ - 'Only lower case', - 'Only upper case', - 'Lower and upper case', - 'Exit' - ] - option = Console.select('>', 'Select option: ', options) - - length = int(Console.read('Length: ')) - - index = options.index(option) - letters = '' - if index == 0: - letters = string.ascii_lowercase - elif index == 1: - letters = string.ascii_uppercase - elif index == 2: - letters = string.ascii_letters - elif index == len(options) - 1: - exit() - - Console.write_line('Password: ', generate_password(letters, length)) - - - if __name__ == '__main__': - main() - - ``` - -## What's next - -In this section, you've created an application that uses user input to generate a password. - -To continue exploring CPL and developing applications: - -- [Application base](cpl_core.application) -- [Dependency injection](cpl_core.dependency_injection) -- [Console](cpl_core.console) - - -[pip-url]: https://pip.sh-edraft.de -[python]: https://www.python.org/ -[pip]: https://pypi.org/project/pip/ diff --git a/docs/source/setup.md b/docs/source/setup.md deleted file mode 100644 index 1a953c69..00000000 --- a/docs/source/setup.md +++ /dev/null @@ -1,113 +0,0 @@ -# Setting up the local environment and workspace - -## Table of Contents - -1. [Prerequisites](#prerequisites) -2. [Install the package](#install-the-package) -3. [Install the CLI](#install-the-cli) -3. [Install the query](#install-the-query) -4. [Create a initial application](#create-initial-console-app) -5. [Create a initial library](#create-initial-library) -6. [Start the application](#start-the-app) -7. [What's next](#whats-next) - -## Prerequisites - -To get most out of this tutorial you should already have a basic understanding of the following. - -- [Python][python] - -Also you need to have the following installed. - -- [Python][python] -- [Pip][pip-url] - -## Install the package - -To install the package, open a terminal window and run the following command: - -```sh -pip install cpl-core --extra-index-url https://pip.sh-edraft.de -``` - -## Install the CLI - -You use the CPL CLI to create projects, generate application and library code. You also use the CLI to build and publish your python packages. - -To install the CLI, open a terminal window and run the following command: - -```sh -pip install cpl-cli --extra-index-url https://pip.sh-edraft.de -``` - -## Install the query - -To install the package, open a terminal window and run the following command: - -```sh -pip install cpl-query --extra-index-url https://pip.sh-edraft.de -``` - -## Create initial console app - -You develop apps and packages in the context of an CPL project which is defined in an cpl_core.json. - -1. Run the CLI command ```cpl new console``` and provide the name my-app, as shown here: - - ```sh - cpl new console my-app - ``` - -2. The cpl new command prompts you for information about features to include in the initial app. Decline the defaults by enter 'n' and press the Enter key. - -The CLI create a new workspace and a simple 'Hello World' app, ready to run. - -## Create initial library - -You develop apps and packages in the context of an CPL project which is defined in an cpl_core.json. - -1. Run the CLI command ```cpl new library``` and provide the name my-lib, as shown here: - - ```sh - cpl new library my-lib - ``` - -2. The cpl new command prompts you for information about features to include in the initial library. Decline the defaults by enter 'n' and press the Enter key. - -The CLI create a new workspace and a simple 'Hello World' library with CLI, ready to run. - -## Start the app - -The CLI includes a live development server, so that you can run your app locally. - -1. Open a terminal window - -2. To navigate to your project workspace, run the following command: - - ```sh - cd /path/to/project/name - ``` - -3. To run the app run: - - ```sh - cpl start - ``` - -The ```cpl start``` command launches the server, watches your source files, and restarts the app as you make chnages to thoses source files. - -If your installation and setup was successful, you should see a output similar to the following: - -```sh -Hello World -``` - -## What's next - -- To learn more about the CPL CLI, see the [CLI Overview](cpl_cli.overview) -- Fore more informations about the Pyhton files generated by ```cpl new```, see [New Command](cpl_cli.new) - - -[pip-url]: https://pip.sh-edraft.de -[python]: https://www.python.org/ -[pip]: https://pypi.org/project/pip/ diff --git a/docs/source/tutorials.appsettings.md b/docs/source/tutorials.appsettings.md deleted file mode 100644 index 4eabffa2..00000000 --- a/docs/source/tutorials.appsettings.md +++ /dev/null @@ -1,3 +0,0 @@ -# Using appsettings.json - -## Coming soon \ No newline at end of file diff --git a/docs/source/tutorials.console-arguments.md b/docs/source/tutorials.console-arguments.md deleted file mode 100644 index 0a3b5a42..00000000 --- a/docs/source/tutorials.console-arguments.md +++ /dev/null @@ -1,3 +0,0 @@ -# Handle console arguments - -## Coming soon \ No newline at end of file diff --git a/docs/source/tutorials.console.md b/docs/source/tutorials.console.md deleted file mode 100644 index fcbaaba1..00000000 --- a/docs/source/tutorials.console.md +++ /dev/null @@ -1,3 +0,0 @@ -# Use cpl_core.console.Console - -## Coming soon \ No newline at end of file diff --git a/docs/source/tutorials.create-startup.md b/docs/source/tutorials.create-startup.md deleted file mode 100644 index 028d072c..00000000 --- a/docs/source/tutorials.create-startup.md +++ /dev/null @@ -1,3 +0,0 @@ -# Create startup class - -## Coming soon \ No newline at end of file diff --git a/docs/source/tutorials.extend-application.md b/docs/source/tutorials.extend-application.md deleted file mode 100644 index 1eec6e9e..00000000 --- a/docs/source/tutorials.extend-application.md +++ /dev/null @@ -1,3 +0,0 @@ -# Extend application - -## Coming soon \ No newline at end of file diff --git a/docs/source/tutorials.extend-startup.md b/docs/source/tutorials.extend-startup.md deleted file mode 100644 index 98b90da4..00000000 --- a/docs/source/tutorials.extend-startup.md +++ /dev/null @@ -1,3 +0,0 @@ -# Extend startup - -## Coming soon \ No newline at end of file diff --git a/docs/source/tutorials.logging.md b/docs/source/tutorials.logging.md deleted file mode 100644 index 660fbfe1..00000000 --- a/docs/source/tutorials.logging.md +++ /dev/null @@ -1,3 +0,0 @@ -# Use builtin logger - -## Coming soon \ No newline at end of file diff --git a/docs/source/tutorials.mail.md b/docs/source/tutorials.mail.md deleted file mode 100644 index 7b6c9150..00000000 --- a/docs/source/tutorials.mail.md +++ /dev/null @@ -1,3 +0,0 @@ -# Send mails - -## Coming soon \ No newline at end of file diff --git a/docs/source/tutorials.rst b/docs/source/tutorials.rst deleted file mode 100644 index b8fd6668..00000000 --- a/docs/source/tutorials.rst +++ /dev/null @@ -1,15 +0,0 @@ -Tutorials -============= - -.. toctree:: - :maxdepth: 4 - - tutorials.extend-application - tutorials.create-startup - tutorials.extend-startup - tutorials.appsettings - tutorials.console-arguments - tutorials.console - tutorials.logging - tutorials.mail - tutorials.templating \ No newline at end of file diff --git a/docs/source/tutorials.templating.md b/docs/source/tutorials.templating.md deleted file mode 100644 index 4530b17c..00000000 --- a/docs/source/tutorials.templating.md +++ /dev/null @@ -1,181 +0,0 @@ -# Using cpl g & cpl n templating - -## Contents - -- [Prerequisites](#prerequisites) -- [Generate schematics](#cpl-generate-scmatics) -- [Project types](#cpl-new-project-types) - -## Prerequisites - -Create a folder called ```.cpl``` - -## cpl generate schematics - -Create a file which begins with ```schematic_your_schematic.py```. -A schematic template is detected by starting with ```schematic_``` and endswith ```.py```. - -You should replace ```your_schematic``` with an appropriate name of your schematic. For example, we will choose ```Enum```. -Attention: It is important that you do not overwrite templates by creating a file or class with the same name. - -In the template create a class with the name of your schematic. For example: - -```python -from cpl_cli.abc.generate_schematic_abc import GenerateSchematicABC - - -class Enum(GenerateSchematicABC): - - def __init__(self, *args: str): - GenerateSchematicABC.__init__(self, *args) - - def get_code(self) -> str: - import textwrap - code = textwrap.dedent("""\ - from enum import Enum - - - class $Name(Enum): - - atr = 0 - """) - return self.build_code_str(code, Name=self._class_name) - - @classmethod - def register(cls): - GenerateSchematicABC.register( - cls, - 'enum', - ['e', 'E'] - ) - -``` - -You can test it by calling ```cpl g --help``` your schematic should be listed as available. - -## cpl new project types - -The project templating is a little more complex and is therefore divided into several files. -First of all, for information, it is very important not to overwrite any existing files or classes! - -Template structure explained by the example of the internal type ```console```: - -``` -- project_console.py -- project_file_license.py -- project_file_appsettings.py -- project_file.py -- project_file_readme.py -- project_file_code_main.py -- project_file_code_startup.py -- project_file_code_application.py -``` - -Here the template ```project_console.py``` defines how a console project has to look like when it is generated. Here is the code to illustrate this: - -```python -from cpl_cli.abc.project_type_abc import ProjectTypeABC -from cpl_cli.configuration import WorkspaceSettings -from cpl_core.utils import String - - -class Console(ProjectTypeABC): - - def __init__( - self, - base_path: str, - project_name: str, - workspace: WorkspaceSettings, - use_application_api: bool, - use_startup: bool, - use_service_providing: bool, - use_async: bool, - project_file_data: dict, - ): - from project_file import ProjectFile - from project_file_appsettings import ProjectFileAppsettings - from project_file_code_application import ProjectFileApplication - from project_file_code_main import ProjectFileMain - from project_file_code_startup import ProjectFileStartup - from project_file_readme import ProjectFileReadme - from project_file_license import ProjectFileLicense - from schematic_init import Init - - ProjectTypeABC.__init__(self, base_path, project_name, workspace, use_application_api, use_startup, use_service_providing, use_async, project_file_data) - - project_path = f'{base_path}{String.convert_to_snake_case(project_name.split("/")[-1])}/' - - self.add_template(ProjectFile(project_name.split('/')[-1], project_path, project_file_data)) - if workspace is None: - self.add_template(ProjectFileLicense('')) - self.add_template(ProjectFileReadme('')) - self.add_template(Init('', 'init', f'{base_path}tests/')) - - self.add_template(Init('', 'init', project_path)) - self.add_template(ProjectFileAppsettings(project_path)) - - if use_application_api: - self.add_template(ProjectFileApplication(project_path, use_application_api, use_startup, use_service_providing, use_async)) - - if use_startup: - self.add_template(ProjectFileStartup(project_path, use_application_api, use_startup, use_service_providing, use_async)) - - self.add_template(ProjectFileMain(project_name.split('/')[-1], project_path, use_application_api, use_startup, use_service_providing, use_async)) -``` - -The class must be named exactly as the project type should be named. It is also checked on the initial letter of the class as alias. -Now create a class for normal files which inherits from ```FileTemplateABC``` and a class for code files which inherits from ```CodeFileTemplateABC```. - -For example: - -project_file_code_startup.py: -```python -from cpl_cli.abc.code_file_template_abc import CodeFileTemplateABC - - -class ProjectFileStartup(CodeFileTemplateABC): - - def __init__(self, path: str, use_application_api: bool, use_startup: bool, use_service_providing: bool, use_async: bool): - CodeFileTemplateABC.__init__(self, 'startup', path, '', use_application_api, use_startup, use_service_providing, use_async) - - def get_code(self) -> str: - import textwrap - - return textwrap.dedent("""\ - from cpl_core.application import StartupABC - from cpl_core.configuration import ConfigurationABC - from cpl_core.dependency_injection import ServiceProviderABC, ServiceCollectionABC - from cpl_core.environment import ApplicationEnvironment - - - class Startup(StartupABC): - - def __init__(self): - StartupABC.__init__(self) - - def configure_configuration(self, configuration: ConfigurationABC, environment: ApplicationEnvironment) -> ConfigurationABC: - return configuration - - def configure_services(self, services: ServiceCollectionABC, environment: ApplicationEnvironment) -> ServiceProviderABC: - return services.build_service_provider() - """) -``` - -project_file.py: - -```python -import json - -from cpl_cli.abc.file_template_abc import FileTemplateABC - - -class ProjectFile(FileTemplateABC): - - def __init__(self, name: str, path: str, code: dict): - FileTemplateABC.__init__(self, '', path, '{}') - self._name = f'{name}.json' - self._code = code - - def get_code(self) -> str: - return json.dumps(self._code, indent=2) -``` diff --git a/tools/set_pip_urls/__init__.py b/tools/set_pip_urls/__init__.py deleted file mode 100644 index 5c7b277e..00000000 --- a/tools/set_pip_urls/__init__.py +++ /dev/null @@ -1,26 +0,0 @@ -# -*- coding: utf-8 -*- - -""" -set-pip-urls CPL internal tool to set pip URL for CLI by environment -~~~~~~~~~~~~~~~~~~~ - -CPL internal tool to set pip URL for CLI by environment - -:copyright: (c) 2022 sh-edraft.de -:license: MIT, see LICENSE for more details. - -""" - -__title__ = "set_pip_urls" -__author__ = "Sven Heidemann" -__license__ = "MIT" -__copyright__ = "Copyright (c) 2022 sh-edraft.de" -__version__ = "2022.12.0" - -from collections import namedtuple - - -# imports: - -VersionInfo = namedtuple("VersionInfo", "major minor micro") -version_info = VersionInfo(major="2022", minor="12", micro="0") diff --git a/tools/set_pip_urls/application.py b/tools/set_pip_urls/application.py deleted file mode 100644 index 5165965f..00000000 --- a/tools/set_pip_urls/application.py +++ /dev/null @@ -1,45 +0,0 @@ -import json -import os -import sys -from typing import Optional - -from cpl_core.environment import EnvironmentNameEnum - -from cpl_core.application import ApplicationABC -from cpl_core.configuration import ConfigurationABC -from cpl_core.console import Console -from cpl_core.dependency_injection import ServiceProviderABC -from set_pip_urls.pip_settings import PIPSettings - - -class Application(ApplicationABC): - def __init__(self, config: ConfigurationABC, services: ServiceProviderABC): - ApplicationABC.__init__(self, config, services) - - self._pip_settings: Optional[PIPSettings] = config.get_configuration(PIPSettings) - - def configure(self): - self._configuration.parse_console_arguments(self._services) - - def main(self): - if self._pip_settings is None: - Console.error("appsettings.json not found") - sys.exit() - - url = None - match self._environment.environment_name: - case EnvironmentNameEnum.production.value: - url = self._pip_settings.production - case EnvironmentNameEnum.staging.value: - url = self._pip_settings.staging - case EnvironmentNameEnum.development.value: - url = self._pip_settings.development - - cli_json = {"CLI": {"PipPath": url}} - file = os.path.abspath( - os.path.join(self._environment.working_directory, "../../src/cpl_cli", "appsettings.json") - ) - Console.write_line(f"Writing PipPath: {url} to {file}") - with open(file, "w") as f: - f.write(json.dumps(cli_json, indent=2)) - f.close() diff --git a/tools/set_pip_urls/appsettings.json b/tools/set_pip_urls/appsettings.json deleted file mode 100644 index 25b04f41..00000000 --- a/tools/set_pip_urls/appsettings.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "PIPSettings": { - "production": "https://pip.sh-edraft.de", - "staging": "https://pip-exp.sh-edraft.de", - "development": "https://pip-dev.sh-edraft.de" - } -} diff --git a/tools/set_pip_urls/main.py b/tools/set_pip_urls/main.py deleted file mode 100644 index 15fb7659..00000000 --- a/tools/set_pip_urls/main.py +++ /dev/null @@ -1,14 +0,0 @@ -from cpl_core.application import ApplicationBuilder - -from set_pip_urls.application import Application -from set_pip_urls.startup import Startup - - -def main(): - app_builder = ApplicationBuilder(Application) - app_builder.use_startup(Startup) - app_builder.build().run() - - -if __name__ == "__main__": - main() diff --git a/tools/set_pip_urls/pip_settings.py b/tools/set_pip_urls/pip_settings.py deleted file mode 100644 index 233abc4d..00000000 --- a/tools/set_pip_urls/pip_settings.py +++ /dev/null @@ -1,22 +0,0 @@ -from cpl_core.configuration.configuration_model_abc import ConfigurationModelABC - - -class PIPSettings(ConfigurationModelABC): - def __init__(self, production: str = None, staging: str = None, development: str = None): - ConfigurationModelABC.__init__(self) - - self._production = production - self._staging = staging - self._development = development - - @property - def production(self): - return self._production - - @property - def staging(self): - return self._staging - - @property - def development(self): - return self._development diff --git a/tools/set_pip_urls/set-pip-urls.json b/tools/set_pip_urls/set-pip-urls.json deleted file mode 100644 index 348e4aa5..00000000 --- a/tools/set_pip_urls/set-pip-urls.json +++ /dev/null @@ -1,42 +0,0 @@ -{ - "ProjectSettings": { - "Name": "set-pip-urls", - "Version": { - "Major": "2024", - "Minor": "7", - "Micro": "0" - }, - "Author": "Sven Heidemann", - "AuthorEmail": "sven.heidemann@sh-edraft.de", - "Description": "CPL internal tool to set pip URL for CLI by environment", - "LongDescription": "CPL internal tool to set pip URL for CLI by environment", - "URL": "https://www.sh-edraft.de", - "CopyrightDate": "2022", - "CopyrightName": "sh-edraft.de", - "LicenseName": "MIT", - "LicenseDescription": "MIT, see LICENSE for more details.", - "Dependencies": [ - "cpl-core==2022.12.0" - ], - "PythonVersion": ">=3.10.4", - "PythonPath": {}, - "Classifiers": [], - "DevDependencies": [] - }, - "BuildSettings": { - "ProjectType": "console", - "SourcePath": "", - "OutputPath": "../../dist", - "Main": "set_pip_url.main", - "EntryPoint": "set-pip-url", - "IncludePackageData": false, - "Included": [], - "Excluded": [ - "*/__pycache__", - "*/logs", - "*/tests" - ], - "PackageData": {}, - "ProjectReferences": [] - } -} \ No newline at end of file diff --git a/tools/set_pip_urls/startup.py b/tools/set_pip_urls/startup.py deleted file mode 100644 index 470e8dab..00000000 --- a/tools/set_pip_urls/startup.py +++ /dev/null @@ -1,21 +0,0 @@ -from cpl_core.application import StartupABC -from cpl_core.configuration import ConfigurationABC -from cpl_core.dependency_injection import ServiceProviderABC, ServiceCollectionABC -from cpl_core.environment import ApplicationEnvironment - - -class Startup(StartupABC): - def __init__(self): - StartupABC.__init__(self) - - def configure_configuration( - self, configuration: ConfigurationABC, environment: ApplicationEnvironment - ) -> ConfigurationABC: - configuration.add_environment_variables("CPL_") - configuration.add_json_file("appsettings.json", optional=False, output=False) - return configuration - - def configure_services( - self, services: ServiceCollectionABC, environment: ApplicationEnvironment - ) -> ServiceProviderABC: - return services.build_service_provider() diff --git a/tools/set_version/__init__.py b/tools/set_version/__init__.py deleted file mode 100644 index 81e446bc..00000000 --- a/tools/set_version/__init__.py +++ /dev/null @@ -1,26 +0,0 @@ -# -*- coding: utf-8 -*- - -""" -set-version CPL internal tool to set version from branch name -~~~~~~~~~~~~~~~~~~~ - -CPL internal tool to set version from branch name - -:copyright: (c) 2022 sh-edraft.de -:license: MIT, see LICENSE for more details. - -""" - -__title__ = "set_version" -__author__ = "Sven Heidemann" -__license__ = "MIT" -__copyright__ = "Copyright (c) 2022 sh-edraft.de" -__version__ = "2022.12.0" - -from collections import namedtuple - - -# imports: - -VersionInfo = namedtuple("VersionInfo", "major minor micro") -version_info = VersionInfo(major="2022", minor="12", micro="0") diff --git a/tools/set_version/application.py b/tools/set_version/application.py deleted file mode 100644 index 91bab130..00000000 --- a/tools/set_version/application.py +++ /dev/null @@ -1,124 +0,0 @@ -import os -import traceback - -from cpl_cli.configuration import ProjectSettings -from cpl_core.utils import String - -from cpl_cli.configuration.version_settings_name_enum import VersionSettingsNameEnum -from cpl_cli.configuration.workspace_settings import WorkspaceSettings -from cpl_core.application.application_abc import ApplicationABC -from cpl_core.configuration.configuration_abc import ConfigurationABC -from cpl_core.console.console import Console -from cpl_core.dependency_injection.service_provider_abc import ServiceProviderABC -from cpl_core.pipes.version_pipe import VersionPipe -from set_version.git_service import GitService -from set_version.version_setter_service import VersionSetterService - - -class Application(ApplicationABC): - def __init__(self, config: ConfigurationABC, services: ServiceProviderABC): - ApplicationABC.__init__(self, config, services) - - self._workspace: WorkspaceSettings = config.get_configuration(WorkspaceSettings) - - self._git_service: GitService = self._services.get_service(GitService) - self._version_setter: VersionSetterService = self._services.get_service(VersionSetterService) - self._version_pipe: VersionPipe = self._services.get_service(VersionPipe) - - def configure(self): - self._configuration.parse_console_arguments(self._services) - - def main(self): - Console.write_line("Set versions:") - - args = self._configuration.additional_arguments - version = {} - branch = "" - suffix = "" - force = False - if "--force" in args: - args.remove("--force") - force = True - - if len(args) > 1: - Console.error(f'Unexpected argument(s): {", ".join(args[1:])}') - return - - if len(args) == 1: - suffix = args[0] - - try: - branch = self._git_service.get_active_branch_name() - Console.write_line(f"Found branch: {branch}") - except Exception as e: - Console.error("Branch not found", traceback.format_exc()) - return - - try: - if suffix != "": - self._configuration.add_json_file( - self._workspace.projects[self._workspace.default_project], optional=False, output=False - ) - ps: ProjectSettings = self._configuration.get_configuration(ProjectSettings) - - version[VersionSettingsNameEnum.major.value] = ps.version.major - version[VersionSettingsNameEnum.minor.value] = ps.version.minor - version[VersionSettingsNameEnum.micro.value] = suffix - elif branch.startswith("#"): - self._configuration.add_json_file( - self._workspace.projects[self._workspace.default_project], optional=False, output=False - ) - ps: ProjectSettings = self._configuration.get_configuration(ProjectSettings) - - version[VersionSettingsNameEnum.major.value] = ps.version.major - version[VersionSettingsNameEnum.minor.value] = ps.version.minor - version[VersionSettingsNameEnum.micro.value] = f'dev{branch.split("#")[1]}' - else: - version[VersionSettingsNameEnum.major.value] = branch.split(".")[0] - version[VersionSettingsNameEnum.minor.value] = branch.split(".")[1] - if len(branch.split(".")) == 2: - if suffix == "": - suffix = "0" - version[VersionSettingsNameEnum.micro.value] = f"{suffix}" - else: - version[VersionSettingsNameEnum.micro.value] = f'{branch.split(".")[2]}{suffix}' - except Exception as e: - Console.error(f"Branch {branch} does not contain valid version") - return - - diff_paths = [] - for file in self._git_service.get_diff_files(): - if file.startswith("tools"): - continue - - if "/" in file: - file = file.split("/")[1] - else: - file = os.path.basename(os.path.dirname(file)) - - if file in diff_paths: - continue - - diff_paths.append(file) - - try: - skipped = [] - for project in self._workspace.projects: - if project not in diff_paths and String.convert_to_snake_case(project) not in diff_paths and not force: - # Console.write_line(f'Skipping {project} due to missing changes') - skipped.append(project) - continue - - Console.write_line(f"Set dependencies {self._version_pipe.transform(version)} for {project}") - self._version_setter.set_dependencies( - self._workspace.projects[project], version, "Dependencies", skipped=skipped - ) - self._version_setter.set_dependencies( - self._workspace.projects[project], version, "DevDependencies", skipped=skipped - ) - - Console.write_line(f"Set version {self._version_pipe.transform(version)} for {project}") - self._version_setter.set_version(self._workspace.projects[project], version) - except Exception as e: - Console.error("Version could not be set", traceback.format_exc()) - return diff --git a/tools/set_version/git_service.py b/tools/set_version/git_service.py deleted file mode 100644 index 3e942914..00000000 --- a/tools/set_version/git_service.py +++ /dev/null @@ -1,17 +0,0 @@ -import os - -from cpl_core.environment import ApplicationEnvironmentABC -from git import Repo - - -class GitService: - def __init__(self, env: ApplicationEnvironmentABC): - self._env = env - self._repo = Repo(env.working_directory) - - def get_active_branch_name(self) -> str: - branch = self._repo.active_branch - return branch.name - - def get_diff_files(self) -> list[str]: - return [item.a_path for item in self._repo.index.diff(None)] diff --git a/tools/set_version/main.py b/tools/set_version/main.py deleted file mode 100644 index dfbecfda..00000000 --- a/tools/set_version/main.py +++ /dev/null @@ -1,14 +0,0 @@ -from cpl_core.application import ApplicationBuilder - -from set_version.application import Application -from set_version.startup import Startup - - -def main(): - app_builder = ApplicationBuilder(Application) - app_builder.use_startup(Startup) - app_builder.build().run() - - -if __name__ == "__main__": - main() diff --git a/tools/set_version/set-version.json b/tools/set_version/set-version.json deleted file mode 100644 index 91e57f59..00000000 --- a/tools/set_version/set-version.json +++ /dev/null @@ -1,43 +0,0 @@ -{ - "ProjectSettings": { - "Name": "set-version", - "Version": { - "Major": "2024", - "Minor": "7", - "Micro": "0" - }, - "Author": "Sven Heidemann", - "AuthorEmail": "sven.heidemann@sh-edraft.de", - "Description": "CPL internal tool to set version from branch name", - "LongDescription": "CPL internal tool to set version from branch name", - "URL": "https://www.sh-edraft.de", - "CopyrightDate": "2022", - "CopyrightName": "sh-edraft.de", - "LicenseName": "MIT", - "LicenseDescription": "MIT, see LICENSE for more details.", - "Dependencies": [ - "cpl-core>=2024.6.2024.07.0", - "GitPython>=3.1.29" - ], - "DevDependencies": [], - "PythonVersion": ">=3.10.4", - "PythonPath": {}, - "Classifiers": [] - }, - "BuildSettings": { - "ProjectType": "console", - "SourcePath": "", - "OutputPath": "../../dist", - "Main": "set_version.main", - "EntryPoint": "set-version", - "IncludePackageData": false, - "Included": [], - "Excluded": [ - "*/__pycache__", - "*/logs", - "*/tests" - ], - "PackageData": {}, - "ProjectReferences": [] - } -} \ No newline at end of file diff --git a/tools/set_version/startup.py b/tools/set_version/startup.py deleted file mode 100644 index ce7fb47f..00000000 --- a/tools/set_version/startup.py +++ /dev/null @@ -1,34 +0,0 @@ -import os - -from cpl_cli.configuration import WorkspaceSettings -from cpl_core.application import StartupABC -from cpl_core.configuration import ConfigurationABC -from cpl_core.dependency_injection import ServiceProviderABC, ServiceCollectionABC -from cpl_core.environment import ApplicationEnvironment -from cpl_core.pipes.version_pipe import VersionPipe -from set_version.git_service import GitService -from set_version.version_setter_service import VersionSetterService - - -class Startup(StartupABC): - def __init__(self): - StartupABC.__init__(self) - - def configure_configuration( - self, configuration: ConfigurationABC, environment: ApplicationEnvironment - ) -> ConfigurationABC: - configuration.add_json_file("cpl-workspace.json", optional=True, output=False) - if configuration.get_configuration(WorkspaceSettings) is None: - environment.set_working_directory(os.path.join(environment.working_directory, "../../")) - configuration.add_json_file("cpl-workspace.json", optional=False, output=False) - - return configuration - - def configure_services( - self, services: ServiceCollectionABC, environment: ApplicationEnvironment - ) -> ServiceProviderABC: - services.add_pipes() - services.add_singleton(GitService) - services.add_transient(VersionSetterService) - - return services.build_service_provider() diff --git a/tools/set_version/version_setter_service.py b/tools/set_version/version_setter_service.py deleted file mode 100644 index e1dfcf8a..00000000 --- a/tools/set_version/version_setter_service.py +++ /dev/null @@ -1,62 +0,0 @@ -import json -import os -from string import ascii_letters - -from cpl_core.environment import ApplicationEnvironmentABC -from cpl_core.utils import String - - -class VersionSetterService: - def __init__(self, env: ApplicationEnvironmentABC): - self._env = env - - def _read_file(self, file: str) -> dict: - project_json = {} - with open(os.path.join(self._env.working_directory, file), "r", encoding="utf-8") as f: - # load json - project_json = json.load(f) - f.close() - - return project_json - - def _write_file(self, file: str, project_json: dict): - with open(os.path.join(self._env.working_directory, file), "w", encoding="utf-8") as f: - f.write(json.dumps(project_json, indent=2)) - f.close() - - def set_version(self, file: str, version: dict): - project_json = self._read_file(file) - project_json["ProjectSettings"]["Version"] = version - self._write_file(file, project_json) - - def set_dependencies(self, file: str, version: dict, key: str, skipped=None): - project_json = self._read_file(file) - if key not in project_json["ProjectSettings"]: - project_json["ProjectSettings"][key] = [] - - dependencies = project_json["ProjectSettings"][key] - new_deps = [] - for dependency in dependencies: - if not dependency.startswith("cpl-"): - new_deps.append(dependency) - continue - - dep_version = dependency.split("=")[1] - dep_name = dependency.split("=")[0] - if dep_name[len(dep_name) - 1] not in ascii_letters: - dep_name = dep_name[: len(dep_name) - 1] - - if ( - skipped is not None - and (dep_name in skipped or String.convert_to_snake_case(dep_name) in skipped) - or dep_version == "" - ): - new_deps.append(dependency) - continue - - new_deps.append( - dependency.replace(dep_version, f'{version["Major"]}.{version["Minor"]}.{version["Micro"]}') - ) - - project_json["ProjectSettings"][key] = new_deps - self._write_file(file, project_json)