166 Commits

Author SHA1 Message Date
b9e0b7ccd0 Build 2022.6.0.rc1 2022-06-27 20:55:44 +02:00
4b9e428abb Updated tools 2022-06-27 20:52:27 +02:00
63ad13e09a Improved version handling of set-version 2022-06-27 20:46:01 +02:00
cc06a308a1 Merge pull request '2022.6.10 - Dev dependencies' (#86) from 2022.6.10 into 2022.6
Reviewed-on: #86
Closes #71
2022-06-27 20:18:24 +02:00
e9fdd20181 Updated unittests 2022-06-27 20:16:37 +02:00
8692686cb5 Added dev-deps support to new command 2022-06-27 20:07:52 +02:00
db29ad36fe Added dev-deps support to cpl install without package 2022-06-27 20:05:34 +02:00
0710b25317 Added dev-dependencies to uninstall command 2022-06-27 20:04:19 +02:00
cbd2964f42 Added dev-dependencies to install command 2022-06-27 20:02:01 +02:00
f51118f13c Merge pull request '2022.6.2 - Venv support' (#85) from 2022.6.2 into 2022.6
Reviewed-on: #85
Closes #51
2022-06-27 11:52:17 +02:00
323e363b42 Improved venv support to all related commands 2022-06-27 11:50:22 +02:00
e8a4fe6142 Added venv support to install command 2022-06-27 10:52:26 +02:00
587d9b359c Merge pull request '2022.6.17 - Unittests' (#84) from 2022.6.17 into 2022.6
Reviewed-on: #84
2022-06-27 10:03:54 +02:00
c2632253ac Added tests for update command 2022-06-27 09:10:21 +02:00
45be77dd10 Added tests for version command 2022-06-26 19:51:18 +02:00
78ffbcc33d Readded all test cases 2022-06-26 01:07:10 +02:00
d83d1a244e Fixed for start command [WIP] output is needed 2022-06-26 01:05:45 +02:00
fa002a50ac Fixed for start command 2022-06-26 00:41:25 +02:00
32507afae9 Added tests for start command 2022-06-26 00:39:16 +02:00
6de3bbdaf4 Added tests for run command 2022-06-26 00:15:05 +02:00
6e50d0cb22 Added tests for publish command 2022-06-23 23:47:29 +02:00
9e978f3ece Fixed tests for un/install commands 2022-06-23 23:39:41 +02:00
32478926c8 Added tests for build command 2022-06-23 21:49:44 +02:00
2925788d01 Added tests for uninstall command 2022-06-21 09:24:56 +02:00
c0789cf4f7 Added tests for install command 2022-06-21 08:56:26 +02:00
89d591ce0a Added project reference handling in cpl remove 2022-06-04 00:36:31 +02:00
77c560b40c Improved cpl remove test 2022-06-03 23:46:03 +02:00
dad4913bcd Added cpl remove test 2022-06-03 23:44:26 +02:00
9b56650d4b Added cpl add test 2022-06-03 23:35:07 +02:00
9fca2018e5 Build dev10 2022-05-27 18:57:12 +02:00
e5dd890931 Improved unittest for cpl new & Fixed subdirectory handling with cpl new 2022-05-27 18:57:00 +02:00
beadbf8e91 Improved set-version to ignore skipped deps 2022-05-27 18:26:32 +02:00
ff5f9b833d Improved unittest for cpl new 2022-05-27 18:07:12 +02:00
162f06001a Build dev8 & improved cpl new unittests 2022-05-26 23:27:32 +02:00
348fad24c7 Build dev8 & improved set-version change handling 2022-05-26 23:27:20 +02:00
f9748cdb76 Improved gitignore 2022-05-26 23:03:18 +02:00
56380763a9 Improved unittests 2022-05-26 23:01:50 +02:00
3a1630b687 Added force option to set-version 2022-05-26 23:01:23 +02:00
a593f34cde Build dev7 2022-05-26 23:00:55 +02:00
49cce5fa1a Extended cpl new options 2022-05-26 22:52:03 +02:00
df7bd06629 Fixed additional argument & flag bug 2022-05-26 22:51:29 +02:00
e0da77fd4b Added new test condition for cpl new 2022-05-26 22:24:19 +02:00
833dd83008 Improved unittests & added tests for cpl new 2022-05-26 22:21:16 +02:00
ce0ad4013f [WIP] Improved unittest 2022-05-26 21:42:43 +02:00
698f80adfe Build dev6 2022-05-26 21:42:28 +02:00
d0b0f4bfcb Fixed set-version 2022-05-26 21:41:42 +02:00
d23ea86ccf Added logic to answer questions of new command dialog by flag arguments 2022-05-26 21:18:57 +02:00
15d938b172 Fixed handing of unregistered console arguments 2022-05-26 21:01:41 +02:00
6c1d7a3b29 Removed prints from CLITestSuite 2022-05-26 16:29:07 +02:00
c28f551682 Added skip message to set-version 2022-05-26 16:26:55 +02:00
def92c78c8 Added logic to change version only for projects with changes 2022-05-26 16:25:15 +02:00
ddff9dec11 Fixed install command 2022-05-26 16:08:37 +02:00
9e0e85d646 Fixed install command 2022-05-26 16:06:56 +02:00
b05ca7e980 Set dev version 2022-05-26 16:03:14 +02:00
8f8a9f7dd7 Moved query unittests 2022-05-26 15:53:23 +02:00
df32978a31 Moved unittests 2022-05-26 15:49:52 +02:00
79b51cf8c5 Build dev4 & added unittest support to console 2022-05-26 15:41:47 +02:00
a72dd0dc2e Improved tests 2022-05-26 15:29:49 +02:00
d937c4c0e6 Added tests for generate command 2022-05-26 14:47:36 +02:00
46cceb0910 Registered CLI test cases 2022-05-26 13:59:46 +02:00
e74e39c189 Added CLI command test cases 2022-05-26 13:49:31 +02:00
c2706c7737 Added unittest projects 2022-05-26 13:37:15 +02:00
d0e66d24bd Added logic to generate test cases 2022-05-26 13:17:58 +02:00
c1a1849ad2 Added logic to create new unittest project 2022-05-26 13:12:35 +02:00
0675105731 Merge pull request '2022.6.16 - Build-Tools' (#83) from 2022.6.16 into 2022.6
Reviewed-on: #83
Closes #82
2022-05-26 12:13:45 +02:00
7ee0b951a8 Rebuild & improved workspace scripts 2022-05-25 19:59:38 +02:00
d8168f024c Added logic to write PipPath & build dev2 2022-05-25 19:53:05 +02:00
2654dc7c69 Merge remote-tracking branch 'origin/2022.6.16' into 2022.6.16 2022-05-25 19:38:56 +02:00
4224960837 First dev build 2022-05-25 19:38:49 +02:00
907c3a8fff First dev build 2022-05-25 19:38:38 +02:00
28505479ba Added new project 2022-05-25 19:30:11 +02:00
84d3abce3f Merge pull request '2022.6.15 - set-version' (#81) from 2022.6.15 into 2022.6
Reviewed-on: #81
Closes #80
2022-05-25 19:10:35 +02:00
9050dffc53 Renamed projects && build dev6 2022-05-25 19:07:29 +02:00
e0f69c9bdf Fixed old naming of cpl_core 2022-05-25 18:56:08 +02:00
bbd0a60f98 Added functionality to set dependencies for all projects in workspace 2022-05-25 18:54:21 +02:00
e23f4187fe Added logic to add internal pipes in ServiceCollection 2022-05-25 18:42:47 +02:00
15f200df3a Added version pipe 2022-05-25 18:40:01 +02:00
a1a3ad6fb5 Build dev4 2022-05-25 17:09:31 +02:00
d6677d53a3 Added empty lines to generate output 2022-05-25 17:08:03 +02:00
07e43b50d1 Fixed generate pipe argument 2022-05-25 17:07:22 +02:00
ac83555b24 Added logic to handle cpl deps 2022-05-25 17:04:18 +02:00
1ab358059c Added more pre-build scripts 2022-05-25 16:57:21 +02:00
5bf83c0d77 Build dev2 2022-05-25 16:56:24 +02:00
03ac00c6e3 Bugfixes for set-version & CustomScriptService 2022-05-25 16:51:52 +02:00
0122d8fc78 Merge remote-tracking branch 'origin/2022.6.15' into 2022.6.15 2022-05-25 16:43:52 +02:00
a66ce96dbf Added set-version logic && Fixed CustomScriptService to handle arguments 2022-05-25 16:43:43 +02:00
6da8e30446 Added set-version logic && Fixed CustomScriptService to handle arguments 2022-05-25 16:43:28 +02:00
539ed13be4 Bugfixes for run service 2022-05-25 16:06:44 +02:00
036a553f64 Dev build 2022.6.15.dev1 2022-05-25 15:12:36 +02:00
976a14584b Dev build 2022.6.15.dev1 2022-05-25 15:12:30 +02:00
ed69f52927 Fixed generate service 2022-05-25 15:11:42 +02:00
98847495e6 Merge pull request '2022.6.14 - Pre & Post build scripts' (#79) from 2022.6.14 into 2022.6
Reviewed-on: #79
Closes #77
2022-05-25 14:15:24 +02:00
40f132da33 Added workspace scripts 2022-05-25 14:14:26 +02:00
5feb44595a Fixed cpl run command 2022-05-25 14:00:38 +02:00
48c6941f1a Added run command & tools/set-version project 2022-05-25 13:43:16 +02:00
a8756d493a Fixed error with RemoveService 2022-05-25 13:19:12 +02:00
9f4077a073 Improved configuration 2022-05-25 13:11:41 +02:00
3e7a3d75c5 Merge pull request 'cpl@2022.6.13 - cpl run command' (#78) from 2022.6.13 into 2022.6
Reviewed-on: #78
Closes #76
2022-05-25 08:42:41 +02:00
477d2d87d3 Added run command 2022-05-25 08:41:35 +02:00
7a65dbe39b Readded logic to handle pre and post scripts from workspace 2022-05-24 22:28:38 +02:00
f83755ac77 Removed console output & build new dev version 2022-05-24 20:20:42 +02:00
a590cfd066 Bugfixes for start service 2022-05-24 20:12:59 +02:00
f317035342 Bugfixes for test application & added validators to cli 2022-05-24 19:20:55 +02:00
8900bdd446 Removed invalid import && build for rc1 2022-05-24 18:20:31 +02:00
35ecf158a2 Fixed loading by base_type 2022-05-24 18:13:39 +02:00
353c1d30ec Merge pull request '2022.6.9 - Singleton initialisierung' (#75) from 2022.6.9 into 2022.6
Reviewed-on: #75
Closes #70
2022-05-24 17:52:13 +02:00
1c94fb5bd1 Added logic to load singletons when requested not when registered 2022-05-24 17:51:17 +02:00
cf305aeebb Merge pull request '2022.6.12 - Alle Umgebungsvariablen' (#74) from 2022.6.12 into 2022.6
Reviewed-on: #74
Closes #73
2022-05-24 17:39:20 +02:00
90e97433e0 Added logic to load all environment variables by prefix 2022-05-24 17:37:31 +02:00
125a85a0af Merge pull request '2022.6.7 - Pipes' (#69) from 2022.6.7 into 2022.6
Reviewed-on: #69
Closes #60
2022-05-22 20:28:46 +02:00
cfb8838c73 Added default pipes 2022-05-22 20:27:58 +02:00
824d491ebc Dev build projects 2022-05-22 18:49:31 +02:00
d694c408c0 Added CLI logic to generate pipes 2022-05-22 18:48:33 +02:00
d1bb266d49 Added Pipes 2022-05-22 18:43:10 +02:00
419fcc3d29 Merge pull request '2022.6.5 - CLI Erweiterung' (#68) from 2022.6.5 into 2022.6
Reviewed-on: #68
Closes #54
2022-05-22 18:34:44 +02:00
24ab6a51c1 Refactored executable arguments 2022-05-22 18:33:07 +02:00
dec4a45d98 Added logic to add CLI commands from external packages 2022-05-22 18:32:34 +02:00
d11c56db03 Merge pull request 'cpl@2022.6.3 - Verbesserung der Parameter' (#67) from 2022.6.3 into 2022.6
Reviewed-on: #67
2022-05-22 17:38:21 +02:00
fc23315cc7 Build version 2022.6.3 2022-05-22 17:35:38 +02:00
1f503fe20d Build new version 2022-05-20 10:37:43 +02:00
4564f7ac0e Improved output & imports 2022-05-20 10:35:47 +02:00
7b823e1141 Added validator generation 2022-05-20 10:34:09 +02:00
dac3d9c6bb Added validators (closes #59) 2022-05-20 10:27:55 +02:00
ccca904cb8 Smaller output fixes 2022-05-20 09:17:51 +02:00
c66a81c0ec Dev build & migrated custom scripts 2022-05-20 09:12:28 +02:00
fb810e2943 Dev build & migrated custom scripts & add logic to prevent next executable 2022-05-20 09:10:29 +02:00
5cc663dedc Migrated generate command 2022-05-20 08:50:50 +02:00
593372699b BUild dev version 2022-05-20 08:44:32 +02:00
1899cb5b86 Added scripts to workspace 2022-05-19 20:49:48 +02:00
0a285f2d28 Improved help command 2022-05-19 20:23:21 +02:00
94c82e6701 Improved help command 2022-05-19 20:21:46 +02:00
0d37c86061 Removed console output 2022-05-19 20:05:22 +02:00
6c8e9ccd89 Migrated StartService to new argument parsing 2022-05-19 20:04:29 +02:00
e7cf545502 Migrated NewService to new argument parsing 2022-05-19 19:52:36 +02:00
44182eec86 Fixed value handling for variable arguments 2022-05-19 19:41:02 +02:00
0f5b1b7586 Improved argument handling 2022-05-19 19:37:32 +02:00
4fe073580a Migrated first commands to new argument parser 2022-05-19 18:12:47 +02:00
2fed654c16 Improved argument handling 2022-05-19 18:09:25 +02:00
8ebd4864d3 Improved & added commands 2022-05-19 08:25:32 +02:00
a495532a4d Removed console debug outputs 2022-05-18 22:29:44 +02:00
d87ce72f07 Improved argument parsing 2022-05-18 22:26:11 +02:00
50201346e2 Added functions to define console arguments 2022-05-18 18:21:05 +02:00
773b154371 Improved service collection 2022-05-18 18:20:25 +02:00
5b59d1d384 Merge pull request '2022.6.4' (#58) from 2022.6.4 into 2022.6
Reviewed-on: #58
2022-04-30 18:33:54 +02:00
dcd8583183 Build packages 2022-04-30 17:44:15 +02:00
97e52b39c0 Added logic to handle StartupExtension classes 2022-04-30 17:43:34 +02:00
581013b61a Merge pull request '2022.6.1' (#57) from 2022.6.1 into 2022.6
Reviewed-on: #57
2022-04-30 17:16:49 +02:00
fd68d25a1d Updated to python3.10 2022-04-30 17:15:26 +02:00
588f93f7b1 Updated packages 2022-04-30 16:41:52 +02:00
96f402dcdd Updated packages 2022-04-30 16:33:30 +02:00
c1b7fca8d5 Moved from pyfiglet to art 2022-01-19 22:06:59 +01:00
2e4e7ccc57 Fixed minor issues with console & updated packages 2022-01-19 15:06:26 +01:00
ada3d133df Changed exit() to sys.exit() 2022-01-19 12:44:23 +01:00
61e7b9d684 Fixed cpl new command 2022-01-15 23:28:22 +01:00
24172c658c Fixed cpl new command 2022-01-15 22:16:17 +01:00
62ac976b99 Fixed where query typing 2022-01-15 11:11:14 +01:00
1f445a99b2 Fixed typing in count function of cpl_query 2022-01-08 18:09:03 +01:00
025286052b Fixed typing in service collection abc 2022-01-08 17:58:22 +01:00
32a856f8e8 Published new version 2021-12-07 16:07:21 +01:00
21f50f3b24 Fixed table_abc 2021-12-07 16:06:20 +01:00
ce77d41246 Build new docs 2021-12-02 08:20:38 +01:00
dec137220c Improved TableABC 2021-11-30 17:48:08 +01:00
01c7e155c3 Fixed typo 2021-11-30 15:24:01 +01:00
dcbcb67ce8 Fixed db connection 2021-11-30 15:01:28 +01:00
d57fd10718 Fixed add_db_context function 2021-11-30 14:14:34 +01:00
2b91db5d81 Removed unsued parameter 2021-11-30 14:05:52 +01:00
328 changed files with 14095 additions and 3484 deletions

4
.gitignore vendored
View File

@@ -106,6 +106,7 @@ celerybeat.pid
.venv
env/
venv/
venv_*/
ENV/
env.bak/
venv.bak/
@@ -134,3 +135,6 @@ dmypy.json
# IDE
.idea/
PythonImportHelper-v2-Completion.json
# cpl unittest stuff
unittests/test_*_playground

View File

@@ -1,4 +1,4 @@
MIT License Copyright (c) 2020 - 2021 sh-edraft.de
MIT License Copyright (c) 2020 - 2022 sh-edraft.de
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal

View File

@@ -1,13 +1,95 @@
{
"WorkspaceSettings": {
"DefaultProject": "cpl_cli",
"DefaultProject": "cpl-cli",
"Projects": {
"cpl_core": "src/cpl_core/cpl_core.json",
"cpl_cli": "src/cpl_cli/cpl_cli.json",
"cpl_query": "src/cpl_query/cpl_query.json"
"cpl-core": "src/cpl_core/cpl-core.json",
"cpl-cli": "src/cpl_cli/cpl-cli.json",
"cpl-query": "src/cpl_query/cpl-query.json",
"set-version": "tools/set_version/set-version.json",
"set-pip-urls": "tools/set_pip_urls/set-pip-urls.json",
"unittests": "unittests/unittests/unittests.json",
"unittests_cli": "unittests/unittests_cli/unittests_cli.json",
"unittests_core": "unittests/unittests_core/unittests_core.json",
"unittests_query": "unittests/unittests_query/unittests_query.json",
"unittests_shared": "unittests/unittests_shared/unittests_shared.json"
},
"Scripts": {
"hello-world": "echo 'Hello World'"
"hello-world": "echo 'Hello World'",
"sv": "cpl set-version",
"set-version": "cpl run set-version $ARGS; echo '';",
"spu": "cpl set-pip-urls",
"set-pip-urls": "cpl run set-pip-urls $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;",
"db": "cpl build-docs",
"docs-open": "xdg-open $PWD/docs/build/html/index.html &",
"do": "cpl docs-open",
"test": "cpl run unittests",
"pre-build-all": "cpl sv $ARGS; cpl spu $ARGS;",
"build-all": "cpl build-cli; cpl build-core; cpl build-query; cpl build-set-pip-urls; cpl build-set-version",
"ba": "cpl build-all $ARGS",
"build-cli": "echo 'Build cpl-cli'; cd ./src/cpl_cli; cpl build; cd ../../;",
"build-core": "echo 'Build cpl-core'; cd ./src/cpl_core; cpl build; cd ../../;",
"build-query": "echo 'Build cpl-query'; cd ./src/cpl_query; cpl build; cd ../../;",
"build-set-pip-urls": "echo 'Build set-pip-urls'; cd ./tools/set_pip_urls; cpl build; cd ../../;",
"build-set-version": "echo 'Build set-version'; cd ./tools/set_version; cpl build; cd ../../;",
"pre-publish-all": "cpl sv $ARGS; cpl spu $ARGS;",
"publish-all": "cpl publish-cli; cpl publish-core; cpl publish-query;",
"pa": "cpl build-all $ARGS",
"publish-cli": "echo 'Publish cpl-cli'; cd ./src/cpl_cli; cpl publish; cd ../../;",
"publish-core": "echo 'Publish cpl-core'; cd ./src/cpl_core; cpl publish; cd ../../;",
"publish-query": "echo 'Publish cpl_query'; cd ./src/cpl_query; cpl publish; cd ../../;",
"upload-prod-cli": "echo 'PROD Upload cpl-cli'; cpl upl-prod-cli;",
"upl-prod-cli": "twine upload -r pip.sh-edraft.de dist/cpl-cli/publish/setup/*",
"upload-prod-core": "echo 'PROD Upload cpl-core'; cpl upl-prod-core;",
"upl-prod-core": "twine upload -r pip.sh-edraft.de dist/cpl-core/publish/setup/*",
"upload-prod-query": "echo 'PROD Upload cpl_query'; cpl upl-prod-query;",
"upl-prod-query": "twine upload -r pip.sh-edraft.de dist/cpl-query/publish/setup/*",
"upload-exp-cli": "echo 'EXP Upload cpl-cli'; cpl upl-exp-cli;",
"upl-exp-cli": "twine upload -r pip-exp.sh-edraft.de dist/cpl-cli/publish/setup/*",
"upload-exp-core": "echo 'EXP Upload cpl-core'; cpl upl-exp-core;",
"upl-exp-core": "twine upload -r pip-exp.sh-edraft.de dist/cpl-core/publish/setup/*",
"upload-exp-query": "echo 'EXP Upload cpl_query'; cpl upl-exp-query;",
"upl-exp-query": "twine upload -r pip-exp.sh-edraft.de dist/cpl-query/publish/setup/*",
"upload-dev-cli": "echo 'DEV Upload cpl-cli'; cpl upl-dev-cli;",
"upl-dev-cli": "twine upload -r pip-dev.sh-edraft.de dist/cpl-cli/publish/setup/*",
"upload-dev-core": "echo 'DEV Upload cpl-core'; cpl upl-dev-core;",
"upl-dev-core": "twine upload -r pip-dev.sh-edraft.de dist/cpl-core/publish/setup/*",
"upload-dev-query": "echo 'DEV Upload cpl_query'; cpl upl-dev-query;",
"upl-dev-query": "twine upload -r pip-dev.sh-edraft.de dist/cpl-query/publish/setup/*",
"pre-deploy-prod": "cpl sv $ARGS; cpl spu --environment=production;",
"deploy-prod": "cpl deploy-prod-cli; cpl deploy-prod-core; cpl deploy-prod-query;",
"dp": "cpl deploy-prod $ARGS",
"deploy-prod-cli": "cpl publish-cli; cpl upload-prod-cli",
"deploy-prod-core": "cpl publish-core; cpl upload-prod-core",
"deploy-prod-query": "cpl publish-query; cpl upload-prod-query",
"pre-deploy-exp": "cpl sv $ARGS; cpl spu --environment=staging;",
"deploy-exp": "cpl deploy-exp-cli; cpl deploy-exp-core; cpl deploy-exp-query;",
"de": "cpl deploy-exp $ARGS",
"deploy-exp-cli": "cpl publish-cli; cpl upload-exp-cli",
"deploy-exp-core": "cpl publish-core; cpl upload-exp-core",
"deploy-exp-query": "cpl publish-query; cpl upload-exp-query",
"pre-deploy-dev": "cpl sv $ARGS; cpl spu --environment=development;",
"deploy-dev": "cpl deploy-dev-cli; cpl deploy-dev-core; cpl deploy-dev-query;",
"dd": "cpl deploy-dev $ARGS",
"deploy-dev-cli": "cpl publish-cli; cpl upload-dev-cli",
"deploy-dev-core": "cpl publish-core; cpl upload-dev-core",
"deploy-dev-query": "cpl publish-query; cpl upload-dev-query",
"dev-install": "cpl di-core; cpl di-cli; cpl di-query;",
"di": "cpl dev-install",
"di-core": "pip install cpl-query --pre --upgrade --extra-index-url https://pip-dev.sh-edraft.de",
"di-cli": "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"
}
}
}

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

View File

@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: e947378348368955f94cb62626664e15
config: 8170277cf12e5442e6180427108a8adf
tags: 645f666f9bcd5a90fca523b33c5a78b7

View File

@@ -5,6 +5,7 @@
1. [Prerequisites](#prerequisites)
2. [Install the package](#install-the-package)
3. [Install the CLI](#install-the-cli)
3. [Install the query](#install-the-query)
4. [Create a initial application](#create-initial-console-app)
5. [Create a initial library](#create-initial-library)
6. [Start the application](#start-the-app)
@@ -26,7 +27,7 @@ Also you need to have the following installed.
To install the package, open a terminal window and run the following command:
```sh
pip install sh_cpl --extra-index-url https://pip.sh-edraft.de
pip install sh_cpl-core --extra-index-url https://pip.sh-edraft.de
```
## Install the CLI
@@ -39,6 +40,14 @@ To install the CLI, open a terminal window and run the following command:
pip install sh_cpl-cli --extra-index-url https://pip.sh-edraft.de
```
## Install the query
To install the package, open a terminal window and run the following command:
```sh
pip install sh_cpl-query --extra-index-url https://pip.sh-edraft.de
```
## Create initial console app
You develop apps and packages in the context of an CPL project which is defined in an cpl_core.json.

View File

@@ -130,7 +130,7 @@ ul.search li a {
font-weight: bold;
}
ul.search li p.context {
ul.search li div.context {
color: #888;
margin: 2px 0 0 30px;
text-align: left;
@@ -277,25 +277,25 @@ p.rubric {
font-weight: bold;
}
img.align-left, figure.align-left, .figure.align-left, object.align-left {
img.align-left, .figure.align-left, object.align-left {
clear: left;
float: left;
margin-right: 1em;
}
img.align-right, figure.align-right, .figure.align-right, object.align-right {
img.align-right, .figure.align-right, object.align-right {
clear: right;
float: right;
margin-left: 1em;
}
img.align-center, figure.align-center, .figure.align-center, object.align-center {
img.align-center, .figure.align-center, object.align-center {
display: block;
margin-left: auto;
margin-right: auto;
}
img.align-default, figure.align-default, .figure.align-default {
img.align-default, .figure.align-default {
display: block;
margin-left: auto;
margin-right: auto;
@@ -319,8 +319,7 @@ img.align-default, figure.align-default, .figure.align-default {
/* -- sidebars -------------------------------------------------------------- */
div.sidebar,
aside.sidebar {
div.sidebar {
margin: 0 0 0.5em 1em;
border: 1px solid #ddb;
padding: 7px;
@@ -378,14 +377,12 @@ div.body p.centered {
/* -- content of sidebars/topics/admonitions -------------------------------- */
div.sidebar > :last-child,
aside.sidebar > :last-child,
div.topic > :last-child,
div.admonition > :last-child {
margin-bottom: 0;
}
div.sidebar::after,
aside.sidebar::after,
div.topic::after,
div.admonition::after,
blockquote::after {
@@ -458,22 +455,20 @@ td > :last-child {
/* -- figures --------------------------------------------------------------- */
div.figure, figure {
div.figure {
margin: 0.5em;
padding: 0.5em;
}
div.figure p.caption, figcaption {
div.figure p.caption {
padding: 0.3em;
}
div.figure p.caption span.caption-number,
figcaption span.caption-number {
div.figure p.caption span.caption-number {
font-style: italic;
}
div.figure p.caption span.caption-text,
figcaption span.caption-text {
div.figure p.caption span.caption-text {
}
/* -- field list styles ----------------------------------------------------- */
@@ -508,63 +503,6 @@ table.hlist td {
vertical-align: top;
}
/* -- object description styles --------------------------------------------- */
.sig {
font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace;
}
.sig-name, code.descname {
background-color: transparent;
font-weight: bold;
}
.sig-name {
font-size: 1.1em;
}
code.descname {
font-size: 1.2em;
}
.sig-prename, code.descclassname {
background-color: transparent;
}
.optional {
font-size: 1.3em;
}
.sig-paren {
font-size: larger;
}
.sig-param.n {
font-style: italic;
}
/* C++ specific styling */
.sig-inline.c-texpr,
.sig-inline.cpp-texpr {
font-family: unset;
}
.sig.c .k, .sig.c .kt,
.sig.cpp .k, .sig.cpp .kt {
color: #0033B3;
}
.sig.c .m,
.sig.cpp .m {
color: #1750EB;
}
.sig.c .s, .sig.c .sc,
.sig.cpp .s, .sig.cpp .sc {
color: #067D17;
}
/* -- other body styles ----------------------------------------------------- */
@@ -691,6 +629,14 @@ dl.glossary dt {
font-size: 1.1em;
}
.optional {
font-size: 1.3em;
}
.sig-paren {
font-size: larger;
}
.versionmodified {
font-style: italic;
}
@@ -819,12 +765,8 @@ div.code-block-caption code {
table.highlighttable td.linenos,
span.linenos,
div.highlight span.gp { /* gp: Generic.Prompt */
user-select: none;
-webkit-user-select: text; /* Safari fallback only */
-webkit-user-select: none; /* Chrome/Safari */
-moz-user-select: none; /* Firefox */
-ms-user-select: none; /* IE10+ */
div.doctest > div.highlight span.gp { /* gp: Generic.Prompt */
user-select: none;
}
div.code-block-caption span.caption-number {
@@ -839,6 +781,16 @@ div.literal-block-wrapper {
margin: 1em 0;
}
code.descname {
background-color: transparent;
font-weight: bold;
font-size: 1.2em;
}
code.descclassname {
background-color: transparent;
}
code.xref, a code {
background-color: transparent;
font-weight: bold;

File diff suppressed because one or more lines are too long

View File

@@ -301,14 +301,12 @@ var Documentation = {
window.location.href = prevHref;
return false;
}
break;
case 39: // right
var nextHref = $('link[rel="next"]').prop('href');
if (nextHref) {
window.location.href = nextHref;
return false;
}
break;
}
}
});

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

File diff suppressed because it is too large Load Diff

After

Width:  |  Height:  |  Size: 434 KiB

Binary file not shown.

Binary file not shown.

Binary file not shown.

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

View File

@@ -282,10 +282,7 @@ var Search = {
complete: function(jqxhr, textstatus) {
var data = jqxhr.responseText;
if (data !== '' && data !== undefined) {
var summary = Search.makeSearchSummary(data, searchterms, hlterms);
if (summary) {
listItem.append(summary);
}
listItem.append(Search.makeSearchSummary(data, searchterms, hlterms));
}
Search.output.append(listItem);
setTimeout(function() {
@@ -501,9 +498,6 @@ var Search = {
*/
makeSearchSummary : function(htmlText, keywords, hlwords) {
var text = Search.htmlToText(htmlText);
if (text == "") {
return null;
}
var textLower = text.toLowerCase();
var start = 0;
$.each(keywords, function() {
@@ -515,7 +509,7 @@ var Search = {
var excerpt = ((start > 0) ? '...' : '') +
$.trim(text.substr(start, 240)) +
((start + 240 - text.length) ? '...' : '');
var rv = $('<p class="context"></p>').text(excerpt);
var rv = $('<div class="context"></div>').text(excerpt);
$.each(hlwords, function() {
rv = rv.highlightText(this, 'highlighted');
});

View File

@@ -1,19 +1,19 @@
(function (global, factory) {
typeof exports === 'object' && typeof module !== 'undefined' ? module.exports = factory() :
typeof define === 'function' && define.amd ? define('underscore', factory) :
(global = typeof globalThis !== 'undefined' ? globalThis : global || self, (function () {
(global = global || self, (function () {
var current = global._;
var exports = global._ = factory();
exports.noConflict = function () { global._ = current; return exports; };
}()));
}(this, (function () {
// Underscore.js 1.13.1
// Underscore.js 1.12.0
// https://underscorejs.org
// (c) 2009-2021 Jeremy Ashkenas, Julian Gonggrijp, and DocumentCloud and Investigative Reporters & Editors
// (c) 2009-2020 Jeremy Ashkenas, DocumentCloud and Investigative Reporters & Editors
// Underscore may be freely distributed under the MIT license.
// Current version.
var VERSION = '1.13.1';
var VERSION = '1.12.0';
// Establish the root object, `window` (`self`) in the browser, `global`
// on the server, or `this` in some virtual machines. We use `self`
@@ -170,7 +170,7 @@
var isArray = nativeIsArray || tagTester('Array');
// Internal function to check whether `key` is an own property name of `obj`.
function has$1(obj, key) {
function has(obj, key) {
return obj != null && hasOwnProperty.call(obj, key);
}
@@ -181,7 +181,7 @@
(function() {
if (!isArguments(arguments)) {
isArguments = function(obj) {
return has$1(obj, 'callee');
return has(obj, 'callee');
};
}
}());
@@ -268,7 +268,7 @@
// Constructor is a special case.
var prop = 'constructor';
if (has$1(obj, prop) && !keys.contains(prop)) keys.push(prop);
if (has(obj, prop) && !keys.contains(prop)) keys.push(prop);
while (nonEnumIdx--) {
prop = nonEnumerableProps[nonEnumIdx];
@@ -284,7 +284,7 @@
if (!isObject(obj)) return [];
if (nativeKeys) return nativeKeys(obj);
var keys = [];
for (var key in obj) if (has$1(obj, key)) keys.push(key);
for (var key in obj) if (has(obj, key)) keys.push(key);
// Ahem, IE < 9.
if (hasEnumBug) collectNonEnumProps(obj, keys);
return keys;
@@ -318,24 +318,24 @@
// If Underscore is called as a function, it returns a wrapped object that can
// be used OO-style. This wrapper holds altered versions of all functions added
// through `_.mixin`. Wrapped objects may be chained.
function _$1(obj) {
if (obj instanceof _$1) return obj;
if (!(this instanceof _$1)) return new _$1(obj);
function _(obj) {
if (obj instanceof _) return obj;
if (!(this instanceof _)) return new _(obj);
this._wrapped = obj;
}
_$1.VERSION = VERSION;
_.VERSION = VERSION;
// Extracts the result from a wrapped and chained object.
_$1.prototype.value = function() {
_.prototype.value = function() {
return this._wrapped;
};
// Provide unwrapping proxies for some methods used in engine operations
// such as arithmetic and JSON stringification.
_$1.prototype.valueOf = _$1.prototype.toJSON = _$1.prototype.value;
_.prototype.valueOf = _.prototype.toJSON = _.prototype.value;
_$1.prototype.toString = function() {
_.prototype.toString = function() {
return String(this._wrapped);
};
@@ -370,8 +370,8 @@
// Internal recursive comparison function for `_.isEqual`.
function deepEq(a, b, aStack, bStack) {
// Unwrap any wrapped objects.
if (a instanceof _$1) a = a._wrapped;
if (b instanceof _$1) b = b._wrapped;
if (a instanceof _) a = a._wrapped;
if (b instanceof _) b = b._wrapped;
// Compare `[[Class]]` names.
var className = toString.call(a);
if (className !== toString.call(b)) return false;
@@ -463,7 +463,7 @@
while (length--) {
// Deep compare each member
key = _keys[length];
if (!(has$1(b, key) && eq(a[key], b[key], aStack, bStack))) return false;
if (!(has(b, key) && eq(a[key], b[key], aStack, bStack))) return false;
}
}
// Remove the first object from the stack of traversed objects.
@@ -642,15 +642,15 @@
// Normalize a (deep) property `path` to array.
// Like `_.iteratee`, this function can be customized.
function toPath$1(path) {
function toPath(path) {
return isArray(path) ? path : [path];
}
_$1.toPath = toPath$1;
_.toPath = toPath;
// Internal wrapper for `_.toPath` to enable minification.
// Similar to `cb` for `_.iteratee`.
function toPath(path) {
return _$1.toPath(path);
function toPath$1(path) {
return _.toPath(path);
}
// Internal function to obtain a nested property in `obj` along `path`.
@@ -668,19 +668,19 @@
// `undefined`, return `defaultValue` instead.
// The `path` is normalized through `_.toPath`.
function get(object, path, defaultValue) {
var value = deepGet(object, toPath(path));
var value = deepGet(object, toPath$1(path));
return isUndefined(value) ? defaultValue : value;
}
// Shortcut function for checking if an object has a given property directly on
// itself (in other words, not on a prototype). Unlike the internal `has`
// function, this public version can also traverse nested properties.
function has(obj, path) {
path = toPath(path);
function has$1(obj, path) {
path = toPath$1(path);
var length = path.length;
for (var i = 0; i < length; i++) {
var key = path[i];
if (!has$1(obj, key)) return false;
if (!has(obj, key)) return false;
obj = obj[key];
}
return !!length;
@@ -703,7 +703,7 @@
// Creates a function that, when passed an object, will traverse that objects
// properties down the given `path`, specified as an array of keys or indices.
function property(path) {
path = toPath(path);
path = toPath$1(path);
return function(obj) {
return deepGet(obj, path);
};
@@ -747,12 +747,12 @@
function iteratee(value, context) {
return baseIteratee(value, context, Infinity);
}
_$1.iteratee = iteratee;
_.iteratee = iteratee;
// The function we call internally to generate a callback. It invokes
// `_.iteratee` if overridden, otherwise `baseIteratee`.
function cb(value, context, argCount) {
if (_$1.iteratee !== iteratee) return _$1.iteratee(value, context);
if (_.iteratee !== iteratee) return _.iteratee(value, context);
return baseIteratee(value, context, argCount);
}
@@ -840,7 +840,7 @@
// By default, Underscore uses ERB-style template delimiters. Change the
// following template settings to use alternative delimiters.
var templateSettings = _$1.templateSettings = {
var templateSettings = _.templateSettings = {
evaluate: /<%([\s\S]+?)%>/g,
interpolate: /<%=([\s\S]+?)%>/g,
escape: /<%-([\s\S]+?)%>/g
@@ -868,20 +868,13 @@
return '\\' + escapes[match];
}
// In order to prevent third-party code injection through
// `_.templateSettings.variable`, we test it against the following regular
// expression. It is intentionally a bit more liberal than just matching valid
// identifiers, but still prevents possible loopholes through defaults or
// destructuring assignment.
var bareIdentifier = /^\s*(\w|\$)+\s*$/;
// JavaScript micro-templating, similar to John Resig's implementation.
// Underscore templating handles arbitrary delimiters, preserves whitespace,
// and correctly escapes quotes within interpolated code.
// NB: `oldSettings` only exists for backwards compatibility.
function template(text, settings, oldSettings) {
if (!settings && oldSettings) settings = oldSettings;
settings = defaults({}, settings, _$1.templateSettings);
settings = defaults({}, settings, _.templateSettings);
// Combine delimiters into one regular expression via alternation.
var matcher = RegExp([
@@ -910,17 +903,8 @@
});
source += "';\n";
var argument = settings.variable;
if (argument) {
// Insure against third-party code injection. (CVE-2021-23358)
if (!bareIdentifier.test(argument)) throw new Error(
'variable is not a bare identifier: ' + argument
);
} else {
// If a variable is not specified, place data values in local scope.
source = 'with(obj||{}){\n' + source + '}\n';
argument = 'obj';
}
// If a variable is not specified, place data values in local scope.
if (!settings.variable) source = 'with(obj||{}){\n' + source + '}\n';
source = "var __t,__p='',__j=Array.prototype.join," +
"print=function(){__p+=__j.call(arguments,'');};\n" +
@@ -928,17 +912,18 @@
var render;
try {
render = new Function(argument, '_', source);
render = new Function(settings.variable || 'obj', '_', source);
} catch (e) {
e.source = source;
throw e;
}
var template = function(data) {
return render.call(this, data, _$1);
return render.call(this, data, _);
};
// Provide the compiled source as a convenience for precompilation.
var argument = settings.variable || 'obj';
template.source = 'function(' + argument + '){\n' + source + '}';
return template;
@@ -948,7 +933,7 @@
// is invoked with its parent as context. Returns the value of the final
// child, or `fallback` if any child is undefined.
function result(obj, path, fallback) {
path = toPath(path);
path = toPath$1(path);
var length = path.length;
if (!length) {
return isFunction$1(fallback) ? fallback.call(obj) : fallback;
@@ -974,7 +959,7 @@
// Start chaining a wrapped Underscore object.
function chain(obj) {
var instance = _$1(obj);
var instance = _(obj);
instance._chain = true;
return instance;
}
@@ -1008,7 +993,7 @@
return bound;
});
partial.placeholder = _$1;
partial.placeholder = _;
// Create a function bound to a given object (assigning `this`, and arguments,
// optionally).
@@ -1027,7 +1012,7 @@
var isArrayLike = createSizePropertyCheck(getLength);
// Internal implementation of a recursive `flatten` function.
function flatten$1(input, depth, strict, output) {
function flatten(input, depth, strict, output) {
output = output || [];
if (!depth && depth !== 0) {
depth = Infinity;
@@ -1040,7 +1025,7 @@
if (isArrayLike(value) && (isArray(value) || isArguments$1(value))) {
// Flatten current level of array or arguments object.
if (depth > 1) {
flatten$1(value, depth - 1, strict, output);
flatten(value, depth - 1, strict, output);
idx = output.length;
} else {
var j = 0, len = value.length;
@@ -1057,7 +1042,7 @@
// are the method names to be bound. Useful for ensuring that all callbacks
// defined on an object belong to it.
var bindAll = restArguments(function(obj, keys) {
keys = flatten$1(keys, false, false);
keys = flatten(keys, false, false);
var index = keys.length;
if (index < 1) throw new Error('bindAll must be passed function names');
while (index--) {
@@ -1072,7 +1057,7 @@
var memoize = function(key) {
var cache = memoize.cache;
var address = '' + (hasher ? hasher.apply(this, arguments) : key);
if (!has$1(cache, address)) cache[address] = func.apply(this, arguments);
if (!has(cache, address)) cache[address] = func.apply(this, arguments);
return cache[address];
};
memoize.cache = {};
@@ -1089,7 +1074,7 @@
// Defers a function, scheduling it to run after the current call stack has
// cleared.
var defer = partial(delay, _$1, 1);
var defer = partial(delay, _, 1);
// Returns a function, that, when invoked, will only be triggered at most once
// during a given window of time. Normally, the throttled function will run
@@ -1435,7 +1420,7 @@
if (isFunction$1(path)) {
func = path;
} else {
path = toPath(path);
path = toPath$1(path);
contextPath = path.slice(0, -1);
path = path[path.length - 1];
}
@@ -1577,7 +1562,7 @@
// Groups the object's values by a criterion. Pass either a string attribute
// to group by, or a function that returns the criterion.
var groupBy = group(function(result, value, key) {
if (has$1(result, key)) result[key].push(value); else result[key] = [value];
if (has(result, key)) result[key].push(value); else result[key] = [value];
});
// Indexes the object's values by a criterion, similar to `_.groupBy`, but for
@@ -1590,7 +1575,7 @@
// either a string attribute to count by, or a function that returns the
// criterion.
var countBy = group(function(result, value, key) {
if (has$1(result, key)) result[key]++; else result[key] = 1;
if (has(result, key)) result[key]++; else result[key] = 1;
});
// Split a collection into two arrays: one whose elements all pass the given
@@ -1633,7 +1618,7 @@
keys = allKeys(obj);
} else {
iteratee = keyInObj;
keys = flatten$1(keys, false, false);
keys = flatten(keys, false, false);
obj = Object(obj);
}
for (var i = 0, length = keys.length; i < length; i++) {
@@ -1651,7 +1636,7 @@
iteratee = negate(iteratee);
if (keys.length > 1) context = keys[1];
} else {
keys = map(flatten$1(keys, false, false), String);
keys = map(flatten(keys, false, false), String);
iteratee = function(value, key) {
return !contains(keys, key);
};
@@ -1696,14 +1681,14 @@
// Flatten out an array, either recursively (by default), or up to `depth`.
// Passing `true` or `false` as `depth` means `1` or `Infinity`, respectively.
function flatten(array, depth) {
return flatten$1(array, depth, false);
function flatten$1(array, depth) {
return flatten(array, depth, false);
}
// Take the difference between one array and a number of other arrays.
// Only the elements present in just the first array will remain.
var difference = restArguments(function(array, rest) {
rest = flatten$1(rest, true, true);
rest = flatten(rest, true, true);
return filter(array, function(value){
return !contains(rest, value);
});
@@ -1749,7 +1734,7 @@
// Produce an array that contains the union: each distinct element from all of
// the passed-in arrays.
var union = restArguments(function(arrays) {
return uniq(flatten$1(arrays, true, true));
return uniq(flatten(arrays, true, true));
});
// Produce an array that contains every item shared between all the
@@ -1836,26 +1821,26 @@
// Helper function to continue chaining intermediate results.
function chainResult(instance, obj) {
return instance._chain ? _$1(obj).chain() : obj;
return instance._chain ? _(obj).chain() : obj;
}
// Add your own custom functions to the Underscore object.
function mixin(obj) {
each(functions(obj), function(name) {
var func = _$1[name] = obj[name];
_$1.prototype[name] = function() {
var func = _[name] = obj[name];
_.prototype[name] = function() {
var args = [this._wrapped];
push.apply(args, arguments);
return chainResult(this, func.apply(_$1, args));
return chainResult(this, func.apply(_, args));
};
});
return _$1;
return _;
}
// Add all mutator `Array` functions to the wrapper.
each(['pop', 'push', 'reverse', 'shift', 'sort', 'splice', 'unshift'], function(name) {
var method = ArrayProto[name];
_$1.prototype[name] = function() {
_.prototype[name] = function() {
var obj = this._wrapped;
if (obj != null) {
method.apply(obj, arguments);
@@ -1870,7 +1855,7 @@
// Add all accessor `Array` functions to the wrapper.
each(['concat', 'join', 'slice'], function(name) {
var method = ArrayProto[name];
_$1.prototype[name] = function() {
_.prototype[name] = function() {
var obj = this._wrapped;
if (obj != null) obj = method.apply(obj, arguments);
return chainResult(this, obj);
@@ -1924,12 +1909,12 @@
clone: clone,
tap: tap,
get: get,
has: has,
has: has$1,
mapObject: mapObject,
identity: identity,
constant: constant,
noop: noop,
toPath: toPath$1,
toPath: toPath,
property: property,
propertyOf: propertyOf,
matcher: matcher,
@@ -2012,7 +1997,7 @@
tail: rest,
drop: rest,
compact: compact,
flatten: flatten,
flatten: flatten$1,
without: without,
uniq: uniq,
unique: uniq,
@@ -2026,17 +2011,17 @@
range: range,
chunk: chunk,
mixin: mixin,
'default': _$1
'default': _
};
// Default Export
// Add all of the Underscore functions to the wrapper object.
var _ = mixin(allExports);
var _$1 = mixin(allExports);
// Legacy Node.js API.
_._ = _;
_$1._ = _$1;
return _;
return _$1;
})));
//# sourceMappingURL=underscore-umd.js.map
//# sourceMappingURL=underscore.js.map

File diff suppressed because one or more lines are too long

View File

@@ -1,33 +1,70 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>cpl add &mdash; 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" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.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 type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/js/theme.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="cpl build" href="cli.build.html" />
<link rel="prev" title="CLI Overview and Command Reference" href="cli.overview.html" />
</head>
<body class="wy-body-for-nav">
<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" />
@@ -35,7 +72,18 @@
<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">
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<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>
@@ -64,35 +112,77 @@
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query 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" >
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<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">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl_cli.html">CLI Reference</a> &raquo;</li>
<li>cpl add</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/cli.add.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">
<div class="tex2jax_ignore mathjax_ignore section" id="cpl-add">
<h1>cpl add<a class="headerlink" href="#cpl-add" title="Permalink to this headline"></a></h1>
<div class="section" id="cpl-add">
<h1>cpl add<a class="headerlink" href="#cpl-add" title="Permalink to this headline"></a></h1>
<div class="section" id="contents">
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this headline"></a></h2>
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li><p><a class="reference external" href="#description">Description</a></p></li>
<li><p><a class="reference external" href="#arguments">Arguments</a></p></li>
@@ -103,12 +193,12 @@ cpl <strong>a</strong> <em>&lt;source-project&gt;</em> <em>&lt;target-project&gt
cpl <strong>A</strong> <em>&lt;source-project&gt;</em> <em>&lt;target-project&gt;</em></p>
</div>
<div class="section" id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>Adds a project reference to given project.</p>
<p>If you call the command in a CPL workspace, you can use the project names. Otherwise the paths of the projects must be specified.</p>
</div>
<div class="section" id="arguments">
<h2>Arguments<a class="headerlink" href="#arguments" title="Permalink to this headline"></a></h2>
<h2>Arguments<a class="headerlink" href="#arguments" title="Permalink to this headline"></a></h2>
<table class="colwidths-auto docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>Argument</p></th>
@@ -132,33 +222,50 @@ cpl <strong>A</strong> <em>&lt;source-project&gt;</em> <em>&lt;target-project&gt
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="cli.overview.html" class="btn btn-neutral float-left" title="CLI Overview and Command Reference" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="cli.build.html" class="btn btn-neutral float-right" title="cpl build" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="cli.overview.html" class="btn btn-neutral float-left" title="CLI Overview and Command Reference" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2021, Sven Heidemann.</p>
</div>
<p>
&#169; Copyright 2021, Sven Heidemann.
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
</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>.
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</script>
</body>
</html>

View File

@@ -1,33 +1,70 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>cpl build &mdash; 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" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.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 type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/js/theme.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="cpl generate" href="cli.generate.html" />
<link rel="prev" title="cpl add" href="cli.add.html" />
</head>
<body class="wy-body-for-nav">
<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" />
@@ -35,7 +72,18 @@
<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">
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<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>
@@ -63,35 +111,77 @@
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query 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" >
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<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">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl_cli.html">CLI Reference</a> &raquo;</li>
<li>cpl build</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/cli.build.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">
<div class="tex2jax_ignore mathjax_ignore section" id="cpl-build">
<h1>cpl build<a class="headerlink" href="#cpl-build" title="Permalink to this headline"></a></h1>
<div class="section" id="cpl-build">
<h1>cpl build<a class="headerlink" href="#cpl-build" title="Permalink to this headline"></a></h1>
<div class="section" id="contents">
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this headline"></a></h2>
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li><p><a class="reference external" href="#description">Description</a></p></li>
</ul>
@@ -102,7 +192,7 @@ cpl <strong>b</strong> <br>
cpl <strong>B</strong></p>
</div>
<div class="section" id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>The command can be used to build a project of type “console” or “library”.</p>
<p>The build command copies all included source files to the output directory. You can run the source files in the output directory directly.</p>
<p>The command is used to prepare the source files for the publish command or to copy them to an target for execution.</p>
@@ -116,33 +206,50 @@ cpl <strong>B</strong></p>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="cli.add.html" class="btn btn-neutral float-left" title="cpl add" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="cli.generate.html" class="btn btn-neutral float-right" title="cpl generate" 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-left" title="cpl add" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2021, Sven Heidemann.</p>
</div>
<p>
&#169; Copyright 2021, Sven Heidemann.
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
</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>.
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</script>
</body>
</html>

View File

@@ -1,33 +1,70 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>cpl generate &mdash; 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" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.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 type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/js/theme.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="cpl help" href="cli.help.html" />
<link rel="prev" title="cpl build" href="cli.build.html" />
</head>
<body class="wy-body-for-nav">
<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" />
@@ -35,7 +72,18 @@
<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">
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<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>
@@ -65,35 +113,77 @@
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query 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" >
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<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">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl_cli.html">CLI Reference</a> &raquo;</li>
<li>cpl generate</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/cli.generate.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">
<div class="tex2jax_ignore mathjax_ignore section" id="cpl-generate">
<h1>cpl generate<a class="headerlink" href="#cpl-generate" title="Permalink to this headline"></a></h1>
<div class="section" id="cpl-generate">
<h1>cpl generate<a class="headerlink" href="#cpl-generate" title="Permalink to this headline"></a></h1>
<div class="section" id="contents">
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this headline"></a></h2>
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li><p><a class="reference external" href="#description">Description</a></p></li>
<li><p><a class="reference external" href="#arguments">Arguments</a></p></li>
@@ -105,11 +195,11 @@ cpl <strong>g</strong> <em>&lt;schematic&gt;</em> <em>&lt;name&gt;</em> <br>
cpl <strong>G</strong> <em>&lt;schematic&gt;</em> <em>&lt;name&gt;</em></p>
</div>
<div class="section" id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>Generates files based on a schematic.</p>
</div>
<div class="section" id="arguments">
<h2>Arguments<a class="headerlink" href="#arguments" title="Permalink to this headline"></a></h2>
<h2>Arguments<a class="headerlink" href="#arguments" title="Permalink to this headline"></a></h2>
<table class="colwidths-auto docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>Argument</p></th>
@@ -130,7 +220,7 @@ cpl <strong>G</strong> <em>&lt;schematic&gt;</em> <em>&lt;name&gt;</em></p>
</table>
</div>
<div class="section" id="schematics">
<h2>Schematics<a class="headerlink" href="#schematics" title="Permalink to this headline"></a></h2>
<h2>Schematics<a class="headerlink" href="#schematics" title="Permalink to this headline"></a></h2>
<table class="colwidths-auto docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>Schematic</p></th>
@@ -170,33 +260,50 @@ cpl <strong>G</strong> <em>&lt;schematic&gt;</em> <em>&lt;name&gt;</em></p>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="cli.build.html" class="btn btn-neutral float-left" title="cpl build" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="cli.help.html" class="btn btn-neutral float-right" title="cpl help" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="cli.build.html" class="btn btn-neutral float-left" title="cpl build" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2021, Sven Heidemann.</p>
</div>
<p>
&#169; Copyright 2021, Sven Heidemann.
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
</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>.
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</script>
</body>
</html>

View File

@@ -1,33 +1,70 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>cpl help &mdash; 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" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.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 type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/js/theme.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="cpl install" href="cli.install.html" />
<link rel="prev" title="cpl generate" href="cli.generate.html" />
</head>
<body class="wy-body-for-nav">
<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" />
@@ -35,7 +72,18 @@
<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">
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<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>
@@ -63,33 +111,75 @@
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query 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" >
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<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">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl_cli.html">CLI Reference</a> &raquo;</li>
<li>cpl help</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/cli.help.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">
<div class="tex2jax_ignore mathjax_ignore section" id="cpl-help">
<h1>cpl help<a class="headerlink" href="#cpl-help" title="Permalink to this headline"></a></h1>
<div class="section" id="cpl-help">
<h1>cpl help<a class="headerlink" href="#cpl-help" title="Permalink to this headline"></a></h1>
<!-- ## Contents
- [Description](#description) -->
@@ -99,11 +189,11 @@
cpl <strong>h</strong> <em>&lt;command&gt;</em> <br>
cpl <strong>H</strong> <em>&lt;command&gt;</em></p>
<div class="section" id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>Lists available command and their short descriptions.</p>
</div>
<div class="section" id="arguments">
<h2>Arguments<a class="headerlink" href="#arguments" title="Permalink to this headline"></a></h2>
<h2>Arguments<a class="headerlink" href="#arguments" title="Permalink to this headline"></a></h2>
<table class="colwidths-auto docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>Argument</p></th>
@@ -123,33 +213,50 @@ cpl <strong>H</strong> <em>&lt;command&gt;</em></p>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="cli.generate.html" class="btn btn-neutral float-left" title="cpl generate" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="cli.install.html" class="btn btn-neutral float-right" title="cpl install" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="cli.generate.html" class="btn btn-neutral float-left" title="cpl generate" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2021, Sven Heidemann.</p>
</div>
<p>
&#169; Copyright 2021, Sven Heidemann.
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
</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>.
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</script>
</body>
</html>

View File

@@ -1,33 +1,70 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>cpl install &mdash; 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" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.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 type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/js/theme.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="cpl new" href="cli.new.html" />
<link rel="prev" title="cpl help" href="cli.help.html" />
</head>
<body class="wy-body-for-nav">
<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" />
@@ -35,7 +72,18 @@
<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">
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<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>
@@ -64,35 +112,77 @@
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query 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" >
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<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">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl_cli.html">CLI Reference</a> &raquo;</li>
<li>cpl install</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/cli.install.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">
<div class="tex2jax_ignore mathjax_ignore section" id="cpl-install">
<h1>cpl install<a class="headerlink" href="#cpl-install" title="Permalink to this headline"></a></h1>
<div class="section" id="cpl-install">
<h1>cpl install<a class="headerlink" href="#cpl-install" title="Permalink to this headline"></a></h1>
<div class="section" id="contents">
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this headline"></a></h2>
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li><p><a class="reference external" href="#description">Description</a></p></li>
<li><p><a class="reference external" href="#arguments">Arguments</a></p></li>
@@ -103,12 +193,12 @@ cpl <strong>i</strong> <em>&lt;package&gt;</em> <br>
cpl <strong>I</strong> <em>&lt;package&gt;</em></p>
</div>
<div class="section" id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>Install given package to project via pip.
Without given package it will install the depedencies of the CPL project your in.</p>
</div>
<div class="section" id="arguments">
<h2>Arguments<a class="headerlink" href="#arguments" title="Permalink to this headline"></a></h2>
<h2>Arguments<a class="headerlink" href="#arguments" title="Permalink to this headline"></a></h2>
<table class="colwidths-auto docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>Argument</p></th>
@@ -128,33 +218,50 @@ Without given package it will install the depedencies of the CPL project your in
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="cli.help.html" class="btn btn-neutral float-left" title="cpl help" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="cli.new.html" class="btn btn-neutral float-right" title="cpl new" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="cli.help.html" class="btn btn-neutral float-left" title="cpl help" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2021, Sven Heidemann.</p>
</div>
<p>
&#169; Copyright 2021, Sven Heidemann.
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
</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>.
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</script>
</body>
</html>

View File

@@ -1,33 +1,70 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>cpl new &mdash; 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" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.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 type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/js/theme.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="cpl publish" href="cli.publish.html" />
<link rel="prev" title="cpl install" href="cli.install.html" />
</head>
<body class="wy-body-for-nav">
<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" />
@@ -35,7 +72,18 @@
<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">
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<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>
@@ -64,35 +112,77 @@
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query 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" >
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<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">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl_cli.html">CLI Reference</a> &raquo;</li>
<li>cpl new</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/cli.new.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">
<div class="tex2jax_ignore mathjax_ignore section" id="cpl-new">
<h1>cpl new<a class="headerlink" href="#cpl-new" title="Permalink to this headline"></a></h1>
<div class="section" id="cpl-new">
<h1>cpl new<a class="headerlink" href="#cpl-new" title="Permalink to this headline"></a></h1>
<div class="section" id="contents">
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this headline"></a></h2>
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li><p><a class="reference external" href="#description">Description</a></p></li>
<li><p><a class="reference external" href="#arguments">Arguments</a></p></li>
@@ -104,7 +194,7 @@ cpl <strong>n</strong> <em>&lt;type&gt;</em> <em>&lt;name&gt;</em> <br>
cpl <strong>N</strong> <em>&lt;type&gt;</em> <em>&lt;name&gt;</em></p>
</div>
<div class="section" id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>Generates a workspace and initial project or add a project to 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">
@@ -127,7 +217,7 @@ cpl <strong>N</strong> <em>&lt;type&gt;</em> <em>&lt;name&gt;</em></p>
</table>
</div>
<div class="section" id="project-types">
<h2>Project types<a class="headerlink" href="#project-types" title="Permalink to this headline"></a></h2>
<h2>Project types<a class="headerlink" href="#project-types" title="Permalink to this headline"></a></h2>
<table class="colwidths-auto docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>Project type</p></th>
@@ -148,33 +238,50 @@ cpl <strong>N</strong> <em>&lt;type&gt;</em> <em>&lt;name&gt;</em></p>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="cli.install.html" class="btn btn-neutral float-left" title="cpl install" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="cli.publish.html" class="btn btn-neutral float-right" title="cpl publish" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="cli.install.html" class="btn btn-neutral float-left" title="cpl install" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2021, Sven Heidemann.</p>
</div>
<p>
&#169; Copyright 2021, Sven Heidemann.
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
</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>.
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</script>
</body>
</html>

View File

@@ -1,33 +1,70 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>CLI Overview and Command Reference &mdash; 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" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.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 type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/js/theme.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="cpl add" href="cli.add.html" />
<link rel="prev" title="CLI Reference" href="cpl_cli.html" />
</head>
<body class="wy-body-for-nav">
<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" />
@@ -35,7 +72,18 @@
<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">
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<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>
@@ -69,35 +117,77 @@
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query 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" >
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<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">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl_cli.html">CLI Reference</a> &raquo;</li>
<li>CLI Overview and Command Reference</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/cli.overview.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">
<div class="tex2jax_ignore mathjax_ignore section" id="cli-overview-and-command-reference">
<h1>CLI Overview and Command Reference<a class="headerlink" href="#cli-overview-and-command-reference" title="Permalink to this headline"></a></h1>
<div class="section" id="cli-overview-and-command-reference">
<h1>CLI Overview and Command Reference<a class="headerlink" href="#cli-overview-and-command-reference" title="Permalink to this headline"></a></h1>
<div class="section" id="table-of-contents">
<h2>Table of Contents<a class="headerlink" href="#table-of-contents" title="Permalink to this headline"></a></h2>
<h2>Table of Contents<a class="headerlink" href="#table-of-contents" title="Permalink to this headline"></a></h2>
<ol class="simple">
<li><p><a class="reference external" href="setup#install-the-package">Install CPL</a></p></li>
<li><p><a class="reference external" href="setup#install-the-cli">Install CPL CLI</a></p></li>
@@ -107,7 +197,7 @@
</ol>
</div>
<div class="section" id="basic-workflow">
<h2>Basic workflow<a class="headerlink" href="#basic-workflow" title="Permalink to this headline"></a></h2>
<h2>Basic workflow<a class="headerlink" href="#basic-workflow" title="Permalink to this headline"></a></h2>
<p>To create, build, and serve a new, basic CPL project on a development server, go to the parent directory of your new workspace use the following commands:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>cpl new console my-first-project
<span class="nb">cd</span> my-first-project
@@ -117,23 +207,23 @@ cpl start
<p>In the terminal you will the output of the app.</p>
</div>
<div class="section" id="cli-command-language-syntax">
<h2>CLI command-language syntax<a class="headerlink" href="#cli-command-language-syntax" title="Permalink to this headline"></a></h2>
<h2>CLI command-language syntax<a class="headerlink" href="#cli-command-language-syntax" title="Permalink to this headline"></a></h2>
<p><code class="docutils literal notranslate"><span class="pre">cpl</span></code> commandNameOrAlias requiredArg <code class="docutils literal notranslate"><span class="pre">[optionalsArgs]</span></code></p>
<ul class="simple">
<li><p>Most commands, and some options, have aliases. Aliases are shown in the syntax statement for each command.</p></li>
<li><p>Arguments are not prefixed.</p></li>
</ul>
<div class="section" id="relative-paths">
<h3>Relative paths<a class="headerlink" href="#relative-paths" title="Permalink to this headline"></a></h3>
<h3>Relative paths<a class="headerlink" href="#relative-paths" title="Permalink to this headline"></a></h3>
<p>Options that specify files can be given as absolute paths, or as paths relative to the current working directory, which is generally either the workspace or project root.</p>
</div>
<div class="section" id="schematics">
<h3>Schematics<a class="headerlink" href="#schematics" title="Permalink to this headline"></a></h3>
<h3>Schematics<a class="headerlink" href="#schematics" title="Permalink to this headline"></a></h3>
<p>The cpl generate command takes as an argument the artifact to be generated. In addition to any general options, each artifact defines its own options in a schematic. Schematic options are supplied to the command in the same format as immediate command options.</p>
</div>
</div>
<div class="section" id="command-overview">
<h2>Command overview<a class="headerlink" href="#command-overview" title="Permalink to this headline"></a></h2>
<h2>Command overview<a class="headerlink" href="#command-overview" title="Permalink to this headline"></a></h2>
<table class="colwidths-auto docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>Command</p></th>
@@ -197,33 +287,50 @@ cpl start
</div>
</div>
<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>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<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="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>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2021, Sven Heidemann.</p>
</div>
<p>
&#169; Copyright 2021, Sven Heidemann.
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
</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>.
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</script>
</body>
</html>

View File

@@ -1,33 +1,70 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>cpl publish &mdash; 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" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.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 type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/js/theme.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="cpl remove" href="cli.remove.html" />
<link rel="prev" title="cpl new" href="cli.new.html" />
</head>
<body class="wy-body-for-nav">
<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" />
@@ -35,7 +72,18 @@
<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">
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<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>
@@ -63,35 +111,77 @@
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query 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" >
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<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">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl_cli.html">CLI Reference</a> &raquo;</li>
<li>cpl publish</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/cli.publish.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">
<div class="tex2jax_ignore mathjax_ignore section" id="cpl-publish">
<h1>cpl publish<a class="headerlink" href="#cpl-publish" title="Permalink to this headline"></a></h1>
<div class="section" id="cpl-publish">
<h1>cpl publish<a class="headerlink" href="#cpl-publish" title="Permalink to this headline"></a></h1>
<div class="section" id="contents">
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this headline"></a></h2>
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li><p><a class="reference external" href="#description">Description</a></p></li>
</ul>
@@ -102,7 +192,7 @@ cpl <strong>p</strong> <br>
cpl <strong>P</strong></p>
</div>
<div class="section" id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>The command can be used to publish a project of type “console” or “library”.</p>
<p>The publish command builds the source files and then creates an <code class="docutils literal notranslate"><span class="pre">setup.py</span></code> with data from <code class="docutils literal notranslate"><span class="pre">cpl_core.json</span></code>.
The command executes the <code class="docutils literal notranslate"><span class="pre">setup.py</span></code> and removes all source files with the <code class="docutils literal notranslate"><span class="pre">setup.py</span></code> from the publish/ directory.</p>
@@ -116,33 +206,50 @@ The command executes the <code class="docutils literal notranslate"><span class=
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="cli.new.html" class="btn btn-neutral float-left" title="cpl new" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="cli.remove.html" class="btn btn-neutral float-right" title="cpl remove" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="cli.new.html" class="btn btn-neutral float-left" title="cpl new" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2021, Sven Heidemann.</p>
</div>
<p>
&#169; Copyright 2021, Sven Heidemann.
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
</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>.
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</script>
</body>
</html>

View File

@@ -1,33 +1,70 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>cpl remove &mdash; 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" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.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 type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/js/theme.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="cpl start" href="cli.start.html" />
<link rel="prev" title="cpl publish" href="cli.publish.html" />
</head>
<body class="wy-body-for-nav">
<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" />
@@ -35,7 +72,18 @@
<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">
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<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>
@@ -64,35 +112,77 @@
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query 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" >
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<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">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl_cli.html">CLI Reference</a> &raquo;</li>
<li>cpl remove</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/cli.remove.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">
<div class="tex2jax_ignore mathjax_ignore section" id="cpl-remove">
<h1>cpl remove<a class="headerlink" href="#cpl-remove" title="Permalink to this headline"></a></h1>
<div class="section" id="cpl-remove">
<h1>cpl remove<a class="headerlink" href="#cpl-remove" title="Permalink to this headline"></a></h1>
<div class="section" id="contents">
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this headline"></a></h2>
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li><p><a class="reference external" href="#description">Description</a></p></li>
<li><p><a class="reference external" href="#arguments">Arguments</a></p></li>
@@ -103,12 +193,12 @@ cpl <strong>r</strong> <em>&lt;project&gt;</em> <br>
cpl <strong>R</strong> <em>&lt;project&gt;</em></p>
</div>
<div class="section" id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>Removes a project reference and the files from workspace.</p>
<p>If you call the command in a CPL workspace, you can use the project names. Otherwise the paths of the projects must be specified.</p>
</div>
<div class="section" id="arguments">
<h2>Arguments<a class="headerlink" href="#arguments" title="Permalink to this headline"></a></h2>
<h2>Arguments<a class="headerlink" href="#arguments" title="Permalink to this headline"></a></h2>
<table class="colwidths-auto docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>Argument</p></th>
@@ -128,33 +218,50 @@ cpl <strong>R</strong> <em>&lt;project&gt;</em></p>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="cli.publish.html" class="btn btn-neutral float-left" title="cpl publish" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="cli.start.html" class="btn btn-neutral float-right" title="cpl start" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="cli.publish.html" class="btn btn-neutral float-left" title="cpl publish" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2021, Sven Heidemann.</p>
</div>
<p>
&#169; Copyright 2021, Sven Heidemann.
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
</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>.
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</script>
</body>
</html>

View File

@@ -1,33 +1,70 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>cpl start &mdash; 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" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.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 type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/js/theme.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="cpl uninstall" href="cli.uninstall.html" />
<link rel="prev" title="cpl remove" href="cli.remove.html" />
</head>
<body class="wy-body-for-nav">
<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" />
@@ -35,7 +72,18 @@
<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">
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<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>
@@ -59,33 +107,75 @@
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query 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" >
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<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">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl_cli.html">CLI Reference</a> &raquo;</li>
<li>cpl start</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/cli.start.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">
<div class="tex2jax_ignore mathjax_ignore section" id="cpl-start">
<h1>cpl start<a class="headerlink" href="#cpl-start" title="Permalink to this headline"></a></h1>
<div class="section" id="cpl-start">
<h1>cpl start<a class="headerlink" href="#cpl-start" title="Permalink to this headline"></a></h1>
<p>Starts your application, restarting on file changes.</p>
<p>cpl <strong>start</strong> <br>
cpl <strong>s</strong> <br>
@@ -94,33 +184,50 @@ cpl <strong>S</strong></p>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="cli.remove.html" class="btn btn-neutral float-left" title="cpl remove" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="cli.uninstall.html" class="btn btn-neutral float-right" title="cpl uninstall" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="cli.remove.html" class="btn btn-neutral float-left" title="cpl remove" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2021, Sven Heidemann.</p>
</div>
<p>
&#169; Copyright 2021, Sven Heidemann.
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
</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>.
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</script>
</body>
</html>

View File

@@ -1,33 +1,70 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>cpl uninstall &mdash; 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" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.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 type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/js/theme.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="cpl update" href="cli.update.html" />
<link rel="prev" title="cpl start" href="cli.start.html" />
</head>
<body class="wy-body-for-nav">
<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" />
@@ -35,7 +72,18 @@
<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">
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<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>
@@ -64,35 +112,77 @@
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query 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" >
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<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">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl_cli.html">CLI Reference</a> &raquo;</li>
<li>cpl uninstall</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/cli.uninstall.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">
<div class="tex2jax_ignore mathjax_ignore section" id="cpl-uninstall">
<h1>cpl uninstall<a class="headerlink" href="#cpl-uninstall" title="Permalink to this headline"></a></h1>
<div class="section" id="cpl-uninstall">
<h1>cpl uninstall<a class="headerlink" href="#cpl-uninstall" title="Permalink to this headline"></a></h1>
<div class="section" id="contents">
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this headline"></a></h2>
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li><p><a class="reference external" href="#description">Description</a></p></li>
<li><p><a class="reference external" href="#arguments">Arguments</a></p></li>
@@ -103,11 +193,11 @@ cpl <strong>ui</strong> <em>&lt;package&gt;</em> <br>
cpl <strong>UI</strong> <em>&lt;package&gt;</em></p>
</div>
<div class="section" id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>Uninstall given package from project via pip.</p>
</div>
<div class="section" id="arguments">
<h2>Arguments<a class="headerlink" href="#arguments" title="Permalink to this headline"></a></h2>
<h2>Arguments<a class="headerlink" href="#arguments" title="Permalink to this headline"></a></h2>
<table class="colwidths-auto docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>Argument</p></th>
@@ -127,33 +217,50 @@ cpl <strong>UI</strong> <em>&lt;package&gt;</em></p>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="cli.start.html" class="btn btn-neutral float-left" title="cpl start" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="cli.update.html" class="btn btn-neutral float-right" title="cpl update" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="cli.start.html" class="btn btn-neutral float-left" title="cpl start" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2021, Sven Heidemann.</p>
</div>
<p>
&#169; Copyright 2021, Sven Heidemann.
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
</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>.
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</script>
</body>
</html>

View File

@@ -1,33 +1,70 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>cpl update &mdash; 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" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.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 type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/js/theme.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="cpl version" href="cli.version.html" />
<link rel="prev" title="cpl uninstall" href="cli.uninstall.html" />
</head>
<body class="wy-body-for-nav">
<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" />
@@ -35,7 +72,18 @@
<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">
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<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>
@@ -59,33 +107,75 @@
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query 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" >
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<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">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl_cli.html">CLI Reference</a> &raquo;</li>
<li>cpl update</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/cli.update.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">
<div class="tex2jax_ignore mathjax_ignore section" id="cpl-update">
<h1>cpl update<a class="headerlink" href="#cpl-update" title="Permalink to this headline"></a></h1>
<div class="section" id="cpl-update">
<h1>cpl update<a class="headerlink" href="#cpl-update" title="Permalink to this headline"></a></h1>
<p>Updates the CPL and project dependencies.</p>
<p>cpl <strong>update</strong> <br>
cpl <strong>u</strong> <br>
@@ -94,33 +184,50 @@ cpl <strong>U</strong></p>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="cli.uninstall.html" class="btn btn-neutral float-left" title="cpl uninstall" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="cli.version.html" class="btn btn-neutral float-right" title="cpl version" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="cli.uninstall.html" class="btn btn-neutral float-left" title="cpl uninstall" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2021, Sven Heidemann.</p>
</div>
<p>
&#169; Copyright 2021, Sven Heidemann.
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
</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>.
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</script>
</body>
</html>

View File

@@ -1,33 +1,70 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>cpl version &mdash; 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" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.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 type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/js/theme.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="API Reference" href="cpl_core.html" />
<link rel="prev" title="cpl update" href="cli.update.html" />
</head>
<body class="wy-body-for-nav">
<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" />
@@ -35,7 +72,18 @@
<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">
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<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>
@@ -59,33 +107,75 @@
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query 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" >
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<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">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl_cli.html">CLI Reference</a> &raquo;</li>
<li>cpl version</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/cli.version.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">
<div class="tex2jax_ignore mathjax_ignore section" id="cpl-version">
<h1>cpl version<a class="headerlink" href="#cpl-version" title="Permalink to this headline"></a></h1>
<div class="section" id="cpl-version">
<h1>cpl version<a class="headerlink" href="#cpl-version" title="Permalink to this headline"></a></h1>
<p>Lists the version of CPL, CPL CLI and all installed packages from pip.</p>
<p>cpl <strong>version</strong> <br>
cpl <strong>v</strong> <br>
@@ -94,33 +184,50 @@ cpl <strong>V</strong></p>
</div>
</div>
<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>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<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="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>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2021, Sven Heidemann.</p>
</div>
<p>
&#169; Copyright 2021, Sven Heidemann.
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
</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>.
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</script>
</body>
</html>

View File

@@ -1,31 +1,68 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Contributing to CPL &mdash; 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" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.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 type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/js/theme.js"></script>
<script type="text/javascript" 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">
<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" />
@@ -33,7 +70,18 @@
<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">
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<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>
@@ -42,32 +90,73 @@
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query 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" >
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<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">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li>Contributing to CPL</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/contributing.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">
<div class="tex2jax_ignore mathjax_ignore section" id="contributing-to-cpl">
<h1>Contributing to CPL<a class="headerlink" href="#contributing-to-cpl" title="Permalink to this headline"></a></h1>
<div class="section" id="contributing-to-cpl">
<h1>Contributing to CPL<a class="headerlink" href="#contributing-to-cpl" title="Permalink to this headline"></a></h1>
<p>We would love for you to contribute to CPL and help make it even better than it is today! As a contributor, here are the guidelines we would like you to follow:</p>
<ul class="simple">
<li><p><a class="reference external" href="#found-a-bug">Issuses and Bugs</a></p></li>
@@ -77,20 +166,20 @@
<li><p><a class="reference external" href="#license">License</a></p></li>
</ul>
<div class="section" id="found-a-bug">
<h2>Found a Bug?<a class="headerlink" href="#found-a-bug" title="Permalink to this headline"></a></h2>
<h2>Found a Bug?<a class="headerlink" href="#found-a-bug" title="Permalink to this headline"></a></h2>
<p>If you find a bug in the source code, you can help us by <a class="reference external" href="#submitting-an-issue">submitting an issue</a> to our <a class="reference external" href="https://git.sh-edraft.de/sh-edraft.de/sh_cpl/">Gitea Repository</a>. Even better, you can <a class="reference external" href="#submitting-a-pull-request">submit a Pull Request</a> with a fix.</p>
</div>
<div class="section" id="feature-request">
<h2>Feature Request<a class="headerlink" href="#feature-request" title="Permalink to this headline"></a></h2>
<h2>Feature Request<a class="headerlink" href="#feature-request" title="Permalink to this headline"></a></h2>
<p>You can request a new feature by submitting an issue to our <a class="reference external" href="https://git.sh-edraft.de/sh-edraft.de/sh_cpl/">Gitea Repository</a>. If you would like to implement a new feature, please consider the size of the change in order to determine the right steps to proceed:</p>
<p>For a Major Feature, first open an issue and outline your proposal so that it can be discussed. This process allows us to better coordinate our efforts, prevent duplication of work, and help you to craft the change so that it is successfully accepted into the project.</p>
<p>Note: Adding a new topic to the documentation, or significantly re-writing a topic, counts as a major feature.</p>
<p>Small Features can be crafted and directly submitted as a <a class="reference external" href="#submit-pr">Pull Request</a>.</p>
</div>
<div class="section" id="submission-guidelines">
<h2>Submission Guidelines<a class="headerlink" href="#submission-guidelines" title="Permalink to this headline"></a></h2>
<h2>Submission Guidelines<a class="headerlink" href="#submission-guidelines" title="Permalink to this headline"></a></h2>
<div class="section" id="submitting-an-issue">
<h3>Submitting an Issue<a class="headerlink" href="#submitting-an-issue" title="Permalink to this headline"></a></h3>
<h3>Submitting an Issue<a class="headerlink" href="#submitting-an-issue" title="Permalink to this headline"></a></h3>
<p>Before you submit an issue, please search the issue tracker, maybe an issue for your problem already exists and the discussion might inform you of workarounds readily available.</p>
<p>We want to fix all the issues as soon as possible, but before fixing a bug we need to reproduce and confirm it. In order to reproduce bugs, we require that you provide a minimal reproduction. Having a minimal reproducible scenario gives us a wealth of important information without going back and forth to you with additional questions.</p>
<p>A minimal reproduction allows us to quickly confirm a bug (or point out a coding problem) as well as confirm that we are fixing the right problem.</p>
@@ -98,7 +187,7 @@
<p>Unfortunately, we are not able to investigate / fix bugs without a minimal reproduction, so if we dont hear back from you, we are going to close an issue that doesnt have enough info to be reproduced.</p>
</div>
<div class="section" id="submitting-a-pull-request">
<h3>Submitting a Pull Request<a class="headerlink" href="#submitting-a-pull-request" title="Permalink to this headline"></a></h3>
<h3>Submitting a Pull Request<a class="headerlink" href="#submitting-a-pull-request" title="Permalink to this headline"></a></h3>
<p>Before you submit your Pull Request (PR) consider the following guidelines:</p>
<ol>
<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 dont want to duplicate existing efforts.</p></li>
@@ -128,10 +217,10 @@
</ol>
</div>
<div class="section" id="reviewing-a-pull-request">
<h3>Reviewing a Pull Request<a class="headerlink" href="#reviewing-a-pull-request" title="Permalink to this headline"></a></h3>
<h3>Reviewing a Pull Request<a class="headerlink" href="#reviewing-a-pull-request" title="Permalink to this headline"></a></h3>
<p>The sh-edraft.de team reserves the right not to accept pull requests from community members who havent been good citizens of the community. Such behavior includes not following the CPL <a class="reference external" href="#coding-rules">coding rules</a> and applies within or outside of CPL managed channels.</p>
<div class="section" id="addressing-review-feedback">
<h4>Addressing review feedback<a class="headerlink" href="#addressing-review-feedback" title="Permalink to this headline"></a></h4>
<h4>Addressing review feedback<a class="headerlink" href="#addressing-review-feedback" title="Permalink to this headline"></a></h4>
<p>If we ask for changes via code reviews then:</p>
<ol>
<li><p>Make the required updates to the code.</p></li>
@@ -147,7 +236,7 @@ git push
</div>
</div>
<div class="section" id="coding-rules">
<h2>Coding Rules<a class="headerlink" href="#coding-rules" title="Permalink to this headline"></a></h2>
<h2>Coding Rules<a class="headerlink" href="#coding-rules" title="Permalink to this headline"></a></h2>
<p>To ensure consistency throughout the source code, keep these rules in mind as you are working:</p>
<ul class="simple">
<li><p>All features or bug fixes must be tested by one or more unit-tests.</p></li>
@@ -156,7 +245,7 @@ git push
</ul>
</div>
<div class="section" id="license">
<h2>License<a class="headerlink" href="#license" title="Permalink to this headline"></a></h2>
<h2>License<a class="headerlink" href="#license" title="Permalink to this headline"></a></h2>
<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>
<!-- LINKS -->
@@ -165,30 +254,46 @@ See <a class="reference external" href="https://git.sh-edraft.de/sh-edraft.de/sh
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2021, Sven Heidemann.</p>
</div>
<p>
&#169; Copyright 2021, Sven Heidemann.
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
</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>.
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</script>
</body>
</html>

View File

@@ -1,33 +1,70 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>CLI Reference &mdash; 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" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.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 type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/js/theme.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="CLI Overview and Command Reference" href="cli.overview.html" />
<link rel="prev" title="Setting up the local environment and workspace" href="setup.html" />
</head>
<body class="wy-body-for-nav">
<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" />
@@ -35,7 +72,18 @@
<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">
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<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>
@@ -59,32 +107,73 @@
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query 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" >
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<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">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li>CLI Reference</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/cpl_cli.rst.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">
<div class="section" id="cli-reference">
<h1>CLI Reference<a class="headerlink" href="#cli-reference" title="Permalink to this headline"></a></h1>
<h1>CLI Reference<a class="headerlink" href="#cli-reference" title="Permalink to this headline"></a></h1>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a><ul>
@@ -159,33 +248,50 @@
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="setup.html" class="btn btn-neutral float-left" title="Setting up the local environment and workspace" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="cli.overview.html" class="btn btn-neutral float-right" title="CLI Overview and Command Reference" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="setup.html" class="btn btn-neutral float-left" title="Setting up the local environment and workspace" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2021, Sven Heidemann.</p>
</div>
<p>
&#169; Copyright 2021, Sven Heidemann.
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
</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>.
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</script>
</body>
</html>

View File

@@ -1,33 +1,70 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>cpl_core.application &mdash; 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" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.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 type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/js/theme.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="cpl_core.configuration" href="cpl_core.configuration.html" />
<link rel="prev" title="API Reference" href="cpl_core.html" />
</head>
<body class="wy-body-for-nav">
<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" />
@@ -35,7 +72,18 @@
<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">
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<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>
@@ -62,38 +110,80 @@
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query 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" >
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<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">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl_core.html">API Reference</a> &raquo;</li>
<li>cpl_core.application</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/cpl_core.application.rst.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">
<div class="section" id="cpl-core-application">
<h1>cpl_core.application<a class="headerlink" href="#cpl-core-application" title="Permalink to this headline"></a></h1>
<h1>cpl_core.application<a class="headerlink" href="#cpl-core-application" title="Permalink to this headline"></a></h1>
<div class="section" id="module-cpl_core.application.application_abc">
<span id="cpl-core-application-application-abc"></span><h2>cpl_core.application.application_abc<a class="headerlink" href="#module-cpl_core.application.application_abc" title="Permalink to this headline"></a></h2>
<span id="cpl-core-application-application-abc"></span><h2>cpl_core.application.application_abc<a class="headerlink" href="#module-cpl_core.application.application_abc" title="Permalink to this headline"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="cpl_core.application.application_abc.ApplicationABC">
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">cpl_core.application.application_abc.</span></span><span class="sig-name descname"><span class="pre">ApplicationABC</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_abc.ConfigurationABC" title="cpl_core.configuration.configuration_abc.ConfigurationABC"><span class="pre">cpl_core.configuration.configuration_abc.ConfigurationABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">services</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC"><span class="pre">cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.application.application_abc.ApplicationABC" title="Permalink to this definition"></a></dt>
<dt id="cpl_core.application.application_abc.ApplicationABC">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_core.application.application_abc.</span></code><code class="sig-name descname"><span class="pre">ApplicationABC</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_abc.ConfigurationABC" title="cpl_core.configuration.configuration_abc.ConfigurationABC"><span class="pre">cpl_core.configuration.configuration_abc.ConfigurationABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">services</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC"><span class="pre">cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.application.application_abc.ApplicationABC" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">abc.ABC</span></code></p>
<p>ABC for the Application class</p>
<blockquote>
@@ -105,22 +195,29 @@
</dl>
</div></blockquote>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_core.application.application_abc.ApplicationABC.configure">
<em class="property"><span class="pre">abstract</span> </em><span class="sig-name descname"><span class="pre">configure</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.application.application_abc.ApplicationABC.configure" title="Permalink to this definition"></a></dt>
<dt id="cpl_core.application.application_abc.ApplicationABC.configure">
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">configure</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.application.application_abc.ApplicationABC.configure" title="Permalink to this definition"></a></dt>
<dd><p>Configure the application</p>
<p>Called by <a class="reference internal" href="#cpl_core.application.application_abc.ApplicationABC.run" title="cpl_core.application.application_abc.ApplicationABC.run"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.application.application_abc.ApplicationABC.run</span></code></a></p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_core.application.application_abc.ApplicationABC.main">
<em class="property"><span class="pre">abstract</span> </em><span class="sig-name descname"><span class="pre">main</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.application.application_abc.ApplicationABC.main" title="Permalink to this definition"></a></dt>
<dt id="cpl_core.application.application_abc.ApplicationABC.main">
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">main</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.application.application_abc.ApplicationABC.main" title="Permalink to this definition"></a></dt>
<dd><p>Custom entry point</p>
<p>Called by <a class="reference internal" href="#cpl_core.application.application_abc.ApplicationABC.run" title="cpl_core.application.application_abc.ApplicationABC.run"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.application.application_abc.ApplicationABC.run</span></code></a></p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_core.application.application_abc.ApplicationABC.run">
<span class="sig-name descname"><span class="pre">run</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.application.application_abc.ApplicationABC.run" title="Permalink to this definition"></a></dt>
<dt id="cpl_core.application.application_abc.ApplicationABC.run">
<code class="sig-name descname"><span class="pre">run</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.application.application_abc.ApplicationABC.run" title="Permalink to this definition"></a></dt>
<dd><p>Entry point</p>
<p>Called by custom Application.main</p>
</dd></dl>
<dl class="py method">
<dt id="cpl_core.application.application_abc.ApplicationABC.run_async">
<em class="property"><span class="pre">async</span> </em><code class="sig-name descname"><span class="pre">run_async</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.application.application_abc.ApplicationABC.run_async" title="Permalink to this definition"></a></dt>
<dd><p>Entry point</p>
<p>Called by custom Application.main</p>
</dd></dl>
@@ -129,10 +226,10 @@
</div>
<div class="section" id="module-cpl_core.application.application_builder">
<span id="cpl-core-application-application-builder"></span><h2>cpl_core.application.application_builder<a class="headerlink" href="#module-cpl_core.application.application_builder" title="Permalink to this headline"></a></h2>
<span id="cpl-core-application-application-builder"></span><h2>cpl_core.application.application_builder<a class="headerlink" href="#module-cpl_core.application.application_builder" title="Permalink to this headline"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="cpl_core.application.application_builder.ApplicationBuilder">
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">cpl_core.application.application_builder.</span></span><span class="sig-name descname"><span class="pre">ApplicationBuilder</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">app</span></span><span class="p"><span class="pre">:</span></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.application_abc.ApplicationABC" title="cpl_core.application.application_abc.ApplicationABC"><span class="pre">cpl_core.application.application_abc.ApplicationABC</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" title="Permalink to this definition"></a></dt>
<dt id="cpl_core.application.application_builder.ApplicationBuilder">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_core.application.application_builder.</span></code><code class="sig-name descname"><span class="pre">ApplicationBuilder</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">app</span></span><span class="p"><span class="pre">:</span></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.application_abc.ApplicationABC" title="cpl_core.application.application_abc.ApplicationABC"><span class="pre">cpl_core.application.application_abc.ApplicationABC</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" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#cpl_core.application.application_builder_abc.ApplicationBuilderABC" title="cpl_core.application.application_builder_abc.ApplicationBuilderABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.application.application_builder_abc.ApplicationBuilderABC</span></code></a></p>
<p>This is class is used to build a object of <a class="reference internal" href="#cpl_core.application.application_abc.ApplicationABC" title="cpl_core.application.application_abc.ApplicationABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.application.application_abc.ApplicationABC</span></code></a></p>
<blockquote>
@@ -142,8 +239,8 @@
</dl>
</div></blockquote>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_core.application.application_builder.ApplicationBuilder.build">
<span class="sig-name descname"><span class="pre">build</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_core.application.application_abc.ApplicationABC" title="cpl_core.application.application_abc.ApplicationABC"><span class="pre">cpl_core.application.application_abc.ApplicationABC</span></a></span></span><a class="headerlink" href="#cpl_core.application.application_builder.ApplicationBuilder.build" title="Permalink to this definition"></a></dt>
<dt id="cpl_core.application.application_builder.ApplicationBuilder.build">
<code class="sig-name descname"><span class="pre">build</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span> &#x2192; <a class="reference internal" href="#cpl_core.application.application_abc.ApplicationABC" title="cpl_core.application.application_abc.ApplicationABC"><span class="pre">cpl_core.application.application_abc.ApplicationABC</span></a><a class="headerlink" href="#cpl_core.application.application_builder.ApplicationBuilder.build" title="Permalink to this definition"></a></dt>
<dd><p>Creates custom application object</p>
<blockquote>
<div><p>Object of <a class="reference internal" href="#cpl_core.application.application_abc.ApplicationABC" title="cpl_core.application.application_abc.ApplicationABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.application.application_abc.ApplicationABC</span></code></a></p>
@@ -151,14 +248,23 @@
</dd></dl>
<dl class="py method">
<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="n"><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><span class="pre">cpl_core.application.application_extension_abc.ApplicationExtensionABC</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>
<dt id="cpl_core.application.application_builder.ApplicationBuilder.build_async">
<em class="property"><span class="pre">async</span> </em><code class="sig-name descname"><span class="pre">build_async</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span> &#x2192; <a class="reference internal" href="#cpl_core.application.application_abc.ApplicationABC" title="cpl_core.application.application_abc.ApplicationABC"><span class="pre">cpl_core.application.application_abc.ApplicationABC</span></a><a class="headerlink" href="#cpl_core.application.application_builder.ApplicationBuilder.build_async" title="Permalink to this definition"></a></dt>
<dd><p>Creates custom application object async</p>
<blockquote>
<div><p>Object of <a class="reference internal" href="#cpl_core.application.application_abc.ApplicationABC" title="cpl_core.application.application_abc.ApplicationABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.application.application_abc.ApplicationABC</span></code></a></p>
</div></blockquote>
</dd></dl>
<dl class="py method">
<dt id="cpl_core.application.application_builder.ApplicationBuilder.use_extension">
<code class="sig-name descname"><span class="pre">use_extension</span></code><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="n"><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><span class="pre">cpl_core.application.application_extension_abc.ApplicationExtensionABC</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>
<dd></dd></dl>
<dl class="py method">
<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="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">cpl_core.application.startup_abc.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>
<dd><p>Sets the custom startup class to use</p>
<dt id="cpl_core.application.application_builder.ApplicationBuilder.use_startup">
<code class="sig-name descname"><span class="pre">use_startup</span></code><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="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">cpl_core.application.startup_abc.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>
<dd><p>Sets the custom startup class to use async</p>
<blockquote>
<div><dl class="simple">
<dt>startup: Type[<a class="reference internal" href="#cpl_core.application.startup_abc.StartupABC" title="cpl_core.application.startup_abc.StartupABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.application.startup_abc.StartupABC</span></code></a>]</dt><dd><p>Startup class to use</p>
@@ -171,15 +277,15 @@
</div>
<div class="section" id="module-cpl_core.application.application_builder_abc">
<span id="cpl-core-application-application-builder-abc"></span><h2>cpl_core.application.application_builder_abc<a class="headerlink" href="#module-cpl_core.application.application_builder_abc" title="Permalink to this headline"></a></h2>
<span id="cpl-core-application-application-builder-abc"></span><h2>cpl_core.application.application_builder_abc<a class="headerlink" href="#module-cpl_core.application.application_builder_abc" title="Permalink to this headline"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="cpl_core.application.application_builder_abc.ApplicationBuilderABC">
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">cpl_core.application.application_builder_abc.</span></span><span class="sig-name descname"><span class="pre">ApplicationBuilderABC</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.application.application_builder_abc.ApplicationBuilderABC" title="Permalink to this definition"></a></dt>
<dt id="cpl_core.application.application_builder_abc.ApplicationBuilderABC">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_core.application.application_builder_abc.</span></code><code class="sig-name descname"><span class="pre">ApplicationBuilderABC</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.application.application_builder_abc.ApplicationBuilderABC" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">abc.ABC</span></code></p>
<p>ABC for the <a class="reference internal" href="#cpl_core.application.application_builder.ApplicationBuilder" title="cpl_core.application.application_builder.ApplicationBuilder"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.application.application_builder.ApplicationBuilder</span></code></a></p>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_core.application.application_builder_abc.ApplicationBuilderABC.build">
<em class="property"><span class="pre">abstract</span> </em><span class="sig-name descname"><span class="pre">build</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_core.application.application_abc.ApplicationABC" title="cpl_core.application.application_abc.ApplicationABC"><span class="pre">cpl_core.application.application_abc.ApplicationABC</span></a></span></span><a class="headerlink" href="#cpl_core.application.application_builder_abc.ApplicationBuilderABC.build" title="Permalink to this definition"></a></dt>
<dt id="cpl_core.application.application_builder_abc.ApplicationBuilderABC.build">
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">build</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span> &#x2192; <a class="reference internal" href="#cpl_core.application.application_abc.ApplicationABC" title="cpl_core.application.application_abc.ApplicationABC"><span class="pre">cpl_core.application.application_abc.ApplicationABC</span></a><a class="headerlink" href="#cpl_core.application.application_builder_abc.ApplicationBuilderABC.build" title="Permalink to this definition"></a></dt>
<dd><p>Creates custom application object</p>
<blockquote>
<div><p>Object of <a class="reference internal" href="#cpl_core.application.application_abc.ApplicationABC" title="cpl_core.application.application_abc.ApplicationABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.application.application_abc.ApplicationABC</span></code></a></p>
@@ -187,9 +293,18 @@
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_core.application.application_builder_abc.ApplicationBuilderABC.use_startup">
<em class="property"><span class="pre">abstract</span> </em><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="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">cpl_core.application.startup_abc.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_abc.ApplicationBuilderABC.use_startup" title="Permalink to this definition"></a></dt>
<dd><p>Sets the custom startup class to use</p>
<dt id="cpl_core.application.application_builder_abc.ApplicationBuilderABC.build_async">
<em class="property"><span class="pre">abstract</span> <span class="pre">async</span> </em><code class="sig-name descname"><span class="pre">build_async</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span> &#x2192; <a class="reference internal" href="#cpl_core.application.application_abc.ApplicationABC" title="cpl_core.application.application_abc.ApplicationABC"><span class="pre">cpl_core.application.application_abc.ApplicationABC</span></a><a class="headerlink" href="#cpl_core.application.application_builder_abc.ApplicationBuilderABC.build_async" title="Permalink to this definition"></a></dt>
<dd><p>Creates custom application object async</p>
<blockquote>
<div><p>Object of <a class="reference internal" href="#cpl_core.application.application_abc.ApplicationABC" title="cpl_core.application.application_abc.ApplicationABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.application.application_abc.ApplicationABC</span></code></a></p>
</div></blockquote>
</dd></dl>
<dl class="py method">
<dt id="cpl_core.application.application_builder_abc.ApplicationBuilderABC.use_startup">
<em class="property"><span class="pre">abstract</span> <span class="pre">async</span> </em><code class="sig-name descname"><span class="pre">use_startup</span></code><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="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">cpl_core.application.startup_abc.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_abc.ApplicationBuilderABC.use_startup" title="Permalink to this definition"></a></dt>
<dd><p>Sets the custom startup class to use async</p>
<blockquote>
<div><dl class="simple">
<dt>startup: Type[<a class="reference internal" href="#cpl_core.application.startup_abc.StartupABC" title="cpl_core.application.startup_abc.StartupABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.application.startup_abc.StartupABC</span></code></a>]</dt><dd><p>Startup class to use</p>
@@ -202,15 +317,15 @@
</div>
<div class="section" id="module-cpl_core.application.startup_abc">
<span id="cpl-core-application-startup-abc"></span><h2>cpl_core.application.startup_abc<a class="headerlink" href="#module-cpl_core.application.startup_abc" title="Permalink to this headline"></a></h2>
<span id="cpl-core-application-startup-abc"></span><h2>cpl_core.application.startup_abc<a class="headerlink" href="#module-cpl_core.application.startup_abc" title="Permalink to this headline"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="cpl_core.application.startup_abc.StartupABC">
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">cpl_core.application.startup_abc.</span></span><span class="sig-name descname"><span class="pre">StartupABC</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.application.startup_abc.StartupABC" title="Permalink to this definition"></a></dt>
<dt id="cpl_core.application.startup_abc.StartupABC">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_core.application.startup_abc.</span></code><code class="sig-name descname"><span class="pre">StartupABC</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.application.startup_abc.StartupABC" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">abc.ABC</span></code></p>
<p>ABC for the startup class</p>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_core.application.startup_abc.StartupABC.configure_configuration">
<em class="property"><span class="pre">abstract</span> </em><span class="sig-name descname"><span class="pre">configure_configuration</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_abc.ConfigurationABC" title="cpl_core.configuration.configuration_abc.ConfigurationABC"><span class="pre">cpl_core.configuration.configuration_abc.ConfigurationABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">env</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl_core.environment.html#cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC" title="cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC"><span class="pre">cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_abc.ConfigurationABC" title="cpl_core.configuration.configuration_abc.ConfigurationABC"><span class="pre">cpl_core.configuration.configuration_abc.ConfigurationABC</span></a></span></span><a class="headerlink" href="#cpl_core.application.startup_abc.StartupABC.configure_configuration" title="Permalink to this definition"></a></dt>
<dt id="cpl_core.application.startup_abc.StartupABC.configure_configuration">
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">configure_configuration</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_abc.ConfigurationABC" title="cpl_core.configuration.configuration_abc.ConfigurationABC"><span class="pre">cpl_core.configuration.configuration_abc.ConfigurationABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">env</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl_core.environment.html#cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC" title="cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC"><span class="pre">cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC</span></a></span></em><span class="sig-paren">)</span> &#x2192; <a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_abc.ConfigurationABC" title="cpl_core.configuration.configuration_abc.ConfigurationABC"><span class="pre">cpl_core.configuration.configuration_abc.ConfigurationABC</span></a><a class="headerlink" href="#cpl_core.application.startup_abc.StartupABC.configure_configuration" title="Permalink to this definition"></a></dt>
<dd><p>Creates configuration of application</p>
<blockquote>
<div><p>config: <a class="reference internal" href="cpl_core.configuration.html#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">cpl_core.configuration.configuration_abc.ConfigurationABC</span></code></a>
@@ -222,8 +337,8 @@ env: <a class="reference internal" href="cpl_core.environment.html#module-cpl_co
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_core.application.startup_abc.StartupABC.configure_services">
<em class="property"><span class="pre">abstract</span> </em><span class="sig-name descname"><span class="pre">configure_services</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC" title="cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC"><span class="pre">cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">env</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl_core.environment.html#cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC" title="cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC"><span class="pre">cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC"><span class="pre">cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC</span></a></span></span><a class="headerlink" href="#cpl_core.application.startup_abc.StartupABC.configure_services" title="Permalink to this definition"></a></dt>
<dt id="cpl_core.application.startup_abc.StartupABC.configure_services">
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">configure_services</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC" title="cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC"><span class="pre">cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">env</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl_core.environment.html#cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC" title="cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC"><span class="pre">cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC</span></a></span></em><span class="sig-paren">)</span> &#x2192; <a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC"><span class="pre">cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC</span></a><a class="headerlink" href="#cpl_core.application.startup_abc.StartupABC.configure_services" title="Permalink to this definition"></a></dt>
<dd><p>Creates service provider</p>
<blockquote>
<div><p>services: <a class="reference internal" href="cpl_core.dependency_injection.html#module-cpl_core.dependency_injection.service_collection_abc" title="cpl_core.dependency_injection.service_collection_abc"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.dependency_injection.service_collection_abc</span></code></a>
@@ -241,33 +356,50 @@ env: <a class="reference internal" href="cpl_core.environment.html#module-cpl_co
</div>
</div>
<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>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<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.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>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2021, Sven Heidemann.</p>
</div>
<p>
&#169; Copyright 2021, Sven Heidemann.
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
</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>.
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</script>
</body>
</html>

View File

@@ -1,33 +1,70 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>cpl_core.configuration &mdash; 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" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.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 type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/js/theme.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="cpl_core.console" href="cpl_core.console.html" />
<link rel="prev" title="cpl_core.application" href="cpl_core.application.html" />
</head>
<body class="wy-body-for-nav">
<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" />
@@ -35,7 +72,18 @@
<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">
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<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>
@@ -63,42 +111,84 @@
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query 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" >
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<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">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl_core.html">API Reference</a> &raquo;</li>
<li>cpl_core.configuration</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/cpl_core.configuration.rst.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">
<div class="section" id="cpl-core-configuration">
<h1>cpl_core.configuration<a class="headerlink" href="#cpl-core-configuration" title="Permalink to this headline"></a></h1>
<h1>cpl_core.configuration<a class="headerlink" href="#cpl-core-configuration" title="Permalink to this headline"></a></h1>
<div class="section" id="module-cpl_core.configuration.configuration">
<span id="cpl-core-configuration-configuration"></span><h2>cpl_core.configuration.configuration<a class="headerlink" href="#module-cpl_core.configuration.configuration" title="Permalink to this headline"></a></h2>
<span id="cpl-core-configuration-configuration"></span><h2>cpl_core.configuration.configuration<a class="headerlink" href="#module-cpl_core.configuration.configuration" title="Permalink to this headline"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="cpl_core.configuration.configuration.Configuration">
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">cpl_core.configuration.configuration.</span></span><span class="sig-name descname"><span class="pre">Configuration</span></span><a class="headerlink" href="#cpl_core.configuration.configuration.Configuration" title="Permalink to this definition"></a></dt>
<dt id="cpl_core.configuration.configuration.Configuration">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_core.configuration.configuration.</span></code><code class="sig-name descname"><span class="pre">Configuration</span></code><a class="headerlink" href="#cpl_core.configuration.configuration.Configuration" title="Permalink to this definition"></a></dt>
<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">cpl_core.configuration.configuration_abc.ConfigurationABC</span></code></a></p>
<dl class="py method">
<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="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="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="n"><a class="reference internal" href="#cpl_core.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl_core.configuration.configuration_model_abc.ConfigurationModelABC"><span class="pre">cpl_core.configuration.configuration_model_abc.ConfigurationModelABC</span></a></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>
<dt id="cpl_core.configuration.configuration.Configuration.add_configuration">
<code class="sig-name descname"><span class="pre">add_configuration</span></code><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="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="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="n"><a class="reference internal" href="#cpl_core.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl_core.configuration.configuration_model_abc.ConfigurationModelABC"><span class="pre">cpl_core.configuration.configuration_model_abc.ConfigurationModelABC</span></a></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>
<blockquote>
<div><dl class="simple">
@@ -111,8 +201,8 @@
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_core.configuration.configuration.Configuration.add_console_argument">
<span class="sig-name descname"><span class="pre">add_console_argument</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">argument</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="#cpl_core.configuration.console_argument.ConsoleArgument" title="cpl_core.configuration.console_argument.ConsoleArgument"><span class="pre">cpl_core.configuration.console_argument.ConsoleArgument</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.configuration.Configuration.add_console_argument" title="Permalink to this definition"></a></dt>
<dt id="cpl_core.configuration.configuration.Configuration.add_console_argument">
<code class="sig-name descname"><span class="pre">add_console_argument</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">argument</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="#cpl_core.configuration.console_argument.ConsoleArgument" title="cpl_core.configuration.console_argument.ConsoleArgument"><span class="pre">cpl_core.configuration.console_argument.ConsoleArgument</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.configuration.Configuration.add_console_argument" title="Permalink to this definition"></a></dt>
<dd><p>Adds console argument to known console arguments</p>
<blockquote>
<div><dl class="simple">
@@ -123,8 +213,8 @@
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_core.configuration.configuration.Configuration.add_console_arguments">
<span class="sig-name descname"><span class="pre">add_console_arguments</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">error</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.configuration.Configuration.add_console_arguments" title="Permalink to this definition"></a></dt>
<dt id="cpl_core.configuration.configuration.Configuration.add_console_arguments">
<code class="sig-name descname"><span class="pre">add_console_arguments</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">error</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.configuration.Configuration.add_console_arguments" title="Permalink to this definition"></a></dt>
<dd><p>Reads the console arguments</p>
<blockquote>
<div><dl class="simple">
@@ -135,8 +225,8 @@
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_core.configuration.configuration.Configuration.add_environment_variables">
<span class="sig-name descname"><span class="pre">add_environment_variables</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">prefix</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.configuration.Configuration.add_environment_variables" title="Permalink to this definition"></a></dt>
<dt id="cpl_core.configuration.configuration.Configuration.add_environment_variables">
<code class="sig-name descname"><span class="pre">add_environment_variables</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">prefix</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.configuration.Configuration.add_environment_variables" title="Permalink to this definition"></a></dt>
<dd><p>Reads the environment variables</p>
<blockquote>
<div><dl class="simple">
@@ -147,8 +237,8 @@
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_core.configuration.configuration.Configuration.add_json_file">
<span class="sig-name descname"><span class="pre">add_json_file</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">optional</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">bool</span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">path</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.configuration.Configuration.add_json_file" title="Permalink to this definition"></a></dt>
<dt id="cpl_core.configuration.configuration.Configuration.add_json_file">
<code class="sig-name descname"><span class="pre">add_json_file</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">optional</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">bool</span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">path</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.configuration.Configuration.add_json_file" title="Permalink to this definition"></a></dt>
<dd><p>Reads and saves settings from given json file</p>
<blockquote>
<div><dl class="simple">
@@ -164,24 +254,24 @@
</div></blockquote>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="cpl_core.configuration.configuration.Configuration.additional_arguments">
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">additional_arguments</span></span><em class="property"><span class="pre">:</span> <span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#cpl_core.configuration.configuration.Configuration.additional_arguments" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="cpl_core.configuration.configuration.Configuration.argument_error_function">
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">argument_error_function</span></span><em class="property"><span class="pre">:</span> <span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">collections.abc.Callable</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#cpl_core.configuration.configuration.Configuration.argument_error_function" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="cpl_core.configuration.configuration.Configuration.environment">
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">environment</span></span><em class="property"><span class="pre">:</span> <a class="reference internal" href="cpl_core.environment.html#cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC" title="cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC"><span class="pre">cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC</span></a></em><a class="headerlink" href="#cpl_core.configuration.configuration.Configuration.environment" title="Permalink to this definition"></a></dt>
<dl class="py method">
<dt id="cpl_core.configuration.configuration.Configuration.additional_arguments">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">additional_arguments</span></code><a class="headerlink" href="#cpl_core.configuration.configuration.Configuration.additional_arguments" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<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="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="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">cpl_core.configuration.configuration_model_abc.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">&#x2192;</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="pre">collections.abc.Callable</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">cpl_core.configuration.configuration_model_abc.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>
<dt id="cpl_core.configuration.configuration.Configuration.argument_error_function">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">argument_error_function</span></code><a class="headerlink" href="#cpl_core.configuration.configuration.Configuration.argument_error_function" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="cpl_core.configuration.configuration.Configuration.environment">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">environment</span></code><a class="headerlink" href="#cpl_core.configuration.configuration.Configuration.environment" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="cpl_core.configuration.configuration.Configuration.get_configuration">
<code class="sig-name descname"><span class="pre">get_configuration</span></code><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="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="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">cpl_core.configuration.configuration_model_abc.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> &#x2192; <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="pre">collections.abc.Callable</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">cpl_core.configuration.configuration_model_abc.ConfigurationModelABC</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</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>
<blockquote>
<div><dl class="simple">
@@ -198,14 +288,14 @@
</div>
<div class="section" id="module-cpl_core.configuration.configuration_abc">
<span id="cpl-core-configuration-configuration-abc"></span><h2>cpl_core.configuration.configuration_abc<a class="headerlink" href="#module-cpl_core.configuration.configuration_abc" title="Permalink to this headline"></a></h2>
<span id="cpl-core-configuration-configuration-abc"></span><h2>cpl_core.configuration.configuration_abc<a class="headerlink" href="#module-cpl_core.configuration.configuration_abc" title="Permalink to this headline"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="cpl_core.configuration.configuration_abc.ConfigurationABC">
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">cpl_core.configuration.configuration_abc.</span></span><span class="sig-name descname"><span class="pre">ConfigurationABC</span></span><a class="headerlink" href="#cpl_core.configuration.configuration_abc.ConfigurationABC" title="Permalink to this definition"></a></dt>
<dt id="cpl_core.configuration.configuration_abc.ConfigurationABC">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_core.configuration.configuration_abc.</span></code><code class="sig-name descname"><span class="pre">ConfigurationABC</span></code><a class="headerlink" href="#cpl_core.configuration.configuration_abc.ConfigurationABC" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">abc.ABC</span></code></p>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_core.configuration.configuration_abc.ConfigurationABC.add_configuration">
<em class="property"><span class="pre">abstract</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="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="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="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><a class="reference internal" href="#cpl_core.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl_core.configuration.configuration_model_abc.ConfigurationModelABC"><span class="pre">cpl_core.configuration.configuration_model_abc.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>
<dt id="cpl_core.configuration.configuration_abc.ConfigurationABC.add_configuration">
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">add_configuration</span></code><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="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="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="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><a class="reference internal" href="#cpl_core.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl_core.configuration.configuration_model_abc.ConfigurationModelABC"><span class="pre">cpl_core.configuration.configuration_model_abc.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>
<dd><p>Add configuration object</p>
<blockquote>
<div><dl class="simple">
@@ -218,8 +308,8 @@
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_core.configuration.configuration_abc.ConfigurationABC.add_console_argument">
<em class="property"><span class="pre">abstract</span> </em><span class="sig-name descname"><span class="pre">add_console_argument</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">argument</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="#cpl_core.configuration.console_argument.ConsoleArgument" title="cpl_core.configuration.console_argument.ConsoleArgument"><span class="pre">cpl_core.configuration.console_argument.ConsoleArgument</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.configuration_abc.ConfigurationABC.add_console_argument" title="Permalink to this definition"></a></dt>
<dt id="cpl_core.configuration.configuration_abc.ConfigurationABC.add_console_argument">
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">add_console_argument</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">argument</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="#cpl_core.configuration.console_argument.ConsoleArgument" title="cpl_core.configuration.console_argument.ConsoleArgument"><span class="pre">cpl_core.configuration.console_argument.ConsoleArgument</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.configuration_abc.ConfigurationABC.add_console_argument" title="Permalink to this definition"></a></dt>
<dd><p>Adds console argument to known console arguments</p>
<blockquote>
<div><dl class="simple">
@@ -230,8 +320,8 @@
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_core.configuration.configuration_abc.ConfigurationABC.add_console_arguments">
<em class="property"><span class="pre">abstract</span> </em><span class="sig-name descname"><span class="pre">add_console_arguments</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">error</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.configuration_abc.ConfigurationABC.add_console_arguments" title="Permalink to this definition"></a></dt>
<dt id="cpl_core.configuration.configuration_abc.ConfigurationABC.add_console_arguments">
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">add_console_arguments</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">error</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.configuration_abc.ConfigurationABC.add_console_arguments" title="Permalink to this definition"></a></dt>
<dd><p>Reads the console arguments</p>
<blockquote>
<div><dl class="simple">
@@ -242,8 +332,8 @@
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_core.configuration.configuration_abc.ConfigurationABC.add_environment_variables">
<em class="property"><span class="pre">abstract</span> </em><span class="sig-name descname"><span class="pre">add_environment_variables</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">prefix</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.configuration_abc.ConfigurationABC.add_environment_variables" title="Permalink to this definition"></a></dt>
<dt id="cpl_core.configuration.configuration_abc.ConfigurationABC.add_environment_variables">
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">add_environment_variables</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">prefix</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.configuration_abc.ConfigurationABC.add_environment_variables" title="Permalink to this definition"></a></dt>
<dd><p>Reads the environment variables</p>
<blockquote>
<div><dl class="simple">
@@ -254,8 +344,8 @@
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_core.configuration.configuration_abc.ConfigurationABC.add_json_file">
<em class="property"><span class="pre">abstract</span> </em><span class="sig-name descname"><span class="pre">add_json_file</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">optional</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">bool</span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">path</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.configuration_abc.ConfigurationABC.add_json_file" title="Permalink to this definition"></a></dt>
<dt id="cpl_core.configuration.configuration_abc.ConfigurationABC.add_json_file">
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">add_json_file</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">optional</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">bool</span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">path</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.configuration_abc.ConfigurationABC.add_json_file" title="Permalink to this definition"></a></dt>
<dd><p>Reads and saves settings from given json file</p>
<blockquote>
<div><dl class="simple">
@@ -271,24 +361,24 @@
</div></blockquote>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="cpl_core.configuration.configuration_abc.ConfigurationABC.additional_arguments">
<em class="property"><span class="pre">abstract</span> <span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">additional_arguments</span></span><em class="property"><span class="pre">:</span> <span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#cpl_core.configuration.configuration_abc.ConfigurationABC.additional_arguments" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="cpl_core.configuration.configuration_abc.ConfigurationABC.argument_error_function">
<em class="property"><span class="pre">abstract</span> <span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">argument_error_function</span></span><em class="property"><span class="pre">:</span> <span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">collections.abc.Callable</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#cpl_core.configuration.configuration_abc.ConfigurationABC.argument_error_function" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="cpl_core.configuration.configuration_abc.ConfigurationABC.environment">
<em class="property"><span class="pre">abstract</span> <span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">environment</span></span><em class="property"><span class="pre">:</span> <a class="reference internal" href="cpl_core.environment.html#cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC" title="cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC"><span class="pre">cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC</span></a></em><a class="headerlink" href="#cpl_core.configuration.configuration_abc.ConfigurationABC.environment" title="Permalink to this definition"></a></dt>
<dl class="py method">
<dt id="cpl_core.configuration.configuration_abc.ConfigurationABC.additional_arguments">
<em class="property"><span class="pre">abstract</span> <span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">additional_arguments</span></code><a class="headerlink" href="#cpl_core.configuration.configuration_abc.ConfigurationABC.additional_arguments" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_core.configuration.configuration_abc.ConfigurationABC.get_configuration">
<em class="property"><span class="pre">abstract</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="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="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">cpl_core.configuration.configuration_model_abc.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">&#x2192;</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="pre">collections.abc.Callable</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">cpl_core.configuration.configuration_model_abc.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_abc.ConfigurationABC.get_configuration" title="Permalink to this definition"></a></dt>
<dt id="cpl_core.configuration.configuration_abc.ConfigurationABC.argument_error_function">
<em class="property"><span class="pre">abstract</span> <span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">argument_error_function</span></code><a class="headerlink" href="#cpl_core.configuration.configuration_abc.ConfigurationABC.argument_error_function" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="cpl_core.configuration.configuration_abc.ConfigurationABC.environment">
<em class="property"><span class="pre">abstract</span> <span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">environment</span></code><a class="headerlink" href="#cpl_core.configuration.configuration_abc.ConfigurationABC.environment" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="cpl_core.configuration.configuration_abc.ConfigurationABC.get_configuration">
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">get_configuration</span></code><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="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="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">cpl_core.configuration.configuration_model_abc.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> &#x2192; <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="pre">collections.abc.Callable</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">cpl_core.configuration.configuration_model_abc.ConfigurationModelABC</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</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>
<blockquote>
<div><dl class="simple">
@@ -305,14 +395,14 @@
</div>
<div class="section" id="module-cpl_core.configuration.configuration_model_abc">
<span id="cpl-core-configuration-configuration-model-abc"></span><h2>cpl_core.configuration.configuration_model_abc<a class="headerlink" href="#module-cpl_core.configuration.configuration_model_abc" title="Permalink to this headline"></a></h2>
<span id="cpl-core-configuration-configuration-model-abc"></span><h2>cpl_core.configuration.configuration_model_abc<a class="headerlink" href="#module-cpl_core.configuration.configuration_model_abc" title="Permalink to this headline"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="cpl_core.configuration.configuration_model_abc.ConfigurationModelABC">
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">cpl_core.configuration.configuration_model_abc.</span></span><span class="sig-name descname"><span class="pre">ConfigurationModelABC</span></span><a class="headerlink" href="#cpl_core.configuration.configuration_model_abc.ConfigurationModelABC" title="Permalink to this definition"></a></dt>
<dt id="cpl_core.configuration.configuration_model_abc.ConfigurationModelABC">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_core.configuration.configuration_model_abc.</span></code><code class="sig-name descname"><span class="pre">ConfigurationModelABC</span></code><a class="headerlink" href="#cpl_core.configuration.configuration_model_abc.ConfigurationModelABC" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">abc.ABC</span></code></p>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_core.configuration.configuration_model_abc.ConfigurationModelABC.from_dict">
<em class="property"><span class="pre">abstract</span> </em><span class="sig-name descname"><span class="pre">from_dict</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">settings</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">dict</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.configuration_model_abc.ConfigurationModelABC.from_dict" title="Permalink to this definition"></a></dt>
<dt id="cpl_core.configuration.configuration_model_abc.ConfigurationModelABC.from_dict">
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">from_dict</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">settings</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">dict</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.configuration_model_abc.ConfigurationModelABC.from_dict" title="Permalink to this definition"></a></dt>
<dd><p>Converts attributes to dict</p>
<blockquote>
<div><p>settings: <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></p>
@@ -323,69 +413,69 @@
</div>
<div class="section" id="module-cpl_core.configuration.configuration_variable_name_enum">
<span id="cpl-core-configuration-configuration-variable-name-enum"></span><h2>cpl_core.configuration.configuration_variable_name_enum<a class="headerlink" href="#module-cpl_core.configuration.configuration_variable_name_enum" title="Permalink to this headline"></a></h2>
<span id="cpl-core-configuration-configuration-variable-name-enum"></span><h2>cpl_core.configuration.configuration_variable_name_enum<a class="headerlink" href="#module-cpl_core.configuration.configuration_variable_name_enum" title="Permalink to this headline"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="cpl_core.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum">
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">cpl_core.configuration.configuration_variable_name_enum.</span></span><span class="sig-name descname"><span class="pre">ConfigurationVariableNameEnum</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum" title="Permalink to this definition"></a></dt>
<dt id="cpl_core.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_core.configuration.configuration_variable_name_enum.</span></code><code class="sig-name descname"><span class="pre">ConfigurationVariableNameEnum</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">enum.Enum</span></code></p>
<p>An enumeration.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="cpl_core.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum.customer">
<span class="sig-name descname"><span class="pre">customer</span></span><em class="property"> <span class="pre">=</span> <span class="pre">'CUSTOMER'</span></em><a class="headerlink" href="#cpl_core.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum.customer" title="Permalink to this definition"></a></dt>
<dt id="cpl_core.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum.customer">
<code class="sig-name descname"><span class="pre">customer</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'CUSTOMER'</span></em><a class="headerlink" href="#cpl_core.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum.customer" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="cpl_core.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum.environment">
<span class="sig-name descname"><span class="pre">environment</span></span><em class="property"> <span class="pre">=</span> <span class="pre">'ENVIRONMENT'</span></em><a class="headerlink" href="#cpl_core.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum.environment" title="Permalink to this definition"></a></dt>
<dt id="cpl_core.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum.environment">
<code class="sig-name descname"><span class="pre">environment</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'ENVIRONMENT'</span></em><a class="headerlink" href="#cpl_core.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum.environment" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="cpl_core.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum.name">
<span class="sig-name descname"><span class="pre">name</span></span><em class="property"> <span class="pre">=</span> <span class="pre">'NAME'</span></em><a class="headerlink" href="#cpl_core.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum.name" title="Permalink to this definition"></a></dt>
<dt id="cpl_core.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum.name">
<code class="sig-name descname"><span class="pre">name</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'NAME'</span></em><a class="headerlink" href="#cpl_core.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum.name" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_core.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum.to_list">
<em class="property"><span class="pre">static</span> </em><span class="sig-name descname"><span class="pre">to_list</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum.to_list" title="Permalink to this definition"></a></dt>
<dt id="cpl_core.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum.to_list">
<em class="property"><span class="pre">static</span> </em><code class="sig-name descname"><span class="pre">to_list</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum.to_list" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</div>
<div class="section" id="module-cpl_core.configuration.console_argument">
<span id="cpl-core-configuration-console-argument"></span><h2>cpl_core.configuration.console_argument<a class="headerlink" href="#module-cpl_core.configuration.console_argument" title="Permalink to this headline"></a></h2>
<span id="cpl-core-configuration-console-argument"></span><h2>cpl_core.configuration.console_argument<a class="headerlink" href="#module-cpl_core.configuration.console_argument" title="Permalink to this headline"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="cpl_core.configuration.console_argument.ConsoleArgument">
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">cpl_core.configuration.console_argument.</span></span><span class="sig-name descname"><span class="pre">ConsoleArgument</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">token</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">aliases</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value_token</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">is_value_token_optional</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">console_arguments</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">'ConsoleArgument'</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.console_argument.ConsoleArgument" title="Permalink to this definition"></a></dt>
<dt id="cpl_core.configuration.console_argument.ConsoleArgument">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_core.configuration.console_argument.</span></code><code class="sig-name descname"><span class="pre">ConsoleArgument</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">token</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">aliases</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">list</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value_token</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">is_value_token_optional</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">console_arguments</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">list</span><span class="p"><span class="pre">]</span></span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.console_argument.ConsoleArgument" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<dl class="py property">
<dt class="sig sig-object py" id="cpl_core.configuration.console_argument.ConsoleArgument.aliases">
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">aliases</span></span><em class="property"><span class="pre">:</span> <span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#cpl_core.configuration.console_argument.ConsoleArgument.aliases" title="Permalink to this definition"></a></dt>
<dl class="py method">
<dt id="cpl_core.configuration.console_argument.ConsoleArgument.aliases">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">aliases</span></code><a class="headerlink" href="#cpl_core.configuration.console_argument.ConsoleArgument.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="cpl_core.configuration.console_argument.ConsoleArgument.console_arguments">
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">console_arguments</span></span><em class="property"><span class="pre">:</span> <span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">'ConsoleArgument'</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#cpl_core.configuration.console_argument.ConsoleArgument.console_arguments" title="Permalink to this definition"></a></dt>
<dl class="py method">
<dt id="cpl_core.configuration.console_argument.ConsoleArgument.console_arguments">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">console_arguments</span></code><a class="headerlink" href="#cpl_core.configuration.console_argument.ConsoleArgument.console_arguments" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="cpl_core.configuration.console_argument.ConsoleArgument.is_value_token_optional">
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">is_value_token_optional</span></span><em class="property"><span class="pre">:</span> <span class="pre">bool</span></em><a class="headerlink" href="#cpl_core.configuration.console_argument.ConsoleArgument.is_value_token_optional" title="Permalink to this definition"></a></dt>
<dl class="py method">
<dt id="cpl_core.configuration.console_argument.ConsoleArgument.is_value_token_optional">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">is_value_token_optional</span></code><a class="headerlink" href="#cpl_core.configuration.console_argument.ConsoleArgument.is_value_token_optional" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="cpl_core.configuration.console_argument.ConsoleArgument.name">
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="pre">:</span> <span class="pre">str</span></em><a class="headerlink" href="#cpl_core.configuration.console_argument.ConsoleArgument.name" title="Permalink to this definition"></a></dt>
<dl class="py method">
<dt id="cpl_core.configuration.console_argument.ConsoleArgument.name">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">name</span></code><a class="headerlink" href="#cpl_core.configuration.console_argument.ConsoleArgument.name" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="cpl_core.configuration.console_argument.ConsoleArgument.token">
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">token</span></span><em class="property"><span class="pre">:</span> <span class="pre">str</span></em><a class="headerlink" href="#cpl_core.configuration.console_argument.ConsoleArgument.token" title="Permalink to this definition"></a></dt>
<dl class="py method">
<dt id="cpl_core.configuration.console_argument.ConsoleArgument.token">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">token</span></code><a class="headerlink" href="#cpl_core.configuration.console_argument.ConsoleArgument.token" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="cpl_core.configuration.console_argument.ConsoleArgument.value_token">
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">value_token</span></span><em class="property"><span class="pre">:</span> <span class="pre">str</span></em><a class="headerlink" href="#cpl_core.configuration.console_argument.ConsoleArgument.value_token" title="Permalink to this definition"></a></dt>
<dl class="py method">
<dt id="cpl_core.configuration.console_argument.ConsoleArgument.value_token">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">value_token</span></code><a class="headerlink" href="#cpl_core.configuration.console_argument.ConsoleArgument.value_token" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
@@ -395,33 +485,50 @@
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="cpl_core.application.html" class="btn btn-neutral float-left" title="cpl_core.application" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="cpl_core.console.html" class="btn btn-neutral float-right" title="cpl_core.console" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="cpl_core.application.html" class="btn btn-neutral float-left" title="cpl_core.application" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2021, Sven Heidemann.</p>
</div>
<p>
&#169; Copyright 2021, Sven Heidemann.
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
</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>.
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</script>
</body>
</html>

File diff suppressed because one or more lines are too long

Some files were not shown because too many files have changed in this diff Show More