2022.12 #133
16
README.md
16
README.md
@ -87,17 +87,17 @@
|
|||||||
|
|
||||||
Install the CPL package
|
Install the CPL package
|
||||||
```sh
|
```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
|
Install the CPL CLI
|
||||||
```sh
|
```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:
|
Create workspace:
|
||||||
```sh
|
```sh
|
||||||
cpl new <console|library> <PROJECT NAME>
|
cpl new <console|library|unittest> <PROJECT NAME>
|
||||||
```
|
```
|
||||||
|
|
||||||
Run the application:
|
Run the application:
|
||||||
@ -110,7 +110,7 @@ cpl start
|
|||||||
<!-- ROADMAP -->
|
<!-- ROADMAP -->
|
||||||
## Roadmap
|
## 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
|
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)
|
||||||
|
|
||||||
<!-- External LINKS -->
|
<!-- External LINKS -->
|
||||||
[pip_url]: https://pip.sh-edraft.de
|
[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/
|
[pip]: https://pypi.org/project/pip/
|
||||||
|
|
||||||
<!-- Internal LINKS -->
|
<!-- Internal LINKS -->
|
||||||
[project]: https://git.sh-edraft.de/sh-edraft.de/sh_common_py_lib
|
[project]: https://git.sh-edraft.de/sh-edraft.de/sh_cpl
|
||||||
[quickstart]: https://git.sh-edraft.de/sh-edraft.de/sh_common_py_lib/wiki/quickstart
|
[quickstart]: https://git.sh-edraft.de/sh-edraft.de/sh_cpl/wiki/quickstart
|
||||||
[contributing]: https://git.sh-edraft.de/sh-edraft.de/sh_common_py_lib/wiki/contributing
|
[contributing]: https://git.sh-edraft.de/sh-edraft.de/sh_cpl/wiki/contributing
|
||||||
[license]: LICENSE
|
[license]: LICENSE
|
||||||
|
@ -20,12 +20,16 @@
|
|||||||
"hello-world": "echo 'Hello World'",
|
"hello-world": "echo 'Hello World'",
|
||||||
|
|
||||||
"sv": "cpl set-version",
|
"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",
|
"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",
|
"db": "cpl docs-build",
|
||||||
|
|
||||||
"docs-open": "xdg-open $PWD/docs/build/html/index.html &",
|
"docs-open": "xdg-open $PWD/docs/build/html/index.html &",
|
||||||
@ -46,7 +50,7 @@
|
|||||||
|
|
||||||
"pre-publish-all": "cpl sv $ARGS; cpl spu $ARGS;",
|
"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;",
|
"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-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-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 ../../;",
|
"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-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-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-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"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
BIN
docs/build/doctrees/cli.generate.doctree
vendored
BIN
docs/build/doctrees/cli.generate.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cli.new.doctree
vendored
BIN
docs/build/doctrees/cli.new.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cli.run.doctree
vendored
Normal file
BIN
docs/build/doctrees/cli.run.doctree
vendored
Normal file
Binary file not shown.
BIN
docs/build/doctrees/cli.start.doctree
vendored
BIN
docs/build/doctrees/cli.start.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/contributing.doctree
vendored
BIN
docs/build/doctrees/contributing.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_cli.doctree
vendored
BIN
docs/build/doctrees/cpl_cli.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_core.application.doctree
vendored
BIN
docs/build/doctrees/cpl_core.application.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_core.configuration.doctree
vendored
BIN
docs/build/doctrees/cpl_core.configuration.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_core.database.doctree
vendored
BIN
docs/build/doctrees/cpl_core.database.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_core.doctree
vendored
BIN
docs/build/doctrees/cpl_core.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_core.pipes.doctree
vendored
BIN
docs/build/doctrees/cpl_core.pipes.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_discord.application.doctree
vendored
Normal file
BIN
docs/build/doctrees/cpl_discord.application.doctree
vendored
Normal file
Binary file not shown.
BIN
docs/build/doctrees/cpl_discord.command.doctree
vendored
Normal file
BIN
docs/build/doctrees/cpl_discord.command.doctree
vendored
Normal file
Binary file not shown.
BIN
docs/build/doctrees/cpl_discord.configuration.doctree
vendored
Normal file
BIN
docs/build/doctrees/cpl_discord.configuration.doctree
vendored
Normal file
Binary file not shown.
BIN
docs/build/doctrees/cpl_discord.container.doctree
vendored
Normal file
BIN
docs/build/doctrees/cpl_discord.container.doctree
vendored
Normal file
Binary file not shown.
BIN
docs/build/doctrees/cpl_discord.doctree
vendored
Normal file
BIN
docs/build/doctrees/cpl_discord.doctree
vendored
Normal file
Binary file not shown.
BIN
docs/build/doctrees/cpl_discord.events.doctree
vendored
Normal file
BIN
docs/build/doctrees/cpl_discord.events.doctree
vendored
Normal file
Binary file not shown.
BIN
docs/build/doctrees/cpl_discord.helper.doctree
vendored
Normal file
BIN
docs/build/doctrees/cpl_discord.helper.doctree
vendored
Normal file
Binary file not shown.
BIN
docs/build/doctrees/cpl_discord.service.doctree
vendored
Normal file
BIN
docs/build/doctrees/cpl_discord.service.doctree
vendored
Normal file
Binary file not shown.
BIN
docs/build/doctrees/cpl_query.base.doctree
vendored
Normal file
BIN
docs/build/doctrees/cpl_query.base.doctree
vendored
Normal file
Binary file not shown.
BIN
docs/build/doctrees/cpl_query.doctree
vendored
BIN
docs/build/doctrees/cpl_query.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_query.enumerable.doctree
vendored
Normal file
BIN
docs/build/doctrees/cpl_query.enumerable.doctree
vendored
Normal file
Binary file not shown.
BIN
docs/build/doctrees/cpl_query.exceptions.doctree
vendored
BIN
docs/build/doctrees/cpl_query.exceptions.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_query.extension.doctree
vendored
BIN
docs/build/doctrees/cpl_query.extension.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_query.iterable.doctree
vendored
Normal file
BIN
docs/build/doctrees/cpl_query.iterable.doctree
vendored
Normal file
Binary file not shown.
BIN
docs/build/doctrees/cpl_translation.doctree
vendored
Normal file
BIN
docs/build/doctrees/cpl_translation.doctree
vendored
Normal file
Binary file not shown.
BIN
docs/build/doctrees/environment.pickle
vendored
BIN
docs/build/doctrees/environment.pickle
vendored
Binary file not shown.
BIN
docs/build/doctrees/index.doctree
vendored
BIN
docs/build/doctrees/index.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/modules.doctree
vendored
BIN
docs/build/doctrees/modules.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/setup.doctree
vendored
BIN
docs/build/doctrees/setup.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/tutorials.appsettings.doctree
vendored
BIN
docs/build/doctrees/tutorials.appsettings.doctree
vendored
Binary file not shown.
Binary file not shown.
BIN
docs/build/doctrees/tutorials.console.doctree
vendored
BIN
docs/build/doctrees/tutorials.console.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/tutorials.create-startup.doctree
vendored
BIN
docs/build/doctrees/tutorials.create-startup.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/tutorials.doctree
vendored
BIN
docs/build/doctrees/tutorials.doctree
vendored
Binary file not shown.
Binary file not shown.
BIN
docs/build/doctrees/tutorials.extend-startup.doctree
vendored
BIN
docs/build/doctrees/tutorials.extend-startup.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/tutorials.logging.doctree
vendored
BIN
docs/build/doctrees/tutorials.logging.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/tutorials.mail.doctree
vendored
BIN
docs/build/doctrees/tutorials.mail.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/tutorials.templating.doctree
vendored
Normal file
BIN
docs/build/doctrees/tutorials.templating.doctree
vendored
Normal file
Binary file not shown.
2
docs/build/html/.buildinfo
vendored
2
docs/build/html/.buildinfo
vendored
@ -1,4 +1,4 @@
|
|||||||
# Sphinx build info version 1
|
# 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.
|
# 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
|
tags: 645f666f9bcd5a90fca523b33c5a78b7
|
||||||
|
9
docs/build/html/_sources/cli.generate.md.txt
vendored
9
docs/build/html/_sources/cli.generate.md.txt
vendored
@ -16,17 +16,20 @@ cpl **G** *<schematic>* *<name>*
|
|||||||
|
|
||||||
Generates files based on a schematic.
|
Generates files based on a schematic.
|
||||||
|
|
||||||
|
You can define custom schematics by creating templates in a ```.cpl``` folder.
|
||||||
|
|
||||||
## Arguments
|
## Arguments
|
||||||
|
|
||||||
| Argument | Description | Value type |
|
| Argument | Description | Value type |
|
||||||
| ----------------- |:---------------------------------:|:-------------:|
|
|-------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------:|:-------------:|
|
||||||
| ```<schematic>``` | The schematic to generate. | ```str``` |
|
| ```<schematic>``` | The schematic to generate. | ```str``` |
|
||||||
| ```<name>``` | The name of the generated file. | ```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
|
## Schematics
|
||||||
|
|
||||||
| Schematic | Description | Arguments |
|
| Schematic | Description | Arguments |
|
||||||
|-----------------|:-------------------------------------:|:------------:|
|
|-----------------|:--------------------------------------:|:------------:|
|
||||||
| ```abc``` | Abstract base class | ```<name>``` |
|
| ```abc``` | Abstract base class | ```<name>``` |
|
||||||
| ```class``` | Class | ```<name>``` |
|
| ```class``` | Class | ```<name>``` |
|
||||||
| ```enum``` | Enum class | ```<name>``` |
|
| ```enum``` | Enum class | ```<name>``` |
|
||||||
@ -36,3 +39,5 @@ Generates files based on a schematic.
|
|||||||
| ```test``` | Test class | ```<name>``` |
|
| ```test``` | Test class | ```<name>``` |
|
||||||
| ```thread``` | Thread class | ```<name>``` |
|
| ```thread``` | Thread class | ```<name>``` |
|
||||||
| ```validator``` | Validator class | ```<name>``` |
|
| ```validator``` | Validator class | ```<name>``` |
|
||||||
|
| ```command``` | Discord bot command class | ```<name>``` |
|
||||||
|
| ```event``` | Discord bot event class | ```<name>``` |
|
||||||
|
5
docs/build/html/_sources/cli.new.md.txt
vendored
5
docs/build/html/_sources/cli.new.md.txt
vendored
@ -16,12 +16,15 @@ cpl **N** *<type>* *<name>*
|
|||||||
|
|
||||||
Generates a workspace and initial project or add a project to workspace.
|
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.
|
If the command is running in a CPL workspace, it will add the new project to the workspace.
|
||||||
|
|
||||||
| Argument | Description | Value type |
|
| Argument | Description | Value type |
|
||||||
|--------------|:----------------------------------------------------:|:----------:|
|
|--------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------:|:----------:|
|
||||||
| ```<type>``` | The type of the project, see [types](#project-types) | ```str``` |
|
| ```<type>``` | The type of the project, see [types](#project-types) | ```str``` |
|
||||||
| ```<name>``` | The name of the project | ```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 types
|
||||||
|
|
||||||
|
12
docs/build/html/_sources/cli.run.md.txt
vendored
Normal file
12
docs/build/html/_sources/cli.run.md.txt
vendored
Normal file
@ -0,0 +1,12 @@
|
|||||||
|
# cpl run
|
||||||
|
|
||||||
|
Starts your application once.
|
||||||
|
|
||||||
|
cpl **run** <br>
|
||||||
|
cpl **r** <br>
|
||||||
|
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``` |
|
4
docs/build/html/_sources/cli.start.md.txt
vendored
4
docs/build/html/_sources/cli.start.md.txt
vendored
@ -5,3 +5,7 @@ Starts your application, restarting on file changes.
|
|||||||
cpl **start** <br>
|
cpl **start** <br>
|
||||||
cpl **s** <br>
|
cpl **s** <br>
|
||||||
cpl **S**
|
cpl **S**
|
||||||
|
|
||||||
|
| Argument | Description | Value type |
|
||||||
|
|-----------------|:----------------------------------------------------------------------------------------------------:|:----------:|
|
||||||
|
| ```--dev``` | To run the project from source and not from dist after build. | ```str``` |
|
6
docs/build/html/_sources/contributing.md.txt
vendored
6
docs/build/html/_sources/contributing.md.txt
vendored
@ -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.
|
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:
|
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
|
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
|
### Reviewing a Pull Request
|
||||||
|
|
||||||
@ -104,7 +104,7 @@ To ensure consistency throughout the source code, keep these rules in mind as yo
|
|||||||
## License
|
## License
|
||||||
|
|
||||||
By contributing, you agree that your contributions will be licensed under its MIT 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)
|
||||||
|
|
||||||
<!-- LINKS -->
|
<!-- LINKS -->
|
||||||
[gitea-repo]: https://git.sh-edraft.de/sh-edraft.de/sh_cpl/
|
[gitea-repo]: https://git.sh-edraft.de/sh-edraft.de/sh_cpl/
|
||||||
|
2
docs/build/html/_sources/cpl_cli.rst.txt
vendored
2
docs/build/html/_sources/cpl_cli.rst.txt
vendored
@ -1,4 +1,4 @@
|
|||||||
CLI Reference
|
CLI reference
|
||||||
=============
|
=============
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
|
@ -7,8 +7,7 @@ cpl_core.database
|
|||||||
cpl_core.database.connection
|
cpl_core.database.connection
|
||||||
cpl_core.database.context
|
cpl_core.database.context
|
||||||
|
|
||||||
Submodules
|
|
||||||
----------
|
|
||||||
|
|
||||||
cpl_core.database.database\_model
|
cpl_core.database.database\_model
|
||||||
-----------------------------------
|
-----------------------------------
|
||||||
|
27
docs/build/html/_sources/cpl_core.pipes.rst.txt
vendored
27
docs/build/html/_sources/cpl_core.pipes.rst.txt
vendored
@ -1,10 +1,9 @@
|
|||||||
cpl\_core.pipes
|
cpl\_core.pipes
|
||||||
=======================
|
=======================
|
||||||
|
|
||||||
Submodules
|
|
||||||
----------
|
|
||||||
|
|
||||||
cpl\_core.pipes.bool\_pipe module
|
|
||||||
|
cpl\_core.pipes.bool\_pipe
|
||||||
---------------------------------
|
---------------------------------
|
||||||
|
|
||||||
.. automodule:: cpl_core.pipes.bool_pipe
|
.. automodule:: cpl_core.pipes.bool_pipe
|
||||||
@ -12,7 +11,7 @@ cpl\_core.pipes.bool\_pipe module
|
|||||||
:undoc-members:
|
:undoc-members:
|
||||||
:show-inheritance:
|
: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
|
.. automodule:: cpl_core.pipes.first_char_to_lower_pipe
|
||||||
@ -20,7 +19,7 @@ cpl\_core.pipes.first\_char\_to\_lower\_pipe module
|
|||||||
:undoc-members:
|
:undoc-members:
|
||||||
:show-inheritance:
|
: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
|
.. automodule:: cpl_core.pipes.first_to_upper_pipe
|
||||||
@ -28,7 +27,7 @@ cpl\_core.pipes.first\_to\_upper\_pipe module
|
|||||||
:undoc-members:
|
:undoc-members:
|
||||||
:show-inheritance:
|
:show-inheritance:
|
||||||
|
|
||||||
cpl\_core.pipes.ip\_address\_pipe module
|
cpl\_core.pipes.ip\_address\_pipe
|
||||||
----------------------------------------
|
----------------------------------------
|
||||||
|
|
||||||
.. automodule:: 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:
|
:undoc-members:
|
||||||
:show-inheritance:
|
:show-inheritance:
|
||||||
|
|
||||||
cpl\_core.pipes.pipe\_abc module
|
cpl\_core.pipes.pipe\_abc
|
||||||
--------------------------------
|
--------------------------------
|
||||||
|
|
||||||
.. automodule:: cpl_core.pipes.pipe_abc
|
.. automodule:: cpl_core.pipes.pipe_abc
|
||||||
@ -44,7 +43,7 @@ cpl\_core.pipes.pipe\_abc module
|
|||||||
:undoc-members:
|
:undoc-members:
|
||||||
:show-inheritance:
|
: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
|
.. automodule:: cpl_core.pipes.to_camel_case_pipe
|
||||||
@ -52,7 +51,7 @@ cpl\_core.pipes.to\_camel\_case\_pipe module
|
|||||||
:undoc-members:
|
:undoc-members:
|
||||||
:show-inheritance:
|
: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
|
.. automodule:: cpl_core.pipes.to_snake_case_pipe
|
||||||
@ -60,18 +59,10 @@ cpl\_core.pipes.to\_snake\_case\_pipe module
|
|||||||
:undoc-members:
|
:undoc-members:
|
||||||
:show-inheritance:
|
:show-inheritance:
|
||||||
|
|
||||||
cpl\_core.pipes.version\_pipe module
|
cpl\_core.pipes.version\_pipe
|
||||||
------------------------------------
|
------------------------------------
|
||||||
|
|
||||||
.. automodule:: cpl_core.pipes.version_pipe
|
.. automodule:: cpl_core.pipes.version_pipe
|
||||||
:members:
|
:members:
|
||||||
:undoc-members:
|
:undoc-members:
|
||||||
:show-inheritance:
|
:show-inheritance:
|
||||||
|
|
||||||
Module contents
|
|
||||||
---------------
|
|
||||||
|
|
||||||
.. automodule:: cpl_core.pipes
|
|
||||||
:members:
|
|
||||||
:undoc-members:
|
|
||||||
:show-inheritance:
|
|
||||||
|
2
docs/build/html/_sources/cpl_core.rst.txt
vendored
2
docs/build/html/_sources/cpl_core.rst.txt
vendored
@ -1,4 +1,4 @@
|
|||||||
API Reference
|
API reference
|
||||||
===========
|
===========
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
|
12
docs/build/html/_sources/cpl_discord.application.rst.txt
vendored
Normal file
12
docs/build/html/_sources/cpl_discord.application.rst.txt
vendored
Normal file
@ -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:
|
20
docs/build/html/_sources/cpl_discord.command.rst.txt
vendored
Normal file
20
docs/build/html/_sources/cpl_discord.command.rst.txt
vendored
Normal file
@ -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:
|
12
docs/build/html/_sources/cpl_discord.configuration.rst.txt
vendored
Normal file
12
docs/build/html/_sources/cpl_discord.configuration.rst.txt
vendored
Normal file
@ -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:
|
68
docs/build/html/_sources/cpl_discord.container.rst.txt
vendored
Normal file
68
docs/build/html/_sources/cpl_discord.container.rst.txt
vendored
Normal file
@ -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:
|
412
docs/build/html/_sources/cpl_discord.events.rst.txt
vendored
Normal file
412
docs/build/html/_sources/cpl_discord.events.rst.txt
vendored
Normal file
@ -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:
|
12
docs/build/html/_sources/cpl_discord.helper.rst.txt
vendored
Normal file
12
docs/build/html/_sources/cpl_discord.helper.rst.txt
vendored
Normal file
@ -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:
|
13
docs/build/html/_sources/cpl_discord.rst.txt
vendored
Normal file
13
docs/build/html/_sources/cpl_discord.rst.txt
vendored
Normal file
@ -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
|
60
docs/build/html/_sources/cpl_discord.service.rst.txt
vendored
Normal file
60
docs/build/html/_sources/cpl_discord.service.rst.txt
vendored
Normal file
@ -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:
|
52
docs/build/html/_sources/cpl_query.base.rst.txt
vendored
Normal file
52
docs/build/html/_sources/cpl_query.base.rst.txt
vendored
Normal file
@ -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:
|
20
docs/build/html/_sources/cpl_query.enumerable.rst.txt
vendored
Normal file
20
docs/build/html/_sources/cpl_query.enumerable.rst.txt
vendored
Normal file
@ -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:
|
@ -1,10 +0,0 @@
|
|||||||
cpl_query.exceptions
|
|
||||||
=================================
|
|
||||||
|
|
||||||
cpl_query.exceptions
|
|
||||||
----------------------------------------------------
|
|
||||||
|
|
||||||
.. automodule:: cpl_query.exceptions
|
|
||||||
:members:
|
|
||||||
:undoc-members:
|
|
||||||
:show-inheritance:
|
|
@ -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
|
cpl\_query.extension.list
|
||||||
----------------------------------------------------
|
--------------------------------
|
||||||
|
|
||||||
.. automodule:: cpl_query.extension.iterable
|
|
||||||
:members:
|
|
||||||
:undoc-members:
|
|
||||||
:show-inheritance:
|
|
||||||
|
|
||||||
cpl_query.extension.list
|
|
||||||
----------------------------------------------------
|
|
||||||
|
|
||||||
.. automodule:: cpl_query.extension.list
|
.. automodule:: cpl_query.extension.list
|
||||||
:members:
|
:members:
|
||||||
:undoc-members:
|
:undoc-members:
|
||||||
:show-inheritance:
|
: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:
|
|
20
docs/build/html/_sources/cpl_query.iterable.rst.txt
vendored
Normal file
20
docs/build/html/_sources/cpl_query.iterable.rst.txt
vendored
Normal file
@ -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:
|
6
docs/build/html/_sources/cpl_query.rst.txt
vendored
6
docs/build/html/_sources/cpl_query.rst.txt
vendored
@ -1,8 +1,10 @@
|
|||||||
Query Reference
|
Query reference
|
||||||
===========
|
===========
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 4
|
:maxdepth: 4
|
||||||
|
|
||||||
|
cpl_query.base
|
||||||
|
cpl_query.enumerable
|
||||||
cpl_query.extension
|
cpl_query.extension
|
||||||
cpl_query.exceptions
|
cpl_query.iterable
|
||||||
|
34
docs/build/html/_sources/cpl_translation.rst.txt
vendored
Normal file
34
docs/build/html/_sources/cpl_translation.rst.txt
vendored
Normal file
@ -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:
|
2
docs/build/html/_sources/index.rst.txt
vendored
2
docs/build/html/_sources/index.rst.txt
vendored
@ -89,4 +89,6 @@ These pages go into great detail about everything the Library can do.
|
|||||||
contributing
|
contributing
|
||||||
cpl_cli
|
cpl_cli
|
||||||
cpl_core
|
cpl_core
|
||||||
|
cpl_discord
|
||||||
cpl_query
|
cpl_query
|
||||||
|
cpl_translation
|
||||||
|
2
docs/build/html/_sources/modules.rst.txt
vendored
2
docs/build/html/_sources/modules.rst.txt
vendored
@ -9,4 +9,4 @@ cpl
|
|||||||
cpl_core
|
cpl_core
|
||||||
cpl_discord
|
cpl_discord
|
||||||
cpl_query
|
cpl_query
|
||||||
cpl_translate
|
cpl_translation
|
||||||
|
6
docs/build/html/_sources/setup.md.txt
vendored
6
docs/build/html/_sources/setup.md.txt
vendored
@ -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:
|
To install the package, open a terminal window and run the following command:
|
||||||
|
|
||||||
```sh
|
```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
|
## 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:
|
To install the CLI, open a terminal window and run the following command:
|
||||||
|
|
||||||
```sh
|
```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
|
## 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:
|
To install the package, open a terminal window and run the following command:
|
||||||
|
|
||||||
```sh
|
```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
|
## Create initial console app
|
||||||
|
@ -1,3 +1,3 @@
|
|||||||
# Using appsettings.json
|
# Using appsettings.json
|
||||||
|
|
||||||
## Comming soon
|
## Coming soon
|
@ -1,3 +1,3 @@
|
|||||||
# Handle console arguments
|
# Handle console arguments
|
||||||
|
|
||||||
## Comming soon
|
## Coming soon
|
@ -1,3 +1,3 @@
|
|||||||
# Use cpl_core.console.Console
|
# Use cpl_core.console.Console
|
||||||
|
|
||||||
## Comming soon
|
## Coming soon
|
@ -1,3 +1,3 @@
|
|||||||
# Create startup class
|
# Create startup class
|
||||||
|
|
||||||
## Comming soon
|
## Coming soon
|
@ -1,3 +1,3 @@
|
|||||||
# Extend application
|
# Extend application
|
||||||
|
|
||||||
## Comming soon
|
## Coming soon
|
@ -1,3 +1,3 @@
|
|||||||
# Extend startup
|
# Extend startup
|
||||||
|
|
||||||
## Comming soon
|
## Coming soon
|
@ -1,3 +1,3 @@
|
|||||||
# Use builtin logger
|
# Use builtin logger
|
||||||
|
|
||||||
## Comming soon
|
## Coming soon
|
@ -1,3 +1,3 @@
|
|||||||
# Send mails
|
# Send mails
|
||||||
|
|
||||||
## Comming soon
|
## Coming soon
|
1
docs/build/html/_sources/tutorials.rst.txt
vendored
1
docs/build/html/_sources/tutorials.rst.txt
vendored
@ -12,3 +12,4 @@ Tutorials
|
|||||||
tutorials.console
|
tutorials.console
|
||||||
tutorials.logging
|
tutorials.logging
|
||||||
tutorials.mail
|
tutorials.mail
|
||||||
|
tutorials.templating
|
181
docs/build/html/_sources/tutorials.templating.md.txt
vendored
Normal file
181
docs/build/html/_sources/tutorials.templating.md.txt
vendored
Normal file
@ -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)
|
||||||
|
```
|
12
docs/build/html/cli.add.html
vendored
12
docs/build/html/cli.add.html
vendored
@ -42,7 +42,7 @@
|
|||||||
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI Reference</a><ul class="current">
|
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI reference</a><ul class="current">
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li>
|
||||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl add</a><ul>
|
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl add</a><ul>
|
||||||
<li class="toctree-l3"><a class="reference internal" href="#contents">Contents</a></li>
|
<li class="toctree-l3"><a class="reference internal" href="#contents">Contents</a></li>
|
||||||
@ -64,8 +64,10 @@
|
|||||||
<li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -82,7 +84,7 @@
|
|||||||
<div role="navigation" aria-label="Page navigation">
|
<div role="navigation" aria-label="Page navigation">
|
||||||
<ul class="wy-breadcrumbs">
|
<ul class="wy-breadcrumbs">
|
||||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||||
<li><a href="cpl_cli.html">CLI Reference</a> »</li>
|
<li><a href="cpl_cli.html">CLI reference</a> »</li>
|
||||||
<li>cpl add</li>
|
<li>cpl add</li>
|
||||||
<li class="wy-breadcrumbs-aside">
|
<li class="wy-breadcrumbs-aside">
|
||||||
<a href="_sources/cli.add.md.txt" rel="nofollow"> View page source</a>
|
<a href="_sources/cli.add.md.txt" rel="nofollow"> View page source</a>
|
||||||
@ -161,7 +163,7 @@ cpl <strong>A</strong> <em><source-project></em> <em><target-project>
|
|||||||
<hr/>
|
<hr/>
|
||||||
|
|
||||||
<div role="contentinfo">
|
<div role="contentinfo">
|
||||||
<p>© Copyright 2021, Sven Heidemann.</p>
|
<p>© Copyright 2021 - 2023, Sven Heidemann.</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||||
|
12
docs/build/html/cli.build.html
vendored
12
docs/build/html/cli.build.html
vendored
@ -42,7 +42,7 @@
|
|||||||
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI Reference</a><ul class="current">
|
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI reference</a><ul class="current">
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cli.add.html">cpl add</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.add.html">cpl add</a></li>
|
||||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl build</a><ul>
|
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl build</a><ul>
|
||||||
@ -62,8 +62,10 @@
|
|||||||
<li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -80,7 +82,7 @@
|
|||||||
<div role="navigation" aria-label="Page navigation">
|
<div role="navigation" aria-label="Page navigation">
|
||||||
<ul class="wy-breadcrumbs">
|
<ul class="wy-breadcrumbs">
|
||||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||||
<li><a href="cpl_cli.html">CLI Reference</a> »</li>
|
<li><a href="cpl_cli.html">CLI reference</a> »</li>
|
||||||
<li>cpl build</li>
|
<li>cpl build</li>
|
||||||
<li class="wy-breadcrumbs-aside">
|
<li class="wy-breadcrumbs-aside">
|
||||||
<a href="_sources/cli.build.md.txt" rel="nofollow"> View page source</a>
|
<a href="_sources/cli.build.md.txt" rel="nofollow"> View page source</a>
|
||||||
@ -128,7 +130,7 @@ cpl <strong>B</strong></p>
|
|||||||
<hr/>
|
<hr/>
|
||||||
|
|
||||||
<div role="contentinfo">
|
<div role="contentinfo">
|
||||||
<p>© Copyright 2021, Sven Heidemann.</p>
|
<p>© Copyright 2021 - 2023, Sven Heidemann.</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||||
|
25
docs/build/html/cli.generate.html
vendored
25
docs/build/html/cli.generate.html
vendored
@ -42,7 +42,7 @@
|
|||||||
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI Reference</a><ul class="current">
|
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI reference</a><ul class="current">
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cli.add.html">cpl add</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.add.html">cpl add</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cli.build.html">cpl build</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.build.html">cpl build</a></li>
|
||||||
@ -64,8 +64,10 @@
|
|||||||
<li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -82,7 +84,7 @@
|
|||||||
<div role="navigation" aria-label="Page navigation">
|
<div role="navigation" aria-label="Page navigation">
|
||||||
<ul class="wy-breadcrumbs">
|
<ul class="wy-breadcrumbs">
|
||||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||||
<li><a href="cpl_cli.html">CLI Reference</a> »</li>
|
<li><a href="cpl_cli.html">CLI reference</a> »</li>
|
||||||
<li>cpl generate</li>
|
<li>cpl generate</li>
|
||||||
<li class="wy-breadcrumbs-aside">
|
<li class="wy-breadcrumbs-aside">
|
||||||
<a href="_sources/cli.generate.md.txt" rel="nofollow"> View page source</a>
|
<a href="_sources/cli.generate.md.txt" rel="nofollow"> View page source</a>
|
||||||
@ -110,6 +112,7 @@ cpl <strong>G</strong> <em><schematic></em> <em><name></em></p>
|
|||||||
<section id="description">
|
<section id="description">
|
||||||
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
|
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
|
||||||
<p>Generates files based on a schematic.</p>
|
<p>Generates files based on a schematic.</p>
|
||||||
|
<p>You can define custom schematics by creating templates in a <code class="docutils literal notranslate"><span class="pre">.cpl</span></code> folder.</p>
|
||||||
</section>
|
</section>
|
||||||
<section id="arguments">
|
<section id="arguments">
|
||||||
<h2>Arguments<a class="headerlink" href="#arguments" title="Permalink to this heading"></a></h2>
|
<h2>Arguments<a class="headerlink" href="#arguments" title="Permalink to this heading"></a></h2>
|
||||||
@ -129,6 +132,10 @@ cpl <strong>G</strong> <em><schematic></em> <em><name></em></p>
|
|||||||
<td class="text-center"><p>The name of the generated file.</p></td>
|
<td class="text-center"><p>The name of the generated file.</p></td>
|
||||||
<td class="text-center"><p><code class="docutils literal notranslate"><span class="pre">str</span></code></p></td>
|
<td class="text-center"><p><code class="docutils literal notranslate"><span class="pre">str</span></code></p></td>
|
||||||
</tr>
|
</tr>
|
||||||
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">--base</span></code></p></td>
|
||||||
|
<td class="text-center"><p>First element of path will be used as base-path not ‘src’. For example: ‘cpl g c test/Test’ will be created at <code class="docutils literal notranslate"><span class="pre">src/test/</span></code> with –base it would be <code class="docutils literal notranslate"><span class="pre">test/</span></code></p></td>
|
||||||
|
<td class="text-center"><p><code class="docutils literal notranslate"><span class="pre">str</span></code></p></td>
|
||||||
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
</section>
|
</section>
|
||||||
@ -178,6 +185,14 @@ cpl <strong>G</strong> <em><schematic></em> <em><name></em></p>
|
|||||||
<td class="text-center"><p>Validator class</p></td>
|
<td class="text-center"><p>Validator class</p></td>
|
||||||
<td class="text-center"><p><code class="docutils literal notranslate"><span class="pre"><name></span></code></p></td>
|
<td class="text-center"><p><code class="docutils literal notranslate"><span class="pre"><name></span></code></p></td>
|
||||||
</tr>
|
</tr>
|
||||||
|
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">command</span></code></p></td>
|
||||||
|
<td class="text-center"><p>Discord bot command class</p></td>
|
||||||
|
<td class="text-center"><p><code class="docutils literal notranslate"><span class="pre"><name></span></code></p></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">event</span></code></p></td>
|
||||||
|
<td class="text-center"><p>Discord bot event class</p></td>
|
||||||
|
<td class="text-center"><p><code class="docutils literal notranslate"><span class="pre"><name></span></code></p></td>
|
||||||
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
</section>
|
</section>
|
||||||
@ -194,7 +209,7 @@ cpl <strong>G</strong> <em><schematic></em> <em><name></em></p>
|
|||||||
<hr/>
|
<hr/>
|
||||||
|
|
||||||
<div role="contentinfo">
|
<div role="contentinfo">
|
||||||
<p>© Copyright 2021, Sven Heidemann.</p>
|
<p>© Copyright 2021 - 2023, Sven Heidemann.</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||||
|
12
docs/build/html/cli.help.html
vendored
12
docs/build/html/cli.help.html
vendored
@ -42,7 +42,7 @@
|
|||||||
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI Reference</a><ul class="current">
|
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI reference</a><ul class="current">
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cli.add.html">cpl add</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.add.html">cpl add</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cli.build.html">cpl build</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.build.html">cpl build</a></li>
|
||||||
@ -63,8 +63,10 @@
|
|||||||
<li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -81,7 +83,7 @@
|
|||||||
<div role="navigation" aria-label="Page navigation">
|
<div role="navigation" aria-label="Page navigation">
|
||||||
<ul class="wy-breadcrumbs">
|
<ul class="wy-breadcrumbs">
|
||||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||||
<li><a href="cpl_cli.html">CLI Reference</a> »</li>
|
<li><a href="cpl_cli.html">CLI reference</a> »</li>
|
||||||
<li>cpl help</li>
|
<li>cpl help</li>
|
||||||
<li class="wy-breadcrumbs-aside">
|
<li class="wy-breadcrumbs-aside">
|
||||||
<a href="_sources/cli.help.md.txt" rel="nofollow"> View page source</a>
|
<a href="_sources/cli.help.md.txt" rel="nofollow"> View page source</a>
|
||||||
@ -139,7 +141,7 @@ cpl <strong>H</strong> <em><command></em></p>
|
|||||||
<hr/>
|
<hr/>
|
||||||
|
|
||||||
<div role="contentinfo">
|
<div role="contentinfo">
|
||||||
<p>© Copyright 2021, Sven Heidemann.</p>
|
<p>© Copyright 2021 - 2023, Sven Heidemann.</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||||
|
12
docs/build/html/cli.install.html
vendored
12
docs/build/html/cli.install.html
vendored
@ -42,7 +42,7 @@
|
|||||||
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI Reference</a><ul class="current">
|
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI reference</a><ul class="current">
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cli.add.html">cpl add</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.add.html">cpl add</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cli.build.html">cpl build</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.build.html">cpl build</a></li>
|
||||||
@ -64,8 +64,10 @@
|
|||||||
<li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -82,7 +84,7 @@
|
|||||||
<div role="navigation" aria-label="Page navigation">
|
<div role="navigation" aria-label="Page navigation">
|
||||||
<ul class="wy-breadcrumbs">
|
<ul class="wy-breadcrumbs">
|
||||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||||
<li><a href="cpl_cli.html">CLI Reference</a> »</li>
|
<li><a href="cpl_cli.html">CLI reference</a> »</li>
|
||||||
<li>cpl install</li>
|
<li>cpl install</li>
|
||||||
<li class="wy-breadcrumbs-aside">
|
<li class="wy-breadcrumbs-aside">
|
||||||
<a href="_sources/cli.install.md.txt" rel="nofollow"> View page source</a>
|
<a href="_sources/cli.install.md.txt" rel="nofollow"> View page source</a>
|
||||||
@ -162,7 +164,7 @@ Without given package it will install the depedencies of the CPL project your in
|
|||||||
<hr/>
|
<hr/>
|
||||||
|
|
||||||
<div role="contentinfo">
|
<div role="contentinfo">
|
||||||
<p>© Copyright 2021, Sven Heidemann.</p>
|
<p>© Copyright 2021 - 2023, Sven Heidemann.</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||||
|
17
docs/build/html/cli.new.html
vendored
17
docs/build/html/cli.new.html
vendored
@ -42,7 +42,7 @@
|
|||||||
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI Reference</a><ul class="current">
|
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI reference</a><ul class="current">
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cli.add.html">cpl add</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.add.html">cpl add</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cli.build.html">cpl build</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.build.html">cpl build</a></li>
|
||||||
@ -64,8 +64,10 @@
|
|||||||
<li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -82,7 +84,7 @@
|
|||||||
<div role="navigation" aria-label="Page navigation">
|
<div role="navigation" aria-label="Page navigation">
|
||||||
<ul class="wy-breadcrumbs">
|
<ul class="wy-breadcrumbs">
|
||||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||||
<li><a href="cpl_cli.html">CLI Reference</a> »</li>
|
<li><a href="cpl_cli.html">CLI reference</a> »</li>
|
||||||
<li>cpl new</li>
|
<li>cpl new</li>
|
||||||
<li class="wy-breadcrumbs-aside">
|
<li class="wy-breadcrumbs-aside">
|
||||||
<a href="_sources/cli.new.md.txt" rel="nofollow"> View page source</a>
|
<a href="_sources/cli.new.md.txt" rel="nofollow"> View page source</a>
|
||||||
@ -110,6 +112,7 @@ cpl <strong>N</strong> <em><type></em> <em><name></em></p>
|
|||||||
<section id="description">
|
<section id="description">
|
||||||
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
|
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
|
||||||
<p>Generates a workspace and initial project or add a project to workspace.</p>
|
<p>Generates a workspace and initial project or add a project to workspace.</p>
|
||||||
|
<p>You can define custom project types by creating templates in a <code class="docutils literal notranslate"><span class="pre">.cpl</span></code> folder.</p>
|
||||||
<p>If the command is running in a CPL workspace, it will add the new project to the workspace.</p>
|
<p>If the command is running in a CPL workspace, it will add the new project to the workspace.</p>
|
||||||
<table class="colwidths-auto docutils align-default">
|
<table class="colwidths-auto docutils align-default">
|
||||||
<thead>
|
<thead>
|
||||||
@ -127,6 +130,10 @@ cpl <strong>N</strong> <em><type></em> <em><name></em></p>
|
|||||||
<td class="text-center"><p>The name of the project</p></td>
|
<td class="text-center"><p>The name of the project</p></td>
|
||||||
<td class="text-center"><p><code class="docutils literal notranslate"><span class="pre">str</span></code></p></td>
|
<td class="text-center"><p><code class="docutils literal notranslate"><span class="pre">str</span></code></p></td>
|
||||||
</tr>
|
</tr>
|
||||||
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">--base</span></code></p></td>
|
||||||
|
<td class="text-center"><p>First element of path will be used as base-path not ‘src’. For example: ‘cpl g c test/Test’ will be created at <code class="docutils literal notranslate"><span class="pre">src/test/</span></code> with –base it would be <code class="docutils literal notranslate"><span class="pre">test/</span></code></p></td>
|
||||||
|
<td class="text-center"><p><code class="docutils literal notranslate"><span class="pre">str</span></code></p></td>
|
||||||
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
</section>
|
</section>
|
||||||
@ -191,7 +198,7 @@ cpl <strong>N</strong> <em><type></em> <em><name></em></p>
|
|||||||
<hr/>
|
<hr/>
|
||||||
|
|
||||||
<div role="contentinfo">
|
<div role="contentinfo">
|
||||||
<p>© Copyright 2021, Sven Heidemann.</p>
|
<p>© Copyright 2021 - 2023, Sven Heidemann.</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||||
|
16
docs/build/html/cli.overview.html
vendored
16
docs/build/html/cli.overview.html
vendored
@ -20,7 +20,7 @@
|
|||||||
<link rel="index" title="Index" href="genindex.html" />
|
<link rel="index" title="Index" href="genindex.html" />
|
||||||
<link rel="search" title="Search" href="search.html" />
|
<link rel="search" title="Search" href="search.html" />
|
||||||
<link rel="next" title="cpl add" href="cli.add.html" />
|
<link rel="next" title="cpl add" href="cli.add.html" />
|
||||||
<link rel="prev" title="CLI Reference" href="cpl_cli.html" />
|
<link rel="prev" title="CLI reference" href="cpl_cli.html" />
|
||||||
</head>
|
</head>
|
||||||
|
|
||||||
<body class="wy-body-for-nav">
|
<body class="wy-body-for-nav">
|
||||||
@ -42,7 +42,7 @@
|
|||||||
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI Reference</a><ul class="current">
|
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI reference</a><ul class="current">
|
||||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">CLI Overview and Command Reference</a><ul>
|
<li class="toctree-l2 current"><a class="current reference internal" href="#">CLI Overview and Command Reference</a><ul>
|
||||||
<li class="toctree-l3"><a class="reference internal" href="#table-of-contents">Table of Contents</a></li>
|
<li class="toctree-l3"><a class="reference internal" href="#table-of-contents">Table of Contents</a></li>
|
||||||
<li class="toctree-l3"><a class="reference internal" href="#basic-workflow">Basic workflow</a></li>
|
<li class="toctree-l3"><a class="reference internal" href="#basic-workflow">Basic workflow</a></li>
|
||||||
@ -68,8 +68,10 @@
|
|||||||
<li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -86,7 +88,7 @@
|
|||||||
<div role="navigation" aria-label="Page navigation">
|
<div role="navigation" aria-label="Page navigation">
|
||||||
<ul class="wy-breadcrumbs">
|
<ul class="wy-breadcrumbs">
|
||||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||||
<li><a href="cpl_cli.html">CLI Reference</a> »</li>
|
<li><a href="cpl_cli.html">CLI reference</a> »</li>
|
||||||
<li>CLI Overview and Command Reference</li>
|
<li>CLI Overview and Command Reference</li>
|
||||||
<li class="wy-breadcrumbs-aside">
|
<li class="wy-breadcrumbs-aside">
|
||||||
<a href="_sources/cli.overview.md.txt" rel="nofollow"> View page source</a>
|
<a href="_sources/cli.overview.md.txt" rel="nofollow"> View page source</a>
|
||||||
@ -202,14 +204,14 @@ cpl start
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||||
<a href="cpl_cli.html" class="btn btn-neutral float-left" title="CLI Reference" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
<a href="cpl_cli.html" class="btn btn-neutral float-left" title="CLI reference" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||||
<a href="cli.add.html" class="btn btn-neutral float-right" title="cpl add" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
<a href="cli.add.html" class="btn btn-neutral float-right" title="cpl add" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<hr/>
|
<hr/>
|
||||||
|
|
||||||
<div role="contentinfo">
|
<div role="contentinfo">
|
||||||
<p>© Copyright 2021, Sven Heidemann.</p>
|
<p>© Copyright 2021 - 2023, Sven Heidemann.</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||||
|
12
docs/build/html/cli.publish.html
vendored
12
docs/build/html/cli.publish.html
vendored
@ -42,7 +42,7 @@
|
|||||||
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI Reference</a><ul class="current">
|
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI reference</a><ul class="current">
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cli.add.html">cpl add</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.add.html">cpl add</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cli.build.html">cpl build</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.build.html">cpl build</a></li>
|
||||||
@ -62,8 +62,10 @@
|
|||||||
<li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -80,7 +82,7 @@
|
|||||||
<div role="navigation" aria-label="Page navigation">
|
<div role="navigation" aria-label="Page navigation">
|
||||||
<ul class="wy-breadcrumbs">
|
<ul class="wy-breadcrumbs">
|
||||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||||
<li><a href="cpl_cli.html">CLI Reference</a> »</li>
|
<li><a href="cpl_cli.html">CLI reference</a> »</li>
|
||||||
<li>cpl publish</li>
|
<li>cpl publish</li>
|
||||||
<li class="wy-breadcrumbs-aside">
|
<li class="wy-breadcrumbs-aside">
|
||||||
<a href="_sources/cli.publish.md.txt" rel="nofollow"> View page source</a>
|
<a href="_sources/cli.publish.md.txt" rel="nofollow"> View page source</a>
|
||||||
@ -128,7 +130,7 @@ The command executes the <code class="docutils literal notranslate"><span class=
|
|||||||
<hr/>
|
<hr/>
|
||||||
|
|
||||||
<div role="contentinfo">
|
<div role="contentinfo">
|
||||||
<p>© Copyright 2021, Sven Heidemann.</p>
|
<p>© Copyright 2021 - 2023, Sven Heidemann.</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||||
|
12
docs/build/html/cli.remove.html
vendored
12
docs/build/html/cli.remove.html
vendored
@ -42,7 +42,7 @@
|
|||||||
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI Reference</a><ul class="current">
|
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI reference</a><ul class="current">
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cli.add.html">cpl add</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.add.html">cpl add</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cli.build.html">cpl build</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.build.html">cpl build</a></li>
|
||||||
@ -64,8 +64,10 @@
|
|||||||
<li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -82,7 +84,7 @@
|
|||||||
<div role="navigation" aria-label="Page navigation">
|
<div role="navigation" aria-label="Page navigation">
|
||||||
<ul class="wy-breadcrumbs">
|
<ul class="wy-breadcrumbs">
|
||||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||||
<li><a href="cpl_cli.html">CLI Reference</a> »</li>
|
<li><a href="cpl_cli.html">CLI reference</a> »</li>
|
||||||
<li>cpl remove</li>
|
<li>cpl remove</li>
|
||||||
<li class="wy-breadcrumbs-aside">
|
<li class="wy-breadcrumbs-aside">
|
||||||
<a href="_sources/cli.remove.md.txt" rel="nofollow"> View page source</a>
|
<a href="_sources/cli.remove.md.txt" rel="nofollow"> View page source</a>
|
||||||
@ -156,7 +158,7 @@ cpl <strong>R</strong> <em><project></em></p>
|
|||||||
<hr/>
|
<hr/>
|
||||||
|
|
||||||
<div role="contentinfo">
|
<div role="contentinfo">
|
||||||
<p>© Copyright 2021, Sven Heidemann.</p>
|
<p>© Copyright 2021 - 2023, Sven Heidemann.</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||||
|
128
docs/build/html/cli.run.html
vendored
Normal file
128
docs/build/html/cli.run.html
vendored
Normal file
@ -0,0 +1,128 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html class="writer-html5" lang="en" >
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||||
|
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||||
|
<title>cpl run — Common Python Library documentation</title>
|
||||||
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||||
|
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||||
|
<!--[if lt IE 9]>
|
||||||
|
<script src="_static/js/html5shiv.min.js"></script>
|
||||||
|
<![endif]-->
|
||||||
|
|
||||||
|
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||||
|
<script src="_static/jquery.js"></script>
|
||||||
|
<script src="_static/underscore.js"></script>
|
||||||
|
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||||
|
<script src="_static/doctools.js"></script>
|
||||||
|
<script src="_static/js/theme.js"></script>
|
||||||
|
<link rel="index" title="Index" href="genindex.html" />
|
||||||
|
<link rel="search" title="Search" href="search.html" />
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body class="wy-body-for-nav">
|
||||||
|
<div class="wy-grid-for-nav">
|
||||||
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||||
|
<div class="wy-side-scroll">
|
||||||
|
<div class="wy-side-nav-search" >
|
||||||
|
<a href="index.html" class="icon icon-home"> Common Python Library
|
||||||
|
</a>
|
||||||
|
<div role="search">
|
||||||
|
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||||||
|
<input type="text" name="q" placeholder="Search docs" />
|
||||||
|
<input type="hidden" name="check_keywords" value="yes" />
|
||||||
|
<input type="hidden" name="area" value="default" />
|
||||||
|
</form>
|
||||||
|
</div>
|
||||||
|
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||||||
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||||
|
<a href="index.html">Common Python Library</a>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
<div class="wy-nav-content">
|
||||||
|
<div class="rst-content">
|
||||||
|
<div role="navigation" aria-label="Page navigation">
|
||||||
|
<ul class="wy-breadcrumbs">
|
||||||
|
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||||
|
<li>cpl run</li>
|
||||||
|
<li class="wy-breadcrumbs-aside">
|
||||||
|
<a href="_sources/cli.run.md.txt" rel="nofollow"> View page source</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<hr/>
|
||||||
|
</div>
|
||||||
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||||
|
<div itemprop="articleBody">
|
||||||
|
|
||||||
|
<section id="cpl-run">
|
||||||
|
<h1>cpl run<a class="headerlink" href="#cpl-run" title="Permalink to this heading"></a></h1>
|
||||||
|
<p>Starts your application once.</p>
|
||||||
|
<p>cpl <strong>run</strong> <br>
|
||||||
|
cpl <strong>r</strong> <br>
|
||||||
|
cpl <strong>R</strong></p>
|
||||||
|
<table class="colwidths-auto docutils align-default">
|
||||||
|
<thead>
|
||||||
|
<tr class="row-odd"><th class="head"><p>Argument</p></th>
|
||||||
|
<th class="text-center head"><p>Description</p></th>
|
||||||
|
<th class="text-center head"><p>Value type</p></th>
|
||||||
|
</tr>
|
||||||
|
</thead>
|
||||||
|
<tbody>
|
||||||
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre"><project></span></code></p></td>
|
||||||
|
<td class="text-center"><p>Optional parameter to specify which project to start, if not set default project will be started.</p></td>
|
||||||
|
<td class="text-center"><p><code class="docutils literal notranslate"><span class="pre">str</span></code></p></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">--dev</span></code></p></td>
|
||||||
|
<td class="text-center"><p>To run the project from source and not from dist after build.</p></td>
|
||||||
|
<td class="text-center"><p><code class="docutils literal notranslate"><span class="pre">str</span></code></p></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<footer>
|
||||||
|
|
||||||
|
<hr/>
|
||||||
|
|
||||||
|
<div role="contentinfo">
|
||||||
|
<p>© Copyright 2021 - 2023, Sven Heidemann.</p>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||||
|
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||||
|
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||||
|
|
||||||
|
|
||||||
|
</footer>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
|
</div>
|
||||||
|
<script>
|
||||||
|
jQuery(function () {
|
||||||
|
SphinxRtdTheme.Navigation.enable(true);
|
||||||
|
});
|
||||||
|
</script>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
26
docs/build/html/cli.start.html
vendored
26
docs/build/html/cli.start.html
vendored
@ -42,7 +42,7 @@
|
|||||||
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI Reference</a><ul class="current">
|
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI reference</a><ul class="current">
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cli.add.html">cpl add</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.add.html">cpl add</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cli.build.html">cpl build</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.build.html">cpl build</a></li>
|
||||||
@ -58,8 +58,10 @@
|
|||||||
<li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -76,7 +78,7 @@
|
|||||||
<div role="navigation" aria-label="Page navigation">
|
<div role="navigation" aria-label="Page navigation">
|
||||||
<ul class="wy-breadcrumbs">
|
<ul class="wy-breadcrumbs">
|
||||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||||
<li><a href="cpl_cli.html">CLI Reference</a> »</li>
|
<li><a href="cpl_cli.html">CLI reference</a> »</li>
|
||||||
<li>cpl start</li>
|
<li>cpl start</li>
|
||||||
<li class="wy-breadcrumbs-aside">
|
<li class="wy-breadcrumbs-aside">
|
||||||
<a href="_sources/cli.start.md.txt" rel="nofollow"> View page source</a>
|
<a href="_sources/cli.start.md.txt" rel="nofollow"> View page source</a>
|
||||||
@ -93,6 +95,20 @@
|
|||||||
<p>cpl <strong>start</strong> <br>
|
<p>cpl <strong>start</strong> <br>
|
||||||
cpl <strong>s</strong> <br>
|
cpl <strong>s</strong> <br>
|
||||||
cpl <strong>S</strong></p>
|
cpl <strong>S</strong></p>
|
||||||
|
<table class="colwidths-auto docutils align-default">
|
||||||
|
<thead>
|
||||||
|
<tr class="row-odd"><th class="head"><p>Argument</p></th>
|
||||||
|
<th class="text-center head"><p>Description</p></th>
|
||||||
|
<th class="text-center head"><p>Value type</p></th>
|
||||||
|
</tr>
|
||||||
|
</thead>
|
||||||
|
<tbody>
|
||||||
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">--dev</span></code></p></td>
|
||||||
|
<td class="text-center"><p>To run the project from source and not from dist after build.</p></td>
|
||||||
|
<td class="text-center"><p><code class="docutils literal notranslate"><span class="pre">str</span></code></p></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
</section>
|
</section>
|
||||||
|
|
||||||
|
|
||||||
@ -106,7 +122,7 @@ cpl <strong>S</strong></p>
|
|||||||
<hr/>
|
<hr/>
|
||||||
|
|
||||||
<div role="contentinfo">
|
<div role="contentinfo">
|
||||||
<p>© Copyright 2021, Sven Heidemann.</p>
|
<p>© Copyright 2021 - 2023, Sven Heidemann.</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||||
|
12
docs/build/html/cli.uninstall.html
vendored
12
docs/build/html/cli.uninstall.html
vendored
@ -42,7 +42,7 @@
|
|||||||
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI Reference</a><ul class="current">
|
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI reference</a><ul class="current">
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cli.add.html">cpl add</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.add.html">cpl add</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cli.build.html">cpl build</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.build.html">cpl build</a></li>
|
||||||
@ -64,8 +64,10 @@
|
|||||||
<li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -82,7 +84,7 @@
|
|||||||
<div role="navigation" aria-label="Page navigation">
|
<div role="navigation" aria-label="Page navigation">
|
||||||
<ul class="wy-breadcrumbs">
|
<ul class="wy-breadcrumbs">
|
||||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||||
<li><a href="cpl_cli.html">CLI Reference</a> »</li>
|
<li><a href="cpl_cli.html">CLI reference</a> »</li>
|
||||||
<li>cpl uninstall</li>
|
<li>cpl uninstall</li>
|
||||||
<li class="wy-breadcrumbs-aside">
|
<li class="wy-breadcrumbs-aside">
|
||||||
<a href="_sources/cli.uninstall.md.txt" rel="nofollow"> View page source</a>
|
<a href="_sources/cli.uninstall.md.txt" rel="nofollow"> View page source</a>
|
||||||
@ -161,7 +163,7 @@ cpl <strong>UI</strong> <em><package></em></p>
|
|||||||
<hr/>
|
<hr/>
|
||||||
|
|
||||||
<div role="contentinfo">
|
<div role="contentinfo">
|
||||||
<p>© Copyright 2021, Sven Heidemann.</p>
|
<p>© Copyright 2021 - 2023, Sven Heidemann.</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||||
|
12
docs/build/html/cli.update.html
vendored
12
docs/build/html/cli.update.html
vendored
@ -42,7 +42,7 @@
|
|||||||
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI Reference</a><ul class="current">
|
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI reference</a><ul class="current">
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cli.add.html">cpl add</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.add.html">cpl add</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cli.build.html">cpl build</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.build.html">cpl build</a></li>
|
||||||
@ -61,8 +61,10 @@
|
|||||||
<li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -79,7 +81,7 @@
|
|||||||
<div role="navigation" aria-label="Page navigation">
|
<div role="navigation" aria-label="Page navigation">
|
||||||
<ul class="wy-breadcrumbs">
|
<ul class="wy-breadcrumbs">
|
||||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||||
<li><a href="cpl_cli.html">CLI Reference</a> »</li>
|
<li><a href="cpl_cli.html">CLI reference</a> »</li>
|
||||||
<li>cpl update</li>
|
<li>cpl update</li>
|
||||||
<li class="wy-breadcrumbs-aside">
|
<li class="wy-breadcrumbs-aside">
|
||||||
<a href="_sources/cli.update.md.txt" rel="nofollow"> View page source</a>
|
<a href="_sources/cli.update.md.txt" rel="nofollow"> View page source</a>
|
||||||
@ -124,7 +126,7 @@ cpl <strong>U</strong></p>
|
|||||||
<hr/>
|
<hr/>
|
||||||
|
|
||||||
<div role="contentinfo">
|
<div role="contentinfo">
|
||||||
<p>© Copyright 2021, Sven Heidemann.</p>
|
<p>© Copyright 2021 - 2023, Sven Heidemann.</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||||
|
16
docs/build/html/cli.version.html
vendored
16
docs/build/html/cli.version.html
vendored
@ -19,7 +19,7 @@
|
|||||||
<script src="_static/js/theme.js"></script>
|
<script src="_static/js/theme.js"></script>
|
||||||
<link rel="index" title="Index" href="genindex.html" />
|
<link rel="index" title="Index" href="genindex.html" />
|
||||||
<link rel="search" title="Search" href="search.html" />
|
<link rel="search" title="Search" href="search.html" />
|
||||||
<link rel="next" title="API Reference" href="cpl_core.html" />
|
<link rel="next" title="API reference" href="cpl_core.html" />
|
||||||
<link rel="prev" title="cpl update" href="cli.update.html" />
|
<link rel="prev" title="cpl update" href="cli.update.html" />
|
||||||
</head>
|
</head>
|
||||||
|
|
||||||
@ -42,7 +42,7 @@
|
|||||||
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI Reference</a><ul class="current">
|
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI reference</a><ul class="current">
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cli.add.html">cpl add</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.add.html">cpl add</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cli.build.html">cpl build</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.build.html">cpl build</a></li>
|
||||||
@ -58,8 +58,10 @@
|
|||||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl version</a></li>
|
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl version</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -76,7 +78,7 @@
|
|||||||
<div role="navigation" aria-label="Page navigation">
|
<div role="navigation" aria-label="Page navigation">
|
||||||
<ul class="wy-breadcrumbs">
|
<ul class="wy-breadcrumbs">
|
||||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||||
<li><a href="cpl_cli.html">CLI Reference</a> »</li>
|
<li><a href="cpl_cli.html">CLI reference</a> »</li>
|
||||||
<li>cpl version</li>
|
<li>cpl version</li>
|
||||||
<li class="wy-breadcrumbs-aside">
|
<li class="wy-breadcrumbs-aside">
|
||||||
<a href="_sources/cli.version.md.txt" rel="nofollow"> View page source</a>
|
<a href="_sources/cli.version.md.txt" rel="nofollow"> View page source</a>
|
||||||
@ -100,13 +102,13 @@ cpl <strong>V</strong></p>
|
|||||||
</div>
|
</div>
|
||||||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||||
<a href="cli.update.html" class="btn btn-neutral float-left" title="cpl update" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
<a href="cli.update.html" class="btn btn-neutral float-left" title="cpl update" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||||
<a href="cpl_core.html" class="btn btn-neutral float-right" title="API Reference" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
<a href="cpl_core.html" class="btn btn-neutral float-right" title="API reference" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<hr/>
|
<hr/>
|
||||||
|
|
||||||
<div role="contentinfo">
|
<div role="contentinfo">
|
||||||
<p>© Copyright 2021, Sven Heidemann.</p>
|
<p>© Copyright 2021 - 2023, Sven Heidemann.</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||||
|
24
docs/build/html/contributing.html
vendored
24
docs/build/html/contributing.html
vendored
@ -19,8 +19,8 @@
|
|||||||
<script src="_static/js/theme.js"></script>
|
<script src="_static/js/theme.js"></script>
|
||||||
<link rel="index" title="Index" href="genindex.html" />
|
<link rel="index" title="Index" href="genindex.html" />
|
||||||
<link rel="search" title="Search" href="search.html" />
|
<link rel="search" title="Search" href="search.html" />
|
||||||
<link rel="next" title="CLI Reference" href="cpl_cli.html" />
|
<link rel="next" title="CLI reference" href="cpl_cli.html" />
|
||||||
<link rel="prev" title="Send mails" href="tutorials.mail.html" />
|
<link rel="prev" title="Using cpl g & cpl n templating" href="tutorials.templating.html" />
|
||||||
</head>
|
</head>
|
||||||
|
|
||||||
<body class="wy-body-for-nav">
|
<body class="wy-body-for-nav">
|
||||||
@ -57,9 +57,11 @@
|
|||||||
<li class="toctree-l2"><a class="reference internal" href="#license">License</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="#license">License</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -123,7 +125,7 @@
|
|||||||
<ol class="arabic">
|
<ol class="arabic">
|
||||||
<li><p>Search the <a class="reference external" href="https://git.sh-edraft.de/sh-edraft.de/sh_cpl/">repository</a> for an open or closed PR that relates to your submission. You don’t want to duplicate existing efforts.</p></li>
|
<li><p>Search the <a class="reference external" href="https://git.sh-edraft.de/sh-edraft.de/sh_cpl/">repository</a> for an open or closed PR that relates to your submission. You don’t want to duplicate existing efforts.</p></li>
|
||||||
<li><p>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.</p></li>
|
<li><p>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.</p></li>
|
||||||
<li><p>Fork the sh-edraft.de/sh_cpl repo.</p></li>
|
<li><p>Fork the sh-edraft.de/cpl repo.</p></li>
|
||||||
<li><p>In your forked repository, make your changes in a new git branch:</p>
|
<li><p>In your forked repository, make your changes in a new git branch:</p>
|
||||||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>git checkout -b my-fix-branch master
|
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>git checkout -b my-fix-branch master
|
||||||
</pre></div>
|
</pre></div>
|
||||||
@ -144,7 +146,7 @@
|
|||||||
</pre></div>
|
</pre></div>
|
||||||
</div>
|
</div>
|
||||||
</li>
|
</li>
|
||||||
<li><p>In Gitea, send a pull request to sh_cpl:master</p></li>
|
<li><p>In Gitea, send a pull request to cpl:master</p></li>
|
||||||
</ol>
|
</ol>
|
||||||
</section>
|
</section>
|
||||||
<section id="reviewing-a-pull-request">
|
<section id="reviewing-a-pull-request">
|
||||||
@ -178,7 +180,7 @@ git push
|
|||||||
<section id="license">
|
<section id="license">
|
||||||
<h2>License<a class="headerlink" href="#license" title="Permalink to this heading"></a></h2>
|
<h2>License<a class="headerlink" href="#license" title="Permalink to this heading"></a></h2>
|
||||||
<p>By contributing, you agree that your contributions will be licensed under its MIT License.
|
<p>By contributing, you agree that your contributions will be licensed under its MIT License.
|
||||||
See <a class="reference external" href="https://git.sh-edraft.de/sh-edraft.de/sh_cpl/src/branch/master/LICENSE">LICENSE</a></p>
|
See <a class="reference external" href="https://git.sh-edraft.de/sh-edraft.de/cpl/src/branch/master/LICENSE">LICENSE</a></p>
|
||||||
<!-- LINKS -->
|
<!-- LINKS -->
|
||||||
</section>
|
</section>
|
||||||
</section>
|
</section>
|
||||||
@ -187,14 +189,14 @@ See <a class="reference external" href="https://git.sh-edraft.de/sh-edraft.de/sh
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||||
<a href="tutorials.mail.html" class="btn btn-neutral float-left" title="Send mails" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
<a href="tutorials.templating.html" class="btn btn-neutral float-left" title="Using cpl g & cpl n templating" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||||
<a href="cpl_cli.html" class="btn btn-neutral float-right" title="CLI Reference" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
<a href="cpl_cli.html" class="btn btn-neutral float-right" title="CLI reference" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<hr/>
|
<hr/>
|
||||||
|
|
||||||
<div role="contentinfo">
|
<div role="contentinfo">
|
||||||
<p>© Copyright 2021, Sven Heidemann.</p>
|
<p>© Copyright 2021 - 2023, Sven Heidemann.</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||||
|
16
docs/build/html/cpl_cli.html
vendored
16
docs/build/html/cpl_cli.html
vendored
@ -4,7 +4,7 @@
|
|||||||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||||
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||||
<title>CLI Reference — Common Python Library documentation</title>
|
<title>CLI reference — Common Python Library documentation</title>
|
||||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||||
<!--[if lt IE 9]>
|
<!--[if lt IE 9]>
|
||||||
@ -42,7 +42,7 @@
|
|||||||
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">CLI Reference</a><ul>
|
<li class="toctree-l1 current"><a class="current reference internal" href="#">CLI reference</a><ul>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cli.add.html">cpl add</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.add.html">cpl add</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cli.build.html">cpl build</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.build.html">cpl build</a></li>
|
||||||
@ -58,8 +58,10 @@
|
|||||||
<li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -76,7 +78,7 @@
|
|||||||
<div role="navigation" aria-label="Page navigation">
|
<div role="navigation" aria-label="Page navigation">
|
||||||
<ul class="wy-breadcrumbs">
|
<ul class="wy-breadcrumbs">
|
||||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||||
<li>CLI Reference</li>
|
<li>CLI reference</li>
|
||||||
<li class="wy-breadcrumbs-aside">
|
<li class="wy-breadcrumbs-aside">
|
||||||
<a href="_sources/cpl_cli.rst.txt" rel="nofollow"> View page source</a>
|
<a href="_sources/cpl_cli.rst.txt" rel="nofollow"> View page source</a>
|
||||||
</li>
|
</li>
|
||||||
@ -87,7 +89,7 @@
|
|||||||
<div itemprop="articleBody">
|
<div itemprop="articleBody">
|
||||||
|
|
||||||
<section id="cli-reference">
|
<section id="cli-reference">
|
||||||
<h1>CLI Reference<a class="headerlink" href="#cli-reference" title="Permalink to this heading"></a></h1>
|
<h1>CLI reference<a class="headerlink" href="#cli-reference" title="Permalink to this heading"></a></h1>
|
||||||
<div class="toctree-wrapper compound">
|
<div class="toctree-wrapper compound">
|
||||||
<ul>
|
<ul>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a><ul>
|
<li class="toctree-l1"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a><ul>
|
||||||
@ -180,7 +182,7 @@
|
|||||||
<hr/>
|
<hr/>
|
||||||
|
|
||||||
<div role="contentinfo">
|
<div role="contentinfo">
|
||||||
<p>© Copyright 2021, Sven Heidemann.</p>
|
<p>© Copyright 2021 - 2023, Sven Heidemann.</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||||
|
20
docs/build/html/cpl_core.application.html
vendored
20
docs/build/html/cpl_core.application.html
vendored
@ -20,7 +20,7 @@
|
|||||||
<link rel="index" title="Index" href="genindex.html" />
|
<link rel="index" title="Index" href="genindex.html" />
|
||||||
<link rel="search" title="Search" href="search.html" />
|
<link rel="search" title="Search" href="search.html" />
|
||||||
<link rel="next" title="cpl_core.configuration" href="cpl_core.configuration.html" />
|
<link rel="next" title="cpl_core.configuration" href="cpl_core.configuration.html" />
|
||||||
<link rel="prev" title="API Reference" href="cpl_core.html" />
|
<link rel="prev" title="API reference" href="cpl_core.html" />
|
||||||
</head>
|
</head>
|
||||||
|
|
||||||
<body class="wy-body-for-nav">
|
<body class="wy-body-for-nav">
|
||||||
@ -42,8 +42,8 @@
|
|||||||
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
|
||||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_core.html">API Reference</a><ul class="current">
|
<li class="toctree-l1 current"><a class="reference internal" href="cpl_core.html">API reference</a><ul class="current">
|
||||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl_core.application</a><ul>
|
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl_core.application</a><ul>
|
||||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.application.application_abc">cpl_core.application.application_abc</a></li>
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.application.application_abc">cpl_core.application.application_abc</a></li>
|
||||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.application.application_builder">cpl_core.application.application_builder</a></li>
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.application.application_builder">cpl_core.application.application_builder</a></li>
|
||||||
@ -63,7 +63,9 @@
|
|||||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.utils.html">cpl_core.utils</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cpl_core.utils.html">cpl_core.utils</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -80,7 +82,7 @@
|
|||||||
<div role="navigation" aria-label="Page navigation">
|
<div role="navigation" aria-label="Page navigation">
|
||||||
<ul class="wy-breadcrumbs">
|
<ul class="wy-breadcrumbs">
|
||||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||||
<li><a href="cpl_core.html">API Reference</a> »</li>
|
<li><a href="cpl_core.html">API reference</a> »</li>
|
||||||
<li>cpl_core.application</li>
|
<li>cpl_core.application</li>
|
||||||
<li class="wy-breadcrumbs-aside">
|
<li class="wy-breadcrumbs-aside">
|
||||||
<a href="_sources/cpl_core.application.rst.txt" rel="nofollow"> View page source</a>
|
<a href="_sources/cpl_core.application.rst.txt" rel="nofollow"> View page source</a>
|
||||||
@ -172,12 +174,12 @@
|
|||||||
|
|
||||||
<dl class="py method">
|
<dl class="py method">
|
||||||
<dt class="sig sig-object py" id="cpl_core.application.application_builder.ApplicationBuilder.use_extension">
|
<dt class="sig sig-object py" id="cpl_core.application.application_builder.ApplicationBuilder.use_extension">
|
||||||
<span class="sig-name descname"><span class="pre">use_extension</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">extension</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">ApplicationExtensionABC</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">StartupExtensionABC</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.application.application_builder.ApplicationBuilder.use_extension" title="Permalink to this definition"></a></dt>
|
<span class="sig-name descname"><span class="pre">use_extension</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">extension</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">ApplicationExtensionABC</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">StartupExtensionABC</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_core.application.application_builder.ApplicationBuilder" title="cpl_core.application.application_builder.ApplicationBuilder"><span class="pre">ApplicationBuilder</span></a></span></span><a class="headerlink" href="#cpl_core.application.application_builder.ApplicationBuilder.use_extension" title="Permalink to this definition"></a></dt>
|
||||||
<dd></dd></dl>
|
<dd></dd></dl>
|
||||||
|
|
||||||
<dl class="py method">
|
<dl class="py method">
|
||||||
<dt class="sig sig-object py" id="cpl_core.application.application_builder.ApplicationBuilder.use_startup">
|
<dt class="sig sig-object py" id="cpl_core.application.application_builder.ApplicationBuilder.use_startup">
|
||||||
<span class="sig-name descname"><span class="pre">use_startup</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">startup</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cpl_core.application.startup_abc.StartupABC" title="cpl_core.application.startup_abc.StartupABC"><span class="pre">StartupABC</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.application.application_builder.ApplicationBuilder.use_startup" title="Permalink to this definition"></a></dt>
|
<span class="sig-name descname"><span class="pre">use_startup</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">startup</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cpl_core.application.startup_abc.StartupABC" title="cpl_core.application.startup_abc.StartupABC"><span class="pre">StartupABC</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_core.application.application_builder.ApplicationBuilder" title="cpl_core.application.application_builder.ApplicationBuilder"><span class="pre">ApplicationBuilder</span></a></span></span><a class="headerlink" href="#cpl_core.application.application_builder.ApplicationBuilder.use_startup" title="Permalink to this definition"></a></dt>
|
||||||
<dd><p>Sets the custom startup class to use async</p>
|
<dd><p>Sets the custom startup class to use async</p>
|
||||||
<blockquote>
|
<blockquote>
|
||||||
<div><dl class="simple">
|
<div><dl class="simple">
|
||||||
@ -272,14 +274,14 @@ env: <a class="reference internal" href="cpl_core.environment.html#module-cpl_co
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||||
<a href="cpl_core.html" class="btn btn-neutral float-left" title="API Reference" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
<a href="cpl_core.html" class="btn btn-neutral float-left" title="API reference" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||||
<a href="cpl_core.configuration.html" class="btn btn-neutral float-right" title="cpl_core.configuration" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
<a href="cpl_core.configuration.html" class="btn btn-neutral float-right" title="cpl_core.configuration" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<hr/>
|
<hr/>
|
||||||
|
|
||||||
<div role="contentinfo">
|
<div role="contentinfo">
|
||||||
<p>© Copyright 2021, Sven Heidemann.</p>
|
<p>© Copyright 2021 - 2023, Sven Heidemann.</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||||
|
24
docs/build/html/cpl_core.configuration.html
vendored
24
docs/build/html/cpl_core.configuration.html
vendored
@ -42,8 +42,8 @@
|
|||||||
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
|
||||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_core.html">API Reference</a><ul class="current">
|
<li class="toctree-l1 current"><a class="reference internal" href="cpl_core.html">API reference</a><ul class="current">
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.application.html">cpl_core.application</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cpl_core.application.html">cpl_core.application</a></li>
|
||||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl_core.configuration</a><ul>
|
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl_core.configuration</a><ul>
|
||||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.configuration.configuration">cpl_core.configuration.configuration</a></li>
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.configuration.configuration">cpl_core.configuration.configuration</a></li>
|
||||||
@ -64,7 +64,9 @@
|
|||||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.utils.html">cpl_core.utils</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cpl_core.utils.html">cpl_core.utils</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -81,7 +83,7 @@
|
|||||||
<div role="navigation" aria-label="Page navigation">
|
<div role="navigation" aria-label="Page navigation">
|
||||||
<ul class="wy-breadcrumbs">
|
<ul class="wy-breadcrumbs">
|
||||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||||
<li><a href="cpl_core.html">API Reference</a> »</li>
|
<li><a href="cpl_core.html">API reference</a> »</li>
|
||||||
<li>cpl_core.configuration</li>
|
<li>cpl_core.configuration</li>
|
||||||
<li class="wy-breadcrumbs-aside">
|
<li class="wy-breadcrumbs-aside">
|
||||||
<a href="_sources/cpl_core.configuration.rst.txt" rel="nofollow"> View page source</a>
|
<a href="_sources/cpl_core.configuration.rst.txt" rel="nofollow"> View page source</a>
|
||||||
@ -102,13 +104,13 @@
|
|||||||
<dd><p>Bases: <a class="reference internal" href="#cpl_core.configuration.configuration_abc.ConfigurationABC" title="cpl_core.configuration.configuration_abc.ConfigurationABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">ConfigurationABC</span></code></a></p>
|
<dd><p>Bases: <a class="reference internal" href="#cpl_core.configuration.configuration_abc.ConfigurationABC" title="cpl_core.configuration.configuration_abc.ConfigurationABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">ConfigurationABC</span></code></a></p>
|
||||||
<dl class="py method">
|
<dl class="py method">
|
||||||
<dt class="sig sig-object py" id="cpl_core.configuration.configuration.Configuration.add_configuration">
|
<dt class="sig sig-object py" id="cpl_core.configuration.configuration.Configuration.add_configuration">
|
||||||
<span class="sig-name descname"><span class="pre">add_configuration</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">type</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="#cpl_core.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl_core.configuration.configuration_model_abc.ConfigurationModelABC"><span class="pre">ConfigurationModelABC</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.configuration.Configuration.add_configuration" title="Permalink to this definition"></a></dt>
|
<span class="sig-name descname"><span class="pre">add_configuration</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">type</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">any</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.configuration.Configuration.add_configuration" title="Permalink to this definition"></a></dt>
|
||||||
<dd><p>Add configuration object</p>
|
<dd><p>Add configuration object</p>
|
||||||
<blockquote>
|
<blockquote>
|
||||||
<div><dl class="simple">
|
<div><dl class="simple">
|
||||||
<dt>key_type: Union[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">type</span></code>]</dt><dd><p>Type of the value</p>
|
<dt>key_type: Union[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">type</span></code>]</dt><dd><p>Type of the value</p>
|
||||||
</dd>
|
</dd>
|
||||||
<dt>value: Union[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#cpl_core.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl_core.configuration.configuration_model_abc.ConfigurationModelABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.configuration.configuration_model_abc.ConfigurationModelABC</span></code></a>]</dt><dd><p>Object of the value</p>
|
<dt>value: any</dt><dd><p>Object of the value</p>
|
||||||
</dd>
|
</dd>
|
||||||
</dl>
|
</dl>
|
||||||
</div></blockquote>
|
</div></blockquote>
|
||||||
@ -215,7 +217,7 @@
|
|||||||
|
|
||||||
<dl class="py method">
|
<dl class="py method">
|
||||||
<dt class="sig sig-object py" id="cpl_core.configuration.configuration.Configuration.get_configuration">
|
<dt class="sig sig-object py" id="cpl_core.configuration.configuration.Configuration.get_configuration">
|
||||||
<span class="sig-name descname"><span class="pre">get_configuration</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">search_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cpl_core.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl_core.configuration.configuration_model_abc.ConfigurationModelABC"><span class="pre">ConfigurationModelABC</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="#cpl_core.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl_core.configuration.configuration_model_abc.ConfigurationModelABC"><span class="pre">ConfigurationModelABC</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#cpl_core.configuration.configuration.Configuration.get_configuration" title="Permalink to this definition"></a></dt>
|
<span class="sig-name descname"><span class="pre">get_configuration</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">search_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><span class="pre">T</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">T</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#cpl_core.configuration.configuration.Configuration.get_configuration" title="Permalink to this definition"></a></dt>
|
||||||
<dd><p>Returns value from configuration by given type</p>
|
<dd><p>Returns value from configuration by given type</p>
|
||||||
<blockquote>
|
<blockquote>
|
||||||
<div><dl class="simple">
|
<div><dl class="simple">
|
||||||
@ -254,13 +256,13 @@
|
|||||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
|
||||||
<dl class="py method">
|
<dl class="py method">
|
||||||
<dt class="sig sig-object py" id="cpl_core.configuration.configuration_abc.ConfigurationABC.add_configuration">
|
<dt class="sig sig-object py" id="cpl_core.configuration.configuration_abc.ConfigurationABC.add_configuration">
|
||||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">add_configuration</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">type</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="#cpl_core.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl_core.configuration.configuration_model_abc.ConfigurationModelABC"><span class="pre">ConfigurationModelABC</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.configuration_abc.ConfigurationABC.add_configuration" title="Permalink to this definition"></a></dt>
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">add_configuration</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">type</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">any</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.configuration_abc.ConfigurationABC.add_configuration" title="Permalink to this definition"></a></dt>
|
||||||
<dd><p>Add configuration object</p>
|
<dd><p>Add configuration object</p>
|
||||||
<blockquote>
|
<blockquote>
|
||||||
<div><dl class="simple">
|
<div><dl class="simple">
|
||||||
<dt>key_type: Union[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">type</span></code>]</dt><dd><p>Type of the value</p>
|
<dt>key_type: Union[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">type</span></code>]</dt><dd><p>Type of the value</p>
|
||||||
</dd>
|
</dd>
|
||||||
<dt>value: Union[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#cpl_core.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl_core.configuration.configuration_model_abc.ConfigurationModelABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.configuration.configuration_model_abc.ConfigurationModelABC</span></code></a>]</dt><dd><p>Object of the value</p>
|
<dt>value: any</dt><dd><p>Object of the value</p>
|
||||||
</dd>
|
</dd>
|
||||||
</dl>
|
</dl>
|
||||||
</div></blockquote>
|
</div></blockquote>
|
||||||
@ -367,7 +369,7 @@
|
|||||||
|
|
||||||
<dl class="py method">
|
<dl class="py method">
|
||||||
<dt class="sig sig-object py" id="cpl_core.configuration.configuration_abc.ConfigurationABC.get_configuration">
|
<dt class="sig sig-object py" id="cpl_core.configuration.configuration_abc.ConfigurationABC.get_configuration">
|
||||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_configuration</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">search_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cpl_core.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl_core.configuration.configuration_model_abc.ConfigurationModelABC"><span class="pre">ConfigurationModelABC</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="#cpl_core.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl_core.configuration.configuration_model_abc.ConfigurationModelABC"><span class="pre">ConfigurationModelABC</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#cpl_core.configuration.configuration_abc.ConfigurationABC.get_configuration" title="Permalink to this definition"></a></dt>
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_configuration</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">search_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cpl_core.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl_core.configuration.configuration_model_abc.ConfigurationModelABC"><span class="pre">ConfigurationModelABC</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">T</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#cpl_core.configuration.configuration_abc.ConfigurationABC.get_configuration" title="Permalink to this definition"></a></dt>
|
||||||
<dd><p>Returns value from configuration by given type</p>
|
<dd><p>Returns value from configuration by given type</p>
|
||||||
<blockquote>
|
<blockquote>
|
||||||
<div><dl class="simple">
|
<div><dl class="simple">
|
||||||
@ -462,7 +464,7 @@
|
|||||||
<hr/>
|
<hr/>
|
||||||
|
|
||||||
<div role="contentinfo">
|
<div role="contentinfo">
|
||||||
<p>© Copyright 2021, Sven Heidemann.</p>
|
<p>© Copyright 2021 - 2023, Sven Heidemann.</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||||
|
12
docs/build/html/cpl_core.console.html
vendored
12
docs/build/html/cpl_core.console.html
vendored
@ -42,8 +42,8 @@
|
|||||||
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
|
||||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_core.html">API Reference</a><ul class="current">
|
<li class="toctree-l1 current"><a class="reference internal" href="cpl_core.html">API reference</a><ul class="current">
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.application.html">cpl_core.application</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cpl_core.application.html">cpl_core.application</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.configuration.html">cpl_core.configuration</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cpl_core.configuration.html">cpl_core.configuration</a></li>
|
||||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl_core.console</a><ul>
|
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl_core.console</a><ul>
|
||||||
@ -64,7 +64,9 @@
|
|||||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.utils.html">cpl_core.utils</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cpl_core.utils.html">cpl_core.utils</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -81,7 +83,7 @@
|
|||||||
<div role="navigation" aria-label="Page navigation">
|
<div role="navigation" aria-label="Page navigation">
|
||||||
<ul class="wy-breadcrumbs">
|
<ul class="wy-breadcrumbs">
|
||||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||||
<li><a href="cpl_core.html">API Reference</a> »</li>
|
<li><a href="cpl_core.html">API reference</a> »</li>
|
||||||
<li>cpl_core.console</li>
|
<li>cpl_core.console</li>
|
||||||
<li class="wy-breadcrumbs-aside">
|
<li class="wy-breadcrumbs-aside">
|
||||||
<a href="_sources/cpl_core.console.rst.txt" rel="nofollow"> View page source</a>
|
<a href="_sources/cpl_core.console.rst.txt" rel="nofollow"> View page source</a>
|
||||||
@ -588,7 +590,7 @@ errors defaults to ‘strict’.</p>
|
|||||||
<hr/>
|
<hr/>
|
||||||
|
|
||||||
<div role="contentinfo">
|
<div role="contentinfo">
|
||||||
<p>© Copyright 2021, Sven Heidemann.</p>
|
<p>© Copyright 2021 - 2023, Sven Heidemann.</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||||
|
@ -42,8 +42,8 @@
|
|||||||
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
|
||||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_core.html">API Reference</a><ul class="current">
|
<li class="toctree-l1 current"><a class="reference internal" href="cpl_core.html">API reference</a><ul class="current">
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.application.html">cpl_core.application</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cpl_core.application.html">cpl_core.application</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.configuration.html">cpl_core.configuration</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cpl_core.configuration.html">cpl_core.configuration</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.console.html">cpl_core.console</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cpl_core.console.html">cpl_core.console</a></li>
|
||||||
@ -54,7 +54,6 @@
|
|||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.context.html">cpl_core.database.context</a></li>
|
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.context.html">cpl_core.database.context</a></li>
|
||||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.html#submodules">Submodules</a></li>
|
|
||||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.html#cpl-core-database-database-model">cpl_core.database.database_model</a></li>
|
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.html#cpl-core-database-database-model">cpl_core.database.database_model</a></li>
|
||||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.html#module-cpl_core.database.database_settings">cpl_core.database.database_settings</a></li>
|
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.html#module-cpl_core.database.database_settings">cpl_core.database.database_settings</a></li>
|
||||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.html#module-cpl_core.database.database_settings_name_enum">cpl_core.database.database_settings_name_enum</a></li>
|
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.html#module-cpl_core.database.database_settings_name_enum">cpl_core.database.database_settings_name_enum</a></li>
|
||||||
@ -69,7 +68,9 @@
|
|||||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.utils.html">cpl_core.utils</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cpl_core.utils.html">cpl_core.utils</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -86,7 +87,7 @@
|
|||||||
<div role="navigation" aria-label="Page navigation">
|
<div role="navigation" aria-label="Page navigation">
|
||||||
<ul class="wy-breadcrumbs">
|
<ul class="wy-breadcrumbs">
|
||||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||||
<li><a href="cpl_core.html">API Reference</a> »</li>
|
<li><a href="cpl_core.html">API reference</a> »</li>
|
||||||
<li><a href="cpl_core.database.html">cpl_core.database</a> »</li>
|
<li><a href="cpl_core.database.html">cpl_core.database</a> »</li>
|
||||||
<li>cpl_core.database.connection</li>
|
<li>cpl_core.database.connection</li>
|
||||||
<li class="wy-breadcrumbs-aside">
|
<li class="wy-breadcrumbs-aside">
|
||||||
@ -177,7 +178,7 @@
|
|||||||
<hr/>
|
<hr/>
|
||||||
|
|
||||||
<div role="contentinfo">
|
<div role="contentinfo">
|
||||||
<p>© Copyright 2021, Sven Heidemann.</p>
|
<p>© Copyright 2021 - 2023, Sven Heidemann.</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||||
|
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue
Block a user