Improved documentation for cpl.application
This commit is contained in:
parent
ed1a4eb88c
commit
4209055d62
BIN
docs/build/doctrees/cpl.application.doctree
vendored
BIN
docs/build/doctrees/cpl.application.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl.configuration.doctree
vendored
BIN
docs/build/doctrees/cpl.configuration.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl.console.doctree
vendored
BIN
docs/build/doctrees/cpl.console.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl.database.connection.doctree
vendored
BIN
docs/build/doctrees/cpl.database.connection.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl.database.context.doctree
vendored
BIN
docs/build/doctrees/cpl.database.context.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl.database.doctree
vendored
BIN
docs/build/doctrees/cpl.database.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl.dependency_injection.doctree
vendored
BIN
docs/build/doctrees/cpl.dependency_injection.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl.environment.doctree
vendored
BIN
docs/build/doctrees/cpl.environment.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl.logging.doctree
vendored
BIN
docs/build/doctrees/cpl.logging.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl.mailing.doctree
vendored
BIN
docs/build/doctrees/cpl.mailing.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl.time.doctree
vendored
BIN
docs/build/doctrees/cpl.time.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl.utils.doctree
vendored
BIN
docs/build/doctrees/cpl.utils.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_cli.command.doctree
vendored
BIN
docs/build/doctrees/cpl_cli.command.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_cli.configuration.doctree
vendored
BIN
docs/build/doctrees/cpl_cli.configuration.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.live_server.doctree
vendored
BIN
docs/build/doctrees/cpl_cli.live_server.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.source_creator.doctree
vendored
BIN
docs/build/doctrees/cpl_cli.source_creator.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/index.doctree
vendored
BIN
docs/build/doctrees/index.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/modules.doctree
vendored
BIN
docs/build/doctrees/modules.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/tests.doctree
vendored
BIN
docs/build/doctrees/tests.doctree
vendored
Binary file not shown.
@ -1,7 +1,7 @@
|
||||
cpl.application
|
||||
=======================
|
||||
|
||||
cpl.application.application\_abc module
|
||||
cpl.application.application\_abc
|
||||
---------------------------------------
|
||||
|
||||
.. automodule:: cpl.application.application_abc
|
||||
@ -9,7 +9,7 @@ cpl.application.application\_abc module
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl.application.application\_builder module
|
||||
cpl.application.application\_builder
|
||||
-------------------------------------------
|
||||
|
||||
.. automodule:: cpl.application.application_builder
|
||||
@ -17,7 +17,7 @@ cpl.application.application\_builder module
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl.application.application\_builder\_abc module
|
||||
cpl.application.application\_builder\_abc
|
||||
------------------------------------------------
|
||||
|
||||
.. automodule:: cpl.application.application_builder_abc
|
||||
@ -25,7 +25,7 @@ cpl.application.application\_builder\_abc module
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl.application.startup\_abc module
|
||||
cpl.application.startup\_abc
|
||||
-----------------------------------
|
||||
|
||||
.. automodule:: cpl.application.startup_abc
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
cpl.configuration
|
||||
=========================
|
||||
|
||||
cpl.configuration.configuration module
|
||||
cpl.configuration.configuration
|
||||
--------------------------------------
|
||||
|
||||
.. automodule:: cpl.configuration.configuration
|
||||
@ -9,7 +9,7 @@ cpl.configuration.configuration module
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl.configuration.configuration\_abc module
|
||||
cpl.configuration.configuration\_abc
|
||||
-------------------------------------------
|
||||
|
||||
.. automodule:: cpl.configuration.configuration_abc
|
||||
@ -17,7 +17,7 @@ cpl.configuration.configuration\_abc module
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl.configuration.configuration\_model\_abc module
|
||||
cpl.configuration.configuration\_model\_abc
|
||||
--------------------------------------------------
|
||||
|
||||
.. automodule:: cpl.configuration.configuration_model_abc
|
||||
@ -25,7 +25,7 @@ cpl.configuration.configuration\_model\_abc module
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl.configuration.configuration\_variable\_name\_enum module
|
||||
cpl.configuration.configuration\_variable\_name\_enum
|
||||
------------------------------------------------------------
|
||||
|
||||
.. automodule:: cpl.configuration.configuration_variable_name_enum
|
||||
@ -33,7 +33,7 @@ cpl.configuration.configuration\_variable\_name\_enum module
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl.configuration.console\_argument module
|
||||
cpl.configuration.console\_argument
|
||||
------------------------------------------
|
||||
|
||||
.. automodule:: cpl.configuration.console_argument
|
||||
|
||||
10
docs/build/html/_sources/cpl.console.rst.txt
vendored
10
docs/build/html/_sources/cpl.console.rst.txt
vendored
@ -1,7 +1,7 @@
|
||||
cpl.console
|
||||
===================
|
||||
|
||||
cpl.console.background\_color\_enum module
|
||||
cpl.console.background\_color\_enum
|
||||
------------------------------------------
|
||||
|
||||
.. automodule:: cpl.console.background_color_enum
|
||||
@ -9,7 +9,7 @@ cpl.console.background\_color\_enum module
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl.console.console module
|
||||
cpl.console.console
|
||||
--------------------------
|
||||
|
||||
.. automodule:: cpl.console.console
|
||||
@ -17,7 +17,7 @@ cpl.console.console module
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl.console.console\_call module
|
||||
cpl.console.console\_call
|
||||
--------------------------------
|
||||
|
||||
.. automodule:: cpl.console.console_call
|
||||
@ -25,7 +25,7 @@ cpl.console.console\_call module
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl.console.foreground\_color\_enum module
|
||||
cpl.console.foreground\_color\_enum
|
||||
------------------------------------------
|
||||
|
||||
.. automodule:: cpl.console.foreground_color_enum
|
||||
@ -33,7 +33,7 @@ cpl.console.foreground\_color\_enum module
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl.console.spinner\_thread module
|
||||
cpl.console.spinner\_thread
|
||||
----------------------------------
|
||||
|
||||
.. automodule:: cpl.console.spinner_thread
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
cpl.database.connection
|
||||
===============================
|
||||
|
||||
cpl.database.connection.database\_connection module
|
||||
cpl.database.connection.database\_connection
|
||||
---------------------------------------------------
|
||||
|
||||
.. automodule:: cpl.database.connection.database_connection
|
||||
@ -9,7 +9,7 @@ cpl.database.connection.database\_connection module
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl.database.connection.database\_connection\_abc module
|
||||
cpl.database.connection.database\_connection\_abc
|
||||
--------------------------------------------------------
|
||||
|
||||
.. automodule:: cpl.database.connection.database_connection_abc
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
cpl.database.context
|
||||
============================
|
||||
|
||||
cpl.database.context.database\_context module
|
||||
cpl.database.context.database\_context
|
||||
---------------------------------------------
|
||||
|
||||
.. automodule:: cpl.database.context.database_context
|
||||
@ -9,7 +9,7 @@ cpl.database.context.database\_context module
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl.database.context.database\_context\_abc module
|
||||
cpl.database.context.database\_context\_abc
|
||||
--------------------------------------------------
|
||||
|
||||
.. automodule:: cpl.database.context.database_context_abc
|
||||
|
||||
@ -10,7 +10,7 @@ cpl.database
|
||||
Submodules
|
||||
----------
|
||||
|
||||
cpl.database.database\_model module
|
||||
cpl.database.database\_model
|
||||
-----------------------------------
|
||||
|
||||
.. automodule:: cpl.database.database_model
|
||||
@ -18,7 +18,7 @@ cpl.database.database\_model module
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl.database.database\_settings module
|
||||
cpl.database.database\_settings
|
||||
--------------------------------------
|
||||
|
||||
.. automodule:: cpl.database.database_settings
|
||||
@ -26,7 +26,7 @@ cpl.database.database\_settings module
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl.database.database\_settings\_name\_enum module
|
||||
cpl.database.database\_settings\_name\_enum
|
||||
--------------------------------------------------
|
||||
|
||||
.. automodule:: cpl.database.database_settings_name_enum
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
cpl.dependency\_injection
|
||||
=================================
|
||||
|
||||
cpl.dependency\_injection.service\_collection module
|
||||
cpl.dependency\_injection.service\_collection
|
||||
----------------------------------------------------
|
||||
|
||||
.. automodule:: cpl.dependency_injection.service_collection
|
||||
@ -9,7 +9,7 @@ cpl.dependency\_injection.service\_collection module
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl.dependency\_injection.service\_collection\_abc module
|
||||
cpl.dependency\_injection.service\_collection\_abc
|
||||
---------------------------------------------------------
|
||||
|
||||
.. automodule:: cpl.dependency_injection.service_collection_abc
|
||||
@ -17,7 +17,7 @@ cpl.dependency\_injection.service\_collection\_abc module
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl.dependency\_injection.service\_descriptor module
|
||||
cpl.dependency\_injection.service\_descriptor
|
||||
----------------------------------------------------
|
||||
|
||||
.. automodule:: cpl.dependency_injection.service_descriptor
|
||||
@ -25,7 +25,7 @@ cpl.dependency\_injection.service\_descriptor module
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl.dependency\_injection.service\_lifetime\_enum module
|
||||
cpl.dependency\_injection.service\_lifetime\_enum
|
||||
--------------------------------------------------------
|
||||
|
||||
.. automodule:: cpl.dependency_injection.service_lifetime_enum
|
||||
@ -33,7 +33,7 @@ cpl.dependency\_injection.service\_lifetime\_enum module
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl.dependency\_injection.service\_provider module
|
||||
cpl.dependency\_injection.service\_provider
|
||||
--------------------------------------------------
|
||||
|
||||
.. automodule:: cpl.dependency_injection.service_provider
|
||||
@ -41,7 +41,7 @@ cpl.dependency\_injection.service\_provider module
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl.dependency\_injection.service\_provider\_abc module
|
||||
cpl.dependency\_injection.service\_provider\_abc
|
||||
-------------------------------------------------------
|
||||
|
||||
.. automodule:: cpl.dependency_injection.service_provider_abc
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
cpl.environment
|
||||
=======================
|
||||
|
||||
cpl.environment.application\_environment module
|
||||
cpl.environment.application\_environment
|
||||
-----------------------------------------------
|
||||
|
||||
.. automodule:: cpl.environment.application_environment
|
||||
@ -9,7 +9,7 @@ cpl.environment.application\_environment module
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl.environment.application\_environment\_abc module
|
||||
cpl.environment.application\_environment\_abc
|
||||
----------------------------------------------------
|
||||
|
||||
.. automodule:: cpl.environment.application_environment_abc
|
||||
@ -17,7 +17,7 @@ cpl.environment.application\_environment\_abc module
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl.environment.environment\_name\_enum module
|
||||
cpl.environment.environment\_name\_enum
|
||||
----------------------------------------------
|
||||
|
||||
.. automodule:: cpl.environment.environment_name_enum
|
||||
|
||||
10
docs/build/html/_sources/cpl.logging.rst.txt
vendored
10
docs/build/html/_sources/cpl.logging.rst.txt
vendored
@ -1,7 +1,7 @@
|
||||
cpl.logging
|
||||
===================
|
||||
|
||||
cpl.logging.logger\_abc module
|
||||
cpl.logging.logger\_abc
|
||||
------------------------------
|
||||
|
||||
.. automodule:: cpl.logging.logger_abc
|
||||
@ -9,7 +9,7 @@ cpl.logging.logger\_abc module
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl.logging.logger\_service module
|
||||
cpl.logging.logger\_service
|
||||
----------------------------------
|
||||
|
||||
.. automodule:: cpl.logging.logger_service
|
||||
@ -17,7 +17,7 @@ cpl.logging.logger\_service module
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl.logging.logging\_level\_enum module
|
||||
cpl.logging.logging\_level\_enum
|
||||
---------------------------------------
|
||||
|
||||
.. automodule:: cpl.logging.logging_level_enum
|
||||
@ -25,7 +25,7 @@ cpl.logging.logging\_level\_enum module
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl.logging.logging\_settings module
|
||||
cpl.logging.logging\_settings
|
||||
------------------------------------
|
||||
|
||||
.. automodule:: cpl.logging.logging_settings
|
||||
@ -33,7 +33,7 @@ cpl.logging.logging\_settings module
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl.logging.logging\_settings\_name\_enum module
|
||||
cpl.logging.logging\_settings\_name\_enum
|
||||
------------------------------------------------
|
||||
|
||||
.. automodule:: cpl.logging.logging_settings_name_enum
|
||||
|
||||
10
docs/build/html/_sources/cpl.mailing.rst.txt
vendored
10
docs/build/html/_sources/cpl.mailing.rst.txt
vendored
@ -1,7 +1,7 @@
|
||||
cpl.mailing
|
||||
===================
|
||||
|
||||
cpl.mailing.email module
|
||||
cpl.mailing.email
|
||||
------------------------
|
||||
|
||||
.. automodule:: cpl.mailing.email
|
||||
@ -9,7 +9,7 @@ cpl.mailing.email module
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl.mailing.email\_client\_abc module
|
||||
cpl.mailing.email\_client\_abc
|
||||
-------------------------------------
|
||||
|
||||
.. automodule:: cpl.mailing.email_client_abc
|
||||
@ -17,7 +17,7 @@ cpl.mailing.email\_client\_abc module
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl.mailing.email\_client\_service module
|
||||
cpl.mailing.email\_client\_service
|
||||
-----------------------------------------
|
||||
|
||||
.. automodule:: cpl.mailing.email_client_service
|
||||
@ -25,7 +25,7 @@ cpl.mailing.email\_client\_service module
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl.mailing.email\_client\_settings module
|
||||
cpl.mailing.email\_client\_settings
|
||||
------------------------------------------
|
||||
|
||||
.. automodule:: cpl.mailing.email_client_settings
|
||||
@ -33,7 +33,7 @@ cpl.mailing.email\_client\_settings module
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl.mailing.email\_client\_settings\_name\_enum module
|
||||
cpl.mailing.email\_client\_settings\_name\_enum
|
||||
------------------------------------------------------
|
||||
|
||||
.. automodule:: cpl.mailing.email_client_settings_name_enum
|
||||
|
||||
4
docs/build/html/_sources/cpl.time.rst.txt
vendored
4
docs/build/html/_sources/cpl.time.rst.txt
vendored
@ -1,7 +1,7 @@
|
||||
cpl.time
|
||||
================
|
||||
|
||||
cpl.time.time\_format\_settings module
|
||||
cpl.time.time\_format\_settings
|
||||
--------------------------------------
|
||||
|
||||
.. automodule:: cpl.time.time_format_settings
|
||||
@ -9,7 +9,7 @@ cpl.time.time\_format\_settings module
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl.time.time\_format\_settings\_names\_enum module
|
||||
cpl.time.time\_format\_settings\_names\_enum
|
||||
---------------------------------------------------
|
||||
|
||||
.. automodule:: cpl.time.time_format_settings_names_enum
|
||||
|
||||
6
docs/build/html/_sources/cpl.utils.rst.txt
vendored
6
docs/build/html/_sources/cpl.utils.rst.txt
vendored
@ -1,7 +1,7 @@
|
||||
cpl.utils
|
||||
=================
|
||||
|
||||
cpl.utils.credential\_manager module
|
||||
cpl.utils.credential\_manager
|
||||
------------------------------------
|
||||
|
||||
.. automodule:: cpl.utils.credential_manager
|
||||
@ -9,7 +9,7 @@ cpl.utils.credential\_manager module
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl.utils.pip module
|
||||
cpl.utils.pip
|
||||
--------------------
|
||||
|
||||
.. automodule:: cpl.utils.pip
|
||||
@ -17,7 +17,7 @@ cpl.utils.pip module
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl.utils.string module
|
||||
cpl.utils.string
|
||||
-----------------------
|
||||
|
||||
.. automodule:: cpl.utils.string
|
||||
|
||||
98
docs/build/html/_sources/cpl_cli.command.rst.txt
vendored
98
docs/build/html/_sources/cpl_cli.command.rst.txt
vendored
@ -1,98 +0,0 @@
|
||||
cpl\_cli.command
|
||||
========================
|
||||
|
||||
cpl\_cli.command.add\_service module
|
||||
------------------------------------
|
||||
|
||||
.. automodule:: cpl_cli.command.add_service
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_cli.command.build\_service module
|
||||
--------------------------------------
|
||||
|
||||
.. automodule:: cpl_cli.command.build_service
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_cli.command.generate\_service module
|
||||
-----------------------------------------
|
||||
|
||||
.. automodule:: cpl_cli.command.generate_service
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_cli.command.help\_service module
|
||||
-------------------------------------
|
||||
|
||||
.. automodule:: cpl_cli.command.help_service
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_cli.command.install\_service module
|
||||
----------------------------------------
|
||||
|
||||
.. automodule:: cpl_cli.command.install_service
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_cli.command.new\_service module
|
||||
------------------------------------
|
||||
|
||||
.. automodule:: cpl_cli.command.new_service
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_cli.command.publish\_service module
|
||||
----------------------------------------
|
||||
|
||||
.. automodule:: cpl_cli.command.publish_service
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_cli.command.remove\_service module
|
||||
---------------------------------------
|
||||
|
||||
.. automodule:: cpl_cli.command.remove_service
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_cli.command.start\_service module
|
||||
--------------------------------------
|
||||
|
||||
.. automodule:: cpl_cli.command.start_service
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_cli.command.uninstall\_service module
|
||||
------------------------------------------
|
||||
|
||||
.. automodule:: cpl_cli.command.uninstall_service
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_cli.command.update\_service module
|
||||
---------------------------------------
|
||||
|
||||
.. automodule:: cpl_cli.command.update_service
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_cli.command.version\_service module
|
||||
----------------------------------------
|
||||
|
||||
.. automodule:: cpl_cli.command.version_service
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@ -1,82 +0,0 @@
|
||||
cpl\_cli.configuration
|
||||
==============================
|
||||
|
||||
cpl\_cli.configuration.build\_settings module
|
||||
---------------------------------------------
|
||||
|
||||
.. automodule:: cpl_cli.configuration.build_settings
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_cli.configuration.build\_settings\_name\_enum module
|
||||
---------------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_cli.configuration.build_settings_name_enum
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_cli.configuration.project\_settings module
|
||||
-----------------------------------------------
|
||||
|
||||
.. automodule:: cpl_cli.configuration.project_settings
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_cli.configuration.project\_settings\_name\_enum module
|
||||
-----------------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_cli.configuration.project_settings_name_enum
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_cli.configuration.project\_type\_enum module
|
||||
-------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_cli.configuration.project_type_enum
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_cli.configuration.settings\_helper module
|
||||
----------------------------------------------
|
||||
|
||||
.. automodule:: cpl_cli.configuration.settings_helper
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_cli.configuration.version\_settings module
|
||||
-----------------------------------------------
|
||||
|
||||
.. automodule:: cpl_cli.configuration.version_settings
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_cli.configuration.version\_settings\_name\_enum module
|
||||
-----------------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_cli.configuration.version_settings_name_enum
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_cli.configuration.workspace\_settings module
|
||||
-------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_cli.configuration.workspace_settings
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_cli.configuration.workspace\_settings\_name\_enum module
|
||||
-------------------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_cli.configuration.workspace_settings_name_enum
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@ -1,18 +0,0 @@
|
||||
cpl\_cli.live\_server
|
||||
=============================
|
||||
|
||||
cpl\_cli.live\_server.live\_server\_service module
|
||||
--------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_cli.live_server.live_server_service
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_cli.live\_server.live\_server\_thread module
|
||||
-------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_cli.live_server.live_server_thread
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
18
docs/build/html/_sources/cpl_cli.publish.rst.txt
vendored
18
docs/build/html/_sources/cpl_cli.publish.rst.txt
vendored
@ -1,18 +0,0 @@
|
||||
cpl\_cli.publish
|
||||
========================
|
||||
|
||||
cpl\_cli.publish.publisher\_abc module
|
||||
--------------------------------------
|
||||
|
||||
.. automodule:: cpl_cli.publish.publisher_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_cli.publish.publisher\_service module
|
||||
------------------------------------------
|
||||
|
||||
.. automodule:: cpl_cli.publish.publisher_service
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
92
docs/build/html/_sources/cpl_cli.rst.txt
vendored
92
docs/build/html/_sources/cpl_cli.rst.txt
vendored
@ -1,92 +0,0 @@
|
||||
CPL_CLI
|
||||
================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
|
||||
cpl_cli.command
|
||||
cpl_cli.configuration
|
||||
cpl_cli.live_server
|
||||
cpl_cli.publish
|
||||
cpl_cli.source_creator
|
||||
cpl_cli.templates
|
||||
|
||||
cpl\_cli.cli
|
||||
-------------------
|
||||
|
||||
.. automodule:: cpl_cli.cli
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_cli.cli\_settings
|
||||
-----------------------------
|
||||
|
||||
.. automodule:: cpl_cli.cli_settings
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_cli.cli\_settings\_name\_enum
|
||||
-----------------------------------------
|
||||
|
||||
.. automodule:: cpl_cli.cli_settings_name_enum
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_cli.command\_abc
|
||||
----------------------------
|
||||
|
||||
.. automodule:: cpl_cli.command_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_cli.command\_handler\_service
|
||||
-----------------------------------------
|
||||
|
||||
.. automodule:: cpl_cli.command_handler_service
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_cli.command\_model
|
||||
------------------------------
|
||||
|
||||
.. automodule:: cpl_cli.command_model
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_cli.error
|
||||
---------------------
|
||||
|
||||
.. automodule:: cpl_cli.error
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_cli.main
|
||||
--------------------
|
||||
|
||||
.. automodule:: cpl_cli.main
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_cli.startup
|
||||
-----------------------
|
||||
|
||||
.. automodule:: cpl_cli.startup
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Module contents
|
||||
---------------
|
||||
|
||||
.. automodule:: cpl_cli
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@ -1,26 +0,0 @@
|
||||
cpl\_cli.source\_creator
|
||||
================================
|
||||
|
||||
cpl\_cli.source\_creator.console\_builder module
|
||||
------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_cli.source_creator.console_builder
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_cli.source\_creator.library\_builder module
|
||||
------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_cli.source_creator.library_builder
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_cli.source\_creator.template\_builder module
|
||||
-------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_cli.source_creator.template_builder
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
1
docs/build/html/_sources/index.rst.txt
vendored
1
docs/build/html/_sources/index.rst.txt
vendored
@ -19,4 +19,3 @@ These pages go into great detail about everything the Library can do.
|
||||
:maxdepth: 1
|
||||
|
||||
cpl
|
||||
cpl_cli
|
||||
|
||||
1
docs/build/html/_sources/modules.rst.txt
vendored
1
docs/build/html/_sources/modules.rst.txt
vendored
@ -5,4 +5,3 @@ cpl
|
||||
:maxdepth: 4
|
||||
|
||||
cpl
|
||||
cpl_cli
|
||||
|
||||
10
docs/build/html/_sources/tests.rst.txt
vendored
10
docs/build/html/_sources/tests.rst.txt
vendored
@ -1,10 +0,0 @@
|
||||
tests package
|
||||
=============
|
||||
|
||||
Module contents
|
||||
---------------
|
||||
|
||||
.. automodule:: tests
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
91
docs/build/html/cpl.application.html
vendored
91
docs/build/html/cpl.application.html
vendored
@ -87,10 +87,10 @@
|
||||
<ul class="current">
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl.html">CPL</a><ul class="current">
|
||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl.application</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.application.application_abc">cpl.application.application_abc module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.application.application_builder">cpl.application.application_builder module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.application.application_builder_abc">cpl.application.application_builder_abc module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.application.startup_abc">cpl.application.startup_abc module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.application.application_abc">cpl.application.application_abc</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.application.application_builder">cpl.application.application_builder</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.application.application_builder_abc">cpl.application.application_builder_abc</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.application.startup_abc">cpl.application.startup_abc</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.configuration.html">cpl.configuration</a></li>
|
||||
@ -105,7 +105,6 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.html#module-cpl">Module contents</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CPL_CLI</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
@ -178,101 +177,135 @@
|
||||
<div class="section" id="cpl-application">
|
||||
<h1>cpl.application<a class="headerlink" href="#cpl-application" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="section" id="module-cpl.application.application_abc">
|
||||
<span id="cpl-application-application-abc-module"></span><h2>cpl.application.application_abc module<a class="headerlink" href="#module-cpl.application.application_abc" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="cpl-application-application-abc"></span><h2>cpl.application.application_abc<a class="headerlink" href="#module-cpl.application.application_abc" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl.application.application_abc.ApplicationABC">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.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.configuration.html#cpl.configuration.configuration_abc.ConfigurationABC" title="cpl.configuration.configuration_abc.ConfigurationABC"><span class="pre">cpl.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.dependency_injection.html#cpl.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl.dependency_injection.service_provider_abc.ServiceProviderABC"><span class="pre">cpl.dependency_injection.service_provider_abc.ServiceProviderABC</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.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>
|
||||
<div><dl class="simple">
|
||||
<dt>config: <a class="reference internal" href="cpl.configuration.html#cpl.configuration.configuration_abc.ConfigurationABC" title="cpl.configuration.configuration_abc.ConfigurationABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.configuration.configuration_abc.ConfigurationABC</span></code></a></dt><dd><p>Contains object loaded from appsettings</p>
|
||||
</dd>
|
||||
<dt>services: <a class="reference internal" href="cpl.dependency_injection.html#cpl.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl.dependency_injection.service_provider_abc.ServiceProviderABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.dependency_injection.service_provider_abc.ServiceProviderABC</span></code></a></dt><dd><p>Contains instances of prepared objects</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
<dl class="py method">
|
||||
<dt id="cpl.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.application.application_abc.ApplicationABC.configure" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Prepare the application
|
||||
:return:</p>
|
||||
<dd><p>Configure the application</p>
|
||||
<p>Called by <a class="reference internal" href="#cpl.application.application_abc.ApplicationABC.run" title="cpl.application.application_abc.ApplicationABC.run"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.application.application_abc.ApplicationABC.run</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl.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.application.application_abc.ApplicationABC.main" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Custom entry point
|
||||
:return:</p>
|
||||
<dd><p>Custom entry point</p>
|
||||
<p>Called by <a class="reference internal" href="#cpl.application.application_abc.ApplicationABC.run" title="cpl.application.application_abc.ApplicationABC.run"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.application.application_abc.ApplicationABC.run</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl.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.application.application_abc.ApplicationABC.run" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Entry point
|
||||
:return:</p>
|
||||
<dd><p>Entry point</p>
|
||||
<p>Called by custom Application.main</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-cpl.application.application_builder">
|
||||
<span id="cpl-application-application-builder-module"></span><h2>cpl.application.application_builder module<a class="headerlink" href="#module-cpl.application.application_builder" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="cpl-application-application-builder"></span><h2>cpl.application.application_builder<a class="headerlink" href="#module-cpl.application.application_builder" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl.application.application_builder.ApplicationBuilder">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.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.application.application_abc.ApplicationABC" title="cpl.application.application_abc.ApplicationABC"><span class="pre">cpl.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.application.application_builder.ApplicationBuilder" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#cpl.application.application_builder_abc.ApplicationBuilderABC" title="cpl.application.application_builder_abc.ApplicationBuilderABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.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.application.application_abc.ApplicationABC" title="cpl.application.application_abc.ApplicationABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.application.application_abc.ApplicationABC</span></code></a></p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
<dt>app: Type[<a class="reference internal" href="#cpl.application.application_abc.ApplicationABC" title="cpl.application.application_abc.ApplicationABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.application.application_abc.ApplicationABC</span></code></a>]</dt><dd><p>Application to build</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
<dl class="py method">
|
||||
<dt id="cpl.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> → <a class="reference internal" href="#cpl.application.application_abc.ApplicationABC" title="cpl.application.application_abc.ApplicationABC"><span class="pre">cpl.application.application_abc.ApplicationABC</span></a><a class="headerlink" href="#cpl.application.application_builder.ApplicationBuilder.build" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Creates application host and runtime
|
||||
:return:</p>
|
||||
<dd><p>Creates custom application object</p>
|
||||
<blockquote>
|
||||
<div><p>Object of <a class="reference internal" href="#cpl.application.application_abc.ApplicationABC" title="cpl.application.application_abc.ApplicationABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.application.application_abc.ApplicationABC</span></code></a></p>
|
||||
</div></blockquote>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl.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.application.startup_abc.StartupABC" title="cpl.application.startup_abc.StartupABC"><span class="pre">cpl.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.application.application_builder.ApplicationBuilder.use_startup" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Sets the used startup class
|
||||
:param startup:
|
||||
:return:</p>
|
||||
<dd><p>Sets the custom startup class to use</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
<dt>startup: Type[<a class="reference internal" href="#cpl.application.startup_abc.StartupABC" title="cpl.application.startup_abc.StartupABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.application.startup_abc.StartupABC</span></code></a>]</dt><dd><p>Type of <a class="reference internal" href="#cpl.application.startup_abc.StartupABC" title="cpl.application.startup_abc.StartupABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.application.startup_abc.StartupABC</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-cpl.application.application_builder_abc">
|
||||
<span id="cpl-application-application-builder-abc-module"></span><h2>cpl.application.application_builder_abc module<a class="headerlink" href="#module-cpl.application.application_builder_abc" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="cpl-application-application-builder-abc"></span><h2>cpl.application.application_builder_abc<a class="headerlink" href="#module-cpl.application.application_builder_abc" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl.application.application_builder_abc.ApplicationBuilderABC">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.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.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.application.application_builder.ApplicationBuilder" title="cpl.application.application_builder.ApplicationBuilder"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.application.application_builder.ApplicationBuilder</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt id="cpl.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> → <a class="reference internal" href="#cpl.application.application_abc.ApplicationABC" title="cpl.application.application_abc.ApplicationABC"><span class="pre">cpl.application.application_abc.ApplicationABC</span></a><a class="headerlink" href="#cpl.application.application_builder_abc.ApplicationBuilderABC.build" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Creates application host and runtime
|
||||
:return:</p>
|
||||
<dd><p>Creates custom application object</p>
|
||||
<blockquote>
|
||||
<div><p>Object of <a class="reference internal" href="#cpl.application.application_abc.ApplicationABC" title="cpl.application.application_abc.ApplicationABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.application.application_abc.ApplicationABC</span></code></a></p>
|
||||
</div></blockquote>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl.application.application_builder_abc.ApplicationBuilderABC.use_startup">
|
||||
<em class="property"><span class="pre">abstract</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.application.startup_abc.StartupABC" title="cpl.application.startup_abc.StartupABC"><span class="pre">cpl.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.application.application_builder_abc.ApplicationBuilderABC.use_startup" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Sets the used startup class
|
||||
:param startup:
|
||||
:return:</p>
|
||||
<dd><p>Sets the custom startup class to use</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
<dt>startup: Type[<a class="reference internal" href="#cpl.application.startup_abc.StartupABC" title="cpl.application.startup_abc.StartupABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.application.startup_abc.StartupABC</span></code></a>]</dt><dd><p>Type of <a class="reference internal" href="#cpl.application.startup_abc.StartupABC" title="cpl.application.startup_abc.StartupABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.application.startup_abc.StartupABC</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-cpl.application.startup_abc">
|
||||
<span id="cpl-application-startup-abc-module"></span><h2>cpl.application.startup_abc module<a class="headerlink" href="#module-cpl.application.startup_abc" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="cpl-application-startup-abc"></span><h2>cpl.application.startup_abc<a class="headerlink" href="#module-cpl.application.startup_abc" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl.application.startup_abc.StartupABC">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.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.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 id="cpl.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><span class="sig-paren">)</span> → <a class="reference internal" href="cpl.configuration.html#cpl.configuration.configuration_abc.ConfigurationABC" title="cpl.configuration.configuration_abc.ConfigurationABC"><span class="pre">cpl.configuration.configuration_abc.ConfigurationABC</span></a><a class="headerlink" href="#cpl.application.startup_abc.StartupABC.configure_configuration" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Creates configuration of application
|
||||
:return: configuration</p>
|
||||
<dd><p>Creates configuration of application</p>
|
||||
<blockquote>
|
||||
<div><p>Object of <a class="reference internal" href="cpl.configuration.html#cpl.configuration.configuration_abc.ConfigurationABC" title="cpl.configuration.configuration_abc.ConfigurationABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.configuration.configuration_abc.ConfigurationABC</span></code></a></p>
|
||||
</div></blockquote>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl.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><span class="sig-paren">)</span> → <a class="reference internal" href="cpl.dependency_injection.html#cpl.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl.dependency_injection.service_provider_abc.ServiceProviderABC"><span class="pre">cpl.dependency_injection.service_provider_abc.ServiceProviderABC</span></a><a class="headerlink" href="#cpl.application.startup_abc.StartupABC.configure_services" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Creates service provider
|
||||
:return: service provider</p>
|
||||
<dd><p>Creates service provider</p>
|
||||
<blockquote>
|
||||
<div><p>Object of <a class="reference internal" href="cpl.dependency_injection.html#cpl.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl.dependency_injection.service_provider_abc.ServiceProviderABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.dependency_injection.service_provider_abc.ServiceProviderABC</span></code></a></p>
|
||||
</div></blockquote>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
21
docs/build/html/cpl.configuration.html
vendored
21
docs/build/html/cpl.configuration.html
vendored
@ -88,11 +88,11 @@
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl.html">CPL</a><ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.application.html">cpl.application</a></li>
|
||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl.configuration</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.configuration.configuration">cpl.configuration.configuration module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.configuration.configuration_abc">cpl.configuration.configuration_abc module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.configuration.configuration_model_abc">cpl.configuration.configuration_model_abc module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.configuration.configuration_variable_name_enum">cpl.configuration.configuration_variable_name_enum module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.configuration.console_argument">cpl.configuration.console_argument module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.configuration.configuration">cpl.configuration.configuration</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.configuration.configuration_abc">cpl.configuration.configuration_abc</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.configuration.configuration_model_abc">cpl.configuration.configuration_model_abc</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.configuration.configuration_variable_name_enum">cpl.configuration.configuration_variable_name_enum</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.configuration.console_argument">cpl.configuration.console_argument</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.console.html">cpl.console</a></li>
|
||||
@ -106,7 +106,6 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.html#module-cpl">Module contents</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CPL_CLI</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
@ -179,7 +178,7 @@
|
||||
<div class="section" id="cpl-configuration">
|
||||
<h1>cpl.configuration<a class="headerlink" href="#cpl-configuration" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="section" id="module-cpl.configuration.configuration">
|
||||
<span id="cpl-configuration-configuration-module"></span><h2>cpl.configuration.configuration module<a class="headerlink" href="#module-cpl.configuration.configuration" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="cpl-configuration-configuration"></span><h2>cpl.configuration.configuration<a class="headerlink" href="#module-cpl.configuration.configuration" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl.configuration.configuration.Configuration">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.configuration.configuration.</span></code><code class="sig-name descname"><span class="pre">Configuration</span></code><a class="headerlink" href="#cpl.configuration.configuration.Configuration" title="Permalink to this definition">¶</a></dt>
|
||||
@ -255,7 +254,7 @@
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-cpl.configuration.configuration_abc">
|
||||
<span id="cpl-configuration-configuration-abc-module"></span><h2>cpl.configuration.configuration_abc module<a class="headerlink" href="#module-cpl.configuration.configuration_abc" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="cpl-configuration-configuration-abc"></span><h2>cpl.configuration.configuration_abc<a class="headerlink" href="#module-cpl.configuration.configuration_abc" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl.configuration.configuration_abc.ConfigurationABC">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.configuration.configuration_abc.</span></code><code class="sig-name descname"><span class="pre">ConfigurationABC</span></code><a class="headerlink" href="#cpl.configuration.configuration_abc.ConfigurationABC" title="Permalink to this definition">¶</a></dt>
|
||||
@ -331,7 +330,7 @@
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-cpl.configuration.configuration_model_abc">
|
||||
<span id="cpl-configuration-configuration-model-abc-module"></span><h2>cpl.configuration.configuration_model_abc module<a class="headerlink" href="#module-cpl.configuration.configuration_model_abc" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="cpl-configuration-configuration-model-abc"></span><h2>cpl.configuration.configuration_model_abc<a class="headerlink" href="#module-cpl.configuration.configuration_model_abc" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl.configuration.configuration_model_abc.ConfigurationModelABC">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.configuration.configuration_model_abc.</span></code><code class="sig-name descname"><span class="pre">ConfigurationModelABC</span></code><a class="headerlink" href="#cpl.configuration.configuration_model_abc.ConfigurationModelABC" title="Permalink to this definition">¶</a></dt>
|
||||
@ -348,7 +347,7 @@
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-cpl.configuration.configuration_variable_name_enum">
|
||||
<span id="cpl-configuration-configuration-variable-name-enum-module"></span><h2>cpl.configuration.configuration_variable_name_enum module<a class="headerlink" href="#module-cpl.configuration.configuration_variable_name_enum" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="cpl-configuration-configuration-variable-name-enum"></span><h2>cpl.configuration.configuration_variable_name_enum<a class="headerlink" href="#module-cpl.configuration.configuration_variable_name_enum" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.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.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum" title="Permalink to this definition">¶</a></dt>
|
||||
@ -378,7 +377,7 @@
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-cpl.configuration.console_argument">
|
||||
<span id="cpl-configuration-console-argument-module"></span><h2>cpl.configuration.console_argument module<a class="headerlink" href="#module-cpl.configuration.console_argument" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="cpl-configuration-console-argument"></span><h2>cpl.configuration.console_argument<a class="headerlink" href="#module-cpl.configuration.console_argument" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl.configuration.console_argument.ConsoleArgument">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.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.configuration.console_argument.ConsoleArgument" title="Permalink to this definition">¶</a></dt>
|
||||
|
||||
21
docs/build/html/cpl.console.html
vendored
21
docs/build/html/cpl.console.html
vendored
@ -89,11 +89,11 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.application.html">cpl.application</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.configuration.html">cpl.configuration</a></li>
|
||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl.console</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.console.background_color_enum">cpl.console.background_color_enum module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.console.console">cpl.console.console module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.console.console_call">cpl.console.console_call module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.console.foreground_color_enum">cpl.console.foreground_color_enum module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.console.spinner_thread">cpl.console.spinner_thread module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.console.background_color_enum">cpl.console.background_color_enum</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.console.console">cpl.console.console</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.console.console_call">cpl.console.console_call</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.console.foreground_color_enum">cpl.console.foreground_color_enum</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.console.spinner_thread">cpl.console.spinner_thread</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.database.html">cpl.database</a></li>
|
||||
@ -106,7 +106,6 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.html#module-cpl">Module contents</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CPL_CLI</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
@ -179,7 +178,7 @@
|
||||
<div class="section" id="cpl-console">
|
||||
<h1>cpl.console<a class="headerlink" href="#cpl-console" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="section" id="module-cpl.console.background_color_enum">
|
||||
<span id="cpl-console-background-color-enum-module"></span><h2>cpl.console.background_color_enum module<a class="headerlink" href="#module-cpl.console.background_color_enum" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="cpl-console-background-color-enum"></span><h2>cpl.console.background_color_enum<a class="headerlink" href="#module-cpl.console.background_color_enum" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl.console.background_color_enum.BackgroundColorEnum">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.console.background_color_enum.</span></code><code class="sig-name descname"><span class="pre">BackgroundColorEnum</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.console.background_color_enum.BackgroundColorEnum" title="Permalink to this definition">¶</a></dt>
|
||||
@ -234,7 +233,7 @@
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-cpl.console.console">
|
||||
<span id="cpl-console-console-module"></span><h2>cpl.console.console module<a class="headerlink" href="#module-cpl.console.console" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="cpl-console-console"></span><h2>cpl.console.console<a class="headerlink" href="#module-cpl.console.console" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl.console.console.Console">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.console.console.</span></code><code class="sig-name descname"><span class="pre">Console</span></code><a class="headerlink" href="#cpl.console.console.Console" title="Permalink to this definition">¶</a></dt>
|
||||
@ -437,7 +436,7 @@ When function has ended the spinner stops
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-cpl.console.console_call">
|
||||
<span id="cpl-console-console-call-module"></span><h2>cpl.console.console_call module<a class="headerlink" href="#module-cpl.console.console_call" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="cpl-console-console-call"></span><h2>cpl.console.console_call<a class="headerlink" href="#module-cpl.console.console_call" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl.console.console_call.ConsoleCall">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.console.console_call.</span></code><code class="sig-name descname"><span class="pre">ConsoleCall</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">function</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">collections.abc.Callable</span></span></em>, <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.console.console_call.ConsoleCall" title="Permalink to this definition">¶</a></dt>
|
||||
@ -456,7 +455,7 @@ When function has ended the spinner stops
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-cpl.console.foreground_color_enum">
|
||||
<span id="cpl-console-foreground-color-enum-module"></span><h2>cpl.console.foreground_color_enum module<a class="headerlink" href="#module-cpl.console.foreground_color_enum" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="cpl-console-foreground-color-enum"></span><h2>cpl.console.foreground_color_enum<a class="headerlink" href="#module-cpl.console.foreground_color_enum" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl.console.foreground_color_enum.ForegroundColorEnum">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.console.foreground_color_enum.</span></code><code class="sig-name descname"><span class="pre">ForegroundColorEnum</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.console.foreground_color_enum.ForegroundColorEnum" title="Permalink to this definition">¶</a></dt>
|
||||
@ -511,7 +510,7 @@ When function has ended the spinner stops
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-cpl.console.spinner_thread">
|
||||
<span id="cpl-console-spinner-thread-module"></span><h2>cpl.console.spinner_thread module<a class="headerlink" href="#module-cpl.console.spinner_thread" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="cpl-console-spinner-thread"></span><h2>cpl.console.spinner_thread<a class="headerlink" href="#module-cpl.console.spinner_thread" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl.console.spinner_thread.SpinnerThread">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.console.spinner_thread.</span></code><code class="sig-name descname"><span class="pre">SpinnerThread</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">msg_len</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">foreground_color</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="#cpl.console.foreground_color_enum.ForegroundColorEnum" title="cpl.console.foreground_color_enum.ForegroundColorEnum"><span class="pre">cpl.console.foreground_color_enum.ForegroundColorEnum</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">background_color</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="#cpl.console.background_color_enum.BackgroundColorEnum" title="cpl.console.background_color_enum.BackgroundColorEnum"><span class="pre">cpl.console.background_color_enum.BackgroundColorEnum</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.console.spinner_thread.SpinnerThread" title="Permalink to this definition">¶</a></dt>
|
||||
|
||||
15
docs/build/html/cpl.database.connection.html
vendored
15
docs/build/html/cpl.database.connection.html
vendored
@ -91,15 +91,15 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.console.html">cpl.console</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="cpl.database.html">cpl.database</a><ul class="current">
|
||||
<li class="toctree-l3 current"><a class="current reference internal" href="#">cpl.database.connection</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#module-cpl.database.connection.database_connection">cpl.database.connection.database_connection module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#module-cpl.database.connection.database_connection_abc">cpl.database.connection.database_connection_abc module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#module-cpl.database.connection.database_connection">cpl.database.connection.database_connection</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#module-cpl.database.connection.database_connection_abc">cpl.database.connection.database_connection_abc</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.database.context.html">cpl.database.context</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.database.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.database.html#module-cpl.database.database_model">cpl.database.database_model module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.database.html#module-cpl.database.database_settings">cpl.database.database_settings module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.database.html#module-cpl.database.database_settings_name_enum">cpl.database.database_settings_name_enum module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.database.html#module-cpl.database.database_model">cpl.database.database_model</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.database.html#module-cpl.database.database_settings">cpl.database.database_settings</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.database.html#module-cpl.database.database_settings_name_enum">cpl.database.database_settings_name_enum</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.dependency_injection.html">cpl.dependency_injection</a></li>
|
||||
@ -111,7 +111,6 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.html#module-cpl">Module contents</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CPL_CLI</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
@ -186,7 +185,7 @@
|
||||
<div class="section" id="cpl-database-connection">
|
||||
<h1>cpl.database.connection<a class="headerlink" href="#cpl-database-connection" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="section" id="module-cpl.database.connection.database_connection">
|
||||
<span id="cpl-database-connection-database-connection-module"></span><h2>cpl.database.connection.database_connection module<a class="headerlink" href="#module-cpl.database.connection.database_connection" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="cpl-database-connection-database-connection"></span><h2>cpl.database.connection.database_connection<a class="headerlink" href="#module-cpl.database.connection.database_connection" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl.database.connection.database_connection.DatabaseConnection">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.database.connection.database_connection.</span></code><code class="sig-name descname"><span class="pre">DatabaseConnection</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">database_settings</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl.database.html#cpl.database.database_settings.DatabaseSettings" title="cpl.database.database_settings.DatabaseSettings"><span class="pre">cpl.database.database_settings.DatabaseSettings</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.database.connection.database_connection.DatabaseConnection" title="Permalink to this definition">¶</a></dt>
|
||||
@ -213,7 +212,7 @@
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-cpl.database.connection.database_connection_abc">
|
||||
<span id="cpl-database-connection-database-connection-abc-module"></span><h2>cpl.database.connection.database_connection_abc module<a class="headerlink" href="#module-cpl.database.connection.database_connection_abc" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="cpl-database-connection-database-connection-abc"></span><h2>cpl.database.connection.database_connection_abc<a class="headerlink" href="#module-cpl.database.connection.database_connection_abc" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl.database.connection.database_connection_abc.DatabaseConnectionABC">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.database.connection.database_connection_abc.</span></code><code class="sig-name descname"><span class="pre">DatabaseConnectionABC</span></code><a class="headerlink" href="#cpl.database.connection.database_connection_abc.DatabaseConnectionABC" title="Permalink to this definition">¶</a></dt>
|
||||
|
||||
15
docs/build/html/cpl.database.context.html
vendored
15
docs/build/html/cpl.database.context.html
vendored
@ -92,14 +92,14 @@
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="cpl.database.html">cpl.database</a><ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.database.connection.html">cpl.database.connection</a></li>
|
||||
<li class="toctree-l3 current"><a class="current reference internal" href="#">cpl.database.context</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#module-cpl.database.context.database_context">cpl.database.context.database_context module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#module-cpl.database.context.database_context_abc">cpl.database.context.database_context_abc module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#module-cpl.database.context.database_context">cpl.database.context.database_context</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#module-cpl.database.context.database_context_abc">cpl.database.context.database_context_abc</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.database.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.database.html#module-cpl.database.database_model">cpl.database.database_model module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.database.html#module-cpl.database.database_settings">cpl.database.database_settings module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.database.html#module-cpl.database.database_settings_name_enum">cpl.database.database_settings_name_enum module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.database.html#module-cpl.database.database_model">cpl.database.database_model</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.database.html#module-cpl.database.database_settings">cpl.database.database_settings</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.database.html#module-cpl.database.database_settings_name_enum">cpl.database.database_settings_name_enum</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.dependency_injection.html">cpl.dependency_injection</a></li>
|
||||
@ -111,7 +111,6 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.html#module-cpl">Module contents</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CPL_CLI</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
@ -186,7 +185,7 @@
|
||||
<div class="section" id="cpl-database-context">
|
||||
<h1>cpl.database.context<a class="headerlink" href="#cpl-database-context" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="section" id="module-cpl.database.context.database_context">
|
||||
<span id="cpl-database-context-database-context-module"></span><h2>cpl.database.context.database_context module<a class="headerlink" href="#module-cpl.database.context.database_context" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="cpl-database-context-database-context"></span><h2>cpl.database.context.database_context<a class="headerlink" href="#module-cpl.database.context.database_context" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl.database.context.database_context.DatabaseContext">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.database.context.database_context.</span></code><code class="sig-name descname"><span class="pre">DatabaseContext</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">database_settings</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl.database.html#cpl.database.database_settings.DatabaseSettings" title="cpl.database.database_settings.DatabaseSettings"><span class="pre">cpl.database.database_settings.DatabaseSettings</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.database.context.database_context.DatabaseContext" title="Permalink to this definition">¶</a></dt>
|
||||
@ -219,7 +218,7 @@
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-cpl.database.context.database_context_abc">
|
||||
<span id="cpl-database-context-database-context-abc-module"></span><h2>cpl.database.context.database_context_abc module<a class="headerlink" href="#module-cpl.database.context.database_context_abc" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="cpl-database-context-database-context-abc"></span><h2>cpl.database.context.database_context_abc<a class="headerlink" href="#module-cpl.database.context.database_context_abc" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl.database.context.database_context_abc.DatabaseContextABC">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.database.context.database_context_abc.</span></code><code class="sig-name descname"><span class="pre">DatabaseContextABC</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.database.context.database_context_abc.DatabaseContextABC" title="Permalink to this definition">¶</a></dt>
|
||||
|
||||
21
docs/build/html/cpl.database.html
vendored
21
docs/build/html/cpl.database.html
vendored
@ -93,9 +93,9 @@
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.database.connection.html">cpl.database.connection</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.database.context.html">cpl.database.context</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#submodules">Submodules</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.database.database_model">cpl.database.database_model module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.database.database_settings">cpl.database.database_settings module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.database.database_settings_name_enum">cpl.database.database_settings_name_enum module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.database.database_model">cpl.database.database_model</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.database.database_settings">cpl.database.database_settings</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.database.database_settings_name_enum">cpl.database.database_settings_name_enum</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.dependency_injection.html">cpl.dependency_injection</a></li>
|
||||
@ -107,7 +107,6 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.html#module-cpl">Module contents</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CPL_CLI</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
@ -182,13 +181,13 @@
|
||||
<div class="toctree-wrapper compound">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.database.connection.html">cpl.database.connection</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.database.connection.html#module-cpl.database.connection.database_connection">cpl.database.connection.database_connection module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.database.connection.html#module-cpl.database.connection.database_connection_abc">cpl.database.connection.database_connection_abc module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.database.connection.html#module-cpl.database.connection.database_connection">cpl.database.connection.database_connection</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.database.connection.html#module-cpl.database.connection.database_connection_abc">cpl.database.connection.database_connection_abc</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.database.context.html">cpl.database.context</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.database.context.html#module-cpl.database.context.database_context">cpl.database.context.database_context module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.database.context.html#module-cpl.database.context.database_context_abc">cpl.database.context.database_context_abc module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.database.context.html#module-cpl.database.context.database_context">cpl.database.context.database_context</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.database.context.html#module-cpl.database.context.database_context_abc">cpl.database.context.database_context_abc</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@ -197,10 +196,10 @@
|
||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
||||
</div>
|
||||
<div class="section" id="module-cpl.database.database_model">
|
||||
<span id="cpl-database-database-model-module"></span><h2>cpl.database.database_model module<a class="headerlink" href="#module-cpl.database.database_model" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="cpl-database-database-model"></span><h2>cpl.database.database_model<a class="headerlink" href="#module-cpl.database.database_model" title="Permalink to this headline">¶</a></h2>
|
||||
</div>
|
||||
<div class="section" id="module-cpl.database.database_settings">
|
||||
<span id="cpl-database-database-settings-module"></span><h2>cpl.database.database_settings module<a class="headerlink" href="#module-cpl.database.database_settings" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="cpl-database-database-settings"></span><h2>cpl.database.database_settings<a class="headerlink" href="#module-cpl.database.database_settings" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl.database.database_settings.DatabaseSettings">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.database.database_settings.</span></code><code class="sig-name descname"><span class="pre">DatabaseSettings</span></code><a class="headerlink" href="#cpl.database.database_settings.DatabaseSettings" title="Permalink to this definition">¶</a></dt>
|
||||
@ -247,7 +246,7 @@
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-cpl.database.database_settings_name_enum">
|
||||
<span id="cpl-database-database-settings-name-enum-module"></span><h2>cpl.database.database_settings_name_enum module<a class="headerlink" href="#module-cpl.database.database_settings_name_enum" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="cpl-database-database-settings-name-enum"></span><h2>cpl.database.database_settings_name_enum<a class="headerlink" href="#module-cpl.database.database_settings_name_enum" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl.database.database_settings_name_enum.DatabaseSettingsNameEnum">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.database.database_settings_name_enum.</span></code><code class="sig-name descname"><span class="pre">DatabaseSettingsNameEnum</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.database.database_settings_name_enum.DatabaseSettingsNameEnum" title="Permalink to this definition">¶</a></dt>
|
||||
|
||||
25
docs/build/html/cpl.dependency_injection.html
vendored
25
docs/build/html/cpl.dependency_injection.html
vendored
@ -91,12 +91,12 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.console.html">cpl.console</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.database.html">cpl.database</a></li>
|
||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl.dependency_injection</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.dependency_injection.service_collection">cpl.dependency_injection.service_collection module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.dependency_injection.service_collection_abc">cpl.dependency_injection.service_collection_abc module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.dependency_injection.service_descriptor">cpl.dependency_injection.service_descriptor module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.dependency_injection.service_lifetime_enum">cpl.dependency_injection.service_lifetime_enum module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.dependency_injection.service_provider">cpl.dependency_injection.service_provider module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.dependency_injection.service_provider_abc">cpl.dependency_injection.service_provider_abc module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.dependency_injection.service_collection">cpl.dependency_injection.service_collection</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.dependency_injection.service_collection_abc">cpl.dependency_injection.service_collection_abc</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.dependency_injection.service_descriptor">cpl.dependency_injection.service_descriptor</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.dependency_injection.service_lifetime_enum">cpl.dependency_injection.service_lifetime_enum</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.dependency_injection.service_provider">cpl.dependency_injection.service_provider</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.dependency_injection.service_provider_abc">cpl.dependency_injection.service_provider_abc</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.environment.html">cpl.environment</a></li>
|
||||
@ -107,7 +107,6 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.html#module-cpl">Module contents</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CPL_CLI</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
@ -180,7 +179,7 @@
|
||||
<div class="section" id="cpl-dependency-injection">
|
||||
<h1>cpl.dependency_injection<a class="headerlink" href="#cpl-dependency-injection" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="section" id="module-cpl.dependency_injection.service_collection">
|
||||
<span id="cpl-dependency-injection-service-collection-module"></span><h2>cpl.dependency_injection.service_collection module<a class="headerlink" href="#module-cpl.dependency_injection.service_collection" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="cpl-dependency-injection-service-collection"></span><h2>cpl.dependency_injection.service_collection<a class="headerlink" href="#module-cpl.dependency_injection.service_collection" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl.dependency_injection.service_collection.ServiceCollection">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.dependency_injection.service_collection.</span></code><code class="sig-name descname"><span class="pre">ServiceCollection</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.configuration.html#cpl.configuration.configuration_abc.ConfigurationABC" title="cpl.configuration.configuration_abc.ConfigurationABC"><span class="pre">cpl.configuration.configuration_abc.ConfigurationABC</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.dependency_injection.service_collection.ServiceCollection" title="Permalink to this definition">¶</a></dt>
|
||||
@ -237,7 +236,7 @@
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-cpl.dependency_injection.service_collection_abc">
|
||||
<span id="cpl-dependency-injection-service-collection-abc-module"></span><h2>cpl.dependency_injection.service_collection_abc module<a class="headerlink" href="#module-cpl.dependency_injection.service_collection_abc" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="cpl-dependency-injection-service-collection-abc"></span><h2>cpl.dependency_injection.service_collection_abc<a class="headerlink" href="#module-cpl.dependency_injection.service_collection_abc" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl.dependency_injection.service_collection_abc.ServiceCollectionABC">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.dependency_injection.service_collection_abc.</span></code><code class="sig-name descname"><span class="pre">ServiceCollectionABC</span></code><a class="headerlink" href="#cpl.dependency_injection.service_collection_abc.ServiceCollectionABC" title="Permalink to this definition">¶</a></dt>
|
||||
@ -294,7 +293,7 @@
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-cpl.dependency_injection.service_descriptor">
|
||||
<span id="cpl-dependency-injection-service-descriptor-module"></span><h2>cpl.dependency_injection.service_descriptor module<a class="headerlink" href="#module-cpl.dependency_injection.service_descriptor" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="cpl-dependency-injection-service-descriptor"></span><h2>cpl.dependency_injection.service_descriptor<a class="headerlink" href="#module-cpl.dependency_injection.service_descriptor" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl.dependency_injection.service_descriptor.ServiceDescriptor">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.dependency_injection.service_descriptor.</span></code><code class="sig-name descname"><span class="pre">ServiceDescriptor</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">implementation</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">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">type</span><span class="p"><span class="pre">,</span> </span><span class="pre">object</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lifetime</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="#cpl.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum" title="cpl.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum"><span class="pre">cpl.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.dependency_injection.service_descriptor.ServiceDescriptor" title="Permalink to this definition">¶</a></dt>
|
||||
@ -318,7 +317,7 @@
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-cpl.dependency_injection.service_lifetime_enum">
|
||||
<span id="cpl-dependency-injection-service-lifetime-enum-module"></span><h2>cpl.dependency_injection.service_lifetime_enum module<a class="headerlink" href="#module-cpl.dependency_injection.service_lifetime_enum" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="cpl-dependency-injection-service-lifetime-enum"></span><h2>cpl.dependency_injection.service_lifetime_enum<a class="headerlink" href="#module-cpl.dependency_injection.service_lifetime_enum" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.dependency_injection.service_lifetime_enum.</span></code><code class="sig-name descname"><span class="pre">ServiceLifetimeEnum</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.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum" title="Permalink to this definition">¶</a></dt>
|
||||
@ -343,7 +342,7 @@
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-cpl.dependency_injection.service_provider">
|
||||
<span id="cpl-dependency-injection-service-provider-module"></span><h2>cpl.dependency_injection.service_provider module<a class="headerlink" href="#module-cpl.dependency_injection.service_provider" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="cpl-dependency-injection-service-provider"></span><h2>cpl.dependency_injection.service_provider<a class="headerlink" href="#module-cpl.dependency_injection.service_provider" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl.dependency_injection.service_provider.ServiceProvider">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.dependency_injection.service_provider.</span></code><code class="sig-name descname"><span class="pre">ServiceProvider</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_descriptors</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">config</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl.configuration.html#cpl.configuration.configuration_abc.ConfigurationABC" title="cpl.configuration.configuration_abc.ConfigurationABC"><span class="pre">cpl.configuration.configuration_abc.ConfigurationABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">db_context</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><a class="reference internal" href="cpl.database.context.html#cpl.database.context.database_context_abc.DatabaseContextABC" title="cpl.database.context.database_context_abc.DatabaseContextABC"><span class="pre">cpl.database.context.database_context_abc.DatabaseContextABC</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.dependency_injection.service_provider.ServiceProvider" title="Permalink to this definition">¶</a></dt>
|
||||
@ -368,7 +367,7 @@
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-cpl.dependency_injection.service_provider_abc">
|
||||
<span id="cpl-dependency-injection-service-provider-abc-module"></span><h2>cpl.dependency_injection.service_provider_abc module<a class="headerlink" href="#module-cpl.dependency_injection.service_provider_abc" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="cpl-dependency-injection-service-provider-abc"></span><h2>cpl.dependency_injection.service_provider_abc<a class="headerlink" href="#module-cpl.dependency_injection.service_provider_abc" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl.dependency_injection.service_provider_abc.ServiceProviderABC">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.dependency_injection.service_provider_abc.</span></code><code class="sig-name descname"><span class="pre">ServiceProviderABC</span></code><a class="headerlink" href="#cpl.dependency_injection.service_provider_abc.ServiceProviderABC" title="Permalink to this definition">¶</a></dt>
|
||||
|
||||
13
docs/build/html/cpl.environment.html
vendored
13
docs/build/html/cpl.environment.html
vendored
@ -92,9 +92,9 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.database.html">cpl.database</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.dependency_injection.html">cpl.dependency_injection</a></li>
|
||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl.environment</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.environment.application_environment">cpl.environment.application_environment module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.environment.application_environment_abc">cpl.environment.application_environment_abc module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.environment.environment_name_enum">cpl.environment.environment_name_enum module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.environment.application_environment">cpl.environment.application_environment</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.environment.application_environment_abc">cpl.environment.application_environment_abc</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.environment.environment_name_enum">cpl.environment.environment_name_enum</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.logging.html">cpl.logging</a></li>
|
||||
@ -104,7 +104,6 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.html#module-cpl">Module contents</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CPL_CLI</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
@ -177,7 +176,7 @@
|
||||
<div class="section" id="cpl-environment">
|
||||
<h1>cpl.environment<a class="headerlink" href="#cpl-environment" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="section" id="module-cpl.environment.application_environment">
|
||||
<span id="cpl-environment-application-environment-module"></span><h2>cpl.environment.application_environment module<a class="headerlink" href="#module-cpl.environment.application_environment" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="cpl-environment-application-environment"></span><h2>cpl.environment.application_environment<a class="headerlink" href="#module-cpl.environment.application_environment" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl.environment.application_environment.ApplicationEnvironment">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.environment.application_environment.</span></code><code class="sig-name descname"><span class="pre">ApplicationEnvironment</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="pre">name:</span> <span class="pre">cpl.environment.environment_name_enum.EnvironmentNameEnum</span> <span class="pre">=</span> <span class="pre"><EnvironmentNameEnum.production:</span> <span class="pre">'production'></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.environment.application_environment.ApplicationEnvironment" title="Permalink to this definition">¶</a></dt>
|
||||
@ -247,7 +246,7 @@
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-cpl.environment.application_environment_abc">
|
||||
<span id="cpl-environment-application-environment-abc-module"></span><h2>cpl.environment.application_environment_abc module<a class="headerlink" href="#module-cpl.environment.application_environment_abc" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="cpl-environment-application-environment-abc"></span><h2>cpl.environment.application_environment_abc<a class="headerlink" href="#module-cpl.environment.application_environment_abc" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl.environment.application_environment_abc.ApplicationEnvironmentABC">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.environment.application_environment_abc.</span></code><code class="sig-name descname"><span class="pre">ApplicationEnvironmentABC</span></code><a class="headerlink" href="#cpl.environment.application_environment_abc.ApplicationEnvironmentABC" title="Permalink to this definition">¶</a></dt>
|
||||
@ -317,7 +316,7 @@
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-cpl.environment.environment_name_enum">
|
||||
<span id="cpl-environment-environment-name-enum-module"></span><h2>cpl.environment.environment_name_enum module<a class="headerlink" href="#module-cpl.environment.environment_name_enum" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="cpl-environment-environment-name-enum"></span><h2>cpl.environment.environment_name_enum<a class="headerlink" href="#module-cpl.environment.environment_name_enum" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl.environment.environment_name_enum.EnvironmentNameEnum">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.environment.environment_name_enum.</span></code><code class="sig-name descname"><span class="pre">EnvironmentNameEnum</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.environment.environment_name_enum.EnvironmentNameEnum" title="Permalink to this definition">¶</a></dt>
|
||||
|
||||
91
docs/build/html/cpl.html
vendored
91
docs/build/html/cpl.html
vendored
@ -102,7 +102,6 @@
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CPL_CLI</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
@ -175,85 +174,85 @@
|
||||
<div class="toctree-wrapper compound">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.application.html">cpl.application</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.application.html#module-cpl.application.application_abc">cpl.application.application_abc module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.application.html#module-cpl.application.application_builder">cpl.application.application_builder module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.application.html#module-cpl.application.application_builder_abc">cpl.application.application_builder_abc module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.application.html#module-cpl.application.startup_abc">cpl.application.startup_abc module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.application.html#module-cpl.application.application_abc">cpl.application.application_abc</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.application.html#module-cpl.application.application_builder">cpl.application.application_builder</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.application.html#module-cpl.application.application_builder_abc">cpl.application.application_builder_abc</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.application.html#module-cpl.application.startup_abc">cpl.application.startup_abc</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.configuration.html">cpl.configuration</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.configuration.html#module-cpl.configuration.configuration">cpl.configuration.configuration module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.configuration.html#module-cpl.configuration.configuration_abc">cpl.configuration.configuration_abc module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.configuration.html#module-cpl.configuration.configuration_model_abc">cpl.configuration.configuration_model_abc module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.configuration.html#module-cpl.configuration.configuration_variable_name_enum">cpl.configuration.configuration_variable_name_enum module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.configuration.html#module-cpl.configuration.console_argument">cpl.configuration.console_argument module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.configuration.html#module-cpl.configuration.configuration">cpl.configuration.configuration</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.configuration.html#module-cpl.configuration.configuration_abc">cpl.configuration.configuration_abc</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.configuration.html#module-cpl.configuration.configuration_model_abc">cpl.configuration.configuration_model_abc</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.configuration.html#module-cpl.configuration.configuration_variable_name_enum">cpl.configuration.configuration_variable_name_enum</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.configuration.html#module-cpl.configuration.console_argument">cpl.configuration.console_argument</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.console.html">cpl.console</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.console.html#module-cpl.console.background_color_enum">cpl.console.background_color_enum module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.console.html#module-cpl.console.console">cpl.console.console module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.console.html#module-cpl.console.console_call">cpl.console.console_call module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.console.html#module-cpl.console.foreground_color_enum">cpl.console.foreground_color_enum module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.console.html#module-cpl.console.spinner_thread">cpl.console.spinner_thread module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.console.html#module-cpl.console.background_color_enum">cpl.console.background_color_enum</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.console.html#module-cpl.console.console">cpl.console.console</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.console.html#module-cpl.console.console_call">cpl.console.console_call</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.console.html#module-cpl.console.foreground_color_enum">cpl.console.foreground_color_enum</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.console.html#module-cpl.console.spinner_thread">cpl.console.spinner_thread</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.database.html">cpl.database</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.database.connection.html">cpl.database.connection</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.database.connection.html#module-cpl.database.connection.database_connection">cpl.database.connection.database_connection module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.database.connection.html#module-cpl.database.connection.database_connection_abc">cpl.database.connection.database_connection_abc module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.database.connection.html#module-cpl.database.connection.database_connection">cpl.database.connection.database_connection</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.database.connection.html#module-cpl.database.connection.database_connection_abc">cpl.database.connection.database_connection_abc</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.database.context.html">cpl.database.context</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.database.context.html#module-cpl.database.context.database_context">cpl.database.context.database_context module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.database.context.html#module-cpl.database.context.database_context_abc">cpl.database.context.database_context_abc module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.database.context.html#module-cpl.database.context.database_context">cpl.database.context.database_context</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.database.context.html#module-cpl.database.context.database_context_abc">cpl.database.context.database_context_abc</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.database.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.database.html#module-cpl.database.database_model">cpl.database.database_model module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.database.html#module-cpl.database.database_settings">cpl.database.database_settings module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.database.html#module-cpl.database.database_settings_name_enum">cpl.database.database_settings_name_enum module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.database.html#module-cpl.database.database_model">cpl.database.database_model</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.database.html#module-cpl.database.database_settings">cpl.database.database_settings</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.database.html#module-cpl.database.database_settings_name_enum">cpl.database.database_settings_name_enum</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.dependency_injection.html">cpl.dependency_injection</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.dependency_injection.html#module-cpl.dependency_injection.service_collection">cpl.dependency_injection.service_collection module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.dependency_injection.html#module-cpl.dependency_injection.service_collection_abc">cpl.dependency_injection.service_collection_abc module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.dependency_injection.html#module-cpl.dependency_injection.service_descriptor">cpl.dependency_injection.service_descriptor module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.dependency_injection.html#module-cpl.dependency_injection.service_lifetime_enum">cpl.dependency_injection.service_lifetime_enum module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.dependency_injection.html#module-cpl.dependency_injection.service_provider">cpl.dependency_injection.service_provider module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.dependency_injection.html#module-cpl.dependency_injection.service_provider_abc">cpl.dependency_injection.service_provider_abc module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.dependency_injection.html#module-cpl.dependency_injection.service_collection">cpl.dependency_injection.service_collection</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.dependency_injection.html#module-cpl.dependency_injection.service_collection_abc">cpl.dependency_injection.service_collection_abc</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.dependency_injection.html#module-cpl.dependency_injection.service_descriptor">cpl.dependency_injection.service_descriptor</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.dependency_injection.html#module-cpl.dependency_injection.service_lifetime_enum">cpl.dependency_injection.service_lifetime_enum</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.dependency_injection.html#module-cpl.dependency_injection.service_provider">cpl.dependency_injection.service_provider</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.dependency_injection.html#module-cpl.dependency_injection.service_provider_abc">cpl.dependency_injection.service_provider_abc</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.environment.html">cpl.environment</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.environment.html#module-cpl.environment.application_environment">cpl.environment.application_environment module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.environment.html#module-cpl.environment.application_environment_abc">cpl.environment.application_environment_abc module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.environment.html#module-cpl.environment.environment_name_enum">cpl.environment.environment_name_enum module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.environment.html#module-cpl.environment.application_environment">cpl.environment.application_environment</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.environment.html#module-cpl.environment.application_environment_abc">cpl.environment.application_environment_abc</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.environment.html#module-cpl.environment.environment_name_enum">cpl.environment.environment_name_enum</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.logging.html">cpl.logging</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.logging.html#module-cpl.logging.logger_abc">cpl.logging.logger_abc module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.logging.html#module-cpl.logging.logger_service">cpl.logging.logger_service module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.logging.html#module-cpl.logging.logging_level_enum">cpl.logging.logging_level_enum module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.logging.html#module-cpl.logging.logging_settings">cpl.logging.logging_settings module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.logging.html#module-cpl.logging.logging_settings_name_enum">cpl.logging.logging_settings_name_enum module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.logging.html#module-cpl.logging.logger_abc">cpl.logging.logger_abc</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.logging.html#module-cpl.logging.logger_service">cpl.logging.logger_service</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.logging.html#module-cpl.logging.logging_level_enum">cpl.logging.logging_level_enum</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.logging.html#module-cpl.logging.logging_settings">cpl.logging.logging_settings</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.logging.html#module-cpl.logging.logging_settings_name_enum">cpl.logging.logging_settings_name_enum</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.mailing.html">cpl.mailing</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.mailing.html#module-cpl.mailing.email">cpl.mailing.email module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.mailing.html#module-cpl.mailing.email_client_abc">cpl.mailing.email_client_abc module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.mailing.html#module-cpl.mailing.email_client_service">cpl.mailing.email_client_service module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.mailing.html#module-cpl.mailing.email_client_settings">cpl.mailing.email_client_settings module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.mailing.html#module-cpl.mailing.email_client_settings_name_enum">cpl.mailing.email_client_settings_name_enum module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.mailing.html#module-cpl.mailing.email">cpl.mailing.email</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.mailing.html#module-cpl.mailing.email_client_abc">cpl.mailing.email_client_abc</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.mailing.html#module-cpl.mailing.email_client_service">cpl.mailing.email_client_service</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.mailing.html#module-cpl.mailing.email_client_settings">cpl.mailing.email_client_settings</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.mailing.html#module-cpl.mailing.email_client_settings_name_enum">cpl.mailing.email_client_settings_name_enum</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.time.html">cpl.time</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.time.html#module-cpl.time.time_format_settings">cpl.time.time_format_settings module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.time.html#module-cpl.time.time_format_settings_names_enum">cpl.time.time_format_settings_names_enum module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.time.html#module-cpl.time.time_format_settings">cpl.time.time_format_settings</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.time.html#module-cpl.time.time_format_settings_names_enum">cpl.time.time_format_settings_names_enum</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.utils.html">cpl.utils</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.utils.html#module-cpl.utils.credential_manager">cpl.utils.credential_manager module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.utils.html#module-cpl.utils.pip">cpl.utils.pip module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.utils.html#module-cpl.utils.string">cpl.utils.string module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.utils.html#module-cpl.utils.credential_manager">cpl.utils.credential_manager</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.utils.html#module-cpl.utils.pip">cpl.utils.pip</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.utils.html#module-cpl.utils.string">cpl.utils.string</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
21
docs/build/html/cpl.logging.html
vendored
21
docs/build/html/cpl.logging.html
vendored
@ -93,11 +93,11 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.dependency_injection.html">cpl.dependency_injection</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.environment.html">cpl.environment</a></li>
|
||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl.logging</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.logging.logger_abc">cpl.logging.logger_abc module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.logging.logger_service">cpl.logging.logger_service module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.logging.logging_level_enum">cpl.logging.logging_level_enum module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.logging.logging_settings">cpl.logging.logging_settings module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.logging.logging_settings_name_enum">cpl.logging.logging_settings_name_enum module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.logging.logger_abc">cpl.logging.logger_abc</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.logging.logger_service">cpl.logging.logger_service</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.logging.logging_level_enum">cpl.logging.logging_level_enum</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.logging.logging_settings">cpl.logging.logging_settings</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.logging.logging_settings_name_enum">cpl.logging.logging_settings_name_enum</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.mailing.html">cpl.mailing</a></li>
|
||||
@ -106,7 +106,6 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.html#module-cpl">Module contents</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CPL_CLI</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
@ -179,7 +178,7 @@
|
||||
<div class="section" id="cpl-logging">
|
||||
<h1>cpl.logging<a class="headerlink" href="#cpl-logging" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="section" id="module-cpl.logging.logger_abc">
|
||||
<span id="cpl-logging-logger-abc-module"></span><h2>cpl.logging.logger_abc module<a class="headerlink" href="#module-cpl.logging.logger_abc" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="cpl-logging-logger-abc"></span><h2>cpl.logging.logger_abc<a class="headerlink" href="#module-cpl.logging.logger_abc" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl.logging.logger_abc.LoggerABC">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.logging.logger_abc.</span></code><code class="sig-name descname"><span class="pre">LoggerABC</span></code><a class="headerlink" href="#cpl.logging.logger_abc.LoggerABC" title="Permalink to this definition">¶</a></dt>
|
||||
@ -252,7 +251,7 @@
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-cpl.logging.logger_service">
|
||||
<span id="cpl-logging-logger-service-module"></span><h2>cpl.logging.logger_service module<a class="headerlink" href="#module-cpl.logging.logger_service" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="cpl-logging-logger-service"></span><h2>cpl.logging.logger_service<a class="headerlink" href="#module-cpl.logging.logger_service" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl.logging.logger_service.Logger">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.logging.logger_service.</span></code><code class="sig-name descname"><span class="pre">Logger</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">logging_settings</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="#cpl.logging.logging_settings.LoggingSettings" title="cpl.logging.logging_settings.LoggingSettings"><span class="pre">cpl.logging.logging_settings.LoggingSettings</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">time_format</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl.time.html#cpl.time.time_format_settings.TimeFormatSettings" title="cpl.time.time_format_settings.TimeFormatSettings"><span class="pre">cpl.time.time_format_settings.TimeFormatSettings</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.environment.html#cpl.environment.application_environment_abc.ApplicationEnvironmentABC" title="cpl.environment.application_environment_abc.ApplicationEnvironmentABC"><span class="pre">cpl.environment.application_environment_abc.ApplicationEnvironmentABC</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.logging.logger_service.Logger" title="Permalink to this definition">¶</a></dt>
|
||||
@ -332,7 +331,7 @@
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-cpl.logging.logging_level_enum">
|
||||
<span id="cpl-logging-logging-level-enum-module"></span><h2>cpl.logging.logging_level_enum module<a class="headerlink" href="#module-cpl.logging.logging_level_enum" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="cpl-logging-logging-level-enum"></span><h2>cpl.logging.logging_level_enum<a class="headerlink" href="#module-cpl.logging.logging_level_enum" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl.logging.logging_level_enum.LoggingLevelEnum">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.logging.logging_level_enum.</span></code><code class="sig-name descname"><span class="pre">LoggingLevelEnum</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.logging.logging_level_enum.LoggingLevelEnum" title="Permalink to this definition">¶</a></dt>
|
||||
@ -377,7 +376,7 @@
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-cpl.logging.logging_settings">
|
||||
<span id="cpl-logging-logging-settings-module"></span><h2>cpl.logging.logging_settings module<a class="headerlink" href="#module-cpl.logging.logging_settings" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="cpl-logging-logging-settings"></span><h2>cpl.logging.logging_settings<a class="headerlink" href="#module-cpl.logging.logging_settings" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl.logging.logging_settings.LoggingSettings">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.logging.logging_settings.</span></code><code class="sig-name descname"><span class="pre">LoggingSettings</span></code><a class="headerlink" href="#cpl.logging.logging_settings.LoggingSettings" title="Permalink to this definition">¶</a></dt>
|
||||
@ -414,7 +413,7 @@
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-cpl.logging.logging_settings_name_enum">
|
||||
<span id="cpl-logging-logging-settings-name-enum-module"></span><h2>cpl.logging.logging_settings_name_enum module<a class="headerlink" href="#module-cpl.logging.logging_settings_name_enum" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="cpl-logging-logging-settings-name-enum"></span><h2>cpl.logging.logging_settings_name_enum<a class="headerlink" href="#module-cpl.logging.logging_settings_name_enum" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl.logging.logging_settings_name_enum.LoggingSettingsNameEnum">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.logging.logging_settings_name_enum.</span></code><code class="sig-name descname"><span class="pre">LoggingSettingsNameEnum</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.logging.logging_settings_name_enum.LoggingSettingsNameEnum" title="Permalink to this definition">¶</a></dt>
|
||||
|
||||
21
docs/build/html/cpl.mailing.html
vendored
21
docs/build/html/cpl.mailing.html
vendored
@ -94,11 +94,11 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.environment.html">cpl.environment</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.logging.html">cpl.logging</a></li>
|
||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl.mailing</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.mailing.email">cpl.mailing.email module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.mailing.email_client_abc">cpl.mailing.email_client_abc module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.mailing.email_client_service">cpl.mailing.email_client_service module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.mailing.email_client_settings">cpl.mailing.email_client_settings module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.mailing.email_client_settings_name_enum">cpl.mailing.email_client_settings_name_enum module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.mailing.email">cpl.mailing.email</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.mailing.email_client_abc">cpl.mailing.email_client_abc</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.mailing.email_client_service">cpl.mailing.email_client_service</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.mailing.email_client_settings">cpl.mailing.email_client_settings</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.mailing.email_client_settings_name_enum">cpl.mailing.email_client_settings_name_enum</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.time.html">cpl.time</a></li>
|
||||
@ -106,7 +106,6 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.html#module-cpl">Module contents</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CPL_CLI</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
@ -179,7 +178,7 @@
|
||||
<div class="section" id="cpl-mailing">
|
||||
<h1>cpl.mailing<a class="headerlink" href="#cpl-mailing" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="section" id="module-cpl.mailing.email">
|
||||
<span id="cpl-mailing-email-module"></span><h2>cpl.mailing.email module<a class="headerlink" href="#module-cpl.mailing.email" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="cpl-mailing-email"></span><h2>cpl.mailing.email<a class="headerlink" href="#module-cpl.mailing.email" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl.mailing.email.EMail">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.mailing.email.</span></code><code class="sig-name descname"><span class="pre">EMail</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">header</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>, <em class="sig-param"><span class="n"><span class="pre">subject</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>, <em class="sig-param"><span class="n"><span class="pre">body</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>, <em class="sig-param"><span class="n"><span class="pre">transceiver</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>, <em class="sig-param"><span class="n"><span class="pre">receiver</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.mailing.email.EMail" title="Permalink to this definition">¶</a></dt>
|
||||
@ -255,7 +254,7 @@
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-cpl.mailing.email_client_abc">
|
||||
<span id="cpl-mailing-email-client-abc-module"></span><h2>cpl.mailing.email_client_abc module<a class="headerlink" href="#module-cpl.mailing.email_client_abc" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="cpl-mailing-email-client-abc"></span><h2>cpl.mailing.email_client_abc<a class="headerlink" href="#module-cpl.mailing.email_client_abc" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl.mailing.email_client_abc.EMailClientABC">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.mailing.email_client_abc.</span></code><code class="sig-name descname"><span class="pre">EMailClientABC</span></code><a class="headerlink" href="#cpl.mailing.email_client_abc.EMailClientABC" title="Permalink to this definition">¶</a></dt>
|
||||
@ -279,7 +278,7 @@
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-cpl.mailing.email_client_service">
|
||||
<span id="cpl-mailing-email-client-service-module"></span><h2>cpl.mailing.email_client_service module<a class="headerlink" href="#module-cpl.mailing.email_client_service" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="cpl-mailing-email-client-service"></span><h2>cpl.mailing.email_client_service<a class="headerlink" href="#module-cpl.mailing.email_client_service" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl.mailing.email_client_service.EMailClient">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.mailing.email_client_service.</span></code><code class="sig-name descname"><span class="pre">EMailClient</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">environment</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl.environment.html#cpl.environment.application_environment_abc.ApplicationEnvironmentABC" title="cpl.environment.application_environment_abc.ApplicationEnvironmentABC"><span class="pre">cpl.environment.application_environment_abc.ApplicationEnvironmentABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">logger</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl.logging.html#cpl.logging.logger_abc.LoggerABC" title="cpl.logging.logger_abc.LoggerABC"><span class="pre">cpl.logging.logger_abc.LoggerABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">mail_settings</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="#cpl.mailing.email_client_settings.EMailClientSettings" title="cpl.mailing.email_client_settings.EMailClientSettings"><span class="pre">cpl.mailing.email_client_settings.EMailClientSettings</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.mailing.email_client_service.EMailClient" title="Permalink to this definition">¶</a></dt>
|
||||
@ -317,7 +316,7 @@
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-cpl.mailing.email_client_settings">
|
||||
<span id="cpl-mailing-email-client-settings-module"></span><h2>cpl.mailing.email_client_settings module<a class="headerlink" href="#module-cpl.mailing.email_client_settings" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="cpl-mailing-email-client-settings"></span><h2>cpl.mailing.email_client_settings<a class="headerlink" href="#module-cpl.mailing.email_client_settings" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl.mailing.email_client_settings.EMailClientSettings">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.mailing.email_client_settings.</span></code><code class="sig-name descname"><span class="pre">EMailClientSettings</span></code><a class="headerlink" href="#cpl.mailing.email_client_settings.EMailClientSettings" title="Permalink to this definition">¶</a></dt>
|
||||
@ -354,7 +353,7 @@
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-cpl.mailing.email_client_settings_name_enum">
|
||||
<span id="cpl-mailing-email-client-settings-name-enum-module"></span><h2>cpl.mailing.email_client_settings_name_enum module<a class="headerlink" href="#module-cpl.mailing.email_client_settings_name_enum" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="cpl-mailing-email-client-settings-name-enum"></span><h2>cpl.mailing.email_client_settings_name_enum<a class="headerlink" href="#module-cpl.mailing.email_client_settings_name_enum" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl.mailing.email_client_settings_name_enum.EMailClientSettingsNameEnum">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.mailing.email_client_settings_name_enum.</span></code><code class="sig-name descname"><span class="pre">EMailClientSettingsNameEnum</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.mailing.email_client_settings_name_enum.EMailClientSettingsNameEnum" title="Permalink to this definition">¶</a></dt>
|
||||
|
||||
9
docs/build/html/cpl.time.html
vendored
9
docs/build/html/cpl.time.html
vendored
@ -95,15 +95,14 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.logging.html">cpl.logging</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.mailing.html">cpl.mailing</a></li>
|
||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl.time</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.time.time_format_settings">cpl.time.time_format_settings module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.time.time_format_settings_names_enum">cpl.time.time_format_settings_names_enum module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.time.time_format_settings">cpl.time.time_format_settings</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.time.time_format_settings_names_enum">cpl.time.time_format_settings_names_enum</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.utils.html">cpl.utils</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.html#module-cpl">Module contents</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CPL_CLI</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
@ -176,7 +175,7 @@
|
||||
<div class="section" id="cpl-time">
|
||||
<h1>cpl.time<a class="headerlink" href="#cpl-time" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="section" id="module-cpl.time.time_format_settings">
|
||||
<span id="cpl-time-time-format-settings-module"></span><h2>cpl.time.time_format_settings module<a class="headerlink" href="#module-cpl.time.time_format_settings" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="cpl-time-time-format-settings"></span><h2>cpl.time.time_format_settings<a class="headerlink" href="#module-cpl.time.time_format_settings" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl.time.time_format_settings.TimeFormatSettings">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.time.time_format_settings.</span></code><code class="sig-name descname"><span class="pre">TimeFormatSettings</span></code><a class="headerlink" href="#cpl.time.time_format_settings.TimeFormatSettings" title="Permalink to this definition">¶</a></dt>
|
||||
@ -213,7 +212,7 @@
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-cpl.time.time_format_settings_names_enum">
|
||||
<span id="cpl-time-time-format-settings-names-enum-module"></span><h2>cpl.time.time_format_settings_names_enum module<a class="headerlink" href="#module-cpl.time.time_format_settings_names_enum" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="cpl-time-time-format-settings-names-enum"></span><h2>cpl.time.time_format_settings_names_enum<a class="headerlink" href="#module-cpl.time.time_format_settings_names_enum" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl.time.time_format_settings_names_enum.TimeFormatSettingsNamesEnum">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.time.time_format_settings_names_enum.</span></code><code class="sig-name descname"><span class="pre">TimeFormatSettingsNamesEnum</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.time.time_format_settings_names_enum.TimeFormatSettingsNamesEnum" title="Permalink to this definition">¶</a></dt>
|
||||
|
||||
15
docs/build/html/cpl.utils.html
vendored
15
docs/build/html/cpl.utils.html
vendored
@ -38,7 +38,6 @@
|
||||
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="CPL_CLI" href="cpl_cli.html" />
|
||||
<link rel="prev" title="cpl.time" href="cpl.time.html" />
|
||||
</head>
|
||||
|
||||
@ -96,15 +95,14 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.mailing.html">cpl.mailing</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.time.html">cpl.time</a></li>
|
||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl.utils</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.utils.credential_manager">cpl.utils.credential_manager module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.utils.pip">cpl.utils.pip module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.utils.string">cpl.utils.string module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.utils.credential_manager">cpl.utils.credential_manager</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.utils.pip">cpl.utils.pip</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.utils.string">cpl.utils.string</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.html#module-cpl">Module contents</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CPL_CLI</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
@ -177,7 +175,7 @@
|
||||
<div class="section" id="cpl-utils">
|
||||
<h1>cpl.utils<a class="headerlink" href="#cpl-utils" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="section" id="module-cpl.utils.credential_manager">
|
||||
<span id="cpl-utils-credential-manager-module"></span><h2>cpl.utils.credential_manager module<a class="headerlink" href="#module-cpl.utils.credential_manager" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="cpl-utils-credential-manager"></span><h2>cpl.utils.credential_manager<a class="headerlink" href="#module-cpl.utils.credential_manager" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl.utils.credential_manager.CredentialManager">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.utils.credential_manager.</span></code><code class="sig-name descname"><span class="pre">CredentialManager</span></code><a class="headerlink" href="#cpl.utils.credential_manager.CredentialManager" title="Permalink to this definition">¶</a></dt>
|
||||
@ -212,7 +210,7 @@
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-cpl.utils.pip">
|
||||
<span id="cpl-utils-pip-module"></span><h2>cpl.utils.pip module<a class="headerlink" href="#module-cpl.utils.pip" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="cpl-utils-pip"></span><h2>cpl.utils.pip<a class="headerlink" href="#module-cpl.utils.pip" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl.utils.pip.Pip">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.utils.pip.</span></code><code class="sig-name descname"><span class="pre">Pip</span></code><a class="headerlink" href="#cpl.utils.pip.Pip" title="Permalink to this definition">¶</a></dt>
|
||||
@ -279,7 +277,7 @@
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-cpl.utils.string">
|
||||
<span id="cpl-utils-string-module"></span><h2>cpl.utils.string module<a class="headerlink" href="#module-cpl.utils.string" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="cpl-utils-string"></span><h2>cpl.utils.string<a class="headerlink" href="#module-cpl.utils.string" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl.utils.string.String">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.utils.string.</span></code><code class="sig-name descname"><span class="pre">String</span></code><a class="headerlink" href="#cpl.utils.string.String" title="Permalink to this definition">¶</a></dt>
|
||||
@ -334,7 +332,6 @@
|
||||
</div>
|
||||
<footer>
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||
<a href="cpl_cli.html" class="btn btn-neutral float-right" title="CPL_CLI" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
<a href="cpl.time.html" class="btn btn-neutral float-left" title="cpl.time" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
</div>
|
||||
|
||||
|
||||
506
docs/build/html/cpl_cli.command.html
vendored
506
docs/build/html/cpl_cli.command.html
vendored
@ -1,506 +0,0 @@
|
||||
|
||||
|
||||
<!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_cli.command — Common Python Library documentation</title>
|
||||
|
||||
|
||||
|
||||
<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 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 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_cli.configuration" href="cpl_cli.configuration.html" />
|
||||
<link rel="prev" title="CPL_CLI" href="cpl_cli.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
|
||||
|
||||
<div class="wy-grid-for-nav">
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="index.html" class="icon icon-home"> Common Python Library
|
||||
|
||||
|
||||
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.html">CPL</a></li>
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CPL_CLI</a><ul class="current">
|
||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl_cli.command</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_cli.command.add_service">cpl_cli.command.add_service module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_cli.command.build_service">cpl_cli.command.build_service module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_cli.command.generate_service">cpl_cli.command.generate_service module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_cli.command.help_service">cpl_cli.command.help_service module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_cli.command.install_service">cpl_cli.command.install_service module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_cli.command.new_service">cpl_cli.command.new_service module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_cli.command.publish_service">cpl_cli.command.publish_service module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_cli.command.remove_service">cpl_cli.command.remove_service module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_cli.command.start_service">cpl_cli.command.start_service module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_cli.command.uninstall_service">cpl_cli.command.uninstall_service module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_cli.command.update_service">cpl_cli.command.update_service module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_cli.command.version_service">cpl_cli.command.version_service module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.configuration.html">cpl_cli.configuration</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.live_server.html">cpl_cli.live_server</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.publish.html">cpl_cli.publish</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.source_creator.html">cpl_cli.source_creator</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.cli">cpl_cli.cli</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.cli_settings">cpl_cli.cli_settings</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.cli_settings_name_enum">cpl_cli.cli_settings_name_enum</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.command_abc">cpl_cli.command_abc</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.command_handler_service">cpl_cli.command_handler_service</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.command_model">cpl_cli.command_model</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.error">cpl_cli.error</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.main">cpl_cli.main</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.startup">cpl_cli.startup</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli">Module contents</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<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="breadcrumbs navigation">
|
||||
|
||||
<ul class="wy-breadcrumbs">
|
||||
|
||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||
|
||||
<li><a href="cpl_cli.html">CPL_CLI</a> »</li>
|
||||
|
||||
<li>cpl_cli.command</li>
|
||||
|
||||
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
<a href="_sources/cpl_cli.command.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-cli-command">
|
||||
<h1>cpl_cli.command<a class="headerlink" href="#cpl-cli-command" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="section" id="module-cpl_cli.command.add_service">
|
||||
<span id="cpl-cli-command-add-service-module"></span><h2>cpl_cli.command.add_service module<a class="headerlink" href="#module-cpl_cli.command.add_service" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl_cli.command.add_service.AddService">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_cli.command.add_service.</span></code><code class="sig-name descname"><span class="pre">AddService</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.configuration.html#cpl.configuration.configuration_abc.ConfigurationABC" title="cpl.configuration.configuration_abc.ConfigurationABC"><span class="pre">cpl.configuration.configuration_abc.ConfigurationABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">workspace</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl_cli.configuration.html#cpl_cli.configuration.workspace_settings.WorkspaceSettings" title="cpl_cli.configuration.workspace_settings.WorkspaceSettings"><span class="pre">cpl_cli.configuration.workspace_settings.WorkspaceSettings</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_cli.command.add_service.AddService" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="cpl_cli.html#cpl_cli.command_abc.CommandABC" title="cpl_cli.command_abc.CommandABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_cli.command_abc.CommandABC</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.command.add_service.AddService.help_message">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">help_message</span></code><a class="headerlink" href="#cpl_cli.command.add_service.AddService.help_message" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.command.add_service.AddService.run">
|
||||
<code class="sig-name descname"><span class="pre">run</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">list</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_cli.command.add_service.AddService.run" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Entry point of command
|
||||
:param args:
|
||||
:return:</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-cpl_cli.command.build_service">
|
||||
<span id="cpl-cli-command-build-service-module"></span><h2>cpl_cli.command.build_service module<a class="headerlink" href="#module-cpl_cli.command.build_service" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl_cli.command.build_service.BuildService">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_cli.command.build_service.</span></code><code class="sig-name descname"><span class="pre">BuildService</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">publisher</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl_cli.publish.html#cpl_cli.publish.publisher_abc.PublisherABC" title="cpl_cli.publish.publisher_abc.PublisherABC"><span class="pre">cpl_cli.publish.publisher_abc.PublisherABC</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_cli.command.build_service.BuildService" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="cpl_cli.html#cpl_cli.command_abc.CommandABC" title="cpl_cli.command_abc.CommandABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_cli.command_abc.CommandABC</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.command.build_service.BuildService.help_message">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">help_message</span></code><a class="headerlink" href="#cpl_cli.command.build_service.BuildService.help_message" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.command.build_service.BuildService.run">
|
||||
<code class="sig-name descname"><span class="pre">run</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">list</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_cli.command.build_service.BuildService.run" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Entry point of command
|
||||
:param args:
|
||||
:return:</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-cpl_cli.command.generate_service">
|
||||
<span id="cpl-cli-command-generate-service-module"></span><h2>cpl_cli.command.generate_service module<a class="headerlink" href="#module-cpl_cli.command.generate_service" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl_cli.command.generate_service.GenerateService">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_cli.command.generate_service.</span></code><code class="sig-name descname"><span class="pre">GenerateService</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">configuration</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl.configuration.html#cpl.configuration.configuration_abc.ConfigurationABC" title="cpl.configuration.configuration_abc.ConfigurationABC"><span class="pre">cpl.configuration.configuration_abc.ConfigurationABC</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_cli.command.generate_service.GenerateService" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="cpl_cli.html#cpl_cli.command_abc.CommandABC" title="cpl_cli.command_abc.CommandABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_cli.command_abc.CommandABC</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.command.generate_service.GenerateService.help_message">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">help_message</span></code><a class="headerlink" href="#cpl_cli.command.generate_service.GenerateService.help_message" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.command.generate_service.GenerateService.run">
|
||||
<code class="sig-name descname"><span class="pre">run</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">list</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_cli.command.generate_service.GenerateService.run" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Entry point of command
|
||||
:param args:
|
||||
:return:</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-cpl_cli.command.help_service">
|
||||
<span id="cpl-cli-command-help-service-module"></span><h2>cpl_cli.command.help_service module<a class="headerlink" href="#module-cpl_cli.command.help_service" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl_cli.command.help_service.HelpService">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_cli.command.help_service.</span></code><code class="sig-name descname"><span class="pre">HelpService</span></code><span class="sig-paren">(</span><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.dependency_injection.html#cpl.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl.dependency_injection.service_provider_abc.ServiceProviderABC"><span class="pre">cpl.dependency_injection.service_provider_abc.ServiceProviderABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">cmd_handler</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl_cli.html#cpl_cli.command_handler_service.CommandHandler" title="cpl_cli.command_handler_service.CommandHandler"><span class="pre">cpl_cli.command_handler_service.CommandHandler</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_cli.command.help_service.HelpService" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="cpl_cli.html#cpl_cli.command_abc.CommandABC" title="cpl_cli.command_abc.CommandABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_cli.command_abc.CommandABC</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.command.help_service.HelpService.help_message">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">help_message</span></code><a class="headerlink" href="#cpl_cli.command.help_service.HelpService.help_message" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.command.help_service.HelpService.run">
|
||||
<code class="sig-name descname"><span class="pre">run</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">list</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_cli.command.help_service.HelpService.run" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Entry point of command
|
||||
:param args:
|
||||
:return:</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-cpl_cli.command.install_service">
|
||||
<span id="cpl-cli-command-install-service-module"></span><h2>cpl_cli.command.install_service module<a class="headerlink" href="#module-cpl_cli.command.install_service" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl_cli.command.install_service.InstallService">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_cli.command.install_service.</span></code><code class="sig-name descname"><span class="pre">InstallService</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.configuration.html#cpl.configuration.configuration_abc.ConfigurationABC" title="cpl.configuration.configuration_abc.ConfigurationABC"><span class="pre">cpl.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.environment.html#cpl.environment.application_environment_abc.ApplicationEnvironmentABC" title="cpl.environment.application_environment_abc.ApplicationEnvironmentABC"><span class="pre">cpl.environment.application_environment_abc.ApplicationEnvironmentABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">build_settings</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl_cli.configuration.html#cpl_cli.configuration.build_settings.BuildSettings" title="cpl_cli.configuration.build_settings.BuildSettings"><span class="pre">cpl_cli.configuration.build_settings.BuildSettings</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">project_settings</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl_cli.configuration.html#cpl_cli.configuration.project_settings.ProjectSettings" title="cpl_cli.configuration.project_settings.ProjectSettings"><span class="pre">cpl_cli.configuration.project_settings.ProjectSettings</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">cli_settings</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl_cli.html#cpl_cli.cli_settings.CLISettings" title="cpl_cli.cli_settings.CLISettings"><span class="pre">cpl_cli.cli_settings.CLISettings</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_cli.command.install_service.InstallService" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="cpl_cli.html#cpl_cli.command_abc.CommandABC" title="cpl_cli.command_abc.CommandABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_cli.command_abc.CommandABC</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.command.install_service.InstallService.help_message">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">help_message</span></code><a class="headerlink" href="#cpl_cli.command.install_service.InstallService.help_message" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.command.install_service.InstallService.run">
|
||||
<code class="sig-name descname"><span class="pre">run</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">list</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_cli.command.install_service.InstallService.run" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Entry point of command
|
||||
:param args:
|
||||
:return:</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-cpl_cli.command.new_service">
|
||||
<span id="cpl-cli-command-new-service-module"></span><h2>cpl_cli.command.new_service module<a class="headerlink" href="#module-cpl_cli.command.new_service" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl_cli.command.new_service.NewService">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_cli.command.new_service.</span></code><code class="sig-name descname"><span class="pre">NewService</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">configuration</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl.configuration.html#cpl.configuration.configuration_abc.ConfigurationABC" title="cpl.configuration.configuration_abc.ConfigurationABC"><span class="pre">cpl.configuration.configuration_abc.ConfigurationABC</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_cli.command.new_service.NewService" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="cpl_cli.html#cpl_cli.command_abc.CommandABC" title="cpl_cli.command_abc.CommandABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_cli.command_abc.CommandABC</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.command.new_service.NewService.help_message">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">help_message</span></code><a class="headerlink" href="#cpl_cli.command.new_service.NewService.help_message" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.command.new_service.NewService.run">
|
||||
<code class="sig-name descname"><span class="pre">run</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">list</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_cli.command.new_service.NewService.run" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Entry point of command
|
||||
:param args:
|
||||
:return:</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-cpl_cli.command.publish_service">
|
||||
<span id="cpl-cli-command-publish-service-module"></span><h2>cpl_cli.command.publish_service module<a class="headerlink" href="#module-cpl_cli.command.publish_service" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl_cli.command.publish_service.PublishService">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_cli.command.publish_service.</span></code><code class="sig-name descname"><span class="pre">PublishService</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">publisher</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl_cli.publish.html#cpl_cli.publish.publisher_abc.PublisherABC" title="cpl_cli.publish.publisher_abc.PublisherABC"><span class="pre">cpl_cli.publish.publisher_abc.PublisherABC</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_cli.command.publish_service.PublishService" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="cpl_cli.html#cpl_cli.command_abc.CommandABC" title="cpl_cli.command_abc.CommandABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_cli.command_abc.CommandABC</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.command.publish_service.PublishService.help_message">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">help_message</span></code><a class="headerlink" href="#cpl_cli.command.publish_service.PublishService.help_message" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.command.publish_service.PublishService.run">
|
||||
<code class="sig-name descname"><span class="pre">run</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">list</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_cli.command.publish_service.PublishService.run" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Entry point of command
|
||||
:param args:
|
||||
:return:</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-cpl_cli.command.remove_service">
|
||||
<span id="cpl-cli-command-remove-service-module"></span><h2>cpl_cli.command.remove_service module<a class="headerlink" href="#module-cpl_cli.command.remove_service" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl_cli.command.remove_service.RemoveService">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_cli.command.remove_service.</span></code><code class="sig-name descname"><span class="pre">RemoveService</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.configuration.html#cpl.configuration.configuration_abc.ConfigurationABC" title="cpl.configuration.configuration_abc.ConfigurationABC"><span class="pre">cpl.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.environment.html#cpl.environment.application_environment_abc.ApplicationEnvironmentABC" title="cpl.environment.application_environment_abc.ApplicationEnvironmentABC"><span class="pre">cpl.environment.application_environment_abc.ApplicationEnvironmentABC</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_cli.command.remove_service.RemoveService" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="cpl_cli.html#cpl_cli.command_abc.CommandABC" title="cpl_cli.command_abc.CommandABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_cli.command_abc.CommandABC</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.command.remove_service.RemoveService.help_message">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">help_message</span></code><a class="headerlink" href="#cpl_cli.command.remove_service.RemoveService.help_message" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.command.remove_service.RemoveService.run">
|
||||
<code class="sig-name descname"><span class="pre">run</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">list</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_cli.command.remove_service.RemoveService.run" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Entry point of command
|
||||
:param args:
|
||||
:return:</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-cpl_cli.command.start_service">
|
||||
<span id="cpl-cli-command-start-service-module"></span><h2>cpl_cli.command.start_service module<a class="headerlink" href="#module-cpl_cli.command.start_service" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl_cli.command.start_service.StartService">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_cli.command.start_service.</span></code><code class="sig-name descname"><span class="pre">StartService</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">live_server</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl_cli.live_server.html#cpl_cli.live_server.live_server_service.LiveServerService" title="cpl_cli.live_server.live_server_service.LiveServerService"><span class="pre">cpl_cli.live_server.live_server_service.LiveServerService</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_cli.command.start_service.StartService" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="cpl_cli.html#cpl_cli.command_abc.CommandABC" title="cpl_cli.command_abc.CommandABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_cli.command_abc.CommandABC</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.command.start_service.StartService.help_message">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">help_message</span></code><a class="headerlink" href="#cpl_cli.command.start_service.StartService.help_message" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.command.start_service.StartService.run">
|
||||
<code class="sig-name descname"><span class="pre">run</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">list</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_cli.command.start_service.StartService.run" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Entry point of command
|
||||
:param args:
|
||||
:return:</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-cpl_cli.command.uninstall_service">
|
||||
<span id="cpl-cli-command-uninstall-service-module"></span><h2>cpl_cli.command.uninstall_service module<a class="headerlink" href="#module-cpl_cli.command.uninstall_service" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl_cli.command.uninstall_service.UninstallService">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_cli.command.uninstall_service.</span></code><code class="sig-name descname"><span class="pre">UninstallService</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.configuration.html#cpl.configuration.configuration_abc.ConfigurationABC" title="cpl.configuration.configuration_abc.ConfigurationABC"><span class="pre">cpl.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.environment.html#cpl.environment.application_environment_abc.ApplicationEnvironmentABC" title="cpl.environment.application_environment_abc.ApplicationEnvironmentABC"><span class="pre">cpl.environment.application_environment_abc.ApplicationEnvironmentABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">build_settings</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl_cli.configuration.html#cpl_cli.configuration.build_settings.BuildSettings" title="cpl_cli.configuration.build_settings.BuildSettings"><span class="pre">cpl_cli.configuration.build_settings.BuildSettings</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">project_settings</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl_cli.configuration.html#cpl_cli.configuration.project_settings.ProjectSettings" title="cpl_cli.configuration.project_settings.ProjectSettings"><span class="pre">cpl_cli.configuration.project_settings.ProjectSettings</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_cli.command.uninstall_service.UninstallService" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="cpl_cli.html#cpl_cli.command_abc.CommandABC" title="cpl_cli.command_abc.CommandABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_cli.command_abc.CommandABC</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.command.uninstall_service.UninstallService.help_message">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">help_message</span></code><a class="headerlink" href="#cpl_cli.command.uninstall_service.UninstallService.help_message" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.command.uninstall_service.UninstallService.run">
|
||||
<code class="sig-name descname"><span class="pre">run</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">list</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_cli.command.uninstall_service.UninstallService.run" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Entry point of command
|
||||
:param args:
|
||||
:return:</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-cpl_cli.command.update_service">
|
||||
<span id="cpl-cli-command-update-service-module"></span><h2>cpl_cli.command.update_service module<a class="headerlink" href="#module-cpl_cli.command.update_service" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl_cli.command.update_service.UpdateService">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_cli.command.update_service.</span></code><code class="sig-name descname"><span class="pre">UpdateService</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.configuration.html#cpl.configuration.configuration_abc.ConfigurationABC" title="cpl.configuration.configuration_abc.ConfigurationABC"><span class="pre">cpl.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.environment.html#cpl.environment.application_environment_abc.ApplicationEnvironmentABC" title="cpl.environment.application_environment_abc.ApplicationEnvironmentABC"><span class="pre">cpl.environment.application_environment_abc.ApplicationEnvironmentABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">build_settings</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl_cli.configuration.html#cpl_cli.configuration.build_settings.BuildSettings" title="cpl_cli.configuration.build_settings.BuildSettings"><span class="pre">cpl_cli.configuration.build_settings.BuildSettings</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">project_settings</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl_cli.configuration.html#cpl_cli.configuration.project_settings.ProjectSettings" title="cpl_cli.configuration.project_settings.ProjectSettings"><span class="pre">cpl_cli.configuration.project_settings.ProjectSettings</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">cli_settings</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl_cli.html#cpl_cli.cli_settings.CLISettings" title="cpl_cli.cli_settings.CLISettings"><span class="pre">cpl_cli.cli_settings.CLISettings</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_cli.command.update_service.UpdateService" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="cpl_cli.html#cpl_cli.command_abc.CommandABC" title="cpl_cli.command_abc.CommandABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_cli.command_abc.CommandABC</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.command.update_service.UpdateService.help_message">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">help_message</span></code><a class="headerlink" href="#cpl_cli.command.update_service.UpdateService.help_message" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.command.update_service.UpdateService.run">
|
||||
<code class="sig-name descname"><span class="pre">run</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">list</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_cli.command.update_service.UpdateService.run" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Entry point of command
|
||||
:param args:
|
||||
:return:</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-cpl_cli.command.version_service">
|
||||
<span id="cpl-cli-command-version-service-module"></span><h2>cpl_cli.command.version_service module<a class="headerlink" href="#module-cpl_cli.command.version_service" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl_cli.command.version_service.VersionService">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_cli.command.version_service.</span></code><code class="sig-name descname"><span class="pre">VersionService</span></code><a class="headerlink" href="#cpl_cli.command.version_service.VersionService" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="cpl_cli.html#cpl_cli.command_abc.CommandABC" title="cpl_cli.command_abc.CommandABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_cli.command_abc.CommandABC</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.command.version_service.VersionService.help_message">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">help_message</span></code><a class="headerlink" href="#cpl_cli.command.version_service.VersionService.help_message" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.command.version_service.VersionService.run">
|
||||
<code class="sig-name descname"><span class="pre">run</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">list</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_cli.command.version_service.VersionService.run" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Entry point of command
|
||||
:param args:
|
||||
:return:</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<footer>
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||
<a href="cpl_cli.configuration.html" class="btn btn-neutral float-right" title="cpl_cli.configuration" 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="CPL_CLI" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
</div>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2021, Sven Heidemann.
|
||||
|
||||
</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</section>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
702
docs/build/html/cpl_cli.configuration.html
vendored
702
docs/build/html/cpl_cli.configuration.html
vendored
@ -1,702 +0,0 @@
|
||||
|
||||
|
||||
<!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_cli.configuration — Common Python Library documentation</title>
|
||||
|
||||
|
||||
|
||||
<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 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 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_cli.live_server" href="cpl_cli.live_server.html" />
|
||||
<link rel="prev" title="cpl_cli.command" href="cpl_cli.command.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
|
||||
|
||||
<div class="wy-grid-for-nav">
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="index.html" class="icon icon-home"> Common Python Library
|
||||
|
||||
|
||||
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.html">CPL</a></li>
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CPL_CLI</a><ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.command.html">cpl_cli.command</a></li>
|
||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl_cli.configuration</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_cli.configuration.build_settings">cpl_cli.configuration.build_settings module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_cli.configuration.build_settings_name_enum">cpl_cli.configuration.build_settings_name_enum module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_cli.configuration.project_settings">cpl_cli.configuration.project_settings module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_cli.configuration.project_settings_name_enum">cpl_cli.configuration.project_settings_name_enum module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_cli.configuration.project_type_enum">cpl_cli.configuration.project_type_enum module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_cli.configuration.settings_helper">cpl_cli.configuration.settings_helper module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_cli.configuration.version_settings">cpl_cli.configuration.version_settings module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_cli.configuration.version_settings_name_enum">cpl_cli.configuration.version_settings_name_enum module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_cli.configuration.workspace_settings">cpl_cli.configuration.workspace_settings module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_cli.configuration.workspace_settings_name_enum">cpl_cli.configuration.workspace_settings_name_enum module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.live_server.html">cpl_cli.live_server</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.publish.html">cpl_cli.publish</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.source_creator.html">cpl_cli.source_creator</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.cli">cpl_cli.cli</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.cli_settings">cpl_cli.cli_settings</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.cli_settings_name_enum">cpl_cli.cli_settings_name_enum</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.command_abc">cpl_cli.command_abc</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.command_handler_service">cpl_cli.command_handler_service</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.command_model">cpl_cli.command_model</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.error">cpl_cli.error</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.main">cpl_cli.main</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.startup">cpl_cli.startup</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli">Module contents</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<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="breadcrumbs navigation">
|
||||
|
||||
<ul class="wy-breadcrumbs">
|
||||
|
||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||
|
||||
<li><a href="cpl_cli.html">CPL_CLI</a> »</li>
|
||||
|
||||
<li>cpl_cli.configuration</li>
|
||||
|
||||
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
<a href="_sources/cpl_cli.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-cli-configuration">
|
||||
<h1>cpl_cli.configuration<a class="headerlink" href="#cpl-cli-configuration" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="section" id="module-cpl_cli.configuration.build_settings">
|
||||
<span id="cpl-cli-configuration-build-settings-module"></span><h2>cpl_cli.configuration.build_settings module<a class="headerlink" href="#module-cpl_cli.configuration.build_settings" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl_cli.configuration.build_settings.BuildSettings">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_cli.configuration.build_settings.</span></code><code class="sig-name descname"><span class="pre">BuildSettings</span></code><a class="headerlink" href="#cpl_cli.configuration.build_settings.BuildSettings" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="cpl.configuration.html#cpl.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl.configuration.configuration_model_abc.ConfigurationModelABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.configuration.configuration_model_abc.ConfigurationModelABC</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.configuration.build_settings.BuildSettings.entry_point">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">entry_point</span></code><a class="headerlink" href="#cpl_cli.configuration.build_settings.BuildSettings.entry_point" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.configuration.build_settings.BuildSettings.excluded">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">excluded</span></code><a class="headerlink" href="#cpl_cli.configuration.build_settings.BuildSettings.excluded" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.configuration.build_settings.BuildSettings.from_dict">
|
||||
<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_cli.configuration.build_settings.BuildSettings.from_dict" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Converts attributes to dict
|
||||
:param settings:
|
||||
:return:</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.configuration.build_settings.BuildSettings.include_package_data">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">include_package_data</span></code><a class="headerlink" href="#cpl_cli.configuration.build_settings.BuildSettings.include_package_data" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.configuration.build_settings.BuildSettings.included">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">included</span></code><a class="headerlink" href="#cpl_cli.configuration.build_settings.BuildSettings.included" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.configuration.build_settings.BuildSettings.main">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">main</span></code><a class="headerlink" href="#cpl_cli.configuration.build_settings.BuildSettings.main" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.configuration.build_settings.BuildSettings.output_path">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">output_path</span></code><a class="headerlink" href="#cpl_cli.configuration.build_settings.BuildSettings.output_path" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.configuration.build_settings.BuildSettings.package_data">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">package_data</span></code><a class="headerlink" href="#cpl_cli.configuration.build_settings.BuildSettings.package_data" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.configuration.build_settings.BuildSettings.project_references">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">project_references</span></code><a class="headerlink" href="#cpl_cli.configuration.build_settings.BuildSettings.project_references" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.configuration.build_settings.BuildSettings.project_type">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">project_type</span></code><a class="headerlink" href="#cpl_cli.configuration.build_settings.BuildSettings.project_type" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.configuration.build_settings.BuildSettings.source_path">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">source_path</span></code><a class="headerlink" href="#cpl_cli.configuration.build_settings.BuildSettings.source_path" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-cpl_cli.configuration.build_settings_name_enum">
|
||||
<span id="cpl-cli-configuration-build-settings-name-enum-module"></span><h2>cpl_cli.configuration.build_settings_name_enum module<a class="headerlink" href="#module-cpl_cli.configuration.build_settings_name_enum" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl_cli.configuration.build_settings_name_enum.BuildSettingsNameEnum">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_cli.configuration.build_settings_name_enum.</span></code><code class="sig-name descname"><span class="pre">BuildSettingsNameEnum</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_cli.configuration.build_settings_name_enum.BuildSettingsNameEnum" 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 id="cpl_cli.configuration.build_settings_name_enum.BuildSettingsNameEnum.entry_point">
|
||||
<code class="sig-name descname"><span class="pre">entry_point</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'EntryPoint'</span></em><a class="headerlink" href="#cpl_cli.configuration.build_settings_name_enum.BuildSettingsNameEnum.entry_point" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="cpl_cli.configuration.build_settings_name_enum.BuildSettingsNameEnum.excluded">
|
||||
<code class="sig-name descname"><span class="pre">excluded</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'Excluded'</span></em><a class="headerlink" href="#cpl_cli.configuration.build_settings_name_enum.BuildSettingsNameEnum.excluded" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="cpl_cli.configuration.build_settings_name_enum.BuildSettingsNameEnum.include_package_data">
|
||||
<code class="sig-name descname"><span class="pre">include_package_data</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'IncludePackageData'</span></em><a class="headerlink" href="#cpl_cli.configuration.build_settings_name_enum.BuildSettingsNameEnum.include_package_data" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="cpl_cli.configuration.build_settings_name_enum.BuildSettingsNameEnum.included">
|
||||
<code class="sig-name descname"><span class="pre">included</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'Included'</span></em><a class="headerlink" href="#cpl_cli.configuration.build_settings_name_enum.BuildSettingsNameEnum.included" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="cpl_cli.configuration.build_settings_name_enum.BuildSettingsNameEnum.main">
|
||||
<code class="sig-name descname"><span class="pre">main</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'Main'</span></em><a class="headerlink" href="#cpl_cli.configuration.build_settings_name_enum.BuildSettingsNameEnum.main" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="cpl_cli.configuration.build_settings_name_enum.BuildSettingsNameEnum.output_path">
|
||||
<code class="sig-name descname"><span class="pre">output_path</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'OutputPath'</span></em><a class="headerlink" href="#cpl_cli.configuration.build_settings_name_enum.BuildSettingsNameEnum.output_path" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="cpl_cli.configuration.build_settings_name_enum.BuildSettingsNameEnum.package_data">
|
||||
<code class="sig-name descname"><span class="pre">package_data</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'PackageData'</span></em><a class="headerlink" href="#cpl_cli.configuration.build_settings_name_enum.BuildSettingsNameEnum.package_data" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="cpl_cli.configuration.build_settings_name_enum.BuildSettingsNameEnum.project_references">
|
||||
<code class="sig-name descname"><span class="pre">project_references</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'ProjectReferences'</span></em><a class="headerlink" href="#cpl_cli.configuration.build_settings_name_enum.BuildSettingsNameEnum.project_references" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="cpl_cli.configuration.build_settings_name_enum.BuildSettingsNameEnum.project_type">
|
||||
<code class="sig-name descname"><span class="pre">project_type</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'ProjectType'</span></em><a class="headerlink" href="#cpl_cli.configuration.build_settings_name_enum.BuildSettingsNameEnum.project_type" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="cpl_cli.configuration.build_settings_name_enum.BuildSettingsNameEnum.source_path">
|
||||
<code class="sig-name descname"><span class="pre">source_path</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'SourcePath'</span></em><a class="headerlink" href="#cpl_cli.configuration.build_settings_name_enum.BuildSettingsNameEnum.source_path" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-cpl_cli.configuration.project_settings">
|
||||
<span id="cpl-cli-configuration-project-settings-module"></span><h2>cpl_cli.configuration.project_settings module<a class="headerlink" href="#module-cpl_cli.configuration.project_settings" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl_cli.configuration.project_settings.ProjectSettings">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_cli.configuration.project_settings.</span></code><code class="sig-name descname"><span class="pre">ProjectSettings</span></code><a class="headerlink" href="#cpl_cli.configuration.project_settings.ProjectSettings" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="cpl.configuration.html#cpl.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl.configuration.configuration_model_abc.ConfigurationModelABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.configuration.configuration_model_abc.ConfigurationModelABC</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.configuration.project_settings.ProjectSettings.author">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">author</span></code><a class="headerlink" href="#cpl_cli.configuration.project_settings.ProjectSettings.author" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.configuration.project_settings.ProjectSettings.author_email">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">author_email</span></code><a class="headerlink" href="#cpl_cli.configuration.project_settings.ProjectSettings.author_email" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.configuration.project_settings.ProjectSettings.classifiers">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">classifiers</span></code><a class="headerlink" href="#cpl_cli.configuration.project_settings.ProjectSettings.classifiers" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.configuration.project_settings.ProjectSettings.copyright_date">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">copyright_date</span></code><a class="headerlink" href="#cpl_cli.configuration.project_settings.ProjectSettings.copyright_date" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.configuration.project_settings.ProjectSettings.copyright_name">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">copyright_name</span></code><a class="headerlink" href="#cpl_cli.configuration.project_settings.ProjectSettings.copyright_name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.configuration.project_settings.ProjectSettings.dependencies">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">dependencies</span></code><a class="headerlink" href="#cpl_cli.configuration.project_settings.ProjectSettings.dependencies" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.configuration.project_settings.ProjectSettings.description">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">description</span></code><a class="headerlink" href="#cpl_cli.configuration.project_settings.ProjectSettings.description" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.configuration.project_settings.ProjectSettings.from_dict">
|
||||
<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_cli.configuration.project_settings.ProjectSettings.from_dict" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Converts attributes to dict
|
||||
:param settings:
|
||||
:return:</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.configuration.project_settings.ProjectSettings.license_description">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">license_description</span></code><a class="headerlink" href="#cpl_cli.configuration.project_settings.ProjectSettings.license_description" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.configuration.project_settings.ProjectSettings.license_name">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">license_name</span></code><a class="headerlink" href="#cpl_cli.configuration.project_settings.ProjectSettings.license_name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.configuration.project_settings.ProjectSettings.long_description">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">long_description</span></code><a class="headerlink" href="#cpl_cli.configuration.project_settings.ProjectSettings.long_description" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.configuration.project_settings.ProjectSettings.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_cli.configuration.project_settings.ProjectSettings.name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.configuration.project_settings.ProjectSettings.python_executable">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">python_executable</span></code><a class="headerlink" href="#cpl_cli.configuration.project_settings.ProjectSettings.python_executable" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.configuration.project_settings.ProjectSettings.python_path">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">python_path</span></code><a class="headerlink" href="#cpl_cli.configuration.project_settings.ProjectSettings.python_path" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.configuration.project_settings.ProjectSettings.python_version">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">python_version</span></code><a class="headerlink" href="#cpl_cli.configuration.project_settings.ProjectSettings.python_version" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.configuration.project_settings.ProjectSettings.url">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">url</span></code><a class="headerlink" href="#cpl_cli.configuration.project_settings.ProjectSettings.url" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.configuration.project_settings.ProjectSettings.version">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">version</span></code><a class="headerlink" href="#cpl_cli.configuration.project_settings.ProjectSettings.version" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-cpl_cli.configuration.project_settings_name_enum">
|
||||
<span id="cpl-cli-configuration-project-settings-name-enum-module"></span><h2>cpl_cli.configuration.project_settings_name_enum module<a class="headerlink" href="#module-cpl_cli.configuration.project_settings_name_enum" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl_cli.configuration.project_settings_name_enum.ProjectSettingsNameEnum">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_cli.configuration.project_settings_name_enum.</span></code><code class="sig-name descname"><span class="pre">ProjectSettingsNameEnum</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_cli.configuration.project_settings_name_enum.ProjectSettingsNameEnum" 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 id="cpl_cli.configuration.project_settings_name_enum.ProjectSettingsNameEnum.author">
|
||||
<code class="sig-name descname"><span class="pre">author</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'Author'</span></em><a class="headerlink" href="#cpl_cli.configuration.project_settings_name_enum.ProjectSettingsNameEnum.author" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="cpl_cli.configuration.project_settings_name_enum.ProjectSettingsNameEnum.author_email">
|
||||
<code class="sig-name descname"><span class="pre">author_email</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'AuthorEmail'</span></em><a class="headerlink" href="#cpl_cli.configuration.project_settings_name_enum.ProjectSettingsNameEnum.author_email" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="cpl_cli.configuration.project_settings_name_enum.ProjectSettingsNameEnum.classifiers">
|
||||
<code class="sig-name descname"><span class="pre">classifiers</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'Classifiers'</span></em><a class="headerlink" href="#cpl_cli.configuration.project_settings_name_enum.ProjectSettingsNameEnum.classifiers" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="cpl_cli.configuration.project_settings_name_enum.ProjectSettingsNameEnum.copyright_date">
|
||||
<code class="sig-name descname"><span class="pre">copyright_date</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'CopyrightDate'</span></em><a class="headerlink" href="#cpl_cli.configuration.project_settings_name_enum.ProjectSettingsNameEnum.copyright_date" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="cpl_cli.configuration.project_settings_name_enum.ProjectSettingsNameEnum.copyright_name">
|
||||
<code class="sig-name descname"><span class="pre">copyright_name</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'CopyrightName'</span></em><a class="headerlink" href="#cpl_cli.configuration.project_settings_name_enum.ProjectSettingsNameEnum.copyright_name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="cpl_cli.configuration.project_settings_name_enum.ProjectSettingsNameEnum.dependencies">
|
||||
<code class="sig-name descname"><span class="pre">dependencies</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'Dependencies'</span></em><a class="headerlink" href="#cpl_cli.configuration.project_settings_name_enum.ProjectSettingsNameEnum.dependencies" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="cpl_cli.configuration.project_settings_name_enum.ProjectSettingsNameEnum.description">
|
||||
<code class="sig-name descname"><span class="pre">description</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'Description'</span></em><a class="headerlink" href="#cpl_cli.configuration.project_settings_name_enum.ProjectSettingsNameEnum.description" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="cpl_cli.configuration.project_settings_name_enum.ProjectSettingsNameEnum.license_description">
|
||||
<code class="sig-name descname"><span class="pre">license_description</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'LicenseDescription'</span></em><a class="headerlink" href="#cpl_cli.configuration.project_settings_name_enum.ProjectSettingsNameEnum.license_description" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="cpl_cli.configuration.project_settings_name_enum.ProjectSettingsNameEnum.license_name">
|
||||
<code class="sig-name descname"><span class="pre">license_name</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'LicenseName'</span></em><a class="headerlink" href="#cpl_cli.configuration.project_settings_name_enum.ProjectSettingsNameEnum.license_name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="cpl_cli.configuration.project_settings_name_enum.ProjectSettingsNameEnum.long_description">
|
||||
<code class="sig-name descname"><span class="pre">long_description</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'LongDescription'</span></em><a class="headerlink" href="#cpl_cli.configuration.project_settings_name_enum.ProjectSettingsNameEnum.long_description" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="cpl_cli.configuration.project_settings_name_enum.ProjectSettingsNameEnum.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_cli.configuration.project_settings_name_enum.ProjectSettingsNameEnum.name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="cpl_cli.configuration.project_settings_name_enum.ProjectSettingsNameEnum.python_path">
|
||||
<code class="sig-name descname"><span class="pre">python_path</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'PythonPath'</span></em><a class="headerlink" href="#cpl_cli.configuration.project_settings_name_enum.ProjectSettingsNameEnum.python_path" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="cpl_cli.configuration.project_settings_name_enum.ProjectSettingsNameEnum.python_version">
|
||||
<code class="sig-name descname"><span class="pre">python_version</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'PythonVersion'</span></em><a class="headerlink" href="#cpl_cli.configuration.project_settings_name_enum.ProjectSettingsNameEnum.python_version" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="cpl_cli.configuration.project_settings_name_enum.ProjectSettingsNameEnum.url">
|
||||
<code class="sig-name descname"><span class="pre">url</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'URL'</span></em><a class="headerlink" href="#cpl_cli.configuration.project_settings_name_enum.ProjectSettingsNameEnum.url" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="cpl_cli.configuration.project_settings_name_enum.ProjectSettingsNameEnum.version">
|
||||
<code class="sig-name descname"><span class="pre">version</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'Version'</span></em><a class="headerlink" href="#cpl_cli.configuration.project_settings_name_enum.ProjectSettingsNameEnum.version" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-cpl_cli.configuration.project_type_enum">
|
||||
<span id="cpl-cli-configuration-project-type-enum-module"></span><h2>cpl_cli.configuration.project_type_enum module<a class="headerlink" href="#module-cpl_cli.configuration.project_type_enum" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl_cli.configuration.project_type_enum.ProjectTypeEnum">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_cli.configuration.project_type_enum.</span></code><code class="sig-name descname"><span class="pre">ProjectTypeEnum</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_cli.configuration.project_type_enum.ProjectTypeEnum" 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 id="cpl_cli.configuration.project_type_enum.ProjectTypeEnum.console">
|
||||
<code class="sig-name descname"><span class="pre">console</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'console'</span></em><a class="headerlink" href="#cpl_cli.configuration.project_type_enum.ProjectTypeEnum.console" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="cpl_cli.configuration.project_type_enum.ProjectTypeEnum.library">
|
||||
<code class="sig-name descname"><span class="pre">library</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'library'</span></em><a class="headerlink" href="#cpl_cli.configuration.project_type_enum.ProjectTypeEnum.library" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-cpl_cli.configuration.settings_helper">
|
||||
<span id="cpl-cli-configuration-settings-helper-module"></span><h2>cpl_cli.configuration.settings_helper module<a class="headerlink" href="#module-cpl_cli.configuration.settings_helper" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl_cli.configuration.settings_helper.SettingsHelper">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_cli.configuration.settings_helper.</span></code><code class="sig-name descname"><span class="pre">SettingsHelper</span></code><a class="headerlink" href="#cpl_cli.configuration.settings_helper.SettingsHelper" 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 method">
|
||||
<dt id="cpl_cli.configuration.settings_helper.SettingsHelper.get_build_settings_dict">
|
||||
<em class="property"><span class="pre">static</span> </em><code class="sig-name descname"><span class="pre">get_build_settings_dict</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">build</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="#cpl_cli.configuration.build_settings.BuildSettings" title="cpl_cli.configuration.build_settings.BuildSettings"><span class="pre">cpl_cli.configuration.build_settings.BuildSettings</span></a></span></em><span class="sig-paren">)</span> → <span class="pre">dict</span><a class="headerlink" href="#cpl_cli.configuration.settings_helper.SettingsHelper.get_build_settings_dict" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.configuration.settings_helper.SettingsHelper.get_project_settings_dict">
|
||||
<em class="property"><span class="pre">static</span> </em><code class="sig-name descname"><span class="pre">get_project_settings_dict</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">project</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="#cpl_cli.configuration.project_settings.ProjectSettings" title="cpl_cli.configuration.project_settings.ProjectSettings"><span class="pre">cpl_cli.configuration.project_settings.ProjectSettings</span></a></span></em><span class="sig-paren">)</span> → <span class="pre">dict</span><a class="headerlink" href="#cpl_cli.configuration.settings_helper.SettingsHelper.get_project_settings_dict" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-cpl_cli.configuration.version_settings">
|
||||
<span id="cpl-cli-configuration-version-settings-module"></span><h2>cpl_cli.configuration.version_settings module<a class="headerlink" href="#module-cpl_cli.configuration.version_settings" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl_cli.configuration.version_settings.VersionSettings">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_cli.configuration.version_settings.</span></code><code class="sig-name descname"><span class="pre">VersionSettings</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">major</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>, <em class="sig-param"><span class="n"><span class="pre">minor</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>, <em class="sig-param"><span class="n"><span class="pre">micro</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_cli.configuration.version_settings.VersionSettings" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="cpl.configuration.html#cpl.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl.configuration.configuration_model_abc.ConfigurationModelABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.configuration.configuration_model_abc.ConfigurationModelABC</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.configuration.version_settings.VersionSettings.from_dict">
|
||||
<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_cli.configuration.version_settings.VersionSettings.from_dict" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Converts attributes to dict
|
||||
:param settings:
|
||||
:return:</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.configuration.version_settings.VersionSettings.major">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">major</span></code><a class="headerlink" href="#cpl_cli.configuration.version_settings.VersionSettings.major" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.configuration.version_settings.VersionSettings.micro">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">micro</span></code><a class="headerlink" href="#cpl_cli.configuration.version_settings.VersionSettings.micro" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.configuration.version_settings.VersionSettings.minor">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">minor</span></code><a class="headerlink" href="#cpl_cli.configuration.version_settings.VersionSettings.minor" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.configuration.version_settings.VersionSettings.to_dict">
|
||||
<code class="sig-name descname"><span class="pre">to_dict</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span> → <span class="pre">dict</span><a class="headerlink" href="#cpl_cli.configuration.version_settings.VersionSettings.to_dict" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.configuration.version_settings.VersionSettings.to_str">
|
||||
<code class="sig-name descname"><span class="pre">to_str</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span> → <span class="pre">str</span><a class="headerlink" href="#cpl_cli.configuration.version_settings.VersionSettings.to_str" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-cpl_cli.configuration.version_settings_name_enum">
|
||||
<span id="cpl-cli-configuration-version-settings-name-enum-module"></span><h2>cpl_cli.configuration.version_settings_name_enum module<a class="headerlink" href="#module-cpl_cli.configuration.version_settings_name_enum" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl_cli.configuration.version_settings_name_enum.VersionSettingsNameEnum">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_cli.configuration.version_settings_name_enum.</span></code><code class="sig-name descname"><span class="pre">VersionSettingsNameEnum</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_cli.configuration.version_settings_name_enum.VersionSettingsNameEnum" 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 id="cpl_cli.configuration.version_settings_name_enum.VersionSettingsNameEnum.major">
|
||||
<code class="sig-name descname"><span class="pre">major</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'Major'</span></em><a class="headerlink" href="#cpl_cli.configuration.version_settings_name_enum.VersionSettingsNameEnum.major" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="cpl_cli.configuration.version_settings_name_enum.VersionSettingsNameEnum.micro">
|
||||
<code class="sig-name descname"><span class="pre">micro</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'Micro'</span></em><a class="headerlink" href="#cpl_cli.configuration.version_settings_name_enum.VersionSettingsNameEnum.micro" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="cpl_cli.configuration.version_settings_name_enum.VersionSettingsNameEnum.minor">
|
||||
<code class="sig-name descname"><span class="pre">minor</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'Minor'</span></em><a class="headerlink" href="#cpl_cli.configuration.version_settings_name_enum.VersionSettingsNameEnum.minor" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-cpl_cli.configuration.workspace_settings">
|
||||
<span id="cpl-cli-configuration-workspace-settings-module"></span><h2>cpl_cli.configuration.workspace_settings module<a class="headerlink" href="#module-cpl_cli.configuration.workspace_settings" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl_cli.configuration.workspace_settings.WorkspaceSettings">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_cli.configuration.workspace_settings.</span></code><code class="sig-name descname"><span class="pre">WorkspaceSettings</span></code><a class="headerlink" href="#cpl_cli.configuration.workspace_settings.WorkspaceSettings" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="cpl.configuration.html#cpl.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl.configuration.configuration_model_abc.ConfigurationModelABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.configuration.configuration_model_abc.ConfigurationModelABC</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.configuration.workspace_settings.WorkspaceSettings.default_project">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">default_project</span></code><a class="headerlink" href="#cpl_cli.configuration.workspace_settings.WorkspaceSettings.default_project" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.configuration.workspace_settings.WorkspaceSettings.from_dict">
|
||||
<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_cli.configuration.workspace_settings.WorkspaceSettings.from_dict" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Converts attributes to dict
|
||||
:param settings:
|
||||
:return:</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.configuration.workspace_settings.WorkspaceSettings.projects">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">projects</span></code><a class="headerlink" href="#cpl_cli.configuration.workspace_settings.WorkspaceSettings.projects" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-cpl_cli.configuration.workspace_settings_name_enum">
|
||||
<span id="cpl-cli-configuration-workspace-settings-name-enum-module"></span><h2>cpl_cli.configuration.workspace_settings_name_enum module<a class="headerlink" href="#module-cpl_cli.configuration.workspace_settings_name_enum" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl_cli.configuration.workspace_settings_name_enum.WorkspaceSettingsNameEnum">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_cli.configuration.workspace_settings_name_enum.</span></code><code class="sig-name descname"><span class="pre">WorkspaceSettingsNameEnum</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_cli.configuration.workspace_settings_name_enum.WorkspaceSettingsNameEnum" 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 id="cpl_cli.configuration.workspace_settings_name_enum.WorkspaceSettingsNameEnum.default_project">
|
||||
<code class="sig-name descname"><span class="pre">default_project</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'DefaultProject'</span></em><a class="headerlink" href="#cpl_cli.configuration.workspace_settings_name_enum.WorkspaceSettingsNameEnum.default_project" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="cpl_cli.configuration.workspace_settings_name_enum.WorkspaceSettingsNameEnum.projects">
|
||||
<code class="sig-name descname"><span class="pre">projects</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'Projects'</span></em><a class="headerlink" href="#cpl_cli.configuration.workspace_settings_name_enum.WorkspaceSettingsNameEnum.projects" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<footer>
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||
<a href="cpl_cli.live_server.html" class="btn btn-neutral float-right" title="cpl_cli.live_server" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
<a href="cpl_cli.command.html" class="btn btn-neutral float-left" title="cpl_cli.command" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
</div>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2021, Sven Heidemann.
|
||||
|
||||
</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</section>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
519
docs/build/html/cpl_cli.html
vendored
519
docs/build/html/cpl_cli.html
vendored
@ -1,519 +0,0 @@
|
||||
|
||||
|
||||
<!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_CLI — Common Python Library documentation</title>
|
||||
|
||||
|
||||
|
||||
<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 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 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_cli.command" href="cpl_cli.command.html" />
|
||||
<link rel="prev" title="cpl.utils" href="cpl.utils.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
|
||||
|
||||
<div class="wy-grid-for-nav">
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="index.html" class="icon icon-home"> Common Python Library
|
||||
|
||||
|
||||
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.html">CPL</a></li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">CPL_CLI</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.command.html">cpl_cli.command</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.configuration.html">cpl_cli.configuration</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.live_server.html">cpl_cli.live_server</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.publish.html">cpl_cli.publish</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.source_creator.html">cpl_cli.source_creator</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#module-cpl_cli.cli">cpl_cli.cli</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#module-cpl_cli.cli_settings">cpl_cli.cli_settings</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#module-cpl_cli.cli_settings_name_enum">cpl_cli.cli_settings_name_enum</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#module-cpl_cli.command_abc">cpl_cli.command_abc</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#module-cpl_cli.command_handler_service">cpl_cli.command_handler_service</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#module-cpl_cli.command_model">cpl_cli.command_model</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#module-cpl_cli.error">cpl_cli.error</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#module-cpl_cli.main">cpl_cli.main</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#module-cpl_cli.startup">cpl_cli.startup</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#module-cpl_cli">Module contents</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#sh-cpl-cli-sh-edraft-common-python-library-cli">sh_cpl-cli sh-edraft Common Python library CLI</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<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="breadcrumbs navigation">
|
||||
|
||||
<ul class="wy-breadcrumbs">
|
||||
|
||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||
|
||||
<li>CPL_CLI</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="cpl-cli">
|
||||
<h1>CPL_CLI<a class="headerlink" href="#cpl-cli" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="toctree-wrapper compound">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.command.html">cpl_cli.command</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.command.html#module-cpl_cli.command.add_service">cpl_cli.command.add_service module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.command.html#module-cpl_cli.command.build_service">cpl_cli.command.build_service module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.command.html#module-cpl_cli.command.generate_service">cpl_cli.command.generate_service module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.command.html#module-cpl_cli.command.help_service">cpl_cli.command.help_service module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.command.html#module-cpl_cli.command.install_service">cpl_cli.command.install_service module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.command.html#module-cpl_cli.command.new_service">cpl_cli.command.new_service module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.command.html#module-cpl_cli.command.publish_service">cpl_cli.command.publish_service module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.command.html#module-cpl_cli.command.remove_service">cpl_cli.command.remove_service module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.command.html#module-cpl_cli.command.start_service">cpl_cli.command.start_service module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.command.html#module-cpl_cli.command.uninstall_service">cpl_cli.command.uninstall_service module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.command.html#module-cpl_cli.command.update_service">cpl_cli.command.update_service module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.command.html#module-cpl_cli.command.version_service">cpl_cli.command.version_service module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.configuration.html">cpl_cli.configuration</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.configuration.html#module-cpl_cli.configuration.build_settings">cpl_cli.configuration.build_settings module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.configuration.html#module-cpl_cli.configuration.build_settings_name_enum">cpl_cli.configuration.build_settings_name_enum module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.configuration.html#module-cpl_cli.configuration.project_settings">cpl_cli.configuration.project_settings module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.configuration.html#module-cpl_cli.configuration.project_settings_name_enum">cpl_cli.configuration.project_settings_name_enum module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.configuration.html#module-cpl_cli.configuration.project_type_enum">cpl_cli.configuration.project_type_enum module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.configuration.html#module-cpl_cli.configuration.settings_helper">cpl_cli.configuration.settings_helper module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.configuration.html#module-cpl_cli.configuration.version_settings">cpl_cli.configuration.version_settings module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.configuration.html#module-cpl_cli.configuration.version_settings_name_enum">cpl_cli.configuration.version_settings_name_enum module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.configuration.html#module-cpl_cli.configuration.workspace_settings">cpl_cli.configuration.workspace_settings module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.configuration.html#module-cpl_cli.configuration.workspace_settings_name_enum">cpl_cli.configuration.workspace_settings_name_enum module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.live_server.html">cpl_cli.live_server</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.live_server.html#module-cpl_cli.live_server.live_server_service">cpl_cli.live_server.live_server_service module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.live_server.html#module-cpl_cli.live_server.live_server_thread">cpl_cli.live_server.live_server_thread module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.publish.html">cpl_cli.publish</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.publish.html#module-cpl_cli.publish.publisher_abc">cpl_cli.publish.publisher_abc module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.publish.html#module-cpl_cli.publish.publisher_service">cpl_cli.publish.publisher_service module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.source_creator.html">cpl_cli.source_creator</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.source_creator.html#module-cpl_cli.source_creator.console_builder">cpl_cli.source_creator.console_builder module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.source_creator.html#module-cpl_cli.source_creator.library_builder">cpl_cli.source_creator.library_builder module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.source_creator.html#module-cpl_cli.source_creator.template_builder">cpl_cli.source_creator.template_builder module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="module-cpl_cli.cli">
|
||||
<span id="cpl-cli-cli"></span><h2>cpl_cli.cli<a class="headerlink" href="#module-cpl_cli.cli" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl_cli.cli.CLI">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_cli.cli.</span></code><code class="sig-name descname"><span class="pre">CLI</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.configuration.html#cpl.configuration.configuration_abc.ConfigurationABC" title="cpl.configuration.configuration_abc.ConfigurationABC"><span class="pre">cpl.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.dependency_injection.html#cpl.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl.dependency_injection.service_provider_abc.ServiceProviderABC"><span class="pre">cpl.dependency_injection.service_provider_abc.ServiceProviderABC</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_cli.cli.CLI" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="cpl.application.html#cpl.application.application_abc.ApplicationABC" title="cpl.application.application_abc.ApplicationABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.application.application_abc.ApplicationABC</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.cli.CLI.configure">
|
||||
<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_cli.cli.CLI.configure" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Prepare the application
|
||||
:return:</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.cli.CLI.main">
|
||||
<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_cli.cli.CLI.main" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Entry point of the CPL CLI
|
||||
:return:</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-cpl_cli.cli_settings">
|
||||
<span id="cpl-cli-cli-settings"></span><h2>cpl_cli.cli_settings<a class="headerlink" href="#module-cpl_cli.cli_settings" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl_cli.cli_settings.CLISettings">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_cli.cli_settings.</span></code><code class="sig-name descname"><span class="pre">CLISettings</span></code><a class="headerlink" href="#cpl_cli.cli_settings.CLISettings" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="cpl.configuration.html#cpl.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl.configuration.configuration_model_abc.ConfigurationModelABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.configuration.configuration_model_abc.ConfigurationModelABC</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.cli_settings.CLISettings.from_dict">
|
||||
<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_cli.cli_settings.CLISettings.from_dict" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Converts attributes to dict
|
||||
:param settings:
|
||||
:return:</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.cli_settings.CLISettings.pip_path">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">pip_path</span></code><a class="headerlink" href="#cpl_cli.cli_settings.CLISettings.pip_path" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-cpl_cli.cli_settings_name_enum">
|
||||
<span id="cpl-cli-cli-settings-name-enum"></span><h2>cpl_cli.cli_settings_name_enum<a class="headerlink" href="#module-cpl_cli.cli_settings_name_enum" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl_cli.cli_settings_name_enum.CLISettingsNameEnum">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_cli.cli_settings_name_enum.</span></code><code class="sig-name descname"><span class="pre">CLISettingsNameEnum</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_cli.cli_settings_name_enum.CLISettingsNameEnum" 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 id="cpl_cli.cli_settings_name_enum.CLISettingsNameEnum.pip_path">
|
||||
<code class="sig-name descname"><span class="pre">pip_path</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'PipPath'</span></em><a class="headerlink" href="#cpl_cli.cli_settings_name_enum.CLISettingsNameEnum.pip_path" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-cpl_cli.command_abc">
|
||||
<span id="cpl-cli-command-abc"></span><h2>cpl_cli.command_abc<a class="headerlink" href="#module-cpl_cli.command_abc" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl_cli.command_abc.CommandABC">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_cli.command_abc.</span></code><code class="sig-name descname"><span class="pre">CommandABC</span></code><a class="headerlink" href="#cpl_cli.command_abc.CommandABC" 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 id="cpl_cli.command_abc.CommandABC.help_message">
|
||||
<em class="property"><span class="pre">abstract</span> <span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">help_message</span></code><a class="headerlink" href="#cpl_cli.command_abc.CommandABC.help_message" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.command_abc.CommandABC.run">
|
||||
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">run</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">list</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_cli.command_abc.CommandABC.run" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-cpl_cli.command_handler_service">
|
||||
<span id="cpl-cli-command-handler-service"></span><h2>cpl_cli.command_handler_service<a class="headerlink" href="#module-cpl_cli.command_handler_service" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl_cli.command_handler_service.CommandHandler">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_cli.command_handler_service.</span></code><code class="sig-name descname"><span class="pre">CommandHandler</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.configuration.html#cpl.configuration.configuration_abc.ConfigurationABC" title="cpl.configuration.configuration_abc.ConfigurationABC"><span class="pre">cpl.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.dependency_injection.html#cpl.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl.dependency_injection.service_provider_abc.ServiceProviderABC"><span class="pre">cpl.dependency_injection.service_provider_abc.ServiceProviderABC</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_cli.command_handler_service.CommandHandler" 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 id="cpl_cli.command_handler_service.CommandHandler.add_command">
|
||||
<code class="sig-name descname"><span class="pre">add_command</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cmd</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="#cpl_cli.command_model.CommandModel" title="cpl_cli.command_model.CommandModel"><span class="pre">cpl_cli.command_model.CommandModel</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_cli.command_handler_service.CommandHandler.add_command" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.command_handler_service.CommandHandler.commands">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">commands</span></code><a class="headerlink" href="#cpl_cli.command_handler_service.CommandHandler.commands" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.command_handler_service.CommandHandler.handle">
|
||||
<code class="sig-name descname"><span class="pre">handle</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cmd</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">args</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">list</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_cli.command_handler_service.CommandHandler.handle" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Handles incoming commands and args
|
||||
:param cmd:
|
||||
:param args:
|
||||
:return:</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.command_handler_service.CommandHandler.remove_command">
|
||||
<code class="sig-name descname"><span class="pre">remove_command</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cmd</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="#cpl_cli.command_model.CommandModel" title="cpl_cli.command_model.CommandModel"><span class="pre">cpl_cli.command_model.CommandModel</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_cli.command_handler_service.CommandHandler.remove_command" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-cpl_cli.command_model">
|
||||
<span id="cpl-cli-command-model"></span><h2>cpl_cli.command_model<a class="headerlink" href="#module-cpl_cli.command_model" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl_cli.command_model.CommandModel">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_cli.command_model.</span></code><code class="sig-name descname"><span class="pre">CommandModel</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">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">command</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">collections.abc.Callable</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cpl_cli.command_abc.CommandABC" title="cpl_cli.command_abc.CommandABC"><span class="pre">cpl_cli.command_abc.CommandABC</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">is_workspace_needed</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">bool</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">is_project_needed</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">bool</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">change_cwd</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">bool</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_cli.command_model.CommandModel" 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 method">
|
||||
<dt id="cpl_cli.command_model.CommandModel.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_cli.command_model.CommandModel.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.command_model.CommandModel.change_cwd">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">change_cwd</span></code><a class="headerlink" href="#cpl_cli.command_model.CommandModel.change_cwd" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.command_model.CommandModel.command">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">command</span></code><a class="headerlink" href="#cpl_cli.command_model.CommandModel.command" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.command_model.CommandModel.is_project_needed">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">is_project_needed</span></code><a class="headerlink" href="#cpl_cli.command_model.CommandModel.is_project_needed" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.command_model.CommandModel.is_workspace_needed">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">is_workspace_needed</span></code><a class="headerlink" href="#cpl_cli.command_model.CommandModel.is_workspace_needed" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.command_model.CommandModel.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_cli.command_model.CommandModel.name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-cpl_cli.error">
|
||||
<span id="cpl-cli-error"></span><h2>cpl_cli.error<a class="headerlink" href="#module-cpl_cli.error" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl_cli.error.Error">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_cli.error.</span></code><code class="sig-name descname"><span class="pre">Error</span></code><a class="headerlink" href="#cpl_cli.error.Error" 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 method">
|
||||
<dt id="cpl_cli.error.Error.error">
|
||||
<em class="property"><span class="pre">static</span> </em><code class="sig-name descname"><span class="pre">error</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">message</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_cli.error.Error.error" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.error.Error.warn">
|
||||
<em class="property"><span class="pre">static</span> </em><code class="sig-name descname"><span class="pre">warn</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">message</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_cli.error.Error.warn" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-cpl_cli.main">
|
||||
<span id="cpl-cli-main"></span><h2>cpl_cli.main<a class="headerlink" href="#module-cpl_cli.main" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="py function">
|
||||
<dt id="cpl_cli.main.main">
|
||||
<code class="sig-prename descclassname"><span class="pre">cpl_cli.main.</span></code><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_cli.main.main" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-cpl_cli.startup">
|
||||
<span id="cpl-cli-startup"></span><h2>cpl_cli.startup<a class="headerlink" href="#module-cpl_cli.startup" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl_cli.startup.Startup">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_cli.startup.</span></code><code class="sig-name descname"><span class="pre">Startup</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.configuration.html#cpl.configuration.configuration_abc.ConfigurationABC" title="cpl.configuration.configuration_abc.ConfigurationABC"><span class="pre">cpl.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.dependency_injection.html#cpl.dependency_injection.service_collection_abc.ServiceCollectionABC" title="cpl.dependency_injection.service_collection_abc.ServiceCollectionABC"><span class="pre">cpl.dependency_injection.service_collection_abc.ServiceCollectionABC</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_cli.startup.Startup" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="cpl.application.html#cpl.application.startup_abc.StartupABC" title="cpl.application.startup_abc.StartupABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.application.startup_abc.StartupABC</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.startup.Startup.configure_configuration">
|
||||
<code class="sig-name descname"><span class="pre">configure_configuration</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span> → <a class="reference internal" href="cpl.configuration.html#cpl.configuration.configuration_abc.ConfigurationABC" title="cpl.configuration.configuration_abc.ConfigurationABC"><span class="pre">cpl.configuration.configuration_abc.ConfigurationABC</span></a><a class="headerlink" href="#cpl_cli.startup.Startup.configure_configuration" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Creates configuration of application
|
||||
:return: configuration</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.startup.Startup.configure_services">
|
||||
<code class="sig-name descname"><span class="pre">configure_services</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span> → <a class="reference internal" href="cpl.dependency_injection.html#cpl.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl.dependency_injection.service_provider_abc.ServiceProviderABC"><span class="pre">cpl.dependency_injection.service_provider_abc.ServiceProviderABC</span></a><a class="headerlink" href="#cpl_cli.startup.Startup.configure_services" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Creates service provider
|
||||
:return: service provider</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-cpl_cli">
|
||||
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-cpl_cli" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="sh-cpl-cli-sh-edraft-common-python-library-cli">
|
||||
<h3>sh_cpl-cli sh-edraft Common Python library CLI<a class="headerlink" href="#sh-cpl-cli-sh-edraft-common-python-library-cli" title="Permalink to this headline">¶</a></h3>
|
||||
<p>sh-edraft Common Python library Command Line Interface</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">copyright</dt>
|
||||
<dd class="field-odd"><ol class="loweralpha simple" start="3">
|
||||
<li><p>2020 - 2021 sh-edraft.de</p></li>
|
||||
</ol>
|
||||
</dd>
|
||||
<dt class="field-even">license</dt>
|
||||
<dd class="field-even"><p>MIT, see LICENSE for more details.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py class">
|
||||
<dt id="cpl_cli.VersionInfo">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_cli.</span></code><code class="sig-name descname"><span class="pre">VersionInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">major</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">minor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">micro</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_cli.VersionInfo" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code></p>
|
||||
<dl class="py attribute">
|
||||
<dt id="cpl_cli.VersionInfo.major">
|
||||
<code class="sig-name descname"><span class="pre">major</span></code><a class="headerlink" href="#cpl_cli.VersionInfo.major" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Alias for field number 0</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="cpl_cli.VersionInfo.micro">
|
||||
<code class="sig-name descname"><span class="pre">micro</span></code><a class="headerlink" href="#cpl_cli.VersionInfo.micro" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Alias for field number 2</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="cpl_cli.VersionInfo.minor">
|
||||
<code class="sig-name descname"><span class="pre">minor</span></code><a class="headerlink" href="#cpl_cli.VersionInfo.minor" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Alias for field number 1</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<footer>
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||
<a href="cpl_cli.command.html" class="btn btn-neutral float-right" title="cpl_cli.command" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
<a href="cpl.utils.html" class="btn btn-neutral float-left" title="cpl.utils" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
</div>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2021, Sven Heidemann.
|
||||
|
||||
</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</section>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
283
docs/build/html/cpl_cli.live_server.html
vendored
283
docs/build/html/cpl_cli.live_server.html
vendored
@ -1,283 +0,0 @@
|
||||
|
||||
|
||||
<!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_cli.live_server — Common Python Library documentation</title>
|
||||
|
||||
|
||||
|
||||
<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 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 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_cli.publish" href="cpl_cli.publish.html" />
|
||||
<link rel="prev" title="cpl_cli.configuration" href="cpl_cli.configuration.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
|
||||
|
||||
<div class="wy-grid-for-nav">
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="index.html" class="icon icon-home"> Common Python Library
|
||||
|
||||
|
||||
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.html">CPL</a></li>
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CPL_CLI</a><ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.command.html">cpl_cli.command</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.configuration.html">cpl_cli.configuration</a></li>
|
||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl_cli.live_server</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_cli.live_server.live_server_service">cpl_cli.live_server.live_server_service module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_cli.live_server.live_server_thread">cpl_cli.live_server.live_server_thread module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.publish.html">cpl_cli.publish</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.source_creator.html">cpl_cli.source_creator</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.cli">cpl_cli.cli</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.cli_settings">cpl_cli.cli_settings</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.cli_settings_name_enum">cpl_cli.cli_settings_name_enum</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.command_abc">cpl_cli.command_abc</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.command_handler_service">cpl_cli.command_handler_service</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.command_model">cpl_cli.command_model</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.error">cpl_cli.error</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.main">cpl_cli.main</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.startup">cpl_cli.startup</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli">Module contents</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<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="breadcrumbs navigation">
|
||||
|
||||
<ul class="wy-breadcrumbs">
|
||||
|
||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||
|
||||
<li><a href="cpl_cli.html">CPL_CLI</a> »</li>
|
||||
|
||||
<li>cpl_cli.live_server</li>
|
||||
|
||||
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
<a href="_sources/cpl_cli.live_server.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-cli-live-server">
|
||||
<h1>cpl_cli.live_server<a class="headerlink" href="#cpl-cli-live-server" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="section" id="module-cpl_cli.live_server.live_server_service">
|
||||
<span id="cpl-cli-live-server-live-server-service-module"></span><h2>cpl_cli.live_server.live_server_service module<a class="headerlink" href="#module-cpl_cli.live_server.live_server_service" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl_cli.live_server.live_server_service.LiveServerService">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_cli.live_server.live_server_service.</span></code><code class="sig-name descname"><span class="pre">LiveServerService</span></code><span class="sig-paren">(</span><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.environment.html#cpl.environment.application_environment_abc.ApplicationEnvironmentABC" title="cpl.environment.application_environment_abc.ApplicationEnvironmentABC"><span class="pre">cpl.environment.application_environment_abc.ApplicationEnvironmentABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">project_settings</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl_cli.configuration.html#cpl_cli.configuration.project_settings.ProjectSettings" title="cpl_cli.configuration.project_settings.ProjectSettings"><span class="pre">cpl_cli.configuration.project_settings.ProjectSettings</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">build_settings</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl_cli.configuration.html#cpl_cli.configuration.build_settings.BuildSettings" title="cpl_cli.configuration.build_settings.BuildSettings"><span class="pre">cpl_cli.configuration.build_settings.BuildSettings</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_cli.live_server.live_server_service.LiveServerService" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">watchdog.events.FileSystemEventHandler</span></code></p>
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.live_server.live_server_service.LiveServerService.on_modified">
|
||||
<code class="sig-name descname"><span class="pre">on_modified</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">event</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_cli.live_server.live_server_service.LiveServerService.on_modified" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Triggers when source file is modified
|
||||
:param event:
|
||||
:return:</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.live_server.live_server_service.LiveServerService.start">
|
||||
<code class="sig-name descname"><span class="pre">start</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">list</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_cli.live_server.live_server_service.LiveServerService.start" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Starts the CPL live development server
|
||||
:param args:
|
||||
:return:</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-cpl_cli.live_server.live_server_thread">
|
||||
<span id="cpl-cli-live-server-live-server-thread-module"></span><h2>cpl_cli.live_server.live_server_thread module<a class="headerlink" href="#module-cpl_cli.live_server.live_server_thread" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl_cli.live_server.live_server_thread.LiveServerThread">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_cli.live_server.live_server_thread.</span></code><code class="sig-name descname"><span class="pre">LiveServerThread</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">executable</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">path</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">args</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">env</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl.environment.html#cpl.environment.application_environment_abc.ApplicationEnvironmentABC" title="cpl.environment.application_environment_abc.ApplicationEnvironmentABC"><span class="pre">cpl.environment.application_environment_abc.ApplicationEnvironmentABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">build_settings</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl_cli.configuration.html#cpl_cli.configuration.build_settings.BuildSettings" title="cpl_cli.configuration.build_settings.BuildSettings"><span class="pre">cpl_cli.configuration.build_settings.BuildSettings</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_cli.live_server.live_server_thread.LiveServerThread" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">threading.Thread</span></code></p>
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.live_server.live_server_thread.LiveServerThread.command">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">command</span></code><a class="headerlink" href="#cpl_cli.live_server.live_server_thread.LiveServerThread.command" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.live_server.live_server_thread.LiveServerThread.main">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">main</span></code><a class="headerlink" href="#cpl_cli.live_server.live_server_thread.LiveServerThread.main" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.live_server.live_server_thread.LiveServerThread.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_cli.live_server.live_server_thread.LiveServerThread.run" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Starts the CPL project
|
||||
:return:</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<footer>
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||
<a href="cpl_cli.publish.html" class="btn btn-neutral float-right" title="cpl_cli.publish" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
<a href="cpl_cli.configuration.html" class="btn btn-neutral float-left" title="cpl_cli.configuration" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
</div>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2021, Sven Heidemann.
|
||||
|
||||
</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</section>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
331
docs/build/html/cpl_cli.publish.html
vendored
331
docs/build/html/cpl_cli.publish.html
vendored
@ -1,331 +0,0 @@
|
||||
|
||||
|
||||
<!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_cli.publish — Common Python Library documentation</title>
|
||||
|
||||
|
||||
|
||||
<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 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 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_cli.source_creator" href="cpl_cli.source_creator.html" />
|
||||
<link rel="prev" title="cpl_cli.live_server" href="cpl_cli.live_server.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
|
||||
|
||||
<div class="wy-grid-for-nav">
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="index.html" class="icon icon-home"> Common Python Library
|
||||
|
||||
|
||||
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.html">CPL</a></li>
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CPL_CLI</a><ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.command.html">cpl_cli.command</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.configuration.html">cpl_cli.configuration</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.live_server.html">cpl_cli.live_server</a></li>
|
||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl_cli.publish</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_cli.publish.publisher_abc">cpl_cli.publish.publisher_abc module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_cli.publish.publisher_service">cpl_cli.publish.publisher_service module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.source_creator.html">cpl_cli.source_creator</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.cli">cpl_cli.cli</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.cli_settings">cpl_cli.cli_settings</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.cli_settings_name_enum">cpl_cli.cli_settings_name_enum</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.command_abc">cpl_cli.command_abc</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.command_handler_service">cpl_cli.command_handler_service</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.command_model">cpl_cli.command_model</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.error">cpl_cli.error</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.main">cpl_cli.main</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.startup">cpl_cli.startup</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli">Module contents</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<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="breadcrumbs navigation">
|
||||
|
||||
<ul class="wy-breadcrumbs">
|
||||
|
||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||
|
||||
<li><a href="cpl_cli.html">CPL_CLI</a> »</li>
|
||||
|
||||
<li>cpl_cli.publish</li>
|
||||
|
||||
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
<a href="_sources/cpl_cli.publish.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-cli-publish">
|
||||
<h1>cpl_cli.publish<a class="headerlink" href="#cpl-cli-publish" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="section" id="module-cpl_cli.publish.publisher_abc">
|
||||
<span id="cpl-cli-publish-publisher-abc-module"></span><h2>cpl_cli.publish.publisher_abc module<a class="headerlink" href="#module-cpl_cli.publish.publisher_abc" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl_cli.publish.publisher_abc.PublisherABC">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_cli.publish.publisher_abc.</span></code><code class="sig-name descname"><span class="pre">PublisherABC</span></code><a class="headerlink" href="#cpl_cli.publish.publisher_abc.PublisherABC" 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 id="cpl_cli.publish.publisher_abc.PublisherABC.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><a class="headerlink" href="#cpl_cli.publish.publisher_abc.PublisherABC.build" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.publish.publisher_abc.PublisherABC.dist_path">
|
||||
<em class="property"><span class="pre">abstract</span> <span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">dist_path</span></code><a class="headerlink" href="#cpl_cli.publish.publisher_abc.PublisherABC.dist_path" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.publish.publisher_abc.PublisherABC.exclude">
|
||||
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">exclude</span></code><span class="sig-paren">(</span><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">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_cli.publish.publisher_abc.PublisherABC.exclude" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.publish.publisher_abc.PublisherABC.include">
|
||||
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">include</span></code><span class="sig-paren">(</span><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">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_cli.publish.publisher_abc.PublisherABC.include" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.publish.publisher_abc.PublisherABC.publish">
|
||||
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">publish</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_cli.publish.publisher_abc.PublisherABC.publish" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.publish.publisher_abc.PublisherABC.source_path">
|
||||
<em class="property"><span class="pre">abstract</span> <span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">source_path</span></code><a class="headerlink" href="#cpl_cli.publish.publisher_abc.PublisherABC.source_path" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-cpl_cli.publish.publisher_service">
|
||||
<span id="cpl-cli-publish-publisher-service-module"></span><h2>cpl_cli.publish.publisher_service module<a class="headerlink" href="#module-cpl_cli.publish.publisher_service" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl_cli.publish.publisher_service.PublisherService">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_cli.publish.publisher_service.</span></code><code class="sig-name descname"><span class="pre">PublisherService</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.configuration.html#cpl.configuration.configuration_abc.ConfigurationABC" title="cpl.configuration.configuration_abc.ConfigurationABC"><span class="pre">cpl.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.environment.html#cpl.environment.application_environment_abc.ApplicationEnvironmentABC" title="cpl.environment.application_environment_abc.ApplicationEnvironmentABC"><span class="pre">cpl.environment.application_environment_abc.ApplicationEnvironmentABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">project</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl_cli.configuration.html#cpl_cli.configuration.project_settings.ProjectSettings" title="cpl_cli.configuration.project_settings.ProjectSettings"><span class="pre">cpl_cli.configuration.project_settings.ProjectSettings</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">build</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl_cli.configuration.html#cpl_cli.configuration.build_settings.BuildSettings" title="cpl_cli.configuration.build_settings.BuildSettings"><span class="pre">cpl_cli.configuration.build_settings.BuildSettings</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_cli.publish.publisher_service.PublisherService" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#cpl_cli.publish.publisher_abc.PublisherABC" title="cpl_cli.publish.publisher_abc.PublisherABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_cli.publish.publisher_abc.PublisherABC</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.publish.publisher_service.PublisherService.build">
|
||||
<code class="sig-name descname"><span class="pre">build</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_cli.publish.publisher_service.PublisherService.build" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Build the CPL project to dist_path/build</p>
|
||||
<ol class="arabic simple">
|
||||
<li><p>Reads all included source files</p></li>
|
||||
<li><p>Writes informations from template to all included __init__.py</p></li>
|
||||
</ol>
|
||||
<p>3. Copies all included source files to dist_path/build
|
||||
:return:</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.publish.publisher_service.PublisherService.dist_path">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">dist_path</span></code><a class="headerlink" href="#cpl_cli.publish.publisher_service.PublisherService.dist_path" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.publish.publisher_service.PublisherService.exclude">
|
||||
<code class="sig-name descname"><span class="pre">exclude</span></code><span class="sig-paren">(</span><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">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_cli.publish.publisher_service.PublisherService.exclude" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Excludes given path from sources
|
||||
:param path:
|
||||
:return:</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.publish.publisher_service.PublisherService.include">
|
||||
<code class="sig-name descname"><span class="pre">include</span></code><span class="sig-paren">(</span><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">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_cli.publish.publisher_service.PublisherService.include" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Includes given path from sources
|
||||
:param path:
|
||||
:return:</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.publish.publisher_service.PublisherService.publish">
|
||||
<code class="sig-name descname"><span class="pre">publish</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_cli.publish.publisher_service.PublisherService.publish" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Publishes the CPL project to dist_path/publish</p>
|
||||
<ol class="arabic simple">
|
||||
<li><p>Builds the project</p></li>
|
||||
<li><p>Generates setup.py</p></li>
|
||||
<li><p>Start setup.py</p></li>
|
||||
</ol>
|
||||
<p>4. Remove all included source from dist_path/publish
|
||||
:return:</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_cli.publish.publisher_service.PublisherService.source_path">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">source_path</span></code><a class="headerlink" href="#cpl_cli.publish.publisher_service.PublisherService.source_path" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<footer>
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||
<a href="cpl_cli.source_creator.html" class="btn btn-neutral float-right" title="cpl_cli.source_creator" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
<a href="cpl_cli.live_server.html" class="btn btn-neutral float-left" title="cpl_cli.live_server" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
</div>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2021, Sven Heidemann.
|
||||
|
||||
</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</section>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
295
docs/build/html/cpl_cli.source_creator.html
vendored
295
docs/build/html/cpl_cli.source_creator.html
vendored
@ -1,295 +0,0 @@
|
||||
|
||||
|
||||
<!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_cli.source_creator — Common Python Library documentation</title>
|
||||
|
||||
|
||||
|
||||
<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 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 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="prev" title="cpl_cli.publish" href="cpl_cli.publish.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
|
||||
|
||||
<div class="wy-grid-for-nav">
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="index.html" class="icon icon-home"> Common Python Library
|
||||
|
||||
|
||||
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.html">CPL</a></li>
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CPL_CLI</a><ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.command.html">cpl_cli.command</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.configuration.html">cpl_cli.configuration</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.live_server.html">cpl_cli.live_server</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.publish.html">cpl_cli.publish</a></li>
|
||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl_cli.source_creator</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_cli.source_creator.console_builder">cpl_cli.source_creator.console_builder module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_cli.source_creator.library_builder">cpl_cli.source_creator.library_builder module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_cli.source_creator.template_builder">cpl_cli.source_creator.template_builder module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.cli">cpl_cli.cli</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.cli_settings">cpl_cli.cli_settings</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.cli_settings_name_enum">cpl_cli.cli_settings_name_enum</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.command_abc">cpl_cli.command_abc</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.command_handler_service">cpl_cli.command_handler_service</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.command_model">cpl_cli.command_model</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.error">cpl_cli.error</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.main">cpl_cli.main</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.startup">cpl_cli.startup</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli">Module contents</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<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="breadcrumbs navigation">
|
||||
|
||||
<ul class="wy-breadcrumbs">
|
||||
|
||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||
|
||||
<li><a href="cpl_cli.html">CPL_CLI</a> »</li>
|
||||
|
||||
<li>cpl_cli.source_creator</li>
|
||||
|
||||
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
<a href="_sources/cpl_cli.source_creator.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-cli-source-creator">
|
||||
<h1>cpl_cli.source_creator<a class="headerlink" href="#cpl-cli-source-creator" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="section" id="module-cpl_cli.source_creator.console_builder">
|
||||
<span id="cpl-cli-source-creator-console-builder-module"></span><h2>cpl_cli.source_creator.console_builder module<a class="headerlink" href="#module-cpl_cli.source_creator.console_builder" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl_cli.source_creator.console_builder.ConsoleBuilder">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_cli.source_creator.console_builder.</span></code><code class="sig-name descname"><span class="pre">ConsoleBuilder</span></code><a class="headerlink" href="#cpl_cli.source_creator.console_builder.ConsoleBuilder" 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 method">
|
||||
<dt id="cpl_cli.source_creator.console_builder.ConsoleBuilder.build">
|
||||
<em class="property"><span class="pre">classmethod</span> </em><code class="sig-name descname"><span class="pre">build</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">project_path</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">use_application_api</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">bool</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_startup</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">bool</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_service_providing</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">bool</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">project_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">project_settings</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">dict</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">workspace</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><a class="reference internal" href="cpl_cli.configuration.html#cpl_cli.configuration.workspace_settings.WorkspaceSettings" title="cpl_cli.configuration.workspace_settings.WorkspaceSettings"><span class="pre">cpl_cli.configuration.workspace_settings.WorkspaceSettings</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_cli.source_creator.console_builder.ConsoleBuilder.build" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Builds the console project files
|
||||
:param project_path:
|
||||
:param use_application_api:
|
||||
:param use_startup:
|
||||
:param use_service_providing:
|
||||
:param project_name:
|
||||
:param project_settings:
|
||||
:param workspace:
|
||||
:return:</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-cpl_cli.source_creator.library_builder">
|
||||
<span id="cpl-cli-source-creator-library-builder-module"></span><h2>cpl_cli.source_creator.library_builder module<a class="headerlink" href="#module-cpl_cli.source_creator.library_builder" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl_cli.source_creator.library_builder.LibraryBuilder">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_cli.source_creator.library_builder.</span></code><code class="sig-name descname"><span class="pre">LibraryBuilder</span></code><a class="headerlink" href="#cpl_cli.source_creator.library_builder.LibraryBuilder" 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 method">
|
||||
<dt id="cpl_cli.source_creator.library_builder.LibraryBuilder.build">
|
||||
<em class="property"><span class="pre">classmethod</span> </em><code class="sig-name descname"><span class="pre">build</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">project_path</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">use_application_api</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">bool</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_startup</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">bool</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_service_providing</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">bool</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">project_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">project_settings</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">dict</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">workspace</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><a class="reference internal" href="cpl_cli.configuration.html#cpl_cli.configuration.workspace_settings.WorkspaceSettings" title="cpl_cli.configuration.workspace_settings.WorkspaceSettings"><span class="pre">cpl_cli.configuration.workspace_settings.WorkspaceSettings</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_cli.source_creator.library_builder.LibraryBuilder.build" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Builds the library project files
|
||||
:param project_path:
|
||||
:param use_application_api:
|
||||
:param use_startup:
|
||||
:param use_service_providing:
|
||||
:param project_name:
|
||||
:param project_settings:
|
||||
:param workspace:
|
||||
:return:</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-cpl_cli.source_creator.template_builder">
|
||||
<span id="cpl-cli-source-creator-template-builder-module"></span><h2>cpl_cli.source_creator.template_builder module<a class="headerlink" href="#module-cpl_cli.source_creator.template_builder" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl_cli.source_creator.template_builder.TemplateBuilder">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_cli.source_creator.template_builder.</span></code><code class="sig-name descname"><span class="pre">TemplateBuilder</span></code><a class="headerlink" href="#cpl_cli.source_creator.template_builder.TemplateBuilder" 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 method">
|
||||
<dt id="cpl_cli.source_creator.template_builder.TemplateBuilder.build">
|
||||
<em class="property"><span class="pre">static</span> </em><code class="sig-name descname"><span class="pre">build</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">project_path</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">template</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">cpl_cli._templates.template_file_abc.TemplateFileABC</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_cli.source_creator.template_builder.TemplateBuilder.build" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Creates template
|
||||
:param project_path:
|
||||
:param template:
|
||||
:return:</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<footer>
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||
<a href="cpl_cli.publish.html" class="btn btn-neutral float-left" title="cpl_cli.publish" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
</div>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2021, Sven Heidemann.
|
||||
|
||||
</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</section>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
819
docs/build/html/genindex.html
vendored
819
docs/build/html/genindex.html
vendored
File diff suppressed because it is too large
Load Diff
2
docs/build/html/index.html
vendored
2
docs/build/html/index.html
vendored
@ -85,7 +85,6 @@
|
||||
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.html">CPL</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CPL_CLI</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
@ -163,7 +162,6 @@
|
||||
<div class="toctree-wrapper compound">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.html">CPL</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CPL_CLI</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
151
docs/build/html/modules.html
vendored
151
docs/build/html/modules.html
vendored
@ -84,7 +84,6 @@
|
||||
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.html">CPL</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CPL_CLI</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
@ -158,85 +157,85 @@
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.html">CPL</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.application.html">cpl.application</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.application.html#module-cpl.application.application_abc">cpl.application.application_abc module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.application.html#module-cpl.application.application_builder">cpl.application.application_builder module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.application.html#module-cpl.application.application_builder_abc">cpl.application.application_builder_abc module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.application.html#module-cpl.application.startup_abc">cpl.application.startup_abc module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.application.html#module-cpl.application.application_abc">cpl.application.application_abc</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.application.html#module-cpl.application.application_builder">cpl.application.application_builder</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.application.html#module-cpl.application.application_builder_abc">cpl.application.application_builder_abc</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.application.html#module-cpl.application.startup_abc">cpl.application.startup_abc</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.configuration.html">cpl.configuration</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.configuration.html#module-cpl.configuration.configuration">cpl.configuration.configuration module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.configuration.html#module-cpl.configuration.configuration_abc">cpl.configuration.configuration_abc module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.configuration.html#module-cpl.configuration.configuration_model_abc">cpl.configuration.configuration_model_abc module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.configuration.html#module-cpl.configuration.configuration_variable_name_enum">cpl.configuration.configuration_variable_name_enum module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.configuration.html#module-cpl.configuration.console_argument">cpl.configuration.console_argument module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.configuration.html#module-cpl.configuration.configuration">cpl.configuration.configuration</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.configuration.html#module-cpl.configuration.configuration_abc">cpl.configuration.configuration_abc</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.configuration.html#module-cpl.configuration.configuration_model_abc">cpl.configuration.configuration_model_abc</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.configuration.html#module-cpl.configuration.configuration_variable_name_enum">cpl.configuration.configuration_variable_name_enum</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.configuration.html#module-cpl.configuration.console_argument">cpl.configuration.console_argument</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.console.html">cpl.console</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.console.html#module-cpl.console.background_color_enum">cpl.console.background_color_enum module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.console.html#module-cpl.console.console">cpl.console.console module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.console.html#module-cpl.console.console_call">cpl.console.console_call module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.console.html#module-cpl.console.foreground_color_enum">cpl.console.foreground_color_enum module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.console.html#module-cpl.console.spinner_thread">cpl.console.spinner_thread module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.console.html#module-cpl.console.background_color_enum">cpl.console.background_color_enum</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.console.html#module-cpl.console.console">cpl.console.console</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.console.html#module-cpl.console.console_call">cpl.console.console_call</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.console.html#module-cpl.console.foreground_color_enum">cpl.console.foreground_color_enum</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.console.html#module-cpl.console.spinner_thread">cpl.console.spinner_thread</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.database.html">cpl.database</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.database.connection.html">cpl.database.connection</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.database.connection.html#module-cpl.database.connection.database_connection">cpl.database.connection.database_connection module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.database.connection.html#module-cpl.database.connection.database_connection_abc">cpl.database.connection.database_connection_abc module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.database.connection.html#module-cpl.database.connection.database_connection">cpl.database.connection.database_connection</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.database.connection.html#module-cpl.database.connection.database_connection_abc">cpl.database.connection.database_connection_abc</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.database.context.html">cpl.database.context</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.database.context.html#module-cpl.database.context.database_context">cpl.database.context.database_context module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.database.context.html#module-cpl.database.context.database_context_abc">cpl.database.context.database_context_abc module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.database.context.html#module-cpl.database.context.database_context">cpl.database.context.database_context</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.database.context.html#module-cpl.database.context.database_context_abc">cpl.database.context.database_context_abc</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.database.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.database.html#module-cpl.database.database_model">cpl.database.database_model module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.database.html#module-cpl.database.database_settings">cpl.database.database_settings module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.database.html#module-cpl.database.database_settings_name_enum">cpl.database.database_settings_name_enum module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.database.html#module-cpl.database.database_model">cpl.database.database_model</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.database.html#module-cpl.database.database_settings">cpl.database.database_settings</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.database.html#module-cpl.database.database_settings_name_enum">cpl.database.database_settings_name_enum</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.dependency_injection.html">cpl.dependency_injection</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.dependency_injection.html#module-cpl.dependency_injection.service_collection">cpl.dependency_injection.service_collection module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.dependency_injection.html#module-cpl.dependency_injection.service_collection_abc">cpl.dependency_injection.service_collection_abc module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.dependency_injection.html#module-cpl.dependency_injection.service_descriptor">cpl.dependency_injection.service_descriptor module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.dependency_injection.html#module-cpl.dependency_injection.service_lifetime_enum">cpl.dependency_injection.service_lifetime_enum module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.dependency_injection.html#module-cpl.dependency_injection.service_provider">cpl.dependency_injection.service_provider module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.dependency_injection.html#module-cpl.dependency_injection.service_provider_abc">cpl.dependency_injection.service_provider_abc module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.dependency_injection.html#module-cpl.dependency_injection.service_collection">cpl.dependency_injection.service_collection</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.dependency_injection.html#module-cpl.dependency_injection.service_collection_abc">cpl.dependency_injection.service_collection_abc</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.dependency_injection.html#module-cpl.dependency_injection.service_descriptor">cpl.dependency_injection.service_descriptor</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.dependency_injection.html#module-cpl.dependency_injection.service_lifetime_enum">cpl.dependency_injection.service_lifetime_enum</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.dependency_injection.html#module-cpl.dependency_injection.service_provider">cpl.dependency_injection.service_provider</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.dependency_injection.html#module-cpl.dependency_injection.service_provider_abc">cpl.dependency_injection.service_provider_abc</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.environment.html">cpl.environment</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.environment.html#module-cpl.environment.application_environment">cpl.environment.application_environment module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.environment.html#module-cpl.environment.application_environment_abc">cpl.environment.application_environment_abc module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.environment.html#module-cpl.environment.environment_name_enum">cpl.environment.environment_name_enum module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.environment.html#module-cpl.environment.application_environment">cpl.environment.application_environment</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.environment.html#module-cpl.environment.application_environment_abc">cpl.environment.application_environment_abc</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.environment.html#module-cpl.environment.environment_name_enum">cpl.environment.environment_name_enum</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.logging.html">cpl.logging</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.logging.html#module-cpl.logging.logger_abc">cpl.logging.logger_abc module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.logging.html#module-cpl.logging.logger_service">cpl.logging.logger_service module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.logging.html#module-cpl.logging.logging_level_enum">cpl.logging.logging_level_enum module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.logging.html#module-cpl.logging.logging_settings">cpl.logging.logging_settings module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.logging.html#module-cpl.logging.logging_settings_name_enum">cpl.logging.logging_settings_name_enum module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.logging.html#module-cpl.logging.logger_abc">cpl.logging.logger_abc</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.logging.html#module-cpl.logging.logger_service">cpl.logging.logger_service</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.logging.html#module-cpl.logging.logging_level_enum">cpl.logging.logging_level_enum</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.logging.html#module-cpl.logging.logging_settings">cpl.logging.logging_settings</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.logging.html#module-cpl.logging.logging_settings_name_enum">cpl.logging.logging_settings_name_enum</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.mailing.html">cpl.mailing</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.mailing.html#module-cpl.mailing.email">cpl.mailing.email module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.mailing.html#module-cpl.mailing.email_client_abc">cpl.mailing.email_client_abc module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.mailing.html#module-cpl.mailing.email_client_service">cpl.mailing.email_client_service module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.mailing.html#module-cpl.mailing.email_client_settings">cpl.mailing.email_client_settings module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.mailing.html#module-cpl.mailing.email_client_settings_name_enum">cpl.mailing.email_client_settings_name_enum module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.mailing.html#module-cpl.mailing.email">cpl.mailing.email</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.mailing.html#module-cpl.mailing.email_client_abc">cpl.mailing.email_client_abc</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.mailing.html#module-cpl.mailing.email_client_service">cpl.mailing.email_client_service</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.mailing.html#module-cpl.mailing.email_client_settings">cpl.mailing.email_client_settings</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.mailing.html#module-cpl.mailing.email_client_settings_name_enum">cpl.mailing.email_client_settings_name_enum</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.time.html">cpl.time</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.time.html#module-cpl.time.time_format_settings">cpl.time.time_format_settings module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.time.html#module-cpl.time.time_format_settings_names_enum">cpl.time.time_format_settings_names_enum module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.time.html#module-cpl.time.time_format_settings">cpl.time.time_format_settings</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.time.html#module-cpl.time.time_format_settings_names_enum">cpl.time.time_format_settings_names_enum</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.utils.html">cpl.utils</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.utils.html#module-cpl.utils.credential_manager">cpl.utils.credential_manager module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.utils.html#module-cpl.utils.pip">cpl.utils.pip module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.utils.html#module-cpl.utils.string">cpl.utils.string module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.utils.html#module-cpl.utils.credential_manager">cpl.utils.credential_manager</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.utils.html#module-cpl.utils.pip">cpl.utils.pip</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.utils.html#module-cpl.utils.string">cpl.utils.string</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.html#module-cpl">Module contents</a><ul>
|
||||
@ -245,66 +244,6 @@
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CPL_CLI</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.command.html">cpl_cli.command</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_cli.command.html#module-cpl_cli.command.add_service">cpl_cli.command.add_service module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_cli.command.html#module-cpl_cli.command.build_service">cpl_cli.command.build_service module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_cli.command.html#module-cpl_cli.command.generate_service">cpl_cli.command.generate_service module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_cli.command.html#module-cpl_cli.command.help_service">cpl_cli.command.help_service module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_cli.command.html#module-cpl_cli.command.install_service">cpl_cli.command.install_service module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_cli.command.html#module-cpl_cli.command.new_service">cpl_cli.command.new_service module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_cli.command.html#module-cpl_cli.command.publish_service">cpl_cli.command.publish_service module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_cli.command.html#module-cpl_cli.command.remove_service">cpl_cli.command.remove_service module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_cli.command.html#module-cpl_cli.command.start_service">cpl_cli.command.start_service module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_cli.command.html#module-cpl_cli.command.uninstall_service">cpl_cli.command.uninstall_service module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_cli.command.html#module-cpl_cli.command.update_service">cpl_cli.command.update_service module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_cli.command.html#module-cpl_cli.command.version_service">cpl_cli.command.version_service module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.configuration.html">cpl_cli.configuration</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_cli.configuration.html#module-cpl_cli.configuration.build_settings">cpl_cli.configuration.build_settings module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_cli.configuration.html#module-cpl_cli.configuration.build_settings_name_enum">cpl_cli.configuration.build_settings_name_enum module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_cli.configuration.html#module-cpl_cli.configuration.project_settings">cpl_cli.configuration.project_settings module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_cli.configuration.html#module-cpl_cli.configuration.project_settings_name_enum">cpl_cli.configuration.project_settings_name_enum module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_cli.configuration.html#module-cpl_cli.configuration.project_type_enum">cpl_cli.configuration.project_type_enum module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_cli.configuration.html#module-cpl_cli.configuration.settings_helper">cpl_cli.configuration.settings_helper module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_cli.configuration.html#module-cpl_cli.configuration.version_settings">cpl_cli.configuration.version_settings module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_cli.configuration.html#module-cpl_cli.configuration.version_settings_name_enum">cpl_cli.configuration.version_settings_name_enum module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_cli.configuration.html#module-cpl_cli.configuration.workspace_settings">cpl_cli.configuration.workspace_settings module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_cli.configuration.html#module-cpl_cli.configuration.workspace_settings_name_enum">cpl_cli.configuration.workspace_settings_name_enum module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.live_server.html">cpl_cli.live_server</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_cli.live_server.html#module-cpl_cli.live_server.live_server_service">cpl_cli.live_server.live_server_service module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_cli.live_server.html#module-cpl_cli.live_server.live_server_thread">cpl_cli.live_server.live_server_thread module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.publish.html">cpl_cli.publish</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_cli.publish.html#module-cpl_cli.publish.publisher_abc">cpl_cli.publish.publisher_abc module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_cli.publish.html#module-cpl_cli.publish.publisher_service">cpl_cli.publish.publisher_service module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.source_creator.html">cpl_cli.source_creator</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_cli.source_creator.html#module-cpl_cli.source_creator.console_builder">cpl_cli.source_creator.console_builder module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_cli.source_creator.html#module-cpl_cli.source_creator.library_builder">cpl_cli.source_creator.library_builder module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_cli.source_creator.html#module-cpl_cli.source_creator.template_builder">cpl_cli.source_creator.template_builder module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.cli">cpl_cli.cli</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.cli_settings">cpl_cli.cli_settings</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.cli_settings_name_enum">cpl_cli.cli_settings_name_enum</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.command_abc">cpl_cli.command_abc</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.command_handler_service">cpl_cli.command_handler_service</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.command_model">cpl_cli.command_model</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.error">cpl_cli.error</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.main">cpl_cli.main</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.startup">cpl_cli.startup</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli">Module contents</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_cli.html#sh-cpl-cli-sh-edraft-common-python-library-cli">sh_cpl-cli sh-edraft Common Python library CLI</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
BIN
docs/build/html/objects.inv
vendored
BIN
docs/build/html/objects.inv
vendored
Binary file not shown.
208
docs/build/html/py-modindex.html
vendored
208
docs/build/html/py-modindex.html
vendored
@ -87,7 +87,6 @@
|
||||
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.html">CPL</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CPL_CLI</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
@ -155,8 +154,7 @@
|
||||
<h1>Python Module Index</h1>
|
||||
|
||||
<div class="modindex-jumpbox">
|
||||
<a href="#cap-c"><strong>c</strong></a> |
|
||||
<a href="#cap-t"><strong>t</strong></a>
|
||||
<a href="#cap-c"><strong>c</strong></a>
|
||||
</div>
|
||||
|
||||
<table class="indextable modindextable">
|
||||
@ -394,210 +392,6 @@
|
||||
<td>   
|
||||
<a href="cpl.utils.html#module-cpl.utils.string"><code class="xref">cpl.utils.string</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr>
|
||||
<td><img src="_static/minus.png" class="toggler"
|
||||
id="toggle-2" style="display: none" alt="-" /></td>
|
||||
<td>
|
||||
<a href="cpl_cli.html#module-cpl_cli"><code class="xref">cpl_cli</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_cli.html#module-cpl_cli.cli"><code class="xref">cpl_cli.cli</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_cli.html#module-cpl_cli.cli_settings"><code class="xref">cpl_cli.cli_settings</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_cli.html#module-cpl_cli.cli_settings_name_enum"><code class="xref">cpl_cli.cli_settings_name_enum</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_cli.command.html#module-cpl_cli.command.add_service"><code class="xref">cpl_cli.command.add_service</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_cli.command.html#module-cpl_cli.command.build_service"><code class="xref">cpl_cli.command.build_service</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_cli.command.html#module-cpl_cli.command.generate_service"><code class="xref">cpl_cli.command.generate_service</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_cli.command.html#module-cpl_cli.command.help_service"><code class="xref">cpl_cli.command.help_service</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_cli.command.html#module-cpl_cli.command.install_service"><code class="xref">cpl_cli.command.install_service</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_cli.command.html#module-cpl_cli.command.new_service"><code class="xref">cpl_cli.command.new_service</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_cli.command.html#module-cpl_cli.command.publish_service"><code class="xref">cpl_cli.command.publish_service</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_cli.command.html#module-cpl_cli.command.remove_service"><code class="xref">cpl_cli.command.remove_service</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_cli.command.html#module-cpl_cli.command.start_service"><code class="xref">cpl_cli.command.start_service</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_cli.command.html#module-cpl_cli.command.uninstall_service"><code class="xref">cpl_cli.command.uninstall_service</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_cli.command.html#module-cpl_cli.command.update_service"><code class="xref">cpl_cli.command.update_service</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_cli.command.html#module-cpl_cli.command.version_service"><code class="xref">cpl_cli.command.version_service</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_cli.html#module-cpl_cli.command_abc"><code class="xref">cpl_cli.command_abc</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_cli.html#module-cpl_cli.command_handler_service"><code class="xref">cpl_cli.command_handler_service</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_cli.html#module-cpl_cli.command_model"><code class="xref">cpl_cli.command_model</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_cli.configuration.html#module-cpl_cli.configuration.build_settings"><code class="xref">cpl_cli.configuration.build_settings</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_cli.configuration.html#module-cpl_cli.configuration.build_settings_name_enum"><code class="xref">cpl_cli.configuration.build_settings_name_enum</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_cli.configuration.html#module-cpl_cli.configuration.project_settings"><code class="xref">cpl_cli.configuration.project_settings</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_cli.configuration.html#module-cpl_cli.configuration.project_settings_name_enum"><code class="xref">cpl_cli.configuration.project_settings_name_enum</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_cli.configuration.html#module-cpl_cli.configuration.project_type_enum"><code class="xref">cpl_cli.configuration.project_type_enum</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_cli.configuration.html#module-cpl_cli.configuration.settings_helper"><code class="xref">cpl_cli.configuration.settings_helper</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_cli.configuration.html#module-cpl_cli.configuration.version_settings"><code class="xref">cpl_cli.configuration.version_settings</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_cli.configuration.html#module-cpl_cli.configuration.version_settings_name_enum"><code class="xref">cpl_cli.configuration.version_settings_name_enum</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_cli.configuration.html#module-cpl_cli.configuration.workspace_settings"><code class="xref">cpl_cli.configuration.workspace_settings</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_cli.configuration.html#module-cpl_cli.configuration.workspace_settings_name_enum"><code class="xref">cpl_cli.configuration.workspace_settings_name_enum</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_cli.html#module-cpl_cli.error"><code class="xref">cpl_cli.error</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_cli.live_server.html#module-cpl_cli.live_server.live_server_service"><code class="xref">cpl_cli.live_server.live_server_service</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_cli.live_server.html#module-cpl_cli.live_server.live_server_thread"><code class="xref">cpl_cli.live_server.live_server_thread</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_cli.html#module-cpl_cli.main"><code class="xref">cpl_cli.main</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_cli.publish.html#module-cpl_cli.publish.publisher_abc"><code class="xref">cpl_cli.publish.publisher_abc</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_cli.publish.html#module-cpl_cli.publish.publisher_service"><code class="xref">cpl_cli.publish.publisher_service</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_cli.source_creator.html#module-cpl_cli.source_creator.console_builder"><code class="xref">cpl_cli.source_creator.console_builder</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_cli.source_creator.html#module-cpl_cli.source_creator.library_builder"><code class="xref">cpl_cli.source_creator.library_builder</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_cli.source_creator.html#module-cpl_cli.source_creator.template_builder"><code class="xref">cpl_cli.source_creator.template_builder</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_cli.html#module-cpl_cli.startup"><code class="xref">cpl_cli.startup</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="pcap"><td></td><td> </td><td></td></tr>
|
||||
<tr class="cap" id="cap-t"><td></td><td>
|
||||
<strong>t</strong></td><td></td></tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>
|
||||
<a href="tests.html#module-tests"><code class="xref">tests</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
1
docs/build/html/search.html
vendored
1
docs/build/html/search.html
vendored
@ -87,7 +87,6 @@
|
||||
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.html">CPL</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CPL_CLI</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
2
docs/build/html/searchindex.js
vendored
2
docs/build/html/searchindex.js
vendored
File diff suppressed because one or more lines are too long
244
docs/build/html/tests.html
vendored
244
docs/build/html/tests.html
vendored
@ -1,244 +0,0 @@
|
||||
|
||||
|
||||
<!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>tests package — Common Python Library documentation</title>
|
||||
|
||||
|
||||
|
||||
<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 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 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">
|
||||
|
||||
|
||||
<div class="wy-grid-for-nav">
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="index.html" class="icon icon-home"> Common Python Library
|
||||
|
||||
|
||||
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.html">CPL</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CPL_CLI</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<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="breadcrumbs navigation">
|
||||
|
||||
<ul class="wy-breadcrumbs">
|
||||
|
||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||
|
||||
<li>tests package</li>
|
||||
|
||||
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
<a href="_sources/tests.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="tests-package">
|
||||
<h1>tests package<a class="headerlink" href="#tests-package" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="section" id="module-tests">
|
||||
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-tests" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="sh-cpl-sh-edraft-common-python-library">
|
||||
<h3>sh_cpl sh-edraft Common Python library<a class="headerlink" href="#sh-cpl-sh-edraft-common-python-library" title="Permalink to this headline">¶</a></h3>
|
||||
<p>sh-edraft Common Python library</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">copyright</dt>
|
||||
<dd class="field-odd"><ol class="loweralpha simple" start="3">
|
||||
<li><p>2020 - 2021 sh-edraft.de</p></li>
|
||||
</ol>
|
||||
</dd>
|
||||
<dt class="field-even">license</dt>
|
||||
<dd class="field-even"><p>MIT, see LICENSE for more details.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py class">
|
||||
<dt id="tests.VersionInfo">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">tests.</span></code><code class="sig-name descname"><span class="pre">VersionInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">major</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">minor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">micro</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#tests.VersionInfo" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code></p>
|
||||
<dl class="py attribute">
|
||||
<dt id="tests.VersionInfo.major">
|
||||
<code class="sig-name descname"><span class="pre">major</span></code><a class="headerlink" href="#tests.VersionInfo.major" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Alias for field number 0</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="tests.VersionInfo.micro">
|
||||
<code class="sig-name descname"><span class="pre">micro</span></code><a class="headerlink" href="#tests.VersionInfo.micro" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Alias for field number 2</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="tests.VersionInfo.minor">
|
||||
<code class="sig-name descname"><span class="pre">minor</span></code><a class="headerlink" href="#tests.VersionInfo.minor" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Alias for field number 1</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2021, Sven Heidemann.
|
||||
|
||||
</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</section>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@ -6,7 +6,7 @@
|
||||
|
||||
# -- Path setup --------------------------------------------------------------
|
||||
|
||||
# If extensions (or modules to document with autodoc) are in another directory,
|
||||
# If extensions (ors to document with autodoc) are in another directory,
|
||||
# add these directories to sys.path here. If the directory is relative to the
|
||||
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
||||
#
|
||||
@ -15,7 +15,7 @@
|
||||
# sys.path.insert(0, os.path.abspath('.'))
|
||||
import os
|
||||
import sys
|
||||
sys.path.insert(0, os.path.abspath('../../src'))
|
||||
sys.path.insert(0, os.path.abspath('../../src/'))
|
||||
|
||||
|
||||
# -- Project information -----------------------------------------------------
|
||||
@ -27,7 +27,7 @@ author = 'Sven Heidemann'
|
||||
|
||||
# -- General configuration ---------------------------------------------------
|
||||
|
||||
# Add any Sphinx extension module names here, as strings. They can be
|
||||
# Add any Sphinx extension names here, as strings. They can be
|
||||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
||||
# ones.
|
||||
extensions = [
|
||||
@ -43,6 +43,7 @@ templates_path = ['_templates']
|
||||
# This pattern also affects html_static_path and html_extra_path.
|
||||
exclude_patterns = [
|
||||
'cpl_cli/templates/*',
|
||||
'cpl_cli/*',
|
||||
'tests/*'
|
||||
]
|
||||
|
||||
@ -51,7 +52,7 @@ exclude_patterns = [
|
||||
|
||||
# The theme to use for HTML and HTML Help pages. See the documentation for
|
||||
# a list of builtin themes.
|
||||
#
|
||||
|
||||
html_theme = 'sphinx_rtd_theme'
|
||||
|
||||
# Add any paths that contain custom static files (such as style sheets) here,
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
cpl.application
|
||||
=======================
|
||||
|
||||
cpl.application.application\_abc module
|
||||
cpl.application.application\_abc
|
||||
---------------------------------------
|
||||
|
||||
.. automodule:: cpl.application.application_abc
|
||||
@ -9,7 +9,7 @@ cpl.application.application\_abc module
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl.application.application\_builder module
|
||||
cpl.application.application\_builder
|
||||
-------------------------------------------
|
||||
|
||||
.. automodule:: cpl.application.application_builder
|
||||
@ -17,7 +17,7 @@ cpl.application.application\_builder module
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl.application.application\_builder\_abc module
|
||||
cpl.application.application\_builder\_abc
|
||||
------------------------------------------------
|
||||
|
||||
.. automodule:: cpl.application.application_builder_abc
|
||||
@ -25,7 +25,7 @@ cpl.application.application\_builder\_abc module
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl.application.startup\_abc module
|
||||
cpl.application.startup\_abc
|
||||
-----------------------------------
|
||||
|
||||
.. automodule:: cpl.application.startup_abc
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
cpl.configuration
|
||||
=========================
|
||||
|
||||
cpl.configuration.configuration module
|
||||
cpl.configuration.configuration
|
||||
--------------------------------------
|
||||
|
||||
.. automodule:: cpl.configuration.configuration
|
||||
@ -9,7 +9,7 @@ cpl.configuration.configuration module
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl.configuration.configuration\_abc module
|
||||
cpl.configuration.configuration\_abc
|
||||
-------------------------------------------
|
||||
|
||||
.. automodule:: cpl.configuration.configuration_abc
|
||||
@ -17,7 +17,7 @@ cpl.configuration.configuration\_abc module
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl.configuration.configuration\_model\_abc module
|
||||
cpl.configuration.configuration\_model\_abc
|
||||
--------------------------------------------------
|
||||
|
||||
.. automodule:: cpl.configuration.configuration_model_abc
|
||||
@ -25,7 +25,7 @@ cpl.configuration.configuration\_model\_abc module
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl.configuration.configuration\_variable\_name\_enum module
|
||||
cpl.configuration.configuration\_variable\_name\_enum
|
||||
------------------------------------------------------------
|
||||
|
||||
.. automodule:: cpl.configuration.configuration_variable_name_enum
|
||||
@ -33,7 +33,7 @@ cpl.configuration.configuration\_variable\_name\_enum module
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl.configuration.console\_argument module
|
||||
cpl.configuration.console\_argument
|
||||
------------------------------------------
|
||||
|
||||
.. automodule:: cpl.configuration.console_argument
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
cpl.console
|
||||
===================
|
||||
|
||||
cpl.console.background\_color\_enum module
|
||||
cpl.console.background\_color\_enum
|
||||
------------------------------------------
|
||||
|
||||
.. automodule:: cpl.console.background_color_enum
|
||||
@ -9,7 +9,7 @@ cpl.console.background\_color\_enum module
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl.console.console module
|
||||
cpl.console.console
|
||||
--------------------------
|
||||
|
||||
.. automodule:: cpl.console.console
|
||||
@ -17,7 +17,7 @@ cpl.console.console module
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl.console.console\_call module
|
||||
cpl.console.console\_call
|
||||
--------------------------------
|
||||
|
||||
.. automodule:: cpl.console.console_call
|
||||
@ -25,7 +25,7 @@ cpl.console.console\_call module
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl.console.foreground\_color\_enum module
|
||||
cpl.console.foreground\_color\_enum
|
||||
------------------------------------------
|
||||
|
||||
.. automodule:: cpl.console.foreground_color_enum
|
||||
@ -33,7 +33,7 @@ cpl.console.foreground\_color\_enum module
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl.console.spinner\_thread module
|
||||
cpl.console.spinner\_thread
|
||||
----------------------------------
|
||||
|
||||
.. automodule:: cpl.console.spinner_thread
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
cpl.database.connection
|
||||
===============================
|
||||
|
||||
cpl.database.connection.database\_connection module
|
||||
cpl.database.connection.database\_connection
|
||||
---------------------------------------------------
|
||||
|
||||
.. automodule:: cpl.database.connection.database_connection
|
||||
@ -9,7 +9,7 @@ cpl.database.connection.database\_connection module
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl.database.connection.database\_connection\_abc module
|
||||
cpl.database.connection.database\_connection\_abc
|
||||
--------------------------------------------------------
|
||||
|
||||
.. automodule:: cpl.database.connection.database_connection_abc
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
cpl.database.context
|
||||
============================
|
||||
|
||||
cpl.database.context.database\_context module
|
||||
cpl.database.context.database\_context
|
||||
---------------------------------------------
|
||||
|
||||
.. automodule:: cpl.database.context.database_context
|
||||
@ -9,7 +9,7 @@ cpl.database.context.database\_context module
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl.database.context.database\_context\_abc module
|
||||
cpl.database.context.database\_context\_abc
|
||||
--------------------------------------------------
|
||||
|
||||
.. automodule:: cpl.database.context.database_context_abc
|
||||
|
||||
@ -10,7 +10,7 @@ cpl.database
|
||||
Submodules
|
||||
----------
|
||||
|
||||
cpl.database.database\_model module
|
||||
cpl.database.database\_model
|
||||
-----------------------------------
|
||||
|
||||
.. automodule:: cpl.database.database_model
|
||||
@ -18,7 +18,7 @@ cpl.database.database\_model module
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl.database.database\_settings module
|
||||
cpl.database.database\_settings
|
||||
--------------------------------------
|
||||
|
||||
.. automodule:: cpl.database.database_settings
|
||||
@ -26,7 +26,7 @@ cpl.database.database\_settings module
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl.database.database\_settings\_name\_enum module
|
||||
cpl.database.database\_settings\_name\_enum
|
||||
--------------------------------------------------
|
||||
|
||||
.. automodule:: cpl.database.database_settings_name_enum
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
cpl.dependency\_injection
|
||||
=================================
|
||||
|
||||
cpl.dependency\_injection.service\_collection module
|
||||
cpl.dependency\_injection.service\_collection
|
||||
----------------------------------------------------
|
||||
|
||||
.. automodule:: cpl.dependency_injection.service_collection
|
||||
@ -9,7 +9,7 @@ cpl.dependency\_injection.service\_collection module
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl.dependency\_injection.service\_collection\_abc module
|
||||
cpl.dependency\_injection.service\_collection\_abc
|
||||
---------------------------------------------------------
|
||||
|
||||
.. automodule:: cpl.dependency_injection.service_collection_abc
|
||||
@ -17,7 +17,7 @@ cpl.dependency\_injection.service\_collection\_abc module
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl.dependency\_injection.service\_descriptor module
|
||||
cpl.dependency\_injection.service\_descriptor
|
||||
----------------------------------------------------
|
||||
|
||||
.. automodule:: cpl.dependency_injection.service_descriptor
|
||||
@ -25,7 +25,7 @@ cpl.dependency\_injection.service\_descriptor module
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl.dependency\_injection.service\_lifetime\_enum module
|
||||
cpl.dependency\_injection.service\_lifetime\_enum
|
||||
--------------------------------------------------------
|
||||
|
||||
.. automodule:: cpl.dependency_injection.service_lifetime_enum
|
||||
@ -33,7 +33,7 @@ cpl.dependency\_injection.service\_lifetime\_enum module
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl.dependency\_injection.service\_provider module
|
||||
cpl.dependency\_injection.service\_provider
|
||||
--------------------------------------------------
|
||||
|
||||
.. automodule:: cpl.dependency_injection.service_provider
|
||||
@ -41,7 +41,7 @@ cpl.dependency\_injection.service\_provider module
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl.dependency\_injection.service\_provider\_abc module
|
||||
cpl.dependency\_injection.service\_provider\_abc
|
||||
-------------------------------------------------------
|
||||
|
||||
.. automodule:: cpl.dependency_injection.service_provider_abc
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
cpl.environment
|
||||
=======================
|
||||
|
||||
cpl.environment.application\_environment module
|
||||
cpl.environment.application\_environment
|
||||
-----------------------------------------------
|
||||
|
||||
.. automodule:: cpl.environment.application_environment
|
||||
@ -9,7 +9,7 @@ cpl.environment.application\_environment module
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl.environment.application\_environment\_abc module
|
||||
cpl.environment.application\_environment\_abc
|
||||
----------------------------------------------------
|
||||
|
||||
.. automodule:: cpl.environment.application_environment_abc
|
||||
@ -17,7 +17,7 @@ cpl.environment.application\_environment\_abc module
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl.environment.environment\_name\_enum module
|
||||
cpl.environment.environment\_name\_enum
|
||||
----------------------------------------------
|
||||
|
||||
.. automodule:: cpl.environment.environment_name_enum
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
cpl.logging
|
||||
===================
|
||||
|
||||
cpl.logging.logger\_abc module
|
||||
cpl.logging.logger\_abc
|
||||
------------------------------
|
||||
|
||||
.. automodule:: cpl.logging.logger_abc
|
||||
@ -9,7 +9,7 @@ cpl.logging.logger\_abc module
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl.logging.logger\_service module
|
||||
cpl.logging.logger\_service
|
||||
----------------------------------
|
||||
|
||||
.. automodule:: cpl.logging.logger_service
|
||||
@ -17,7 +17,7 @@ cpl.logging.logger\_service module
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl.logging.logging\_level\_enum module
|
||||
cpl.logging.logging\_level\_enum
|
||||
---------------------------------------
|
||||
|
||||
.. automodule:: cpl.logging.logging_level_enum
|
||||
@ -25,7 +25,7 @@ cpl.logging.logging\_level\_enum module
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl.logging.logging\_settings module
|
||||
cpl.logging.logging\_settings
|
||||
------------------------------------
|
||||
|
||||
.. automodule:: cpl.logging.logging_settings
|
||||
@ -33,7 +33,7 @@ cpl.logging.logging\_settings module
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl.logging.logging\_settings\_name\_enum module
|
||||
cpl.logging.logging\_settings\_name\_enum
|
||||
------------------------------------------------
|
||||
|
||||
.. automodule:: cpl.logging.logging_settings_name_enum
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
cpl.mailing
|
||||
===================
|
||||
|
||||
cpl.mailing.email module
|
||||
cpl.mailing.email
|
||||
------------------------
|
||||
|
||||
.. automodule:: cpl.mailing.email
|
||||
@ -9,7 +9,7 @@ cpl.mailing.email module
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl.mailing.email\_client\_abc module
|
||||
cpl.mailing.email\_client\_abc
|
||||
-------------------------------------
|
||||
|
||||
.. automodule:: cpl.mailing.email_client_abc
|
||||
@ -17,7 +17,7 @@ cpl.mailing.email\_client\_abc module
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl.mailing.email\_client\_service module
|
||||
cpl.mailing.email\_client\_service
|
||||
-----------------------------------------
|
||||
|
||||
.. automodule:: cpl.mailing.email_client_service
|
||||
@ -25,7 +25,7 @@ cpl.mailing.email\_client\_service module
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl.mailing.email\_client\_settings module
|
||||
cpl.mailing.email\_client\_settings
|
||||
------------------------------------------
|
||||
|
||||
.. automodule:: cpl.mailing.email_client_settings
|
||||
@ -33,7 +33,7 @@ cpl.mailing.email\_client\_settings module
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl.mailing.email\_client\_settings\_name\_enum module
|
||||
cpl.mailing.email\_client\_settings\_name\_enum
|
||||
------------------------------------------------------
|
||||
|
||||
.. automodule:: cpl.mailing.email_client_settings_name_enum
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
cpl.time
|
||||
================
|
||||
|
||||
cpl.time.time\_format\_settings module
|
||||
cpl.time.time\_format\_settings
|
||||
--------------------------------------
|
||||
|
||||
.. automodule:: cpl.time.time_format_settings
|
||||
@ -9,7 +9,7 @@ cpl.time.time\_format\_settings module
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl.time.time\_format\_settings\_names\_enum module
|
||||
cpl.time.time\_format\_settings\_names\_enum
|
||||
---------------------------------------------------
|
||||
|
||||
.. automodule:: cpl.time.time_format_settings_names_enum
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
cpl.utils
|
||||
=================
|
||||
|
||||
cpl.utils.credential\_manager module
|
||||
cpl.utils.credential\_manager
|
||||
------------------------------------
|
||||
|
||||
.. automodule:: cpl.utils.credential_manager
|
||||
@ -9,7 +9,7 @@ cpl.utils.credential\_manager module
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl.utils.pip module
|
||||
cpl.utils.pip
|
||||
--------------------
|
||||
|
||||
.. automodule:: cpl.utils.pip
|
||||
@ -17,7 +17,7 @@ cpl.utils.pip module
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl.utils.string module
|
||||
cpl.utils.string
|
||||
-----------------------
|
||||
|
||||
.. automodule:: cpl.utils.string
|
||||
|
||||
@ -1,98 +0,0 @@
|
||||
cpl\_cli.command
|
||||
========================
|
||||
|
||||
cpl\_cli.command.add\_service module
|
||||
------------------------------------
|
||||
|
||||
.. automodule:: cpl_cli.command.add_service
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_cli.command.build\_service module
|
||||
--------------------------------------
|
||||
|
||||
.. automodule:: cpl_cli.command.build_service
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_cli.command.generate\_service module
|
||||
-----------------------------------------
|
||||
|
||||
.. automodule:: cpl_cli.command.generate_service
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_cli.command.help\_service module
|
||||
-------------------------------------
|
||||
|
||||
.. automodule:: cpl_cli.command.help_service
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_cli.command.install\_service module
|
||||
----------------------------------------
|
||||
|
||||
.. automodule:: cpl_cli.command.install_service
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_cli.command.new\_service module
|
||||
------------------------------------
|
||||
|
||||
.. automodule:: cpl_cli.command.new_service
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_cli.command.publish\_service module
|
||||
----------------------------------------
|
||||
|
||||
.. automodule:: cpl_cli.command.publish_service
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_cli.command.remove\_service module
|
||||
---------------------------------------
|
||||
|
||||
.. automodule:: cpl_cli.command.remove_service
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_cli.command.start\_service module
|
||||
--------------------------------------
|
||||
|
||||
.. automodule:: cpl_cli.command.start_service
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_cli.command.uninstall\_service module
|
||||
------------------------------------------
|
||||
|
||||
.. automodule:: cpl_cli.command.uninstall_service
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_cli.command.update\_service module
|
||||
---------------------------------------
|
||||
|
||||
.. automodule:: cpl_cli.command.update_service
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_cli.command.version\_service module
|
||||
----------------------------------------
|
||||
|
||||
.. automodule:: cpl_cli.command.version_service
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@ -1,82 +0,0 @@
|
||||
cpl\_cli.configuration
|
||||
==============================
|
||||
|
||||
cpl\_cli.configuration.build\_settings module
|
||||
---------------------------------------------
|
||||
|
||||
.. automodule:: cpl_cli.configuration.build_settings
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_cli.configuration.build\_settings\_name\_enum module
|
||||
---------------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_cli.configuration.build_settings_name_enum
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_cli.configuration.project\_settings module
|
||||
-----------------------------------------------
|
||||
|
||||
.. automodule:: cpl_cli.configuration.project_settings
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_cli.configuration.project\_settings\_name\_enum module
|
||||
-----------------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_cli.configuration.project_settings_name_enum
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_cli.configuration.project\_type\_enum module
|
||||
-------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_cli.configuration.project_type_enum
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_cli.configuration.settings\_helper module
|
||||
----------------------------------------------
|
||||
|
||||
.. automodule:: cpl_cli.configuration.settings_helper
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_cli.configuration.version\_settings module
|
||||
-----------------------------------------------
|
||||
|
||||
.. automodule:: cpl_cli.configuration.version_settings
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_cli.configuration.version\_settings\_name\_enum module
|
||||
-----------------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_cli.configuration.version_settings_name_enum
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_cli.configuration.workspace\_settings module
|
||||
-------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_cli.configuration.workspace_settings
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_cli.configuration.workspace\_settings\_name\_enum module
|
||||
-------------------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_cli.configuration.workspace_settings_name_enum
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@ -1,18 +0,0 @@
|
||||
cpl\_cli.live\_server
|
||||
=============================
|
||||
|
||||
cpl\_cli.live\_server.live\_server\_service module
|
||||
--------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_cli.live_server.live_server_service
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_cli.live\_server.live\_server\_thread module
|
||||
-------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_cli.live_server.live_server_thread
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@ -1,18 +0,0 @@
|
||||
cpl\_cli.publish
|
||||
========================
|
||||
|
||||
cpl\_cli.publish.publisher\_abc module
|
||||
--------------------------------------
|
||||
|
||||
.. automodule:: cpl_cli.publish.publisher_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_cli.publish.publisher\_service module
|
||||
------------------------------------------
|
||||
|
||||
.. automodule:: cpl_cli.publish.publisher_service
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@ -1,92 +0,0 @@
|
||||
CPL_CLI
|
||||
================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
|
||||
cpl_cli.command
|
||||
cpl_cli.configuration
|
||||
cpl_cli.live_server
|
||||
cpl_cli.publish
|
||||
cpl_cli.source_creator
|
||||
cpl_cli.templates
|
||||
|
||||
cpl\_cli.cli
|
||||
-------------------
|
||||
|
||||
.. automodule:: cpl_cli.cli
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_cli.cli\_settings
|
||||
-----------------------------
|
||||
|
||||
.. automodule:: cpl_cli.cli_settings
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_cli.cli\_settings\_name\_enum
|
||||
-----------------------------------------
|
||||
|
||||
.. automodule:: cpl_cli.cli_settings_name_enum
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_cli.command\_abc
|
||||
----------------------------
|
||||
|
||||
.. automodule:: cpl_cli.command_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_cli.command\_handler\_service
|
||||
-----------------------------------------
|
||||
|
||||
.. automodule:: cpl_cli.command_handler_service
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_cli.command\_model
|
||||
------------------------------
|
||||
|
||||
.. automodule:: cpl_cli.command_model
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_cli.error
|
||||
---------------------
|
||||
|
||||
.. automodule:: cpl_cli.error
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_cli.main
|
||||
--------------------
|
||||
|
||||
.. automodule:: cpl_cli.main
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_cli.startup
|
||||
-----------------------
|
||||
|
||||
.. automodule:: cpl_cli.startup
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Module contents
|
||||
---------------
|
||||
|
||||
.. automodule:: cpl_cli
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@ -1,26 +0,0 @@
|
||||
cpl\_cli.source\_creator
|
||||
================================
|
||||
|
||||
cpl\_cli.source\_creator.console\_builder module
|
||||
------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_cli.source_creator.console_builder
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_cli.source\_creator.library\_builder module
|
||||
------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_cli.source_creator.library_builder
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_cli.source\_creator.template\_builder module
|
||||
-------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_cli.source_creator.template_builder
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@ -19,4 +19,3 @@ These pages go into great detail about everything the Library can do.
|
||||
:maxdepth: 1
|
||||
|
||||
cpl
|
||||
cpl_cli
|
||||
|
||||
@ -5,4 +5,3 @@ cpl
|
||||
:maxdepth: 4
|
||||
|
||||
cpl
|
||||
cpl_cli
|
||||
|
||||
3
scripts/chrome.sh
Normal file
3
scripts/chrome.sh
Normal file
@ -0,0 +1,3 @@
|
||||
#!/bin/bash
|
||||
|
||||
google-chrome $PWD/../docs/build/html/index.html
|
||||
6
scripts/create_docs.sh
Normal file
6
scripts/create_docs.sh
Normal file
@ -0,0 +1,6 @@
|
||||
#!/bin/bash
|
||||
|
||||
cd ../docs/
|
||||
sphinx-apidoc -o source/ ../src/cpl
|
||||
make clean
|
||||
make html;
|
||||
@ -8,20 +8,26 @@ from cpl.environment import ApplicationEnvironmentABC
|
||||
|
||||
|
||||
class ApplicationABC(ABC):
|
||||
r"""ABC for the Application class
|
||||
|
||||
Parameters
|
||||
----------
|
||||
config: :class:`cpl.configuration.configuration_abc.ConfigurationABC`
|
||||
Contains object loaded from appsettings
|
||||
services: :class:`cpl.dependency_injection.service_provider_abc.ServiceProviderABC`
|
||||
Contains instances of prepared objects
|
||||
"""
|
||||
|
||||
@abstractmethod
|
||||
def __init__(self, config: ConfigurationABC, services: ServiceProviderABC):
|
||||
"""
|
||||
ABC of application
|
||||
"""
|
||||
self._configuration: Optional[ConfigurationABC] = config
|
||||
self._environment: Optional[ApplicationEnvironmentABC] = self._configuration.environment
|
||||
self._services: Optional[ServiceProviderABC] = services
|
||||
|
||||
def run(self):
|
||||
"""
|
||||
Entry point
|
||||
:return:
|
||||
r"""Entry point
|
||||
|
||||
Called by custom Application.main
|
||||
"""
|
||||
try:
|
||||
self.configure()
|
||||
@ -31,16 +37,16 @@ class ApplicationABC(ABC):
|
||||
|
||||
@abstractmethod
|
||||
def configure(self):
|
||||
"""
|
||||
Prepare the application
|
||||
:return:
|
||||
r"""Configure the application
|
||||
|
||||
Called by :class:`cpl.application.application_abc.ApplicationABC.run`
|
||||
"""
|
||||
pass
|
||||
|
||||
@abstractmethod
|
||||
def main(self):
|
||||
"""
|
||||
Custom entry point
|
||||
:return:
|
||||
r"""Custom entry point
|
||||
|
||||
Called by :class:`cpl.application.application_abc.ApplicationABC.run`
|
||||
"""
|
||||
pass
|
||||
|
||||
@ -8,11 +8,15 @@ from cpl.dependency_injection.service_collection import ServiceCollection
|
||||
|
||||
|
||||
class ApplicationBuilder(ApplicationBuilderABC):
|
||||
r"""This is class is used to build a object of :class:`cpl.application.application_abc.ApplicationABC`
|
||||
|
||||
Parameter
|
||||
---------
|
||||
app: Type[:class:`cpl.application.application_abc.ApplicationABC`]
|
||||
Application to build
|
||||
"""
|
||||
|
||||
def __init__(self, app: Type[ApplicationABC]):
|
||||
"""
|
||||
Builder class for application
|
||||
"""
|
||||
ApplicationBuilderABC.__init__(self)
|
||||
self._app = app
|
||||
self._startup: Optional[StartupABC] = None
|
||||
@ -22,18 +26,9 @@ class ApplicationBuilder(ApplicationBuilderABC):
|
||||
self._services = ServiceCollection(self._configuration)
|
||||
|
||||
def use_startup(self, startup: Type[StartupABC]):
|
||||
"""
|
||||
Sets the used startup class
|
||||
:param startup:
|
||||
:return:
|
||||
"""
|
||||
self._startup = startup(self._configuration, self._services)
|
||||
|
||||
def build(self) -> ApplicationABC:
|
||||
"""
|
||||
Creates application host and runtime
|
||||
:return:
|
||||
"""
|
||||
if self._startup is not None:
|
||||
self._startup.configure_configuration()
|
||||
self._startup.configure_services()
|
||||
|
||||
@ -6,25 +6,29 @@ from cpl.application.startup_abc import StartupABC
|
||||
|
||||
|
||||
class ApplicationBuilderABC(ABC):
|
||||
r"""ABC for the :class:`cpl.application.application_builder.ApplicationBuilder`"""
|
||||
|
||||
@abstractmethod
|
||||
def __init__(self, *args):
|
||||
"""
|
||||
ABC of application builder
|
||||
"""
|
||||
pass
|
||||
|
||||
@abstractmethod
|
||||
def use_startup(self, startup: Type[StartupABC]):
|
||||
"""
|
||||
Sets the used startup class
|
||||
:param startup:
|
||||
:return:
|
||||
r"""Sets the custom startup class to use
|
||||
|
||||
Parameter
|
||||
---------
|
||||
startup: Type[:class:`cpl.application.startup_abc.StartupABC`]
|
||||
Type of :class:`cpl.application.startup_abc.StartupABC`
|
||||
"""
|
||||
pass
|
||||
|
||||
@abstractmethod
|
||||
def build(self) -> ApplicationABC:
|
||||
"""
|
||||
Creates application host and runtime
|
||||
:return:
|
||||
r"""Creates custom application object
|
||||
|
||||
Returns
|
||||
-------
|
||||
Object of :class:`cpl.application.application_abc.ApplicationABC`
|
||||
"""
|
||||
pass
|
||||
|
||||
@ -5,25 +5,28 @@ from cpl.dependency_injection.service_provider_abc import ServiceProviderABC
|
||||
|
||||
|
||||
class StartupABC(ABC):
|
||||
r"""ABC for the startup class"""
|
||||
|
||||
@abstractmethod
|
||||
def __init__(self, *args):
|
||||
"""
|
||||
ABC for a startup class
|
||||
"""
|
||||
pass
|
||||
|
||||
@abstractmethod
|
||||
def configure_configuration(self) -> ConfigurationABC:
|
||||
"""
|
||||
Creates configuration of application
|
||||
:return: configuration
|
||||
r"""Creates configuration of application
|
||||
|
||||
Returns
|
||||
-------
|
||||
Object of :class:`cpl.configuration.configuration_abc.ConfigurationABC`
|
||||
"""
|
||||
pass
|
||||
|
||||
@abstractmethod
|
||||
def configure_services(self) -> ServiceProviderABC:
|
||||
"""
|
||||
Creates service provider
|
||||
:return: service provider
|
||||
r"""Creates service provider
|
||||
|
||||
Returns
|
||||
-------
|
||||
Object of :class:`cpl.dependency_injection.service_provider_abc.ServiceProviderABC`
|
||||
"""
|
||||
pass
|
||||
|
||||
Loading…
Reference in New Issue
Block a user