diff --git a/README.md b/README.md
index 103a87b2..a6515be0 100644
--- a/README.md
+++ b/README.md
@@ -87,17 +87,17 @@
Install the CPL package
```sh
-pip install sh_cpl --extra-index-url https://pip.sh-edraft.de
+pip install cpl --extra-index-url https://pip.sh-edraft.de
```
Install the CPL CLI
```sh
-pip install sh_cpl-cli --extra-index-url https://pip.sh-edraft.de
+pip install cpl-cli --extra-index-url https://pip.sh-edraft.de
```
Create workspace:
```sh
-cpl new
+cpl new
```
Run the application:
@@ -110,7 +110,7 @@ cpl start
## Roadmap
-See the [open issues](https://git.sh-edraft.de/sh-edraft.de/sh_common_py_lib/issues) for a list of proposed features (and known issues).
+See the [open issues](https://git.sh-edraft.de/sh-edraft.de/sh_cpl/issues) for a list of proposed features (and known issues).
@@ -139,7 +139,7 @@ Distributed under the MIT License. See [LICENSE] for more information.
Sven Heidemann - sven.heidemann@sh-edraft.de
-Project link: [https://git.sh-edraft.de/sh-edraft.de/sh_common_py_lib](https://git.sh-edraft.de/sh-edraft.de/sh_common_py_lib)
+Project link: [https://git.sh-edraft.de/sh-edraft.de/sh_common_py_lib](https://git.sh-edraft.de/sh-edraft.de/sh_cpl)
[pip_url]: https://pip.sh-edraft.de
@@ -147,7 +147,7 @@ Project link: [https://git.sh-edraft.de/sh-edraft.de/sh_common_py_lib](https://g
[pip]: https://pypi.org/project/pip/
-[project]: https://git.sh-edraft.de/sh-edraft.de/sh_common_py_lib
-[quickstart]: https://git.sh-edraft.de/sh-edraft.de/sh_common_py_lib/wiki/quickstart
-[contributing]: https://git.sh-edraft.de/sh-edraft.de/sh_common_py_lib/wiki/contributing
+[project]: https://git.sh-edraft.de/sh-edraft.de/sh_cpl
+[quickstart]: https://git.sh-edraft.de/sh-edraft.de/sh_cpl/wiki/quickstart
+[contributing]: https://git.sh-edraft.de/sh-edraft.de/sh_cpl/wiki/contributing
[license]: LICENSE
diff --git a/cpl-workspace.json b/cpl-workspace.json
index d07c8cae..3c5d5f67 100644
--- a/cpl-workspace.json
+++ b/cpl-workspace.json
@@ -20,12 +20,16 @@
"hello-world": "echo 'Hello World'",
"sv": "cpl set-version",
- "set-version": "cpl run set-version $ARGS; echo '';",
+ "set-version": "cpl run set-version --dev $ARGS; echo '';",
"spu": "cpl set-pip-urls",
- "set-pip-urls": "cpl run set-pip-urls $ARGS; echo '';",
+ "set-pip-urls": "cpl run set-pip-urls --dev $ARGS; echo '';",
- "docs-build": "echo 'Build Documentation'; cd docs/; sphinx-apidoc -o source/ ../src/cpl_core; sphinx-apidoc -o source/ ../src/cpl_query; make clean; make html; rm source/cpl_query.tests.rst;",
+ "docs-build": "echo 'Build Documentation'; cpl db-core; cpl db-discord; cpl db-query; cpl db-translation; cd docs/; make clean; make html; # rm source/cpl_query.tests.rst;",
+ "db-core": "cd docs/; sphinx-apidoc -o source/ ../src/cpl_core; cd ../",
+ "db-discord": "cd docs/; sphinx-apidoc -o source/ ../src/cpl_discord; cd ../",
+ "db-query": "cd docs/; sphinx-apidoc -o source/ ../src/cpl_query; cd ../",
+ "db-translation": "cd docs/; sphinx-apidoc -o source/ ../src/cpl_translation; cd ../",
"db": "cpl docs-build",
"docs-open": "xdg-open $PWD/docs/build/html/index.html &",
@@ -46,7 +50,7 @@
"pre-publish-all": "cpl sv $ARGS; cpl spu $ARGS;",
"publish-all": "cpl publish-cli; cpl publish-core; cpl publish-discord; cpl publish-query; cpl publish-translation;",
- "pa": "cpl build-all $ARGS",
+ "pa": "cpl publish-all $ARGS",
"publish-cli": "echo 'Publish cpl-cli'; cd ./src/cpl_cli; cpl publish; cd ../../;",
"publish-core": "echo 'Publish cpl-core'; cd ./src/cpl_core; cpl publish; cd ../../;",
"publish-discord": "echo 'Publish cpl-discord'; cd ./src/cpl_discord; cpl publish; cd ../../;",
@@ -131,7 +135,15 @@
"di-cli": "pip install cpl-cli --pre --upgrade --extra-index-url https://pip-dev.sh-edraft.de",
"di-discord": "pip install cpl-discord --pre --upgrade --extra-index-url https://pip-dev.sh-edraft.de",
"di-query": "pip install cpl-query --pre --upgrade --extra-index-url https://pip-dev.sh-edraft.de",
- "di-translation": "pip install cpl-translation --pre --upgrade --extra-index-url https://pip-dev.sh-edraft.de"
+ "di-translation": "pip install cpl-translation --pre --upgrade --extra-index-url https://pip-dev.sh-edraft.de",
+
+ "prod-install": "cpl pi-core; cpl pi-cli; cpl pi-query; cpl pi-translation;",
+ "pi": "cpl prod-install",
+ "pi-core": "pip install cpl-core --pre --upgrade --extra-index-url https://pip.sh-edraft.de",
+ "pi-cli": "pip install cpl-cli --pre --upgrade --extra-index-url https://pip.sh-edraft.de",
+ "pi-discord": "pip install cpl-discord --pre --upgrade --extra-index-url https://pip.sh-edraft.de",
+ "pi-query": "pip install cpl-query --pre --upgrade --extra-index-url https://pip.sh-edraft.de",
+ "pi-translation": "pip install cpl-translation --pre --upgrade --extra-index-url https://pip.sh-edraft.de"
}
}
}
\ No newline at end of file
diff --git a/docs/build/doctrees/cli.generate.doctree b/docs/build/doctrees/cli.generate.doctree
index 8148d500..f088d0e2 100644
Binary files a/docs/build/doctrees/cli.generate.doctree and b/docs/build/doctrees/cli.generate.doctree differ
diff --git a/docs/build/doctrees/cli.new.doctree b/docs/build/doctrees/cli.new.doctree
index 9dbd6b98..3dcb9191 100644
Binary files a/docs/build/doctrees/cli.new.doctree and b/docs/build/doctrees/cli.new.doctree differ
diff --git a/docs/build/doctrees/cli.run.doctree b/docs/build/doctrees/cli.run.doctree
new file mode 100644
index 00000000..c1463960
Binary files /dev/null and b/docs/build/doctrees/cli.run.doctree differ
diff --git a/docs/build/doctrees/cli.start.doctree b/docs/build/doctrees/cli.start.doctree
index 85ccbbd0..1bde7025 100644
Binary files a/docs/build/doctrees/cli.start.doctree and b/docs/build/doctrees/cli.start.doctree differ
diff --git a/docs/build/doctrees/contributing.doctree b/docs/build/doctrees/contributing.doctree
index cf8b7e31..6f477c0f 100644
Binary files a/docs/build/doctrees/contributing.doctree and b/docs/build/doctrees/contributing.doctree differ
diff --git a/docs/build/doctrees/cpl_cli.doctree b/docs/build/doctrees/cpl_cli.doctree
index 3aff0849..46b5c415 100644
Binary files a/docs/build/doctrees/cpl_cli.doctree and b/docs/build/doctrees/cpl_cli.doctree differ
diff --git a/docs/build/doctrees/cpl_core.application.doctree b/docs/build/doctrees/cpl_core.application.doctree
index 22d735ef..bdf49dba 100644
Binary files a/docs/build/doctrees/cpl_core.application.doctree and b/docs/build/doctrees/cpl_core.application.doctree differ
diff --git a/docs/build/doctrees/cpl_core.configuration.doctree b/docs/build/doctrees/cpl_core.configuration.doctree
index ef32c21d..d725a0f3 100644
Binary files a/docs/build/doctrees/cpl_core.configuration.doctree and b/docs/build/doctrees/cpl_core.configuration.doctree differ
diff --git a/docs/build/doctrees/cpl_core.database.doctree b/docs/build/doctrees/cpl_core.database.doctree
index a8966e31..208ae505 100644
Binary files a/docs/build/doctrees/cpl_core.database.doctree and b/docs/build/doctrees/cpl_core.database.doctree differ
diff --git a/docs/build/doctrees/cpl_core.doctree b/docs/build/doctrees/cpl_core.doctree
index 367a1667..39eb74a8 100644
Binary files a/docs/build/doctrees/cpl_core.doctree and b/docs/build/doctrees/cpl_core.doctree differ
diff --git a/docs/build/doctrees/cpl_core.pipes.doctree b/docs/build/doctrees/cpl_core.pipes.doctree
index 0fbc26ff..c19a94da 100644
Binary files a/docs/build/doctrees/cpl_core.pipes.doctree and b/docs/build/doctrees/cpl_core.pipes.doctree differ
diff --git a/docs/build/doctrees/cpl_discord.application.doctree b/docs/build/doctrees/cpl_discord.application.doctree
new file mode 100644
index 00000000..64d0f8cc
Binary files /dev/null and b/docs/build/doctrees/cpl_discord.application.doctree differ
diff --git a/docs/build/doctrees/cpl_discord.command.doctree b/docs/build/doctrees/cpl_discord.command.doctree
new file mode 100644
index 00000000..d0fe4f61
Binary files /dev/null and b/docs/build/doctrees/cpl_discord.command.doctree differ
diff --git a/docs/build/doctrees/cpl_discord.configuration.doctree b/docs/build/doctrees/cpl_discord.configuration.doctree
new file mode 100644
index 00000000..0e397e29
Binary files /dev/null and b/docs/build/doctrees/cpl_discord.configuration.doctree differ
diff --git a/docs/build/doctrees/cpl_discord.container.doctree b/docs/build/doctrees/cpl_discord.container.doctree
new file mode 100644
index 00000000..a3f5ee12
Binary files /dev/null and b/docs/build/doctrees/cpl_discord.container.doctree differ
diff --git a/docs/build/doctrees/cpl_discord.doctree b/docs/build/doctrees/cpl_discord.doctree
new file mode 100644
index 00000000..a373b278
Binary files /dev/null and b/docs/build/doctrees/cpl_discord.doctree differ
diff --git a/docs/build/doctrees/cpl_discord.events.doctree b/docs/build/doctrees/cpl_discord.events.doctree
new file mode 100644
index 00000000..a0615548
Binary files /dev/null and b/docs/build/doctrees/cpl_discord.events.doctree differ
diff --git a/docs/build/doctrees/cpl_discord.helper.doctree b/docs/build/doctrees/cpl_discord.helper.doctree
new file mode 100644
index 00000000..e661717e
Binary files /dev/null and b/docs/build/doctrees/cpl_discord.helper.doctree differ
diff --git a/docs/build/doctrees/cpl_discord.service.doctree b/docs/build/doctrees/cpl_discord.service.doctree
new file mode 100644
index 00000000..8e13fbf2
Binary files /dev/null and b/docs/build/doctrees/cpl_discord.service.doctree differ
diff --git a/docs/build/doctrees/cpl_query.base.doctree b/docs/build/doctrees/cpl_query.base.doctree
new file mode 100644
index 00000000..2d7ab57a
Binary files /dev/null and b/docs/build/doctrees/cpl_query.base.doctree differ
diff --git a/docs/build/doctrees/cpl_query.doctree b/docs/build/doctrees/cpl_query.doctree
index a505b701..3f98dae1 100644
Binary files a/docs/build/doctrees/cpl_query.doctree and b/docs/build/doctrees/cpl_query.doctree differ
diff --git a/docs/build/doctrees/cpl_query.enumerable.doctree b/docs/build/doctrees/cpl_query.enumerable.doctree
new file mode 100644
index 00000000..4af22b0d
Binary files /dev/null and b/docs/build/doctrees/cpl_query.enumerable.doctree differ
diff --git a/docs/build/doctrees/cpl_query.exceptions.doctree b/docs/build/doctrees/cpl_query.exceptions.doctree
deleted file mode 100644
index cc1ecc2c..00000000
Binary files a/docs/build/doctrees/cpl_query.exceptions.doctree and /dev/null differ
diff --git a/docs/build/doctrees/cpl_query.extension.doctree b/docs/build/doctrees/cpl_query.extension.doctree
index 64add856..6e010bdc 100644
Binary files a/docs/build/doctrees/cpl_query.extension.doctree and b/docs/build/doctrees/cpl_query.extension.doctree differ
diff --git a/docs/build/doctrees/cpl_query.iterable.doctree b/docs/build/doctrees/cpl_query.iterable.doctree
new file mode 100644
index 00000000..56087112
Binary files /dev/null and b/docs/build/doctrees/cpl_query.iterable.doctree differ
diff --git a/docs/build/doctrees/cpl_translation.doctree b/docs/build/doctrees/cpl_translation.doctree
new file mode 100644
index 00000000..c70dfd3f
Binary files /dev/null and b/docs/build/doctrees/cpl_translation.doctree differ
diff --git a/docs/build/doctrees/environment.pickle b/docs/build/doctrees/environment.pickle
index 4d5ef1f3..1130483c 100644
Binary files a/docs/build/doctrees/environment.pickle and b/docs/build/doctrees/environment.pickle differ
diff --git a/docs/build/doctrees/index.doctree b/docs/build/doctrees/index.doctree
index 0286932c..60583e3c 100644
Binary files a/docs/build/doctrees/index.doctree and b/docs/build/doctrees/index.doctree differ
diff --git a/docs/build/doctrees/modules.doctree b/docs/build/doctrees/modules.doctree
index e436a9a8..ceb86bd7 100644
Binary files a/docs/build/doctrees/modules.doctree and b/docs/build/doctrees/modules.doctree differ
diff --git a/docs/build/doctrees/setup.doctree b/docs/build/doctrees/setup.doctree
index ae9229c2..68420c76 100644
Binary files a/docs/build/doctrees/setup.doctree and b/docs/build/doctrees/setup.doctree differ
diff --git a/docs/build/doctrees/tutorials.appsettings.doctree b/docs/build/doctrees/tutorials.appsettings.doctree
index 9d84d36d..6d64d631 100644
Binary files a/docs/build/doctrees/tutorials.appsettings.doctree and b/docs/build/doctrees/tutorials.appsettings.doctree differ
diff --git a/docs/build/doctrees/tutorials.console-arguments.doctree b/docs/build/doctrees/tutorials.console-arguments.doctree
index 81a2d838..ea98b3c6 100644
Binary files a/docs/build/doctrees/tutorials.console-arguments.doctree and b/docs/build/doctrees/tutorials.console-arguments.doctree differ
diff --git a/docs/build/doctrees/tutorials.console.doctree b/docs/build/doctrees/tutorials.console.doctree
index af9aea73..c336c514 100644
Binary files a/docs/build/doctrees/tutorials.console.doctree and b/docs/build/doctrees/tutorials.console.doctree differ
diff --git a/docs/build/doctrees/tutorials.create-startup.doctree b/docs/build/doctrees/tutorials.create-startup.doctree
index 9cc71581..e9867539 100644
Binary files a/docs/build/doctrees/tutorials.create-startup.doctree and b/docs/build/doctrees/tutorials.create-startup.doctree differ
diff --git a/docs/build/doctrees/tutorials.doctree b/docs/build/doctrees/tutorials.doctree
index f197f99f..98870ee6 100644
Binary files a/docs/build/doctrees/tutorials.doctree and b/docs/build/doctrees/tutorials.doctree differ
diff --git a/docs/build/doctrees/tutorials.extend-application.doctree b/docs/build/doctrees/tutorials.extend-application.doctree
index 93a46435..2bb6929b 100644
Binary files a/docs/build/doctrees/tutorials.extend-application.doctree and b/docs/build/doctrees/tutorials.extend-application.doctree differ
diff --git a/docs/build/doctrees/tutorials.extend-startup.doctree b/docs/build/doctrees/tutorials.extend-startup.doctree
index 1e884925..8623dd4f 100644
Binary files a/docs/build/doctrees/tutorials.extend-startup.doctree and b/docs/build/doctrees/tutorials.extend-startup.doctree differ
diff --git a/docs/build/doctrees/tutorials.logging.doctree b/docs/build/doctrees/tutorials.logging.doctree
index b48d37b5..76efdd33 100644
Binary files a/docs/build/doctrees/tutorials.logging.doctree and b/docs/build/doctrees/tutorials.logging.doctree differ
diff --git a/docs/build/doctrees/tutorials.mail.doctree b/docs/build/doctrees/tutorials.mail.doctree
index e1c5d8df..eca3b1f3 100644
Binary files a/docs/build/doctrees/tutorials.mail.doctree and b/docs/build/doctrees/tutorials.mail.doctree differ
diff --git a/docs/build/doctrees/tutorials.templating.doctree b/docs/build/doctrees/tutorials.templating.doctree
new file mode 100644
index 00000000..113a6786
Binary files /dev/null and b/docs/build/doctrees/tutorials.templating.doctree differ
diff --git a/docs/build/html/.buildinfo b/docs/build/html/.buildinfo
index c200e742..f883c950 100644
--- a/docs/build/html/.buildinfo
+++ b/docs/build/html/.buildinfo
@@ -1,4 +1,4 @@
# 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: 9ea51a00cf3559575c97b7efd7a002e5
+config: 7051b788adc6d655ae340e56640c6925
tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/build/html/_sources/cli.generate.md.txt b/docs/build/html/_sources/cli.generate.md.txt
index 40d79fdf..6dc285a0 100644
--- a/docs/build/html/_sources/cli.generate.md.txt
+++ b/docs/build/html/_sources/cli.generate.md.txt
@@ -16,23 +16,28 @@ cpl **G** *<schematic>* *<name>*
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``` |
+| 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 | `````` |
+| 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/cli.new.md.txt b/docs/build/html/_sources/cli.new.md.txt
index 2ddcb9e7..1301c1ad 100644
--- a/docs/build/html/_sources/cli.new.md.txt
+++ b/docs/build/html/_sources/cli.new.md.txt
@@ -16,12 +16,15 @@ cpl **N** *<type>* *<name>*
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``` |
+| 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
diff --git a/docs/build/html/_sources/cli.run.md.txt b/docs/build/html/_sources/cli.run.md.txt
new file mode 100644
index 00000000..5782a7a4
--- /dev/null
+++ b/docs/build/html/_sources/cli.run.md.txt
@@ -0,0 +1,12 @@
+# 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/cli.start.md.txt b/docs/build/html/_sources/cli.start.md.txt
index 2b067bfb..961feef1 100644
--- a/docs/build/html/_sources/cli.start.md.txt
+++ b/docs/build/html/_sources/cli.start.md.txt
@@ -5,3 +5,7 @@ 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/contributing.md.txt b/docs/build/html/_sources/contributing.md.txt
index 85456726..249c41d6 100644
--- a/docs/build/html/_sources/contributing.md.txt
+++ b/docs/build/html/_sources/contributing.md.txt
@@ -44,7 +44,7 @@ Before you submit your Pull Request (PR) consider the following guidelines:
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/sh_cpl repo.
+3. Fork the sh-edraft.de/cpl repo.
4. In your forked repository, make your changes in a new git branch:
@@ -70,7 +70,7 @@ Before you submit your Pull Request (PR) consider the following guidelines:
git push origin my-fix-branch
```
-8. In Gitea, send a pull request to sh_cpl:master
+8. In Gitea, send a pull request to cpl:master
### Reviewing a Pull Request
@@ -104,7 +104,7 @@ To ensure consistency throughout the source code, keep these rules in mind as yo
## 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/sh_cpl/src/branch/master/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/
diff --git a/docs/build/html/_sources/cpl_cli.rst.txt b/docs/build/html/_sources/cpl_cli.rst.txt
index 338ba5c2..cec12291 100644
--- a/docs/build/html/_sources/cpl_cli.rst.txt
+++ b/docs/build/html/_sources/cpl_cli.rst.txt
@@ -1,4 +1,4 @@
-CLI Reference
+CLI reference
=============
.. toctree::
diff --git a/docs/build/html/_sources/cpl_core.database.rst.txt b/docs/build/html/_sources/cpl_core.database.rst.txt
index fb55c962..cdcb0ce8 100644
--- a/docs/build/html/_sources/cpl_core.database.rst.txt
+++ b/docs/build/html/_sources/cpl_core.database.rst.txt
@@ -7,8 +7,7 @@ cpl_core.database
cpl_core.database.connection
cpl_core.database.context
-Submodules
-----------
+
cpl_core.database.database\_model
-----------------------------------
diff --git a/docs/build/html/_sources/cpl_core.pipes.rst.txt b/docs/build/html/_sources/cpl_core.pipes.rst.txt
index 8af5814b..0a8bba4d 100644
--- a/docs/build/html/_sources/cpl_core.pipes.rst.txt
+++ b/docs/build/html/_sources/cpl_core.pipes.rst.txt
@@ -1,10 +1,9 @@
cpl\_core.pipes
=======================
-Submodules
-----------
-cpl\_core.pipes.bool\_pipe module
+
+cpl\_core.pipes.bool\_pipe
---------------------------------
.. automodule:: cpl_core.pipes.bool_pipe
@@ -12,7 +11,7 @@ cpl\_core.pipes.bool\_pipe module
:undoc-members:
:show-inheritance:
-cpl\_core.pipes.first\_char\_to\_lower\_pipe module
+cpl\_core.pipes.first\_char\_to\_lower\_pipe
---------------------------------------------------
.. automodule:: cpl_core.pipes.first_char_to_lower_pipe
@@ -20,7 +19,7 @@ cpl\_core.pipes.first\_char\_to\_lower\_pipe module
:undoc-members:
:show-inheritance:
-cpl\_core.pipes.first\_to\_upper\_pipe module
+cpl\_core.pipes.first\_to\_upper\_pipe
---------------------------------------------
.. automodule:: cpl_core.pipes.first_to_upper_pipe
@@ -28,7 +27,7 @@ cpl\_core.pipes.first\_to\_upper\_pipe module
:undoc-members:
:show-inheritance:
-cpl\_core.pipes.ip\_address\_pipe module
+cpl\_core.pipes.ip\_address\_pipe
----------------------------------------
.. automodule:: cpl_core.pipes.ip_address_pipe
@@ -36,7 +35,7 @@ cpl\_core.pipes.ip\_address\_pipe module
:undoc-members:
:show-inheritance:
-cpl\_core.pipes.pipe\_abc module
+cpl\_core.pipes.pipe\_abc
--------------------------------
.. automodule:: cpl_core.pipes.pipe_abc
@@ -44,7 +43,7 @@ cpl\_core.pipes.pipe\_abc module
:undoc-members:
:show-inheritance:
-cpl\_core.pipes.to\_camel\_case\_pipe module
+cpl\_core.pipes.to\_camel\_case\_pipe
--------------------------------------------
.. automodule:: cpl_core.pipes.to_camel_case_pipe
@@ -52,7 +51,7 @@ cpl\_core.pipes.to\_camel\_case\_pipe module
:undoc-members:
:show-inheritance:
-cpl\_core.pipes.to\_snake\_case\_pipe module
+cpl\_core.pipes.to\_snake\_case\_pipe
--------------------------------------------
.. automodule:: cpl_core.pipes.to_snake_case_pipe
@@ -60,18 +59,10 @@ cpl\_core.pipes.to\_snake\_case\_pipe module
:undoc-members:
:show-inheritance:
-cpl\_core.pipes.version\_pipe module
+cpl\_core.pipes.version\_pipe
------------------------------------
.. 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
index a71547b3..e1e9b11a 100644
--- a/docs/build/html/_sources/cpl_core.rst.txt
+++ b/docs/build/html/_sources/cpl_core.rst.txt
@@ -1,4 +1,4 @@
-API Reference
+API reference
===========
.. toctree::
diff --git a/docs/build/html/_sources/cpl_discord.application.rst.txt b/docs/build/html/_sources/cpl_discord.application.rst.txt
new file mode 100644
index 00000000..ef077d22
--- /dev/null
+++ b/docs/build/html/_sources/cpl_discord.application.rst.txt
@@ -0,0 +1,12 @@
+cpl\_discord.application
+================================
+
+
+
+cpl\_discord.application.discord\_bot\_application\_abc
+--------------------------------------------------------------
+
+.. automodule:: cpl_discord.application.discord_bot_application_abc
+ :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
new file mode 100644
index 00000000..5f495733
--- /dev/null
+++ b/docs/build/html/_sources/cpl_discord.command.rst.txt
@@ -0,0 +1,20 @@
+cpl\_discord.command
+============================
+
+
+
+cpl\_discord.command.discord\_command\_abc
+-------------------------------------------------
+
+.. automodule:: cpl_discord.command.discord_command_abc
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cpl\_discord.command.discord\_commands\_meta
+---------------------------------------------------
+
+.. automodule:: cpl_discord.command.discord_commands_meta
+ :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
new file mode 100644
index 00000000..eb855d14
--- /dev/null
+++ b/docs/build/html/_sources/cpl_discord.configuration.rst.txt
@@ -0,0 +1,12 @@
+cpl\_discord.configuration
+==================================
+
+
+
+cpl\_discord.configuration.discord\_bot\_settings
+--------------------------------------------------------
+
+.. automodule:: cpl_discord.configuration.discord_bot_settings
+ :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
new file mode 100644
index 00000000..a47f50b1
--- /dev/null
+++ b/docs/build/html/_sources/cpl_discord.container.rst.txt
@@ -0,0 +1,68 @@
+cpl\_discord.container
+==============================
+
+
+
+cpl\_discord.container.category\_channel
+-----------------------------------------------
+
+.. automodule:: cpl_discord.container.category_channel
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cpl\_discord.container.container
+---------------------------------------
+
+.. automodule:: cpl_discord.container.container
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cpl\_discord.container.guild
+-----------------------------------
+
+.. automodule:: cpl_discord.container.guild
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cpl\_discord.container.member
+------------------------------------
+
+.. automodule:: cpl_discord.container.member
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cpl\_discord.container.role
+----------------------------------
+
+.. automodule:: cpl_discord.container.role
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cpl\_discord.container.text\_channel
+-------------------------------------------
+
+.. automodule:: cpl_discord.container.text_channel
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cpl\_discord.container.thread
+------------------------------------
+
+.. automodule:: cpl_discord.container.thread
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cpl\_discord.container.voice\_channel
+--------------------------------------------
+
+.. automodule:: cpl_discord.container.voice_channel
+ :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
new file mode 100644
index 00000000..d26aa744
--- /dev/null
+++ b/docs/build/html/_sources/cpl_discord.events.rst.txt
@@ -0,0 +1,412 @@
+cpl\_discord.events
+===========================
+
+
+
+cpl\_discord.events.on\_bulk\_message\_delete\_abc
+---------------------------------------------------------
+
+.. automodule:: cpl_discord.events.on_bulk_message_delete_abc
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cpl\_discord.events.on\_command\_abc
+-------------------------------------------
+
+.. automodule:: cpl_discord.events.on_command_abc
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cpl\_discord.events.on\_command\_completion\_abc
+-------------------------------------------------------
+
+.. automodule:: cpl_discord.events.on_command_completion_abc
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cpl\_discord.events.on\_command\_error\_abc
+--------------------------------------------------
+
+.. automodule:: cpl_discord.events.on_command_error_abc
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cpl\_discord.events.on\_connect\_abc
+-------------------------------------------
+
+.. automodule:: cpl_discord.events.on_connect_abc
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cpl\_discord.events.on\_disconnect\_abc
+----------------------------------------------
+
+.. automodule:: cpl_discord.events.on_disconnect_abc
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cpl\_discord.events.on\_error\_abc
+-----------------------------------------
+
+.. automodule:: cpl_discord.events.on_error_abc
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cpl\_discord.events.on\_group\_join\_abc
+-----------------------------------------------
+
+.. automodule:: cpl_discord.events.on_group_join_abc
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cpl\_discord.events.on\_group\_remove\_abc
+-------------------------------------------------
+
+.. automodule:: cpl_discord.events.on_group_remove_abc
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cpl\_discord.events.on\_guild\_available\_abc
+----------------------------------------------------
+
+.. automodule:: cpl_discord.events.on_guild_available_abc
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cpl\_discord.events.on\_guild\_channel\_create\_abc
+----------------------------------------------------------
+
+.. automodule:: cpl_discord.events.on_guild_channel_create_abc
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cpl\_discord.events.on\_guild\_channel\_delete\_abc
+----------------------------------------------------------
+
+.. automodule:: cpl_discord.events.on_guild_channel_delete_abc
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cpl\_discord.events.on\_guild\_channel\_pins\_update\_abc
+----------------------------------------------------------------
+
+.. automodule:: cpl_discord.events.on_guild_channel_pins_update_abc
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cpl\_discord.events.on\_guild\_channel\_update\_abc
+----------------------------------------------------------
+
+.. automodule:: cpl_discord.events.on_guild_channel_update_abc
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cpl\_discord.events.on\_guild\_emojis\_update\_abc
+---------------------------------------------------------
+
+.. automodule:: cpl_discord.events.on_guild_emojis_update_abc
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cpl\_discord.events.on\_guild\_integrations\_update\_abc
+---------------------------------------------------------------
+
+.. automodule:: cpl_discord.events.on_guild_integrations_update_abc
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cpl\_discord.events.on\_guild\_join\_abc
+-----------------------------------------------
+
+.. automodule:: cpl_discord.events.on_guild_join_abc
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cpl\_discord.events.on\_guild\_remove\_abc
+-------------------------------------------------
+
+.. automodule:: cpl_discord.events.on_guild_remove_abc
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cpl\_discord.events.on\_guild\_role\_create\_abc
+-------------------------------------------------------
+
+.. automodule:: cpl_discord.events.on_guild_role_create_abc
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cpl\_discord.events.on\_guild\_role\_delete\_abc
+-------------------------------------------------------
+
+.. automodule:: cpl_discord.events.on_guild_role_delete_abc
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cpl\_discord.events.on\_guild\_role\_update\_abc
+-------------------------------------------------------
+
+.. automodule:: cpl_discord.events.on_guild_role_update_abc
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cpl\_discord.events.on\_guild\_unavailable\_abc
+------------------------------------------------------
+
+.. automodule:: cpl_discord.events.on_guild_unavailable_abc
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cpl\_discord.events.on\_guild\_update\_abc
+-------------------------------------------------
+
+.. automodule:: cpl_discord.events.on_guild_update_abc
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cpl\_discord.events.on\_invite\_create\_abc
+--------------------------------------------------
+
+.. automodule:: cpl_discord.events.on_invite_create_abc
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cpl\_discord.events.on\_invite\_delete\_abc
+--------------------------------------------------
+
+.. automodule:: cpl_discord.events.on_invite_delete_abc
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cpl\_discord.events.on\_member\_ban\_abc
+-----------------------------------------------
+
+.. automodule:: cpl_discord.events.on_member_ban_abc
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cpl\_discord.events.on\_member\_join\_abc
+------------------------------------------------
+
+.. automodule:: cpl_discord.events.on_member_join_abc
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cpl\_discord.events.on\_member\_remove\_abc
+--------------------------------------------------
+
+.. automodule:: cpl_discord.events.on_member_remove_abc
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cpl\_discord.events.on\_member\_unban\_abc
+-------------------------------------------------
+
+.. automodule:: cpl_discord.events.on_member_unban_abc
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cpl\_discord.events.on\_member\_update\_abc
+--------------------------------------------------
+
+.. automodule:: cpl_discord.events.on_member_update_abc
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cpl\_discord.events.on\_message\_abc
+-------------------------------------------
+
+.. automodule:: cpl_discord.events.on_message_abc
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cpl\_discord.events.on\_message\_delete\_abc
+---------------------------------------------------
+
+.. automodule:: cpl_discord.events.on_message_delete_abc
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cpl\_discord.events.on\_message\_edit\_abc
+-------------------------------------------------
+
+.. automodule:: cpl_discord.events.on_message_edit_abc
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cpl\_discord.events.on\_private\_channel\_create\_abc
+------------------------------------------------------------
+
+.. automodule:: cpl_discord.events.on_private_channel_create_abc
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cpl\_discord.events.on\_private\_channel\_delete\_abc
+------------------------------------------------------------
+
+.. automodule:: cpl_discord.events.on_private_channel_delete_abc
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cpl\_discord.events.on\_private\_channel\_pins\_update\_abc
+------------------------------------------------------------------
+
+.. automodule:: cpl_discord.events.on_private_channel_pins_update_abc
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cpl\_discord.events.on\_private\_channel\_update\_abc
+------------------------------------------------------------
+
+.. automodule:: cpl_discord.events.on_private_channel_update_abc
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cpl\_discord.events.on\_raw\_reaction\_add\_abc
+------------------------------------------------------
+
+.. automodule:: cpl_discord.events.on_raw_reaction_add_abc
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cpl\_discord.events.on\_raw\_reaction\_clear\_abc
+--------------------------------------------------------
+
+.. automodule:: cpl_discord.events.on_raw_reaction_clear_abc
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cpl\_discord.events.on\_raw\_reaction\_clear\_emoji\_abc
+---------------------------------------------------------------
+
+.. automodule:: cpl_discord.events.on_raw_reaction_clear_emoji_abc
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cpl\_discord.events.on\_raw\_reaction\_remove\_abc
+---------------------------------------------------------
+
+.. automodule:: cpl_discord.events.on_raw_reaction_remove_abc
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cpl\_discord.events.on\_reaction\_add\_abc
+-------------------------------------------------
+
+.. automodule:: cpl_discord.events.on_reaction_add_abc
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cpl\_discord.events.on\_reaction\_clear\_abc
+---------------------------------------------------
+
+.. automodule:: cpl_discord.events.on_reaction_clear_abc
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cpl\_discord.events.on\_reaction\_clear\_emoji\_abc
+----------------------------------------------------------
+
+.. automodule:: cpl_discord.events.on_reaction_clear_emoji_abc
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cpl\_discord.events.on\_reaction\_remove\_abc
+----------------------------------------------------
+
+.. automodule:: cpl_discord.events.on_reaction_remove_abc
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cpl\_discord.events.on\_ready\_abc
+-----------------------------------------
+
+.. automodule:: cpl_discord.events.on_ready_abc
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cpl\_discord.events.on\_resume\_abc
+------------------------------------------
+
+.. automodule:: cpl_discord.events.on_resume_abc
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cpl\_discord.events.on\_typing\_abc
+------------------------------------------
+
+.. automodule:: cpl_discord.events.on_typing_abc
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cpl\_discord.events.on\_user\_update\_abc
+------------------------------------------------
+
+.. automodule:: cpl_discord.events.on_user_update_abc
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cpl\_discord.events.on\_voice\_state\_update\_abc
+--------------------------------------------------------
+
+.. automodule:: cpl_discord.events.on_voice_state_update_abc
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cpl\_discord.events.on\_webhooks\_update\_abc
+----------------------------------------------------
+
+.. automodule:: cpl_discord.events.on_webhooks_update_abc
+ :members:
+ :undoc-members:
+ :show-inheritance:
\ No newline at end of file
diff --git a/docs/build/html/_sources/cpl_discord.helper.rst.txt b/docs/build/html/_sources/cpl_discord.helper.rst.txt
new file mode 100644
index 00000000..396b4c89
--- /dev/null
+++ b/docs/build/html/_sources/cpl_discord.helper.rst.txt
@@ -0,0 +1,12 @@
+cpl\_discord.helper
+===========================
+
+
+
+cpl\_discord.helper.to\_containers\_converter
+----------------------------------------------------
+
+.. automodule:: cpl_discord.helper.to_containers_converter
+ :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
new file mode 100644
index 00000000..5d10fb20
--- /dev/null
+++ b/docs/build/html/_sources/cpl_discord.rst.txt
@@ -0,0 +1,13 @@
+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
diff --git a/docs/build/html/_sources/cpl_discord.service.rst.txt b/docs/build/html/_sources/cpl_discord.service.rst.txt
new file mode 100644
index 00000000..a6898292
--- /dev/null
+++ b/docs/build/html/_sources/cpl_discord.service.rst.txt
@@ -0,0 +1,60 @@
+cpl\_discord.service
+============================
+
+
+
+cpl\_discord.service.command\_error\_handler\_service
+------------------------------------------------------------
+
+.. automodule:: cpl_discord.service.command_error_handler_service
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cpl\_discord.service.discord\_bot\_service
+-------------------------------------------------
+
+.. automodule:: cpl_discord.service.discord_bot_service
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cpl\_discord.service.discord\_bot\_service\_abc
+------------------------------------------------------
+
+.. automodule:: cpl_discord.service.discord_bot_service_abc
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cpl\_discord.service.discord\_collection
+-----------------------------------------------
+
+.. automodule:: cpl_discord.service.discord_collection
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cpl\_discord.service.discord\_collection\_abc
+----------------------------------------------------
+
+.. automodule:: cpl_discord.service.discord_collection_abc
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cpl\_discord.service.discord\_service
+--------------------------------------------
+
+.. automodule:: cpl_discord.service.discord_service
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cpl\_discord.service.discord\_service\_abc
+-------------------------------------------------
+
+.. automodule:: cpl_discord.service.discord_service_abc
+ :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
new file mode 100644
index 00000000..156985e5
--- /dev/null
+++ b/docs/build/html/_sources/cpl_query.base.rst.txt
@@ -0,0 +1,52 @@
+cpl\_query.base
+=======================
+
+
+
+cpl\_query.base.default\_lambda
+--------------------------------------
+
+.. automodule:: cpl_query.base.default_lambda
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cpl\_query.base.ordered\_queryable
+-----------------------------------------
+
+.. automodule:: cpl_query.base.ordered_queryable
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cpl\_query.base.ordered\_queryable\_abc
+----------------------------------------------
+
+.. automodule:: cpl_query.base.ordered_queryable_abc
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cpl\_query.base.queryable\_abc
+-------------------------------------
+
+.. automodule:: cpl_query.base.queryable_abc
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cpl\_query.base.sequence\_abc
+------------------------------------
+
+.. automodule:: cpl_query.base.sequence_abc
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cpl\_query.base.sequence\_values
+---------------------------------------
+
+.. automodule:: cpl_query.base.sequence_values
+ :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
new file mode 100644
index 00000000..37e58add
--- /dev/null
+++ b/docs/build/html/_sources/cpl_query.enumerable.rst.txt
@@ -0,0 +1,20 @@
+cpl\_query.enumerable
+=============================
+
+
+
+cpl\_query.enumerable.enumerable
+---------------------------------------
+
+.. automodule:: cpl_query.enumerable.enumerable
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cpl\_query.enumerable.enumerable\_abc
+--------------------------------------------
+
+.. automodule:: cpl_query.enumerable.enumerable_abc
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/build/html/_sources/cpl_query.exceptions.rst.txt b/docs/build/html/_sources/cpl_query.exceptions.rst.txt
deleted file mode 100644
index d492c637..00000000
--- a/docs/build/html/_sources/cpl_query.exceptions.rst.txt
+++ /dev/null
@@ -1,10 +0,0 @@
-cpl_query.exceptions
-=================================
-
-cpl_query.exceptions
-----------------------------------------------------
-
-.. automodule:: cpl_query.exceptions
- :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
index 9dfaa401..a0bba3e0 100644
--- a/docs/build/html/_sources/cpl_query.extension.rst.txt
+++ b/docs/build/html/_sources/cpl_query.extension.rst.txt
@@ -1,42 +1,12 @@
-cpl_query.extension
-=================================
+cpl\_query.extension
+============================
-cpl_query.extension.iterable_abc
-----------------------------------------------------
-.. automodule:: cpl_query.extension.iterable_abc
- :members:
- :undoc-members:
- :show-inheritance:
-cpl_query.extension.iterable
-----------------------------------------------------
-
-.. automodule:: cpl_query.extension.iterable
- :members:
- :undoc-members:
- :show-inheritance:
-
-cpl_query.extension.list
-----------------------------------------------------
+cpl\_query.extension.list
+--------------------------------
.. automodule:: cpl_query.extension.list
:members:
:undoc-members:
:show-inheritance:
-
-cpl_query.extension.ordered_iterable_abc
-----------------------------------------------------
-
-.. automodule:: cpl_query.extension.ordered_iterable_abc
- :members:
- :undoc-members:
- :show-inheritance:
-
-cpl_query.extension.ordered_iterable
-----------------------------------------------------
-
-.. automodule:: cpl_query.extension.ordered_iterable
- :members:
- :undoc-members:
- :show-inheritance:
\ No newline at end of file
diff --git a/docs/build/html/_sources/cpl_query.iterable.rst.txt b/docs/build/html/_sources/cpl_query.iterable.rst.txt
new file mode 100644
index 00000000..8a7bc919
--- /dev/null
+++ b/docs/build/html/_sources/cpl_query.iterable.rst.txt
@@ -0,0 +1,20 @@
+cpl\_query.iterable
+===========================
+
+
+
+cpl\_query.iterable.iterable
+-----------------------------------
+
+.. automodule:: cpl_query.iterable.iterable
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cpl\_query.iterable.iterable\_abc
+----------------------------------------
+
+.. automodule:: cpl_query.iterable.iterable_abc
+ :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
index 10d6f0d8..5a362b26 100644
--- a/docs/build/html/_sources/cpl_query.rst.txt
+++ b/docs/build/html/_sources/cpl_query.rst.txt
@@ -1,8 +1,10 @@
-Query Reference
+Query reference
===========
.. toctree::
:maxdepth: 4
-
- cpl_query.extension
- cpl_query.exceptions
+
+ 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
new file mode 100644
index 00000000..365356e8
--- /dev/null
+++ b/docs/build/html/_sources/cpl_translation.rst.txt
@@ -0,0 +1,34 @@
+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/index.rst.txt b/docs/build/html/_sources/index.rst.txt
index 0d0ef798..921b7964 100644
--- a/docs/build/html/_sources/index.rst.txt
+++ b/docs/build/html/_sources/index.rst.txt
@@ -89,4 +89,6 @@ These pages go into great detail about everything the Library can do.
contributing
cpl_cli
cpl_core
+ cpl_discord
cpl_query
+ cpl_translation
diff --git a/docs/build/html/_sources/modules.rst.txt b/docs/build/html/_sources/modules.rst.txt
index d1ae65e0..5a411fa4 100644
--- a/docs/build/html/_sources/modules.rst.txt
+++ b/docs/build/html/_sources/modules.rst.txt
@@ -9,4 +9,4 @@ cpl
cpl_core
cpl_discord
cpl_query
- cpl_translate
+ cpl_translation
diff --git a/docs/build/html/_sources/setup.md.txt b/docs/build/html/_sources/setup.md.txt
index 6d0be37c..be16fa9b 100644
--- a/docs/build/html/_sources/setup.md.txt
+++ b/docs/build/html/_sources/setup.md.txt
@@ -27,7 +27,7 @@ Also you need to have the following installed.
To install the package, open a terminal window and run the following command:
```sh
-pip install sh_cpl-core --extra-index-url https://pip.sh-edraft.de
+pip install cpl-core --extra-index-url https://pip.sh-edraft.de
```
## Install the CLI
@@ -37,7 +37,7 @@ You use the CPL CLI to create projects, generate application and library code. Y
To install the CLI, open a terminal window and run the following command:
```sh
-pip install sh_cpl-cli --extra-index-url https://pip.sh-edraft.de
+pip install cpl-cli --extra-index-url https://pip.sh-edraft.de
```
## Install the query
@@ -45,7 +45,7 @@ pip install sh_cpl-cli --extra-index-url https://pip.sh-edraft.de
To install the package, open a terminal window and run the following command:
```sh
-pip install sh_cpl-query --extra-index-url https://pip.sh-edraft.de
+pip install cpl-query --extra-index-url https://pip.sh-edraft.de
```
## Create initial console app
diff --git a/docs/build/html/_sources/tutorials.appsettings.md.txt b/docs/build/html/_sources/tutorials.appsettings.md.txt
index ffe26cba..4eabffa2 100644
--- a/docs/build/html/_sources/tutorials.appsettings.md.txt
+++ b/docs/build/html/_sources/tutorials.appsettings.md.txt
@@ -1,3 +1,3 @@
# Using appsettings.json
-## Comming soon
\ No newline at end of file
+## 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
index a0be2c0f..0a3b5a42 100644
--- a/docs/build/html/_sources/tutorials.console-arguments.md.txt
+++ b/docs/build/html/_sources/tutorials.console-arguments.md.txt
@@ -1,3 +1,3 @@
# Handle console arguments
-## Comming soon
\ No newline at end of file
+## 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
index c7d22b99..fcbaaba1 100644
--- a/docs/build/html/_sources/tutorials.console.md.txt
+++ b/docs/build/html/_sources/tutorials.console.md.txt
@@ -1,3 +1,3 @@
# Use cpl_core.console.Console
-## Comming soon
\ No newline at end of file
+## 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
index ee443126..028d072c 100644
--- a/docs/build/html/_sources/tutorials.create-startup.md.txt
+++ b/docs/build/html/_sources/tutorials.create-startup.md.txt
@@ -1,3 +1,3 @@
# Create startup class
-## Comming soon
\ No newline at end of file
+## 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
index 3697cbc9..1eec6e9e 100644
--- a/docs/build/html/_sources/tutorials.extend-application.md.txt
+++ b/docs/build/html/_sources/tutorials.extend-application.md.txt
@@ -1,3 +1,3 @@
# Extend application
-## Comming soon
\ No newline at end of file
+## 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
index 66e3e54f..98b90da4 100644
--- a/docs/build/html/_sources/tutorials.extend-startup.md.txt
+++ b/docs/build/html/_sources/tutorials.extend-startup.md.txt
@@ -1,3 +1,3 @@
# Extend startup
-## Comming soon
\ No newline at end of file
+## 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
index c98020c5..660fbfe1 100644
--- a/docs/build/html/_sources/tutorials.logging.md.txt
+++ b/docs/build/html/_sources/tutorials.logging.md.txt
@@ -1,3 +1,3 @@
# Use builtin logger
-## Comming soon
\ No newline at end of file
+## 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
index e7a2b778..7b6c9150 100644
--- a/docs/build/html/_sources/tutorials.mail.md.txt
+++ b/docs/build/html/_sources/tutorials.mail.md.txt
@@ -1,3 +1,3 @@
# Send mails
-## Comming soon
\ No newline at end of file
+## 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
index f85e9b8c..b8fd6668 100644
--- a/docs/build/html/_sources/tutorials.rst.txt
+++ b/docs/build/html/_sources/tutorials.rst.txt
@@ -11,4 +11,5 @@ Tutorials
tutorials.console-arguments
tutorials.console
tutorials.logging
- tutorials.mail
\ No newline at end of file
+ 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
new file mode 100644
index 00000000..4530b17c
--- /dev/null
+++ b/docs/build/html/_sources/tutorials.templating.md.txt
@@ -0,0 +1,181 @@
+# 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/cli.add.html b/docs/build/html/cli.add.html
index 683a3330..54bff940 100644
--- a/docs/build/html/cli.add.html
+++ b/docs/build/html/cli.add.html
@@ -42,7 +42,7 @@
Introduction to the CPL Docs
Getting started
Contributing to CPL
-CLI Reference
+CLI reference
@@ -82,7 +84,7 @@
@@ -80,7 +82,7 @@
@@ -82,7 +84,7 @@
»
- CLI Reference »
+ CLI reference »
cpl generate
View page source
@@ -110,6 +112,7 @@ cpl G <schematic> <name>
Description
Generates files based on a schematic.
+You can define custom schematics by creating templates in a .cpl
folder.
Arguments
@@ -129,6 +132,10 @@ cpl G <schematic> <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
+
@@ -178,6 +185,14 @@ cpl G <schematic> <name>
Validator class
<name>
+command
+Discord bot command class
+<name>
+
+event
+Discord bot event class
+<name>
+
@@ -194,7 +209,7 @@ cpl G <schematic> <name>
-
© Copyright 2021, Sven Heidemann.
+
© Copyright 2021 - 2023, Sven Heidemann.
Built with Sphinx using a
diff --git a/docs/build/html/cli.help.html b/docs/build/html/cli.help.html
index 6828004d..c7ae617b 100644
--- a/docs/build/html/cli.help.html
+++ b/docs/build/html/cli.help.html
@@ -42,7 +42,7 @@
Introduction to the CPL Docs
Getting started
Contributing to CPL
-CLI Reference
@@ -81,7 +83,7 @@
@@ -82,7 +84,7 @@
@@ -82,7 +84,7 @@
»
- CLI Reference »
+ CLI reference »
cpl new
View page source
@@ -110,6 +112,7 @@ 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.
@@ -127,6 +130,10 @@ cpl N <type> <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
+
@@ -191,7 +198,7 @@ cpl N <type> <name>
-
© Copyright 2021, Sven Heidemann.
+
© Copyright 2021 - 2023, Sven Heidemann.
Built with Sphinx using a
diff --git a/docs/build/html/cli.overview.html b/docs/build/html/cli.overview.html
index 72f48547..0ed47030 100644
--- a/docs/build/html/cli.overview.html
+++ b/docs/build/html/cli.overview.html
@@ -20,7 +20,7 @@
-
+
@@ -42,7 +42,7 @@
Introduction to the CPL Docs
Getting started
Contributing to CPL
-CLI Reference
@@ -86,7 +88,7 @@
-CLI Reference
-API Reference
-Query Reference
+CLI reference
+API reference
+Discord reference
+Query reference
+Translation reference
@@ -123,7 +125,7 @@
Search the repository for an open or closed PR that relates to your submission. You don’t want to duplicate existing efforts.
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.
-Fork the sh-edraft.de/sh_cpl repo.
+Fork the sh-edraft.de/cpl repo.
In your forked repository, make your changes in a new git branch:
git checkout -b my-fix-branch master
@@ -144,7 +146,7 @@
-In Gitea, send a pull request to sh_cpl:master
+In Gitea, send a pull request to cpl:master
@@ -178,7 +180,7 @@ git push
License
By contributing, you agree that your contributions will be licensed under its MIT License.
-See LICENSE
+See LICENSE
@@ -187,14 +189,14 @@ See
- Previous
- Next
+ Previous
+ Next
-
© Copyright 2021, Sven Heidemann.
+
© Copyright 2021 - 2023, Sven Heidemann.
Built with Sphinx using a
diff --git a/docs/build/html/cpl_cli.html b/docs/build/html/cpl_cli.html
index 657a2b49..4ac7954e 100644
--- a/docs/build/html/cpl_cli.html
+++ b/docs/build/html/cpl_cli.html
@@ -4,7 +4,7 @@
- CLI Reference — Common Python Library documentation
+ CLI reference — Common Python Library documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Common Python Library
+
+
+
+
+
+
+
+
+
+cpl_discord.application
+
+cpl_discord.application.discord_bot_application_abc
+
+
+class cpl_discord.application.discord_bot_application_abc. DiscordBotApplicationABC ( config : ConfigurationABC , services : ServiceProviderABC )
+Bases: ApplicationABC
+
+
+abstract stop_async ( )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+