Compare commits
No commits in common. "master" and "2021.10.0" have entirely different histories.
6
.gitignore
vendored
6
.gitignore
vendored
@ -106,7 +106,6 @@ celerybeat.pid
|
||||
.venv
|
||||
env/
|
||||
venv/
|
||||
venv_*/
|
||||
ENV/
|
||||
env.bak/
|
||||
venv.bak/
|
||||
@ -133,8 +132,5 @@ dmypy.json
|
||||
.pyre/
|
||||
|
||||
# IDE
|
||||
.vscode/
|
||||
.idea/
|
||||
PythonImportHelper-v2-Completion.json
|
||||
|
||||
# cpl unittest stuff
|
||||
unittests/test_*_playground
|
||||
|
2
LICENSE
2
LICENSE
@ -1,4 +1,4 @@
|
||||
MIT License Copyright (c) 2020 - 2023 sh-edraft.de
|
||||
MIT License Copyright (c) 2020 - 2021 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
|
||||
|
63
README.md
63
README.md
@ -13,7 +13,6 @@
|
||||
## Table of Contents
|
||||
<!-- TABLE OF CONTENTS -->
|
||||
<ol>
|
||||
<li><a href="#Features">Features</a></li>
|
||||
<li>
|
||||
<a href="#getting-started">Getting Started</a>
|
||||
<ul>
|
||||
@ -27,52 +26,6 @@
|
||||
<li><a href="#contact">Contact</a></li>
|
||||
</ol>
|
||||
|
||||
## Features
|
||||
<!-- FEATURE OVERVIEW -->
|
||||
- Expandle
|
||||
- Application base
|
||||
- Standardized application classes
|
||||
- Application object builder
|
||||
- Application extension classes
|
||||
- Startup classes
|
||||
- Startup extension classes
|
||||
- Configuration
|
||||
- Configure via object mapped JSON
|
||||
- Console argument handling
|
||||
- Console class for in and output
|
||||
- Banner
|
||||
- Spinner
|
||||
- Options (menu)
|
||||
- Table
|
||||
- Write
|
||||
- Write_at
|
||||
- Write_line
|
||||
- Write_line_at
|
||||
- Dependency injection
|
||||
- Service lifetimes: singleton, scoped and transient
|
||||
- Providing of application environment
|
||||
- Environment (development, staging, testing, production)
|
||||
- Appname
|
||||
- Customer
|
||||
- Hostname
|
||||
- Runtime directory
|
||||
- Working directory
|
||||
- Logging
|
||||
- Standardized logger
|
||||
- Log-level (FATAL, ERROR, WARN, INFO, DEBUG & TRACE)
|
||||
- Mail handling
|
||||
- Send mails
|
||||
- Pipe classes
|
||||
- Convert input
|
||||
- Utils
|
||||
- Credential manager
|
||||
- Encryption via BASE64
|
||||
- PIP wrapper class based on subprocess
|
||||
- Run pip commands
|
||||
- String converter to different variants
|
||||
- to_lower_case
|
||||
- to_camel_case
|
||||
- ...
|
||||
|
||||
<!-- GETTING STARTED -->
|
||||
## Getting Started
|
||||
@ -87,17 +40,17 @@
|
||||
|
||||
Install the CPL package
|
||||
```sh
|
||||
pip install cpl-core --extra-index-url https://pip.sh-edraft.de
|
||||
pip install sh_cpl --extra-index-url https://pip.sh-edraft.de
|
||||
```
|
||||
|
||||
Install the CPL CLI
|
||||
```sh
|
||||
pip install cpl-cli --extra-index-url https://pip.sh-edraft.de
|
||||
pip install sh_cpl-cli --extra-index-url https://pip.sh-edraft.de
|
||||
```
|
||||
|
||||
Create workspace:
|
||||
```sh
|
||||
cpl new <console|library|unittest> <PROJECT NAME>
|
||||
cpl new <console|library> <PROJECT NAME>
|
||||
```
|
||||
|
||||
Run the application:
|
||||
@ -110,7 +63,7 @@ cpl start
|
||||
<!-- ROADMAP -->
|
||||
## Roadmap
|
||||
|
||||
See the [open issues](https://git.sh-edraft.de/sh-edraft.de/sh_cpl/issues) for a list of proposed features (and known issues).
|
||||
See the [open issues](https://git.sh-edraft.de/sh-edraft.de/sh_common_py_lib/issues) for a list of proposed features (and known issues).
|
||||
|
||||
|
||||
|
||||
@ -139,7 +92,7 @@ Distributed under the MIT License. See [LICENSE] for more information.
|
||||
|
||||
Sven Heidemann - sven.heidemann@sh-edraft.de
|
||||
|
||||
Project link: [https://git.sh-edraft.de/sh-edraft.de/sh_common_py_lib](https://git.sh-edraft.de/sh-edraft.de/sh_cpl)
|
||||
Project link: [https://git.sh-edraft.de/sh-edraft.de/sh_common_py_lib](https://git.sh-edraft.de/sh-edraft.de/sh_common_py_lib)
|
||||
|
||||
<!-- External LINKS -->
|
||||
[pip_url]: https://pip.sh-edraft.de
|
||||
@ -147,7 +100,7 @@ Project link: [https://git.sh-edraft.de/sh-edraft.de/sh_common_py_lib](https://g
|
||||
[pip]: https://pypi.org/project/pip/
|
||||
|
||||
<!-- Internal LINKS -->
|
||||
[project]: https://git.sh-edraft.de/sh-edraft.de/sh_cpl
|
||||
[quickstart]: https://git.sh-edraft.de/sh-edraft.de/sh_cpl/wiki/quickstart
|
||||
[contributing]: https://git.sh-edraft.de/sh-edraft.de/sh_cpl/wiki/contributing
|
||||
[project]: https://git.sh-edraft.de/sh-edraft.de/sh_common_py_lib
|
||||
[quickstart]: https://git.sh-edraft.de/sh-edraft.de/sh_common_py_lib/wiki/quickstart
|
||||
[contributing]: https://git.sh-edraft.de/sh-edraft.de/sh_common_py_lib/wiki/contributing
|
||||
[license]: LICENSE
|
||||
|
@ -1,151 +1,11 @@
|
||||
{
|
||||
"WorkspaceSettings": {
|
||||
"DefaultProject": "cpl-core",
|
||||
"DefaultProject": "cpl_cli",
|
||||
"Projects": {
|
||||
"cpl-cli": "src/cpl_cli/cpl-cli.json",
|
||||
"cpl-core": "src/cpl_core/cpl-core.json",
|
||||
"cpl-discord": "src/cpl_discord/cpl-discord.json",
|
||||
"cpl-query": "src/cpl_query/cpl-query.json",
|
||||
"cpl-translation": "src/cpl_translation/cpl-translation.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",
|
||||
"unittests_translation": "unittests/unittests_translation/unittests_translation.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"
|
||||
},
|
||||
"Scripts": {
|
||||
"hello-world": "echo 'Hello World'",
|
||||
|
||||
"format": "echo 'Formatting:'; black ./",
|
||||
|
||||
"sv": "cpl set-version",
|
||||
"set-version": "cpl run set-version --dev $ARGS; echo '';",
|
||||
|
||||
"spu": "cpl set-pip-urls",
|
||||
"set-pip-urls": "cpl run set-pip-urls --dev $ARGS; echo '';",
|
||||
|
||||
"docs-build": "cpl format; echo 'Build Documentation'; cpl db-core; cpl db-discord; cpl db-query; cpl db-translation; cd docs/; make clean; make html;",
|
||||
"db-core": "cd docs/; sphinx-apidoc -o source/ ../src/cpl_core; cd ../",
|
||||
"db-discord": "cd docs/; sphinx-apidoc -o source/ ../src/cpl_discord; cd ../",
|
||||
"db-query": "cd docs/; sphinx-apidoc -o source/ ../src/cpl_query; cd ../",
|
||||
"db-translation": "cd docs/; sphinx-apidoc -o source/ ../src/cpl_translation; cd ../",
|
||||
"db": "cpl docs-build",
|
||||
|
||||
"docs-open": "xdg-open $PWD/docs/build/html/index.html &",
|
||||
"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-discord; cpl build-query; cpl build-translation; 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-discord": "echo 'Build cpl-discord'; cd ./src/cpl_discord; cpl build; cd ../../;",
|
||||
"build-query": "echo 'Build cpl-query'; cd ./src/cpl_query; cpl build; cd ../../;",
|
||||
"build-translation": "echo 'Build cpl-translation'; cd ./src/cpl_translation; 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-discord; cpl publish-query; cpl publish-translation;",
|
||||
"pa": "cpl publish-all $ARGS",
|
||||
"publish-cli": "echo 'Publish cpl-cli'; cd ./src/cpl_cli; cpl publish; cd ../../;",
|
||||
"publish-core": "echo 'Publish cpl-core'; cd ./src/cpl_core; cpl publish; cd ../../;",
|
||||
"publish-discord": "echo 'Publish cpl-discord'; cd ./src/cpl_discord; cpl publish; cd ../../;",
|
||||
"publish-query": "echo 'Publish cpl-query'; cd ./src/cpl_query; cpl publish; cd ../../;",
|
||||
"publish-translation": "echo 'Publish cpl-translation'; cd ./src/cpl_translation; 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-discord": "echo 'PROD Upload cpl-discord'; cpl upl-prod-discord;",
|
||||
"upl-prod-discord": "twine upload -r pip.sh-edraft.de dist/cpl-discord/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-prod-translation": "echo 'PROD Upload cpl-translation'; cpl upl-prod-translation;",
|
||||
"upl-prod-translation": "twine upload -r pip.sh-edraft.de dist/cpl-translation/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-discord": "echo 'EXP Upload cpl-discord'; cpl upl-exp-discord;",
|
||||
"upl-exp-discord": "twine upload -r pip-exp.sh-edraft.de dist/cpl-discord/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-exp-translation": "echo 'EXP Upload cpl-translation'; cpl upl-exp-translation;",
|
||||
"upl-exp-translation": "twine upload -r pip-exp.sh-edraft.de dist/cpl-translation/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-discord": "echo 'DEV Upload cpl-discord'; cpl upl-dev-discord;",
|
||||
"upl-dev-discord": "twine upload -r pip-dev.sh-edraft.de dist/cpl-discord/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/*",
|
||||
|
||||
"upload-dev-translation": "echo 'DEV Upload cpl-translation'; cpl upl-dev-translation;",
|
||||
"upl-dev-translation": "twine upload -r pip-dev.sh-edraft.de dist/cpl-translation/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-discord; cpl deploy-prod-query; cpl deploy-prod-translation;",
|
||||
"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",
|
||||
"deploy-prod-discord": "cpl publish-discord; cpl upload-prod-discord",
|
||||
"deploy-prod-translation": "cpl publish-translation; cpl upload-prod-translation",
|
||||
|
||||
"pre-deploy-exp": "cpl sv $ARGS; cpl spu --environment=staging;",
|
||||
"deploy-exp": "cpl deploy-exp-cli; cpl deploy-exp-core; cpl deploy-exp-discord; cpl deploy-exp-query; cpl deploy-exp-translation;",
|
||||
"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-discord": "cpl publish-discord; cpl upload-exp-discord",
|
||||
"deploy-exp-query": "cpl publish-query; cpl upload-exp-query",
|
||||
"deploy-exp-translation": "cpl publish-translation; cpl upload-exp-translation",
|
||||
|
||||
"pre-deploy-dev": "cpl sv $ARGS; cpl spu --environment=development;",
|
||||
"deploy-dev": "cpl deploy-dev-cli; cpl deploy-dev-core; cpl deploy-dev-discord; cpl deploy-dev-query; cpl deploy-dev-translation;",
|
||||
"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-discord": "cpl publish-discord; cpl upload-dev-discord",
|
||||
"deploy-dev-query": "cpl publish-query; cpl upload-dev-query",
|
||||
"deploy-dev-translation": "cpl publish-query; cpl upload-dev-translation",
|
||||
|
||||
"dev-install": "cpl di-core; cpl di-cli; cpl di-query; cpl di-translation;",
|
||||
"di": "cpl dev-install",
|
||||
"di-core": "pip install cpl-core --pre --upgrade --extra-index-url https://pip-dev.sh-edraft.de",
|
||||
"di-cli": "pip install cpl-cli --pre --upgrade --extra-index-url https://pip-dev.sh-edraft.de",
|
||||
"di-discord": "pip install cpl-discord --pre --upgrade --extra-index-url https://pip-dev.sh-edraft.de",
|
||||
"di-query": "pip install cpl-query --pre --upgrade --extra-index-url https://pip-dev.sh-edraft.de",
|
||||
"di-translation": "pip install cpl-translation --pre --upgrade --extra-index-url https://pip-dev.sh-edraft.de",
|
||||
|
||||
"prod-install": "cpl pi-core; cpl pi-cli; cpl pi-query; cpl pi-translation;",
|
||||
"pi": "cpl prod-install",
|
||||
"pi-core": "pip install cpl-core --pre --upgrade --extra-index-url https://pip.sh-edraft.de",
|
||||
"pi-cli": "pip install cpl-cli --pre --upgrade --extra-index-url https://pip.sh-edraft.de",
|
||||
"pi-discord": "pip install cpl-discord --pre --upgrade --extra-index-url https://pip.sh-edraft.de",
|
||||
"pi-query": "pip install cpl-query --pre --upgrade --extra-index-url https://pip.sh-edraft.de",
|
||||
"pi-translation": "pip install cpl-translation --pre --upgrade --extra-index-url https://pip.sh-edraft.de"
|
||||
}
|
||||
"Scripts": {}
|
||||
}
|
||||
}
|
BIN
docs/build/doctrees/cli.add.doctree
vendored
Normal file
BIN
docs/build/doctrees/cli.add.doctree
vendored
Normal file
Binary file not shown.
BIN
docs/build/doctrees/cli.build.doctree
vendored
Normal file
BIN
docs/build/doctrees/cli.build.doctree
vendored
Normal file
Binary file not shown.
BIN
docs/build/doctrees/cli.generate.doctree
vendored
Normal file
BIN
docs/build/doctrees/cli.generate.doctree
vendored
Normal file
Binary file not shown.
BIN
docs/build/doctrees/cli.help.doctree
vendored
Normal file
BIN
docs/build/doctrees/cli.help.doctree
vendored
Normal file
Binary file not shown.
BIN
docs/build/doctrees/cli.install.doctree
vendored
Normal file
BIN
docs/build/doctrees/cli.install.doctree
vendored
Normal file
Binary file not shown.
BIN
docs/build/doctrees/cli.new.doctree
vendored
Normal file
BIN
docs/build/doctrees/cli.new.doctree
vendored
Normal file
Binary file not shown.
BIN
docs/build/doctrees/cli.overview.doctree
vendored
Normal file
BIN
docs/build/doctrees/cli.overview.doctree
vendored
Normal file
Binary file not shown.
BIN
docs/build/doctrees/cli.publish.doctree
vendored
Normal file
BIN
docs/build/doctrees/cli.publish.doctree
vendored
Normal file
Binary file not shown.
BIN
docs/build/doctrees/cli.remove.doctree
vendored
Normal file
BIN
docs/build/doctrees/cli.remove.doctree
vendored
Normal file
Binary file not shown.
BIN
docs/build/doctrees/cli.start.doctree
vendored
Normal file
BIN
docs/build/doctrees/cli.start.doctree
vendored
Normal file
Binary file not shown.
BIN
docs/build/doctrees/cli.uninstall.doctree
vendored
Normal file
BIN
docs/build/doctrees/cli.uninstall.doctree
vendored
Normal file
Binary file not shown.
BIN
docs/build/doctrees/cli.update.doctree
vendored
Normal file
BIN
docs/build/doctrees/cli.update.doctree
vendored
Normal file
Binary file not shown.
BIN
docs/build/doctrees/cli.version.doctree
vendored
Normal file
BIN
docs/build/doctrees/cli.version.doctree
vendored
Normal file
Binary file not shown.
BIN
docs/build/doctrees/contributing.doctree
vendored
BIN
docs/build/doctrees/contributing.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl.application.doctree
vendored
Normal file
BIN
docs/build/doctrees/cpl.application.doctree
vendored
Normal file
Binary file not shown.
BIN
docs/build/doctrees/cpl.configuration.doctree
vendored
Normal file
BIN
docs/build/doctrees/cpl.configuration.doctree
vendored
Normal file
Binary file not shown.
BIN
docs/build/doctrees/cpl.console.doctree
vendored
Normal file
BIN
docs/build/doctrees/cpl.console.doctree
vendored
Normal file
Binary file not shown.
BIN
docs/build/doctrees/cpl.database.connection.doctree
vendored
Normal file
BIN
docs/build/doctrees/cpl.database.connection.doctree
vendored
Normal file
Binary file not shown.
BIN
docs/build/doctrees/cpl.database.context.doctree
vendored
Normal file
BIN
docs/build/doctrees/cpl.database.context.doctree
vendored
Normal file
Binary file not shown.
BIN
docs/build/doctrees/cpl.database.doctree
vendored
Normal file
BIN
docs/build/doctrees/cpl.database.doctree
vendored
Normal file
Binary file not shown.
BIN
docs/build/doctrees/cpl.dependency_injection.doctree
vendored
Normal file
BIN
docs/build/doctrees/cpl.dependency_injection.doctree
vendored
Normal file
Binary file not shown.
BIN
docs/build/doctrees/cpl.doctree
vendored
Normal file
BIN
docs/build/doctrees/cpl.doctree
vendored
Normal file
Binary file not shown.
BIN
docs/build/doctrees/cpl.environment.doctree
vendored
Normal file
BIN
docs/build/doctrees/cpl.environment.doctree
vendored
Normal file
Binary file not shown.
BIN
docs/build/doctrees/cpl.logging.doctree
vendored
Normal file
BIN
docs/build/doctrees/cpl.logging.doctree
vendored
Normal file
Binary file not shown.
BIN
docs/build/doctrees/cpl.mailing.doctree
vendored
Normal file
BIN
docs/build/doctrees/cpl.mailing.doctree
vendored
Normal file
Binary file not shown.
BIN
docs/build/doctrees/cpl.time.doctree
vendored
Normal file
BIN
docs/build/doctrees/cpl.time.doctree
vendored
Normal file
Binary file not shown.
BIN
docs/build/doctrees/cpl.utils.doctree
vendored
Normal file
BIN
docs/build/doctrees/cpl.utils.doctree
vendored
Normal file
Binary file not shown.
BIN
docs/build/doctrees/cpl_cli.add.doctree
vendored
BIN
docs/build/doctrees/cpl_cli.add.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_cli.build.doctree
vendored
BIN
docs/build/doctrees/cpl_cli.build.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_cli.doctree
vendored
BIN
docs/build/doctrees/cpl_cli.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_cli.generate.doctree
vendored
BIN
docs/build/doctrees/cpl_cli.generate.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_cli.help.doctree
vendored
BIN
docs/build/doctrees/cpl_cli.help.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_cli.install.doctree
vendored
BIN
docs/build/doctrees/cpl_cli.install.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_cli.new.doctree
vendored
BIN
docs/build/doctrees/cpl_cli.new.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_cli.overview.doctree
vendored
BIN
docs/build/doctrees/cpl_cli.overview.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_cli.publish.doctree
vendored
BIN
docs/build/doctrees/cpl_cli.publish.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_cli.remove.doctree
vendored
BIN
docs/build/doctrees/cpl_cli.remove.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_cli.run.doctree
vendored
BIN
docs/build/doctrees/cpl_cli.run.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_cli.start.doctree
vendored
BIN
docs/build/doctrees/cpl_cli.start.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_cli.uninstall.doctree
vendored
BIN
docs/build/doctrees/cpl_cli.uninstall.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_cli.update.doctree
vendored
BIN
docs/build/doctrees/cpl_cli.update.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_cli.version.doctree
vendored
BIN
docs/build/doctrees/cpl_cli.version.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_core.application.doctree
vendored
BIN
docs/build/doctrees/cpl_core.application.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_core.configuration.doctree
vendored
BIN
docs/build/doctrees/cpl_core.configuration.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_core.console.doctree
vendored
BIN
docs/build/doctrees/cpl_core.console.doctree
vendored
Binary file not shown.
Binary file not shown.
Binary file not shown.
BIN
docs/build/doctrees/cpl_core.database.doctree
vendored
BIN
docs/build/doctrees/cpl_core.database.doctree
vendored
Binary file not shown.
Binary file not shown.
BIN
docs/build/doctrees/cpl_core.doctree
vendored
BIN
docs/build/doctrees/cpl_core.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_core.environment.doctree
vendored
BIN
docs/build/doctrees/cpl_core.environment.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_core.logging.doctree
vendored
BIN
docs/build/doctrees/cpl_core.logging.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_core.mailing.doctree
vendored
BIN
docs/build/doctrees/cpl_core.mailing.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_core.pipes.doctree
vendored
BIN
docs/build/doctrees/cpl_core.pipes.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_core.time.doctree
vendored
BIN
docs/build/doctrees/cpl_core.time.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_core.utils.doctree
vendored
BIN
docs/build/doctrees/cpl_core.utils.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_discord.application.doctree
vendored
BIN
docs/build/doctrees/cpl_discord.application.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_discord.command.doctree
vendored
BIN
docs/build/doctrees/cpl_discord.command.doctree
vendored
Binary file not shown.
Binary file not shown.
BIN
docs/build/doctrees/cpl_discord.container.doctree
vendored
BIN
docs/build/doctrees/cpl_discord.container.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_discord.doctree
vendored
BIN
docs/build/doctrees/cpl_discord.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_discord.events.doctree
vendored
BIN
docs/build/doctrees/cpl_discord.events.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_discord.helper.doctree
vendored
BIN
docs/build/doctrees/cpl_discord.helper.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_discord.service.doctree
vendored
BIN
docs/build/doctrees/cpl_discord.service.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_query.base.doctree
vendored
BIN
docs/build/doctrees/cpl_query.base.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_query.doctree
vendored
BIN
docs/build/doctrees/cpl_query.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_query.enumerable.doctree
vendored
BIN
docs/build/doctrees/cpl_query.enumerable.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_query.extension.doctree
vendored
BIN
docs/build/doctrees/cpl_query.extension.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_query.iterable.doctree
vendored
BIN
docs/build/doctrees/cpl_query.iterable.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_translation.doctree
vendored
BIN
docs/build/doctrees/cpl_translation.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/deprecated.doctree
vendored
BIN
docs/build/doctrees/deprecated.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/environment.pickle
vendored
BIN
docs/build/doctrees/environment.pickle
vendored
Binary file not shown.
BIN
docs/build/doctrees/getting_started.doctree
vendored
BIN
docs/build/doctrees/getting_started.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/index.doctree
vendored
BIN
docs/build/doctrees/index.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/introduction.doctree
vendored
BIN
docs/build/doctrees/introduction.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/modules.doctree
vendored
BIN
docs/build/doctrees/modules.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/quickstart.doctree
vendored
BIN
docs/build/doctrees/quickstart.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/setup.doctree
vendored
BIN
docs/build/doctrees/setup.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/tutorials.appsettings.doctree
vendored
BIN
docs/build/doctrees/tutorials.appsettings.doctree
vendored
Binary file not shown.
Binary file not shown.
BIN
docs/build/doctrees/tutorials.console.doctree
vendored
BIN
docs/build/doctrees/tutorials.console.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/tutorials.create-startup.doctree
vendored
BIN
docs/build/doctrees/tutorials.create-startup.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/tutorials.doctree
vendored
BIN
docs/build/doctrees/tutorials.doctree
vendored
Binary file not shown.
Binary file not shown.
BIN
docs/build/doctrees/tutorials.extend-startup.doctree
vendored
BIN
docs/build/doctrees/tutorials.extend-startup.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/tutorials.logging.doctree
vendored
BIN
docs/build/doctrees/tutorials.logging.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/tutorials.mail.doctree
vendored
BIN
docs/build/doctrees/tutorials.mail.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/tutorials.templating.doctree
vendored
BIN
docs/build/doctrees/tutorials.templating.doctree
vendored
Binary file not shown.
2
docs/build/html/.buildinfo
vendored
2
docs/build/html/.buildinfo
vendored
@ -1,4 +1,4 @@
|
||||
# Sphinx build info version 1
|
||||
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
|
||||
config: 7161cd79d6fb56140ef1c390e01dab1c
|
||||
config: 8170277cf12e5442e6180427108a8adf
|
||||
tags: 645f666f9bcd5a90fca523b33c5a78b7
|
||||
|
25
docs/build/html/_sources/cli.add.md.txt
vendored
Normal file
25
docs/build/html/_sources/cli.add.md.txt
vendored
Normal file
@ -0,0 +1,25 @@
|
||||
# cpl add
|
||||
|
||||
## Contents
|
||||
|
||||
- [Description](#description)
|
||||
- [Arguments](#arguments)
|
||||
|
||||
Removes a project from workspace.
|
||||
|
||||
cpl **add** *<source-project>* *<target-project>* <br>
|
||||
cpl **a** *<source-project>* *<target-project>* <br>
|
||||
cpl **A** *<source-project>* *<target-project>*
|
||||
|
||||
## Description
|
||||
|
||||
Adds a project reference to given project.
|
||||
|
||||
If you call the command in a CPL workspace, you can use the project names. Otherwise the paths of the projects must be specified.
|
||||
|
||||
## Arguments
|
||||
|
||||
| Argument | Description | Value type |
|
||||
| ------------------------- |:---------------------------------------------------------------:|:----------------:|
|
||||
| ```<source-project>``` | Name of the project to which the reference has to be added | ```str```
|
||||
| ```<target-project>``` | Name of the project to be referenced | ```str```
|
35
docs/build/html/_sources/cli.generate.md.txt
vendored
Normal file
35
docs/build/html/_sources/cli.generate.md.txt
vendored
Normal file
@ -0,0 +1,35 @@
|
||||
# cpl generate
|
||||
|
||||
## Contents
|
||||
|
||||
- [Description](#description)
|
||||
- [Arguments](#arguments)
|
||||
- [Schematics](#schematics)
|
||||
|
||||
Generate a file based on schematic.
|
||||
|
||||
cpl **generate** *<schematic>* *<name>* <br>
|
||||
cpl **g** *<schematic>* *<name>* <br>
|
||||
cpl **G** *<schematic>* *<name>*
|
||||
|
||||
## Description
|
||||
|
||||
Generates files based on a schematic.
|
||||
|
||||
## Arguments
|
||||
|
||||
| Argument | Description | Value type |
|
||||
| ----------------- |:---------------------------------:|:-------------:|
|
||||
| ```<schematic>``` | The schematic to generate. | ```str``` |
|
||||
| ```<name>``` | The name of the generated file. | ```str``` |
|
||||
|
||||
## Schematics
|
||||
|
||||
| Schematic | Description | Arguments |
|
||||
| ----------------- |:-------------------:|:----------------:|
|
||||
| ```abc``` | Abstract base class | ```<name>```
|
||||
| ```class``` | Class | ```<name>```
|
||||
| ```enum``` | Enum class | ```<name>```
|
||||
| ```service``` | Service class | ```<name>```
|
||||
| ```settings``` | [Configmodel](cpl.configuration) | ```<name>```
|
||||
| ```thread``` | Thread class | ```<name>```
|
@ -1,9 +1,9 @@
|
||||
# cpl help
|
||||
|
||||
## Contents
|
||||
<!-- ## Contents
|
||||
|
||||
- [Description](#description)
|
||||
- [Arguments](#arguments)
|
||||
- [Description](#description) -->
|
||||
<!-- - [Arguments](#arguments) -->
|
||||
|
||||
Lists available command and their short descriptions.
|
||||
|
23
docs/build/html/_sources/cli.install.md.txt
vendored
Normal file
23
docs/build/html/_sources/cli.install.md.txt
vendored
Normal file
@ -0,0 +1,23 @@
|
||||
# cpl install
|
||||
|
||||
## Contents
|
||||
|
||||
- [Description](#description)
|
||||
- [Arguments](#arguments)
|
||||
|
||||
Installs given package via pip
|
||||
|
||||
cpl **install** *<package>* <br>
|
||||
cpl **i** *<package>* <br>
|
||||
cpl **I** *<package>*
|
||||
|
||||
## Description
|
||||
|
||||
Install given package to project via pip.
|
||||
Without given package it will install the depedencies of the CPL project your in.
|
||||
|
||||
## Arguments
|
||||
|
||||
| Argument | Description | Value type |
|
||||
| ----------------- |:-----------------------------:|:-------------:|
|
||||
| ```<package>``` | The package to install | ```str``` |
|
31
docs/build/html/_sources/cli.new.md.txt
vendored
Normal file
31
docs/build/html/_sources/cli.new.md.txt
vendored
Normal file
@ -0,0 +1,31 @@
|
||||
# cpl new
|
||||
|
||||
## Contents
|
||||
|
||||
- [Description](#description)
|
||||
- [Arguments](#arguments)
|
||||
- [Project types](#project-types)
|
||||
|
||||
Generates a workspace and initial project or add a project to workspace.
|
||||
|
||||
cpl **new** *<type>* *<name>*<br>
|
||||
cpl **n** *<type>* *<name>* <br>
|
||||
cpl **N** *<type>* *<name>*
|
||||
|
||||
## Description
|
||||
|
||||
Generates a workspace and initial project or add a project to workspace.
|
||||
|
||||
If the command is running in a CPL workspace, it will add the new project to the workspace.
|
||||
|
||||
| Argument | Description | Value type |
|
||||
| ----------------- |:-----------------------------------------------------:|:-------------:|
|
||||
| ```<type>``` | The type of the project, see [types](#project-types) | ```str``` |
|
||||
| ```<name>``` | The name of the project | ```str``` |
|
||||
|
||||
## Project types
|
||||
|
||||
| Project type | Description |
|
||||
| ----------------- |:-----------------------------:|
|
||||
| ```console``` | A simple console application |
|
||||
| ```library``` | A package |
|
@ -39,15 +39,15 @@ The cpl generate command takes as an argument the artifact to be generated. In
|
||||
|
||||
| Command | Alias | Description |
|
||||
| ----------------------------- |:-------------:|:----------------:|
|
||||
| [add](cpl_cli.add) | a or a | Adds a project reference to given project.
|
||||
| [build](cpl_cli.build) | b or B | Prepares files for publish into an output directory named dist/ at the given output path. Must be executed from within a workspace directory.
|
||||
| [generate](cpl_cli.generate) | g or G | Generate a new file.
|
||||
| [help](cpl_cli.help) | h or H | Lists available command and their short descriptions.
|
||||
| [install](cpl_cli.install) | i or I | With argument installs packages to project, without argument installs project dependencies.
|
||||
| [new](cpl_cli.new) | n or N | Creates new CPL project.
|
||||
| [publish](cpl_cli.publish) | p or P | Prepares files for publish into an output directory named dist/ at the given output path and executes ```setup.py```. Must be executed from within a library workspace directory.
|
||||
| [remove](cpl_cli.remove) | r or R | Removes a project from workspace.
|
||||
| [start](cpl_cli.start) | s or S | Starts CPL project, restarting on file changes.
|
||||
| [uninstall](cpl_cli.uninstall) | ui or UI | Uninstalls packages from project.
|
||||
| [update](cpl_cli.update) | u or U | Update CPL and project dependencies.
|
||||
| [version](cpl_cli.version) | v or V | Outputs CPL CLI version.
|
||||
| [add](cli.add) | a or a | Adds a project reference to given project.
|
||||
| [build](cli.build) | b or B | Prepares files for publish into an output directory named dist/ at the given output path. Must be executed from within a workspace directory.
|
||||
| [generate](cli.generate) | g or G | Generate a new file.
|
||||
| [help](cli.help) | h or H | Lists available command and their short descriptions.
|
||||
| [install](cli.install) | i or I | With argument installs packages to project, without argument installs project dependencies.
|
||||
| [new](cli.new) | n or N | Creates new CPL project.
|
||||
| [publish](cli.publish) | p or P | Prepares files for publish into an output directory named dist/ at the given output path and executes ```setup.py```. Must be executed from within a library workspace directory.
|
||||
| [remove](cli.remove) | r or R | Removes a project from workspace.
|
||||
| [start](cli.start) | s or S | Starts CPL project, restarting on file changes.
|
||||
| [uninstall](cli.uninstall) | ui or UI | Uninstalls packages from project.
|
||||
| [update](cli.update) | u or U | Update CPL and project dependencies.
|
||||
| [version](cli.version) | v or V | Outputs CPL CLI version.
|
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue
Block a user