Build new docs

This commit is contained in:
Sven Heidemann 2021-12-02 08:20:38 +01:00
parent dec137220c
commit ce77d41246
123 changed files with 9254 additions and 2181 deletions

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

View File

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

View File

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

View File

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

File diff suppressed because one or more lines are too long

View File

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

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

File diff suppressed because it is too large Load Diff

After

Width:  |  Height:  |  Size: 434 KiB

Binary file not shown.

Binary file not shown.

Binary file not shown.

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

View File

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

View File

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

File diff suppressed because one or more lines are too long

View File

@ -1,20 +1,41 @@
<!DOCTYPE html> <!DOCTYPE html>
<html class="writer-html5" lang="en" > <html class="writer-html5" lang="en" >
<head> <head>
<meta charset="utf-8" /> <meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>cpl add &mdash; Common Python Library documentation</title> <title>cpl add &mdash; Common Python Library documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<!--[if lt IE 9]> <!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script> <script src="_static/js/html5shiv.min.js"></script>
<![endif]--> <![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script> <script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script> <script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script> <script src="_static/doctools.js"></script>
<script src="_static/js/theme.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" /> <link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" /> <link rel="search" title="Search" href="search.html" />
<link rel="next" title="cpl build" href="cli.build.html" /> <link rel="next" title="cpl build" href="cli.build.html" />
@ -22,12 +43,28 @@
</head> </head>
<body class="wy-body-for-nav"> <body class="wy-body-for-nav">
<div class="wy-grid-for-nav"> <div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side"> <nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll"> <div class="wy-side-scroll">
<div class="wy-side-nav-search" > <div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library <a href="index.html" class="icon icon-home"> Common Python Library
</a> </a>
<div role="search"> <div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get"> <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" /> <input type="text" name="q" placeholder="Search docs" />
@ -35,7 +72,18 @@
<input type="hidden" name="area" value="default" /> <input type="hidden" name="area" value="default" />
</form> </form>
</div> </div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current"> <ul class="current">
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li> <li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li> <li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
@ -64,35 +112,77 @@
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li> <li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li>
</ul> </ul>
</div> </div>
</div> </div>
</nav> </nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i> <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Common Python Library</a> <a href="index.html">Common Python Library</a>
</nav> </nav>
<div class="wy-nav-content"> <div class="wy-nav-content">
<div class="rst-content"> <div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs"> <ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li> <li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl_cli.html">CLI Reference</a> &raquo;</li> <li><a href="cpl_cli.html">CLI Reference</a> &raquo;</li>
<li>cpl add</li> <li>cpl add</li>
<li class="wy-breadcrumbs-aside"> <li class="wy-breadcrumbs-aside">
<a href="_sources/cli.add.md.txt" rel="nofollow"> View page source</a> <a href="_sources/cli.add.md.txt" rel="nofollow"> View page source</a>
</li> </li>
</ul> </ul>
<hr/> <hr/>
</div> </div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody"> <div itemprop="articleBody">
<div class="tex2jax_ignore mathjax_ignore section" id="cpl-add"> <div class="section" id="cpl-add">
<h1>cpl add<a class="headerlink" href="#cpl-add" title="Permalink to this headline"></a></h1> <h1>cpl add<a class="headerlink" href="#cpl-add" title="Permalink to this headline"></a></h1>
<div class="section" id="contents"> <div class="section" id="contents">
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this headline"></a></h2> <h2>Contents<a class="headerlink" href="#contents" title="Permalink to this headline"></a></h2>
<ul class="simple"> <ul class="simple">
<li><p><a class="reference external" href="#description">Description</a></p></li> <li><p><a class="reference external" href="#description">Description</a></p></li>
<li><p><a class="reference external" href="#arguments">Arguments</a></p></li> <li><p><a class="reference external" href="#arguments">Arguments</a></p></li>
@ -103,12 +193,12 @@ cpl <strong>a</strong> <em>&lt;source-project&gt;</em> <em>&lt;target-project&gt
cpl <strong>A</strong> <em>&lt;source-project&gt;</em> <em>&lt;target-project&gt;</em></p> cpl <strong>A</strong> <em>&lt;source-project&gt;</em> <em>&lt;target-project&gt;</em></p>
</div> </div>
<div class="section" id="description"> <div class="section" id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2> <h2>Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>Adds a project reference to given project.</p> <p>Adds a project reference to given project.</p>
<p>If you call the command in a CPL workspace, you can use the project names. Otherwise the paths of the projects must be specified.</p> <p>If you call the command in a CPL workspace, you can use the project names. Otherwise the paths of the projects must be specified.</p>
</div> </div>
<div class="section" id="arguments"> <div class="section" id="arguments">
<h2>Arguments<a class="headerlink" href="#arguments" title="Permalink to this headline"></a></h2> <h2>Arguments<a class="headerlink" href="#arguments" title="Permalink to this headline"></a></h2>
<table class="colwidths-auto docutils align-default"> <table class="colwidths-auto docutils align-default">
<thead> <thead>
<tr class="row-odd"><th class="head"><p>Argument</p></th> <tr class="row-odd"><th class="head"><p>Argument</p></th>
@ -132,33 +222,50 @@ cpl <strong>A</strong> <em>&lt;source-project&gt;</em> <em>&lt;target-project&gt
</div> </div>
</div> </div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> <footer>
<a href="cli.overview.html" class="btn btn-neutral float-left" title="CLI Overview and Command Reference" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="cli.build.html" class="btn btn-neutral float-right" title="cpl build" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> <a href="cli.build.html" class="btn btn-neutral float-right" title="cpl build" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="cli.overview.html" class="btn btn-neutral float-left" title="CLI Overview and Command Reference" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div> </div>
<hr/> <hr/>
<div role="contentinfo"> <div role="contentinfo">
<p>&#169; Copyright 2021, Sven Heidemann.</p> <p>
&#169; Copyright 2021, Sven Heidemann.
</p>
</div> </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>.
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> </footer>
</div> </div>
</div> </div>
</section> </section>
</div> </div>
<script>
<script type="text/javascript">
jQuery(function () { jQuery(function () {
SphinxRtdTheme.Navigation.enable(true); SphinxRtdTheme.Navigation.enable(true);
}); });
</script> </script>
</body> </body>
</html> </html>

View File

@ -1,20 +1,41 @@
<!DOCTYPE html> <!DOCTYPE html>
<html class="writer-html5" lang="en" > <html class="writer-html5" lang="en" >
<head> <head>
<meta charset="utf-8" /> <meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>cpl build &mdash; Common Python Library documentation</title> <title>cpl build &mdash; Common Python Library documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<!--[if lt IE 9]> <!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script> <script src="_static/js/html5shiv.min.js"></script>
<![endif]--> <![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script> <script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script> <script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script> <script src="_static/doctools.js"></script>
<script src="_static/js/theme.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" /> <link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" /> <link rel="search" title="Search" href="search.html" />
<link rel="next" title="cpl generate" href="cli.generate.html" /> <link rel="next" title="cpl generate" href="cli.generate.html" />
@ -22,12 +43,28 @@
</head> </head>
<body class="wy-body-for-nav"> <body class="wy-body-for-nav">
<div class="wy-grid-for-nav"> <div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side"> <nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll"> <div class="wy-side-scroll">
<div class="wy-side-nav-search" > <div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library <a href="index.html" class="icon icon-home"> Common Python Library
</a> </a>
<div role="search"> <div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get"> <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" /> <input type="text" name="q" placeholder="Search docs" />
@ -35,7 +72,18 @@
<input type="hidden" name="area" value="default" /> <input type="hidden" name="area" value="default" />
</form> </form>
</div> </div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current"> <ul class="current">
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li> <li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li> <li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
@ -63,35 +111,77 @@
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li> <li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li>
</ul> </ul>
</div> </div>
</div> </div>
</nav> </nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i> <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Common Python Library</a> <a href="index.html">Common Python Library</a>
</nav> </nav>
<div class="wy-nav-content"> <div class="wy-nav-content">
<div class="rst-content"> <div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs"> <ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li> <li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl_cli.html">CLI Reference</a> &raquo;</li> <li><a href="cpl_cli.html">CLI Reference</a> &raquo;</li>
<li>cpl build</li> <li>cpl build</li>
<li class="wy-breadcrumbs-aside"> <li class="wy-breadcrumbs-aside">
<a href="_sources/cli.build.md.txt" rel="nofollow"> View page source</a> <a href="_sources/cli.build.md.txt" rel="nofollow"> View page source</a>
</li> </li>
</ul> </ul>
<hr/> <hr/>
</div> </div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody"> <div itemprop="articleBody">
<div class="tex2jax_ignore mathjax_ignore section" id="cpl-build"> <div class="section" id="cpl-build">
<h1>cpl build<a class="headerlink" href="#cpl-build" title="Permalink to this headline"></a></h1> <h1>cpl build<a class="headerlink" href="#cpl-build" title="Permalink to this headline"></a></h1>
<div class="section" id="contents"> <div class="section" id="contents">
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this headline"></a></h2> <h2>Contents<a class="headerlink" href="#contents" title="Permalink to this headline"></a></h2>
<ul class="simple"> <ul class="simple">
<li><p><a class="reference external" href="#description">Description</a></p></li> <li><p><a class="reference external" href="#description">Description</a></p></li>
</ul> </ul>
@ -102,7 +192,7 @@ cpl <strong>b</strong> <br>
cpl <strong>B</strong></p> cpl <strong>B</strong></p>
</div> </div>
<div class="section" id="description"> <div class="section" id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2> <h2>Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>The command can be used to build a project of type “console” or “library”.</p> <p>The command can be used to build a project of type “console” or “library”.</p>
<p>The build command copies all included source files to the output directory. You can run the source files in the output directory directly.</p> <p>The build command copies all included source files to the output directory. You can run the source files in the output directory directly.</p>
<p>The command is used to prepare the source files for the publish command or to copy them to an target for execution.</p> <p>The command is used to prepare the source files for the publish command or to copy them to an target for execution.</p>
@ -116,33 +206,50 @@ cpl <strong>B</strong></p>
</div> </div>
</div> </div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> <footer>
<a href="cli.add.html" class="btn btn-neutral float-left" title="cpl add" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="cli.generate.html" class="btn btn-neutral float-right" title="cpl generate" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> <a href="cli.generate.html" class="btn btn-neutral float-right" title="cpl generate" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="cli.add.html" class="btn btn-neutral float-left" title="cpl add" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div> </div>
<hr/> <hr/>
<div role="contentinfo"> <div role="contentinfo">
<p>&#169; Copyright 2021, Sven Heidemann.</p> <p>
&#169; Copyright 2021, Sven Heidemann.
</p>
</div> </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>.
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> </footer>
</div> </div>
</div> </div>
</section> </section>
</div> </div>
<script>
<script type="text/javascript">
jQuery(function () { jQuery(function () {
SphinxRtdTheme.Navigation.enable(true); SphinxRtdTheme.Navigation.enable(true);
}); });
</script> </script>
</body> </body>
</html> </html>

View File

@ -1,20 +1,41 @@
<!DOCTYPE html> <!DOCTYPE html>
<html class="writer-html5" lang="en" > <html class="writer-html5" lang="en" >
<head> <head>
<meta charset="utf-8" /> <meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>cpl generate &mdash; Common Python Library documentation</title> <title>cpl generate &mdash; Common Python Library documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<!--[if lt IE 9]> <!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script> <script src="_static/js/html5shiv.min.js"></script>
<![endif]--> <![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script> <script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script> <script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script> <script src="_static/doctools.js"></script>
<script src="_static/js/theme.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" /> <link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" /> <link rel="search" title="Search" href="search.html" />
<link rel="next" title="cpl help" href="cli.help.html" /> <link rel="next" title="cpl help" href="cli.help.html" />
@ -22,12 +43,28 @@
</head> </head>
<body class="wy-body-for-nav"> <body class="wy-body-for-nav">
<div class="wy-grid-for-nav"> <div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side"> <nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll"> <div class="wy-side-scroll">
<div class="wy-side-nav-search" > <div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library <a href="index.html" class="icon icon-home"> Common Python Library
</a> </a>
<div role="search"> <div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get"> <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" /> <input type="text" name="q" placeholder="Search docs" />
@ -35,7 +72,18 @@
<input type="hidden" name="area" value="default" /> <input type="hidden" name="area" value="default" />
</form> </form>
</div> </div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current"> <ul class="current">
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li> <li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li> <li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
@ -65,35 +113,77 @@
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li> <li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li>
</ul> </ul>
</div> </div>
</div> </div>
</nav> </nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i> <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Common Python Library</a> <a href="index.html">Common Python Library</a>
</nav> </nav>
<div class="wy-nav-content"> <div class="wy-nav-content">
<div class="rst-content"> <div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs"> <ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li> <li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl_cli.html">CLI Reference</a> &raquo;</li> <li><a href="cpl_cli.html">CLI Reference</a> &raquo;</li>
<li>cpl generate</li> <li>cpl generate</li>
<li class="wy-breadcrumbs-aside"> <li class="wy-breadcrumbs-aside">
<a href="_sources/cli.generate.md.txt" rel="nofollow"> View page source</a> <a href="_sources/cli.generate.md.txt" rel="nofollow"> View page source</a>
</li> </li>
</ul> </ul>
<hr/> <hr/>
</div> </div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody"> <div itemprop="articleBody">
<div class="tex2jax_ignore mathjax_ignore section" id="cpl-generate"> <div class="section" id="cpl-generate">
<h1>cpl generate<a class="headerlink" href="#cpl-generate" title="Permalink to this headline"></a></h1> <h1>cpl generate<a class="headerlink" href="#cpl-generate" title="Permalink to this headline"></a></h1>
<div class="section" id="contents"> <div class="section" id="contents">
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this headline"></a></h2> <h2>Contents<a class="headerlink" href="#contents" title="Permalink to this headline"></a></h2>
<ul class="simple"> <ul class="simple">
<li><p><a class="reference external" href="#description">Description</a></p></li> <li><p><a class="reference external" href="#description">Description</a></p></li>
<li><p><a class="reference external" href="#arguments">Arguments</a></p></li> <li><p><a class="reference external" href="#arguments">Arguments</a></p></li>
@ -105,11 +195,11 @@ cpl <strong>g</strong> <em>&lt;schematic&gt;</em> <em>&lt;name&gt;</em> <br>
cpl <strong>G</strong> <em>&lt;schematic&gt;</em> <em>&lt;name&gt;</em></p> cpl <strong>G</strong> <em>&lt;schematic&gt;</em> <em>&lt;name&gt;</em></p>
</div> </div>
<div class="section" id="description"> <div class="section" id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2> <h2>Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>Generates files based on a schematic.</p> <p>Generates files based on a schematic.</p>
</div> </div>
<div class="section" id="arguments"> <div class="section" id="arguments">
<h2>Arguments<a class="headerlink" href="#arguments" title="Permalink to this headline"></a></h2> <h2>Arguments<a class="headerlink" href="#arguments" title="Permalink to this headline"></a></h2>
<table class="colwidths-auto docutils align-default"> <table class="colwidths-auto docutils align-default">
<thead> <thead>
<tr class="row-odd"><th class="head"><p>Argument</p></th> <tr class="row-odd"><th class="head"><p>Argument</p></th>
@ -130,7 +220,7 @@ cpl <strong>G</strong> <em>&lt;schematic&gt;</em> <em>&lt;name&gt;</em></p>
</table> </table>
</div> </div>
<div class="section" id="schematics"> <div class="section" id="schematics">
<h2>Schematics<a class="headerlink" href="#schematics" title="Permalink to this headline"></a></h2> <h2>Schematics<a class="headerlink" href="#schematics" title="Permalink to this headline"></a></h2>
<table class="colwidths-auto docutils align-default"> <table class="colwidths-auto docutils align-default">
<thead> <thead>
<tr class="row-odd"><th class="head"><p>Schematic</p></th> <tr class="row-odd"><th class="head"><p>Schematic</p></th>
@ -170,33 +260,50 @@ cpl <strong>G</strong> <em>&lt;schematic&gt;</em> <em>&lt;name&gt;</em></p>
</div> </div>
</div> </div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> <footer>
<a href="cli.build.html" class="btn btn-neutral float-left" title="cpl build" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="cli.help.html" class="btn btn-neutral float-right" title="cpl help" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> <a href="cli.help.html" class="btn btn-neutral float-right" title="cpl help" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="cli.build.html" class="btn btn-neutral float-left" title="cpl build" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div> </div>
<hr/> <hr/>
<div role="contentinfo"> <div role="contentinfo">
<p>&#169; Copyright 2021, Sven Heidemann.</p> <p>
&#169; Copyright 2021, Sven Heidemann.
</p>
</div> </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>.
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> </footer>
</div> </div>
</div> </div>
</section> </section>
</div> </div>
<script>
<script type="text/javascript">
jQuery(function () { jQuery(function () {
SphinxRtdTheme.Navigation.enable(true); SphinxRtdTheme.Navigation.enable(true);
}); });
</script> </script>
</body> </body>
</html> </html>

View File

@ -1,20 +1,41 @@
<!DOCTYPE html> <!DOCTYPE html>
<html class="writer-html5" lang="en" > <html class="writer-html5" lang="en" >
<head> <head>
<meta charset="utf-8" /> <meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>cpl help &mdash; Common Python Library documentation</title> <title>cpl help &mdash; Common Python Library documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<!--[if lt IE 9]> <!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script> <script src="_static/js/html5shiv.min.js"></script>
<![endif]--> <![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script> <script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script> <script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script> <script src="_static/doctools.js"></script>
<script src="_static/js/theme.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" /> <link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" /> <link rel="search" title="Search" href="search.html" />
<link rel="next" title="cpl install" href="cli.install.html" /> <link rel="next" title="cpl install" href="cli.install.html" />
@ -22,12 +43,28 @@
</head> </head>
<body class="wy-body-for-nav"> <body class="wy-body-for-nav">
<div class="wy-grid-for-nav"> <div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side"> <nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll"> <div class="wy-side-scroll">
<div class="wy-side-nav-search" > <div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library <a href="index.html" class="icon icon-home"> Common Python Library
</a> </a>
<div role="search"> <div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get"> <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" /> <input type="text" name="q" placeholder="Search docs" />
@ -35,7 +72,18 @@
<input type="hidden" name="area" value="default" /> <input type="hidden" name="area" value="default" />
</form> </form>
</div> </div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current"> <ul class="current">
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li> <li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li> <li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
@ -63,33 +111,75 @@
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li> <li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li>
</ul> </ul>
</div> </div>
</div> </div>
</nav> </nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i> <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Common Python Library</a> <a href="index.html">Common Python Library</a>
</nav> </nav>
<div class="wy-nav-content"> <div class="wy-nav-content">
<div class="rst-content"> <div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs"> <ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li> <li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl_cli.html">CLI Reference</a> &raquo;</li> <li><a href="cpl_cli.html">CLI Reference</a> &raquo;</li>
<li>cpl help</li> <li>cpl help</li>
<li class="wy-breadcrumbs-aside"> <li class="wy-breadcrumbs-aside">
<a href="_sources/cli.help.md.txt" rel="nofollow"> View page source</a> <a href="_sources/cli.help.md.txt" rel="nofollow"> View page source</a>
</li> </li>
</ul> </ul>
<hr/> <hr/>
</div> </div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody"> <div itemprop="articleBody">
<div class="tex2jax_ignore mathjax_ignore section" id="cpl-help"> <div class="section" id="cpl-help">
<h1>cpl help<a class="headerlink" href="#cpl-help" title="Permalink to this headline"></a></h1> <h1>cpl help<a class="headerlink" href="#cpl-help" title="Permalink to this headline"></a></h1>
<!-- ## Contents <!-- ## Contents
- [Description](#description) --> - [Description](#description) -->
@ -99,11 +189,11 @@
cpl <strong>h</strong> <em>&lt;command&gt;</em> <br> cpl <strong>h</strong> <em>&lt;command&gt;</em> <br>
cpl <strong>H</strong> <em>&lt;command&gt;</em></p> cpl <strong>H</strong> <em>&lt;command&gt;</em></p>
<div class="section" id="description"> <div class="section" id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2> <h2>Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>Lists available command and their short descriptions.</p> <p>Lists available command and their short descriptions.</p>
</div> </div>
<div class="section" id="arguments"> <div class="section" id="arguments">
<h2>Arguments<a class="headerlink" href="#arguments" title="Permalink to this headline"></a></h2> <h2>Arguments<a class="headerlink" href="#arguments" title="Permalink to this headline"></a></h2>
<table class="colwidths-auto docutils align-default"> <table class="colwidths-auto docutils align-default">
<thead> <thead>
<tr class="row-odd"><th class="head"><p>Argument</p></th> <tr class="row-odd"><th class="head"><p>Argument</p></th>
@ -123,33 +213,50 @@ cpl <strong>H</strong> <em>&lt;command&gt;</em></p>
</div> </div>
</div> </div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> <footer>
<a href="cli.generate.html" class="btn btn-neutral float-left" title="cpl generate" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="cli.install.html" class="btn btn-neutral float-right" title="cpl install" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> <a href="cli.install.html" class="btn btn-neutral float-right" title="cpl install" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="cli.generate.html" class="btn btn-neutral float-left" title="cpl generate" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div> </div>
<hr/> <hr/>
<div role="contentinfo"> <div role="contentinfo">
<p>&#169; Copyright 2021, Sven Heidemann.</p> <p>
&#169; Copyright 2021, Sven Heidemann.
</p>
</div> </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>.
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> </footer>
</div> </div>
</div> </div>
</section> </section>
</div> </div>
<script>
<script type="text/javascript">
jQuery(function () { jQuery(function () {
SphinxRtdTheme.Navigation.enable(true); SphinxRtdTheme.Navigation.enable(true);
}); });
</script> </script>
</body> </body>
</html> </html>

View File

@ -1,20 +1,41 @@
<!DOCTYPE html> <!DOCTYPE html>
<html class="writer-html5" lang="en" > <html class="writer-html5" lang="en" >
<head> <head>
<meta charset="utf-8" /> <meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>cpl install &mdash; Common Python Library documentation</title> <title>cpl install &mdash; Common Python Library documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<!--[if lt IE 9]> <!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script> <script src="_static/js/html5shiv.min.js"></script>
<![endif]--> <![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script> <script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script> <script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script> <script src="_static/doctools.js"></script>
<script src="_static/js/theme.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" /> <link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" /> <link rel="search" title="Search" href="search.html" />
<link rel="next" title="cpl new" href="cli.new.html" /> <link rel="next" title="cpl new" href="cli.new.html" />
@ -22,12 +43,28 @@
</head> </head>
<body class="wy-body-for-nav"> <body class="wy-body-for-nav">
<div class="wy-grid-for-nav"> <div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side"> <nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll"> <div class="wy-side-scroll">
<div class="wy-side-nav-search" > <div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library <a href="index.html" class="icon icon-home"> Common Python Library
</a> </a>
<div role="search"> <div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get"> <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" /> <input type="text" name="q" placeholder="Search docs" />
@ -35,7 +72,18 @@
<input type="hidden" name="area" value="default" /> <input type="hidden" name="area" value="default" />
</form> </form>
</div> </div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current"> <ul class="current">
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li> <li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li> <li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
@ -64,35 +112,77 @@
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li> <li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li>
</ul> </ul>
</div> </div>
</div> </div>
</nav> </nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i> <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Common Python Library</a> <a href="index.html">Common Python Library</a>
</nav> </nav>
<div class="wy-nav-content"> <div class="wy-nav-content">
<div class="rst-content"> <div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs"> <ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li> <li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl_cli.html">CLI Reference</a> &raquo;</li> <li><a href="cpl_cli.html">CLI Reference</a> &raquo;</li>
<li>cpl install</li> <li>cpl install</li>
<li class="wy-breadcrumbs-aside"> <li class="wy-breadcrumbs-aside">
<a href="_sources/cli.install.md.txt" rel="nofollow"> View page source</a> <a href="_sources/cli.install.md.txt" rel="nofollow"> View page source</a>
</li> </li>
</ul> </ul>
<hr/> <hr/>
</div> </div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody"> <div itemprop="articleBody">
<div class="tex2jax_ignore mathjax_ignore section" id="cpl-install"> <div class="section" id="cpl-install">
<h1>cpl install<a class="headerlink" href="#cpl-install" title="Permalink to this headline"></a></h1> <h1>cpl install<a class="headerlink" href="#cpl-install" title="Permalink to this headline"></a></h1>
<div class="section" id="contents"> <div class="section" id="contents">
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this headline"></a></h2> <h2>Contents<a class="headerlink" href="#contents" title="Permalink to this headline"></a></h2>
<ul class="simple"> <ul class="simple">
<li><p><a class="reference external" href="#description">Description</a></p></li> <li><p><a class="reference external" href="#description">Description</a></p></li>
<li><p><a class="reference external" href="#arguments">Arguments</a></p></li> <li><p><a class="reference external" href="#arguments">Arguments</a></p></li>
@ -103,12 +193,12 @@ cpl <strong>i</strong> <em>&lt;package&gt;</em> <br>
cpl <strong>I</strong> <em>&lt;package&gt;</em></p> cpl <strong>I</strong> <em>&lt;package&gt;</em></p>
</div> </div>
<div class="section" id="description"> <div class="section" id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2> <h2>Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>Install given package to project via pip. <p>Install given package to project via pip.
Without given package it will install the depedencies of the CPL project your in.</p> Without given package it will install the depedencies of the CPL project your in.</p>
</div> </div>
<div class="section" id="arguments"> <div class="section" id="arguments">
<h2>Arguments<a class="headerlink" href="#arguments" title="Permalink to this headline"></a></h2> <h2>Arguments<a class="headerlink" href="#arguments" title="Permalink to this headline"></a></h2>
<table class="colwidths-auto docutils align-default"> <table class="colwidths-auto docutils align-default">
<thead> <thead>
<tr class="row-odd"><th class="head"><p>Argument</p></th> <tr class="row-odd"><th class="head"><p>Argument</p></th>
@ -128,33 +218,50 @@ Without given package it will install the depedencies of the CPL project your in
</div> </div>
</div> </div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> <footer>
<a href="cli.help.html" class="btn btn-neutral float-left" title="cpl help" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="cli.new.html" class="btn btn-neutral float-right" title="cpl new" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> <a href="cli.new.html" class="btn btn-neutral float-right" title="cpl new" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="cli.help.html" class="btn btn-neutral float-left" title="cpl help" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div> </div>
<hr/> <hr/>
<div role="contentinfo"> <div role="contentinfo">
<p>&#169; Copyright 2021, Sven Heidemann.</p> <p>
&#169; Copyright 2021, Sven Heidemann.
</p>
</div> </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>.
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> </footer>
</div> </div>
</div> </div>
</section> </section>
</div> </div>
<script>
<script type="text/javascript">
jQuery(function () { jQuery(function () {
SphinxRtdTheme.Navigation.enable(true); SphinxRtdTheme.Navigation.enable(true);
}); });
</script> </script>
</body> </body>
</html> </html>

View File

@ -1,20 +1,41 @@
<!DOCTYPE html> <!DOCTYPE html>
<html class="writer-html5" lang="en" > <html class="writer-html5" lang="en" >
<head> <head>
<meta charset="utf-8" /> <meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>cpl new &mdash; Common Python Library documentation</title> <title>cpl new &mdash; Common Python Library documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<!--[if lt IE 9]> <!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script> <script src="_static/js/html5shiv.min.js"></script>
<![endif]--> <![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script> <script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script> <script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script> <script src="_static/doctools.js"></script>
<script src="_static/js/theme.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" /> <link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" /> <link rel="search" title="Search" href="search.html" />
<link rel="next" title="cpl publish" href="cli.publish.html" /> <link rel="next" title="cpl publish" href="cli.publish.html" />
@ -22,12 +43,28 @@
</head> </head>
<body class="wy-body-for-nav"> <body class="wy-body-for-nav">
<div class="wy-grid-for-nav"> <div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side"> <nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll"> <div class="wy-side-scroll">
<div class="wy-side-nav-search" > <div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library <a href="index.html" class="icon icon-home"> Common Python Library
</a> </a>
<div role="search"> <div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get"> <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" /> <input type="text" name="q" placeholder="Search docs" />
@ -35,7 +72,18 @@
<input type="hidden" name="area" value="default" /> <input type="hidden" name="area" value="default" />
</form> </form>
</div> </div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current"> <ul class="current">
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li> <li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li> <li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
@ -64,35 +112,77 @@
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li> <li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li>
</ul> </ul>
</div> </div>
</div> </div>
</nav> </nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i> <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Common Python Library</a> <a href="index.html">Common Python Library</a>
</nav> </nav>
<div class="wy-nav-content"> <div class="wy-nav-content">
<div class="rst-content"> <div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs"> <ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li> <li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl_cli.html">CLI Reference</a> &raquo;</li> <li><a href="cpl_cli.html">CLI Reference</a> &raquo;</li>
<li>cpl new</li> <li>cpl new</li>
<li class="wy-breadcrumbs-aside"> <li class="wy-breadcrumbs-aside">
<a href="_sources/cli.new.md.txt" rel="nofollow"> View page source</a> <a href="_sources/cli.new.md.txt" rel="nofollow"> View page source</a>
</li> </li>
</ul> </ul>
<hr/> <hr/>
</div> </div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody"> <div itemprop="articleBody">
<div class="tex2jax_ignore mathjax_ignore section" id="cpl-new"> <div class="section" id="cpl-new">
<h1>cpl new<a class="headerlink" href="#cpl-new" title="Permalink to this headline"></a></h1> <h1>cpl new<a class="headerlink" href="#cpl-new" title="Permalink to this headline"></a></h1>
<div class="section" id="contents"> <div class="section" id="contents">
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this headline"></a></h2> <h2>Contents<a class="headerlink" href="#contents" title="Permalink to this headline"></a></h2>
<ul class="simple"> <ul class="simple">
<li><p><a class="reference external" href="#description">Description</a></p></li> <li><p><a class="reference external" href="#description">Description</a></p></li>
<li><p><a class="reference external" href="#arguments">Arguments</a></p></li> <li><p><a class="reference external" href="#arguments">Arguments</a></p></li>
@ -104,7 +194,7 @@ cpl <strong>n</strong> <em>&lt;type&gt;</em> <em>&lt;name&gt;</em> <br>
cpl <strong>N</strong> <em>&lt;type&gt;</em> <em>&lt;name&gt;</em></p> cpl <strong>N</strong> <em>&lt;type&gt;</em> <em>&lt;name&gt;</em></p>
</div> </div>
<div class="section" id="description"> <div class="section" id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2> <h2>Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>Generates a workspace and initial project or add a project to workspace.</p> <p>Generates a workspace and initial project or add a project to workspace.</p>
<p>If the command is running in a CPL workspace, it will add the new project to the workspace.</p> <p>If the command is running in a CPL workspace, it will add the new project to the workspace.</p>
<table class="colwidths-auto docutils align-default"> <table class="colwidths-auto docutils align-default">
@ -127,7 +217,7 @@ cpl <strong>N</strong> <em>&lt;type&gt;</em> <em>&lt;name&gt;</em></p>
</table> </table>
</div> </div>
<div class="section" id="project-types"> <div class="section" id="project-types">
<h2>Project types<a class="headerlink" href="#project-types" title="Permalink to this headline"></a></h2> <h2>Project types<a class="headerlink" href="#project-types" title="Permalink to this headline"></a></h2>
<table class="colwidths-auto docutils align-default"> <table class="colwidths-auto docutils align-default">
<thead> <thead>
<tr class="row-odd"><th class="head"><p>Project type</p></th> <tr class="row-odd"><th class="head"><p>Project type</p></th>
@ -148,33 +238,50 @@ cpl <strong>N</strong> <em>&lt;type&gt;</em> <em>&lt;name&gt;</em></p>
</div> </div>
</div> </div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> <footer>
<a href="cli.install.html" class="btn btn-neutral float-left" title="cpl install" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="cli.publish.html" class="btn btn-neutral float-right" title="cpl publish" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> <a href="cli.publish.html" class="btn btn-neutral float-right" title="cpl publish" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="cli.install.html" class="btn btn-neutral float-left" title="cpl install" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div> </div>
<hr/> <hr/>
<div role="contentinfo"> <div role="contentinfo">
<p>&#169; Copyright 2021, Sven Heidemann.</p> <p>
&#169; Copyright 2021, Sven Heidemann.
</p>
</div> </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>.
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> </footer>
</div> </div>
</div> </div>
</section> </section>
</div> </div>
<script>
<script type="text/javascript">
jQuery(function () { jQuery(function () {
SphinxRtdTheme.Navigation.enable(true); SphinxRtdTheme.Navigation.enable(true);
}); });
</script> </script>
</body> </body>
</html> </html>

View File

@ -1,20 +1,41 @@
<!DOCTYPE html> <!DOCTYPE html>
<html class="writer-html5" lang="en" > <html class="writer-html5" lang="en" >
<head> <head>
<meta charset="utf-8" /> <meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>CLI Overview and Command Reference &mdash; Common Python Library documentation</title> <title>CLI Overview and Command Reference &mdash; Common Python Library documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<!--[if lt IE 9]> <!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script> <script src="_static/js/html5shiv.min.js"></script>
<![endif]--> <![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script> <script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script> <script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script> <script src="_static/doctools.js"></script>
<script src="_static/js/theme.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" /> <link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" /> <link rel="search" title="Search" href="search.html" />
<link rel="next" title="cpl add" href="cli.add.html" /> <link rel="next" title="cpl add" href="cli.add.html" />
@ -22,12 +43,28 @@
</head> </head>
<body class="wy-body-for-nav"> <body class="wy-body-for-nav">
<div class="wy-grid-for-nav"> <div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side"> <nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll"> <div class="wy-side-scroll">
<div class="wy-side-nav-search" > <div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library <a href="index.html" class="icon icon-home"> Common Python Library
</a> </a>
<div role="search"> <div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get"> <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" /> <input type="text" name="q" placeholder="Search docs" />
@ -35,7 +72,18 @@
<input type="hidden" name="area" value="default" /> <input type="hidden" name="area" value="default" />
</form> </form>
</div> </div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current"> <ul class="current">
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li> <li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li> <li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
@ -69,35 +117,77 @@
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li> <li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li>
</ul> </ul>
</div> </div>
</div> </div>
</nav> </nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i> <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Common Python Library</a> <a href="index.html">Common Python Library</a>
</nav> </nav>
<div class="wy-nav-content"> <div class="wy-nav-content">
<div class="rst-content"> <div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs"> <ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li> <li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl_cli.html">CLI Reference</a> &raquo;</li> <li><a href="cpl_cli.html">CLI Reference</a> &raquo;</li>
<li>CLI Overview and Command Reference</li> <li>CLI Overview and Command Reference</li>
<li class="wy-breadcrumbs-aside"> <li class="wy-breadcrumbs-aside">
<a href="_sources/cli.overview.md.txt" rel="nofollow"> View page source</a> <a href="_sources/cli.overview.md.txt" rel="nofollow"> View page source</a>
</li> </li>
</ul> </ul>
<hr/> <hr/>
</div> </div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody"> <div itemprop="articleBody">
<div class="tex2jax_ignore mathjax_ignore section" id="cli-overview-and-command-reference"> <div class="section" id="cli-overview-and-command-reference">
<h1>CLI Overview and Command Reference<a class="headerlink" href="#cli-overview-and-command-reference" title="Permalink to this headline"></a></h1> <h1>CLI Overview and Command Reference<a class="headerlink" href="#cli-overview-and-command-reference" title="Permalink to this headline"></a></h1>
<div class="section" id="table-of-contents"> <div class="section" id="table-of-contents">
<h2>Table of Contents<a class="headerlink" href="#table-of-contents" title="Permalink to this headline"></a></h2> <h2>Table of Contents<a class="headerlink" href="#table-of-contents" title="Permalink to this headline"></a></h2>
<ol class="simple"> <ol class="simple">
<li><p><a class="reference external" href="setup#install-the-package">Install CPL</a></p></li> <li><p><a class="reference external" href="setup#install-the-package">Install CPL</a></p></li>
<li><p><a class="reference external" href="setup#install-the-cli">Install CPL CLI</a></p></li> <li><p><a class="reference external" href="setup#install-the-cli">Install CPL CLI</a></p></li>
@ -107,7 +197,7 @@
</ol> </ol>
</div> </div>
<div class="section" id="basic-workflow"> <div class="section" id="basic-workflow">
<h2>Basic workflow<a class="headerlink" href="#basic-workflow" title="Permalink to this headline"></a></h2> <h2>Basic workflow<a class="headerlink" href="#basic-workflow" title="Permalink to this headline"></a></h2>
<p>To create, build, and serve a new, basic CPL project on a development server, go to the parent directory of your new workspace use the following commands:</p> <p>To create, build, and serve a new, basic CPL project on a development server, go to the parent directory of your new workspace use the following commands:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>cpl new console my-first-project <div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>cpl new console my-first-project
<span class="nb">cd</span> my-first-project <span class="nb">cd</span> my-first-project
@ -117,23 +207,23 @@ cpl start
<p>In the terminal you will the output of the app.</p> <p>In the terminal you will the output of the app.</p>
</div> </div>
<div class="section" id="cli-command-language-syntax"> <div class="section" id="cli-command-language-syntax">
<h2>CLI command-language syntax<a class="headerlink" href="#cli-command-language-syntax" title="Permalink to this headline"></a></h2> <h2>CLI command-language syntax<a class="headerlink" href="#cli-command-language-syntax" title="Permalink to this headline"></a></h2>
<p><code class="docutils literal notranslate"><span class="pre">cpl</span></code> commandNameOrAlias requiredArg <code class="docutils literal notranslate"><span class="pre">[optionalsArgs]</span></code></p> <p><code class="docutils literal notranslate"><span class="pre">cpl</span></code> commandNameOrAlias requiredArg <code class="docutils literal notranslate"><span class="pre">[optionalsArgs]</span></code></p>
<ul class="simple"> <ul class="simple">
<li><p>Most commands, and some options, have aliases. Aliases are shown in the syntax statement for each command.</p></li> <li><p>Most commands, and some options, have aliases. Aliases are shown in the syntax statement for each command.</p></li>
<li><p>Arguments are not prefixed.</p></li> <li><p>Arguments are not prefixed.</p></li>
</ul> </ul>
<div class="section" id="relative-paths"> <div class="section" id="relative-paths">
<h3>Relative paths<a class="headerlink" href="#relative-paths" title="Permalink to this headline"></a></h3> <h3>Relative paths<a class="headerlink" href="#relative-paths" title="Permalink to this headline"></a></h3>
<p>Options that specify files can be given as absolute paths, or as paths relative to the current working directory, which is generally either the workspace or project root.</p> <p>Options that specify files can be given as absolute paths, or as paths relative to the current working directory, which is generally either the workspace or project root.</p>
</div> </div>
<div class="section" id="schematics"> <div class="section" id="schematics">
<h3>Schematics<a class="headerlink" href="#schematics" title="Permalink to this headline"></a></h3> <h3>Schematics<a class="headerlink" href="#schematics" title="Permalink to this headline"></a></h3>
<p>The cpl generate command takes as an argument the artifact to be generated. In addition to any general options, each artifact defines its own options in a schematic. Schematic options are supplied to the command in the same format as immediate command options.</p> <p>The cpl generate command takes as an argument the artifact to be generated. In addition to any general options, each artifact defines its own options in a schematic. Schematic options are supplied to the command in the same format as immediate command options.</p>
</div> </div>
</div> </div>
<div class="section" id="command-overview"> <div class="section" id="command-overview">
<h2>Command overview<a class="headerlink" href="#command-overview" title="Permalink to this headline"></a></h2> <h2>Command overview<a class="headerlink" href="#command-overview" title="Permalink to this headline"></a></h2>
<table class="colwidths-auto docutils align-default"> <table class="colwidths-auto docutils align-default">
<thead> <thead>
<tr class="row-odd"><th class="head"><p>Command</p></th> <tr class="row-odd"><th class="head"><p>Command</p></th>
@ -197,33 +287,50 @@ cpl start
</div> </div>
</div> </div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> <footer>
<a href="cpl_cli.html" class="btn btn-neutral float-left" title="CLI Reference" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="cli.add.html" class="btn btn-neutral float-right" title="cpl add" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> <a href="cli.add.html" class="btn btn-neutral float-right" title="cpl add" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="cpl_cli.html" class="btn btn-neutral float-left" title="CLI Reference" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div> </div>
<hr/> <hr/>
<div role="contentinfo"> <div role="contentinfo">
<p>&#169; Copyright 2021, Sven Heidemann.</p> <p>
&#169; Copyright 2021, Sven Heidemann.
</p>
</div> </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>.
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> </footer>
</div> </div>
</div> </div>
</section> </section>
</div> </div>
<script>
<script type="text/javascript">
jQuery(function () { jQuery(function () {
SphinxRtdTheme.Navigation.enable(true); SphinxRtdTheme.Navigation.enable(true);
}); });
</script> </script>
</body> </body>
</html> </html>

View File

@ -1,20 +1,41 @@
<!DOCTYPE html> <!DOCTYPE html>
<html class="writer-html5" lang="en" > <html class="writer-html5" lang="en" >
<head> <head>
<meta charset="utf-8" /> <meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>cpl publish &mdash; Common Python Library documentation</title> <title>cpl publish &mdash; Common Python Library documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<!--[if lt IE 9]> <!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script> <script src="_static/js/html5shiv.min.js"></script>
<![endif]--> <![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script> <script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script> <script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script> <script src="_static/doctools.js"></script>
<script src="_static/js/theme.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" /> <link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" /> <link rel="search" title="Search" href="search.html" />
<link rel="next" title="cpl remove" href="cli.remove.html" /> <link rel="next" title="cpl remove" href="cli.remove.html" />
@ -22,12 +43,28 @@
</head> </head>
<body class="wy-body-for-nav"> <body class="wy-body-for-nav">
<div class="wy-grid-for-nav"> <div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side"> <nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll"> <div class="wy-side-scroll">
<div class="wy-side-nav-search" > <div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library <a href="index.html" class="icon icon-home"> Common Python Library
</a> </a>
<div role="search"> <div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get"> <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" /> <input type="text" name="q" placeholder="Search docs" />
@ -35,7 +72,18 @@
<input type="hidden" name="area" value="default" /> <input type="hidden" name="area" value="default" />
</form> </form>
</div> </div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current"> <ul class="current">
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li> <li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li> <li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
@ -63,35 +111,77 @@
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li> <li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li>
</ul> </ul>
</div> </div>
</div> </div>
</nav> </nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i> <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Common Python Library</a> <a href="index.html">Common Python Library</a>
</nav> </nav>
<div class="wy-nav-content"> <div class="wy-nav-content">
<div class="rst-content"> <div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs"> <ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li> <li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl_cli.html">CLI Reference</a> &raquo;</li> <li><a href="cpl_cli.html">CLI Reference</a> &raquo;</li>
<li>cpl publish</li> <li>cpl publish</li>
<li class="wy-breadcrumbs-aside"> <li class="wy-breadcrumbs-aside">
<a href="_sources/cli.publish.md.txt" rel="nofollow"> View page source</a> <a href="_sources/cli.publish.md.txt" rel="nofollow"> View page source</a>
</li> </li>
</ul> </ul>
<hr/> <hr/>
</div> </div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody"> <div itemprop="articleBody">
<div class="tex2jax_ignore mathjax_ignore section" id="cpl-publish"> <div class="section" id="cpl-publish">
<h1>cpl publish<a class="headerlink" href="#cpl-publish" title="Permalink to this headline"></a></h1> <h1>cpl publish<a class="headerlink" href="#cpl-publish" title="Permalink to this headline"></a></h1>
<div class="section" id="contents"> <div class="section" id="contents">
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this headline"></a></h2> <h2>Contents<a class="headerlink" href="#contents" title="Permalink to this headline"></a></h2>
<ul class="simple"> <ul class="simple">
<li><p><a class="reference external" href="#description">Description</a></p></li> <li><p><a class="reference external" href="#description">Description</a></p></li>
</ul> </ul>
@ -102,7 +192,7 @@ cpl <strong>p</strong> <br>
cpl <strong>P</strong></p> cpl <strong>P</strong></p>
</div> </div>
<div class="section" id="description"> <div class="section" id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2> <h2>Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>The command can be used to publish a project of type “console” or “library”.</p> <p>The command can be used to publish a project of type “console” or “library”.</p>
<p>The publish command builds the source files and then creates an <code class="docutils literal notranslate"><span class="pre">setup.py</span></code> with data from <code class="docutils literal notranslate"><span class="pre">cpl_core.json</span></code>. <p>The publish command builds the source files and then creates an <code class="docutils literal notranslate"><span class="pre">setup.py</span></code> with data from <code class="docutils literal notranslate"><span class="pre">cpl_core.json</span></code>.
The command executes the <code class="docutils literal notranslate"><span class="pre">setup.py</span></code> and removes all source files with the <code class="docutils literal notranslate"><span class="pre">setup.py</span></code> from the publish/ directory.</p> The command executes the <code class="docutils literal notranslate"><span class="pre">setup.py</span></code> and removes all source files with the <code class="docutils literal notranslate"><span class="pre">setup.py</span></code> from the publish/ directory.</p>
@ -116,33 +206,50 @@ The command executes the <code class="docutils literal notranslate"><span class=
</div> </div>
</div> </div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> <footer>
<a href="cli.new.html" class="btn btn-neutral float-left" title="cpl new" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="cli.remove.html" class="btn btn-neutral float-right" title="cpl remove" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> <a href="cli.remove.html" class="btn btn-neutral float-right" title="cpl remove" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="cli.new.html" class="btn btn-neutral float-left" title="cpl new" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div> </div>
<hr/> <hr/>
<div role="contentinfo"> <div role="contentinfo">
<p>&#169; Copyright 2021, Sven Heidemann.</p> <p>
&#169; Copyright 2021, Sven Heidemann.
</p>
</div> </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>.
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> </footer>
</div> </div>
</div> </div>
</section> </section>
</div> </div>
<script>
<script type="text/javascript">
jQuery(function () { jQuery(function () {
SphinxRtdTheme.Navigation.enable(true); SphinxRtdTheme.Navigation.enable(true);
}); });
</script> </script>
</body> </body>
</html> </html>

View File

@ -1,20 +1,41 @@
<!DOCTYPE html> <!DOCTYPE html>
<html class="writer-html5" lang="en" > <html class="writer-html5" lang="en" >
<head> <head>
<meta charset="utf-8" /> <meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>cpl remove &mdash; Common Python Library documentation</title> <title>cpl remove &mdash; Common Python Library documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<!--[if lt IE 9]> <!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script> <script src="_static/js/html5shiv.min.js"></script>
<![endif]--> <![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script> <script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script> <script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script> <script src="_static/doctools.js"></script>
<script src="_static/js/theme.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" /> <link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" /> <link rel="search" title="Search" href="search.html" />
<link rel="next" title="cpl start" href="cli.start.html" /> <link rel="next" title="cpl start" href="cli.start.html" />
@ -22,12 +43,28 @@
</head> </head>
<body class="wy-body-for-nav"> <body class="wy-body-for-nav">
<div class="wy-grid-for-nav"> <div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side"> <nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll"> <div class="wy-side-scroll">
<div class="wy-side-nav-search" > <div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library <a href="index.html" class="icon icon-home"> Common Python Library
</a> </a>
<div role="search"> <div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get"> <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" /> <input type="text" name="q" placeholder="Search docs" />
@ -35,7 +72,18 @@
<input type="hidden" name="area" value="default" /> <input type="hidden" name="area" value="default" />
</form> </form>
</div> </div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current"> <ul class="current">
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li> <li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li> <li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
@ -64,35 +112,77 @@
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li> <li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li>
</ul> </ul>
</div> </div>
</div> </div>
</nav> </nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i> <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Common Python Library</a> <a href="index.html">Common Python Library</a>
</nav> </nav>
<div class="wy-nav-content"> <div class="wy-nav-content">
<div class="rst-content"> <div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs"> <ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li> <li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl_cli.html">CLI Reference</a> &raquo;</li> <li><a href="cpl_cli.html">CLI Reference</a> &raquo;</li>
<li>cpl remove</li> <li>cpl remove</li>
<li class="wy-breadcrumbs-aside"> <li class="wy-breadcrumbs-aside">
<a href="_sources/cli.remove.md.txt" rel="nofollow"> View page source</a> <a href="_sources/cli.remove.md.txt" rel="nofollow"> View page source</a>
</li> </li>
</ul> </ul>
<hr/> <hr/>
</div> </div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody"> <div itemprop="articleBody">
<div class="tex2jax_ignore mathjax_ignore section" id="cpl-remove"> <div class="section" id="cpl-remove">
<h1>cpl remove<a class="headerlink" href="#cpl-remove" title="Permalink to this headline"></a></h1> <h1>cpl remove<a class="headerlink" href="#cpl-remove" title="Permalink to this headline"></a></h1>
<div class="section" id="contents"> <div class="section" id="contents">
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this headline"></a></h2> <h2>Contents<a class="headerlink" href="#contents" title="Permalink to this headline"></a></h2>
<ul class="simple"> <ul class="simple">
<li><p><a class="reference external" href="#description">Description</a></p></li> <li><p><a class="reference external" href="#description">Description</a></p></li>
<li><p><a class="reference external" href="#arguments">Arguments</a></p></li> <li><p><a class="reference external" href="#arguments">Arguments</a></p></li>
@ -103,12 +193,12 @@ cpl <strong>r</strong> <em>&lt;project&gt;</em> <br>
cpl <strong>R</strong> <em>&lt;project&gt;</em></p> cpl <strong>R</strong> <em>&lt;project&gt;</em></p>
</div> </div>
<div class="section" id="description"> <div class="section" id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2> <h2>Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>Removes a project reference and the files from workspace.</p> <p>Removes a project reference and the files from workspace.</p>
<p>If you call the command in a CPL workspace, you can use the project names. Otherwise the paths of the projects must be specified.</p> <p>If you call the command in a CPL workspace, you can use the project names. Otherwise the paths of the projects must be specified.</p>
</div> </div>
<div class="section" id="arguments"> <div class="section" id="arguments">
<h2>Arguments<a class="headerlink" href="#arguments" title="Permalink to this headline"></a></h2> <h2>Arguments<a class="headerlink" href="#arguments" title="Permalink to this headline"></a></h2>
<table class="colwidths-auto docutils align-default"> <table class="colwidths-auto docutils align-default">
<thead> <thead>
<tr class="row-odd"><th class="head"><p>Argument</p></th> <tr class="row-odd"><th class="head"><p>Argument</p></th>
@ -128,33 +218,50 @@ cpl <strong>R</strong> <em>&lt;project&gt;</em></p>
</div> </div>
</div> </div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> <footer>
<a href="cli.publish.html" class="btn btn-neutral float-left" title="cpl publish" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="cli.start.html" class="btn btn-neutral float-right" title="cpl start" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> <a href="cli.start.html" class="btn btn-neutral float-right" title="cpl start" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="cli.publish.html" class="btn btn-neutral float-left" title="cpl publish" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div> </div>
<hr/> <hr/>
<div role="contentinfo"> <div role="contentinfo">
<p>&#169; Copyright 2021, Sven Heidemann.</p> <p>
&#169; Copyright 2021, Sven Heidemann.
</p>
</div> </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>.
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> </footer>
</div> </div>
</div> </div>
</section> </section>
</div> </div>
<script>
<script type="text/javascript">
jQuery(function () { jQuery(function () {
SphinxRtdTheme.Navigation.enable(true); SphinxRtdTheme.Navigation.enable(true);
}); });
</script> </script>
</body> </body>
</html> </html>

View File

@ -1,20 +1,41 @@
<!DOCTYPE html> <!DOCTYPE html>
<html class="writer-html5" lang="en" > <html class="writer-html5" lang="en" >
<head> <head>
<meta charset="utf-8" /> <meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>cpl start &mdash; Common Python Library documentation</title> <title>cpl start &mdash; Common Python Library documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<!--[if lt IE 9]> <!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script> <script src="_static/js/html5shiv.min.js"></script>
<![endif]--> <![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script> <script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script> <script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script> <script src="_static/doctools.js"></script>
<script src="_static/js/theme.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" /> <link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" /> <link rel="search" title="Search" href="search.html" />
<link rel="next" title="cpl uninstall" href="cli.uninstall.html" /> <link rel="next" title="cpl uninstall" href="cli.uninstall.html" />
@ -22,12 +43,28 @@
</head> </head>
<body class="wy-body-for-nav"> <body class="wy-body-for-nav">
<div class="wy-grid-for-nav"> <div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side"> <nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll"> <div class="wy-side-scroll">
<div class="wy-side-nav-search" > <div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library <a href="index.html" class="icon icon-home"> Common Python Library
</a> </a>
<div role="search"> <div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get"> <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" /> <input type="text" name="q" placeholder="Search docs" />
@ -35,7 +72,18 @@
<input type="hidden" name="area" value="default" /> <input type="hidden" name="area" value="default" />
</form> </form>
</div> </div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current"> <ul class="current">
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li> <li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li> <li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
@ -59,33 +107,75 @@
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li> <li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li>
</ul> </ul>
</div> </div>
</div> </div>
</nav> </nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i> <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Common Python Library</a> <a href="index.html">Common Python Library</a>
</nav> </nav>
<div class="wy-nav-content"> <div class="wy-nav-content">
<div class="rst-content"> <div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs"> <ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li> <li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl_cli.html">CLI Reference</a> &raquo;</li> <li><a href="cpl_cli.html">CLI Reference</a> &raquo;</li>
<li>cpl start</li> <li>cpl start</li>
<li class="wy-breadcrumbs-aside"> <li class="wy-breadcrumbs-aside">
<a href="_sources/cli.start.md.txt" rel="nofollow"> View page source</a> <a href="_sources/cli.start.md.txt" rel="nofollow"> View page source</a>
</li> </li>
</ul> </ul>
<hr/> <hr/>
</div> </div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody"> <div itemprop="articleBody">
<div class="tex2jax_ignore mathjax_ignore section" id="cpl-start"> <div class="section" id="cpl-start">
<h1>cpl start<a class="headerlink" href="#cpl-start" title="Permalink to this headline"></a></h1> <h1>cpl start<a class="headerlink" href="#cpl-start" title="Permalink to this headline"></a></h1>
<p>Starts your application, restarting on file changes.</p> <p>Starts your application, restarting on file changes.</p>
<p>cpl <strong>start</strong> <br> <p>cpl <strong>start</strong> <br>
cpl <strong>s</strong> <br> cpl <strong>s</strong> <br>
@ -94,33 +184,50 @@ cpl <strong>S</strong></p>
</div> </div>
</div> </div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> <footer>
<a href="cli.remove.html" class="btn btn-neutral float-left" title="cpl remove" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="cli.uninstall.html" class="btn btn-neutral float-right" title="cpl uninstall" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> <a href="cli.uninstall.html" class="btn btn-neutral float-right" title="cpl uninstall" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="cli.remove.html" class="btn btn-neutral float-left" title="cpl remove" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div> </div>
<hr/> <hr/>
<div role="contentinfo"> <div role="contentinfo">
<p>&#169; Copyright 2021, Sven Heidemann.</p> <p>
&#169; Copyright 2021, Sven Heidemann.
</p>
</div> </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>.
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> </footer>
</div> </div>
</div> </div>
</section> </section>
</div> </div>
<script>
<script type="text/javascript">
jQuery(function () { jQuery(function () {
SphinxRtdTheme.Navigation.enable(true); SphinxRtdTheme.Navigation.enable(true);
}); });
</script> </script>
</body> </body>
</html> </html>

View File

@ -1,20 +1,41 @@
<!DOCTYPE html> <!DOCTYPE html>
<html class="writer-html5" lang="en" > <html class="writer-html5" lang="en" >
<head> <head>
<meta charset="utf-8" /> <meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>cpl uninstall &mdash; Common Python Library documentation</title> <title>cpl uninstall &mdash; Common Python Library documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<!--[if lt IE 9]> <!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script> <script src="_static/js/html5shiv.min.js"></script>
<![endif]--> <![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script> <script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script> <script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script> <script src="_static/doctools.js"></script>
<script src="_static/js/theme.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" /> <link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" /> <link rel="search" title="Search" href="search.html" />
<link rel="next" title="cpl update" href="cli.update.html" /> <link rel="next" title="cpl update" href="cli.update.html" />
@ -22,12 +43,28 @@
</head> </head>
<body class="wy-body-for-nav"> <body class="wy-body-for-nav">
<div class="wy-grid-for-nav"> <div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side"> <nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll"> <div class="wy-side-scroll">
<div class="wy-side-nav-search" > <div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library <a href="index.html" class="icon icon-home"> Common Python Library
</a> </a>
<div role="search"> <div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get"> <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" /> <input type="text" name="q" placeholder="Search docs" />
@ -35,7 +72,18 @@
<input type="hidden" name="area" value="default" /> <input type="hidden" name="area" value="default" />
</form> </form>
</div> </div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current"> <ul class="current">
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li> <li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li> <li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
@ -64,35 +112,77 @@
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li> <li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li>
</ul> </ul>
</div> </div>
</div> </div>
</nav> </nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i> <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Common Python Library</a> <a href="index.html">Common Python Library</a>
</nav> </nav>
<div class="wy-nav-content"> <div class="wy-nav-content">
<div class="rst-content"> <div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs"> <ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li> <li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl_cli.html">CLI Reference</a> &raquo;</li> <li><a href="cpl_cli.html">CLI Reference</a> &raquo;</li>
<li>cpl uninstall</li> <li>cpl uninstall</li>
<li class="wy-breadcrumbs-aside"> <li class="wy-breadcrumbs-aside">
<a href="_sources/cli.uninstall.md.txt" rel="nofollow"> View page source</a> <a href="_sources/cli.uninstall.md.txt" rel="nofollow"> View page source</a>
</li> </li>
</ul> </ul>
<hr/> <hr/>
</div> </div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody"> <div itemprop="articleBody">
<div class="tex2jax_ignore mathjax_ignore section" id="cpl-uninstall"> <div class="section" id="cpl-uninstall">
<h1>cpl uninstall<a class="headerlink" href="#cpl-uninstall" title="Permalink to this headline"></a></h1> <h1>cpl uninstall<a class="headerlink" href="#cpl-uninstall" title="Permalink to this headline"></a></h1>
<div class="section" id="contents"> <div class="section" id="contents">
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this headline"></a></h2> <h2>Contents<a class="headerlink" href="#contents" title="Permalink to this headline"></a></h2>
<ul class="simple"> <ul class="simple">
<li><p><a class="reference external" href="#description">Description</a></p></li> <li><p><a class="reference external" href="#description">Description</a></p></li>
<li><p><a class="reference external" href="#arguments">Arguments</a></p></li> <li><p><a class="reference external" href="#arguments">Arguments</a></p></li>
@ -103,11 +193,11 @@ cpl <strong>ui</strong> <em>&lt;package&gt;</em> <br>
cpl <strong>UI</strong> <em>&lt;package&gt;</em></p> cpl <strong>UI</strong> <em>&lt;package&gt;</em></p>
</div> </div>
<div class="section" id="description"> <div class="section" id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2> <h2>Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>Uninstall given package from project via pip.</p> <p>Uninstall given package from project via pip.</p>
</div> </div>
<div class="section" id="arguments"> <div class="section" id="arguments">
<h2>Arguments<a class="headerlink" href="#arguments" title="Permalink to this headline"></a></h2> <h2>Arguments<a class="headerlink" href="#arguments" title="Permalink to this headline"></a></h2>
<table class="colwidths-auto docutils align-default"> <table class="colwidths-auto docutils align-default">
<thead> <thead>
<tr class="row-odd"><th class="head"><p>Argument</p></th> <tr class="row-odd"><th class="head"><p>Argument</p></th>
@ -127,33 +217,50 @@ cpl <strong>UI</strong> <em>&lt;package&gt;</em></p>
</div> </div>
</div> </div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> <footer>
<a href="cli.start.html" class="btn btn-neutral float-left" title="cpl start" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="cli.update.html" class="btn btn-neutral float-right" title="cpl update" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> <a href="cli.update.html" class="btn btn-neutral float-right" title="cpl update" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="cli.start.html" class="btn btn-neutral float-left" title="cpl start" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div> </div>
<hr/> <hr/>
<div role="contentinfo"> <div role="contentinfo">
<p>&#169; Copyright 2021, Sven Heidemann.</p> <p>
&#169; Copyright 2021, Sven Heidemann.
</p>
</div> </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>.
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> </footer>
</div> </div>
</div> </div>
</section> </section>
</div> </div>
<script>
<script type="text/javascript">
jQuery(function () { jQuery(function () {
SphinxRtdTheme.Navigation.enable(true); SphinxRtdTheme.Navigation.enable(true);
}); });
</script> </script>
</body> </body>
</html> </html>

View File

@ -1,20 +1,41 @@
<!DOCTYPE html> <!DOCTYPE html>
<html class="writer-html5" lang="en" > <html class="writer-html5" lang="en" >
<head> <head>
<meta charset="utf-8" /> <meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>cpl update &mdash; Common Python Library documentation</title> <title>cpl update &mdash; Common Python Library documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<!--[if lt IE 9]> <!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script> <script src="_static/js/html5shiv.min.js"></script>
<![endif]--> <![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script> <script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script> <script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script> <script src="_static/doctools.js"></script>
<script src="_static/js/theme.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" /> <link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" /> <link rel="search" title="Search" href="search.html" />
<link rel="next" title="cpl version" href="cli.version.html" /> <link rel="next" title="cpl version" href="cli.version.html" />
@ -22,12 +43,28 @@
</head> </head>
<body class="wy-body-for-nav"> <body class="wy-body-for-nav">
<div class="wy-grid-for-nav"> <div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side"> <nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll"> <div class="wy-side-scroll">
<div class="wy-side-nav-search" > <div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library <a href="index.html" class="icon icon-home"> Common Python Library
</a> </a>
<div role="search"> <div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get"> <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" /> <input type="text" name="q" placeholder="Search docs" />
@ -35,7 +72,18 @@
<input type="hidden" name="area" value="default" /> <input type="hidden" name="area" value="default" />
</form> </form>
</div> </div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current"> <ul class="current">
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li> <li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li> <li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
@ -59,33 +107,75 @@
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li> <li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li>
</ul> </ul>
</div> </div>
</div> </div>
</nav> </nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i> <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Common Python Library</a> <a href="index.html">Common Python Library</a>
</nav> </nav>
<div class="wy-nav-content"> <div class="wy-nav-content">
<div class="rst-content"> <div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs"> <ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li> <li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl_cli.html">CLI Reference</a> &raquo;</li> <li><a href="cpl_cli.html">CLI Reference</a> &raquo;</li>
<li>cpl update</li> <li>cpl update</li>
<li class="wy-breadcrumbs-aside"> <li class="wy-breadcrumbs-aside">
<a href="_sources/cli.update.md.txt" rel="nofollow"> View page source</a> <a href="_sources/cli.update.md.txt" rel="nofollow"> View page source</a>
</li> </li>
</ul> </ul>
<hr/> <hr/>
</div> </div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody"> <div itemprop="articleBody">
<div class="tex2jax_ignore mathjax_ignore section" id="cpl-update"> <div class="section" id="cpl-update">
<h1>cpl update<a class="headerlink" href="#cpl-update" title="Permalink to this headline"></a></h1> <h1>cpl update<a class="headerlink" href="#cpl-update" title="Permalink to this headline"></a></h1>
<p>Updates the CPL and project dependencies.</p> <p>Updates the CPL and project dependencies.</p>
<p>cpl <strong>update</strong> <br> <p>cpl <strong>update</strong> <br>
cpl <strong>u</strong> <br> cpl <strong>u</strong> <br>
@ -94,33 +184,50 @@ cpl <strong>U</strong></p>
</div> </div>
</div> </div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> <footer>
<a href="cli.uninstall.html" class="btn btn-neutral float-left" title="cpl uninstall" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="cli.version.html" class="btn btn-neutral float-right" title="cpl version" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> <a href="cli.version.html" class="btn btn-neutral float-right" title="cpl version" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="cli.uninstall.html" class="btn btn-neutral float-left" title="cpl uninstall" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div> </div>
<hr/> <hr/>
<div role="contentinfo"> <div role="contentinfo">
<p>&#169; Copyright 2021, Sven Heidemann.</p> <p>
&#169; Copyright 2021, Sven Heidemann.
</p>
</div> </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>.
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> </footer>
</div> </div>
</div> </div>
</section> </section>
</div> </div>
<script>
<script type="text/javascript">
jQuery(function () { jQuery(function () {
SphinxRtdTheme.Navigation.enable(true); SphinxRtdTheme.Navigation.enable(true);
}); });
</script> </script>
</body> </body>
</html> </html>

View File

@ -1,20 +1,41 @@
<!DOCTYPE html> <!DOCTYPE html>
<html class="writer-html5" lang="en" > <html class="writer-html5" lang="en" >
<head> <head>
<meta charset="utf-8" /> <meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>cpl version &mdash; Common Python Library documentation</title> <title>cpl version &mdash; Common Python Library documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<!--[if lt IE 9]> <!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script> <script src="_static/js/html5shiv.min.js"></script>
<![endif]--> <![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script> <script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script> <script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script> <script src="_static/doctools.js"></script>
<script src="_static/js/theme.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" /> <link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" /> <link rel="search" title="Search" href="search.html" />
<link rel="next" title="API Reference" href="cpl_core.html" /> <link rel="next" title="API Reference" href="cpl_core.html" />
@ -22,12 +43,28 @@
</head> </head>
<body class="wy-body-for-nav"> <body class="wy-body-for-nav">
<div class="wy-grid-for-nav"> <div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side"> <nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll"> <div class="wy-side-scroll">
<div class="wy-side-nav-search" > <div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library <a href="index.html" class="icon icon-home"> Common Python Library
</a> </a>
<div role="search"> <div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get"> <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" /> <input type="text" name="q" placeholder="Search docs" />
@ -35,7 +72,18 @@
<input type="hidden" name="area" value="default" /> <input type="hidden" name="area" value="default" />
</form> </form>
</div> </div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current"> <ul class="current">
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li> <li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li> <li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
@ -59,33 +107,75 @@
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li> <li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li>
</ul> </ul>
</div> </div>
</div> </div>
</nav> </nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i> <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Common Python Library</a> <a href="index.html">Common Python Library</a>
</nav> </nav>
<div class="wy-nav-content"> <div class="wy-nav-content">
<div class="rst-content"> <div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs"> <ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li> <li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl_cli.html">CLI Reference</a> &raquo;</li> <li><a href="cpl_cli.html">CLI Reference</a> &raquo;</li>
<li>cpl version</li> <li>cpl version</li>
<li class="wy-breadcrumbs-aside"> <li class="wy-breadcrumbs-aside">
<a href="_sources/cli.version.md.txt" rel="nofollow"> View page source</a> <a href="_sources/cli.version.md.txt" rel="nofollow"> View page source</a>
</li> </li>
</ul> </ul>
<hr/> <hr/>
</div> </div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody"> <div itemprop="articleBody">
<div class="tex2jax_ignore mathjax_ignore section" id="cpl-version"> <div class="section" id="cpl-version">
<h1>cpl version<a class="headerlink" href="#cpl-version" title="Permalink to this headline"></a></h1> <h1>cpl version<a class="headerlink" href="#cpl-version" title="Permalink to this headline"></a></h1>
<p>Lists the version of CPL, CPL CLI and all installed packages from pip.</p> <p>Lists the version of CPL, CPL CLI and all installed packages from pip.</p>
<p>cpl <strong>version</strong> <br> <p>cpl <strong>version</strong> <br>
cpl <strong>v</strong> <br> cpl <strong>v</strong> <br>
@ -94,33 +184,50 @@ cpl <strong>V</strong></p>
</div> </div>
</div> </div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> <footer>
<a href="cli.update.html" class="btn btn-neutral float-left" title="cpl update" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="cpl_core.html" class="btn btn-neutral float-right" title="API Reference" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> <a href="cpl_core.html" class="btn btn-neutral float-right" title="API Reference" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="cli.update.html" class="btn btn-neutral float-left" title="cpl update" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div> </div>
<hr/> <hr/>
<div role="contentinfo"> <div role="contentinfo">
<p>&#169; Copyright 2021, Sven Heidemann.</p> <p>
&#169; Copyright 2021, Sven Heidemann.
</p>
</div> </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>.
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> </footer>
</div> </div>
</div> </div>
</section> </section>
</div> </div>
<script>
<script type="text/javascript">
jQuery(function () { jQuery(function () {
SphinxRtdTheme.Navigation.enable(true); SphinxRtdTheme.Navigation.enable(true);
}); });
</script> </script>
</body> </body>
</html> </html>

View File

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

View File

@ -1,20 +1,41 @@
<!DOCTYPE html> <!DOCTYPE html>
<html class="writer-html5" lang="en" > <html class="writer-html5" lang="en" >
<head> <head>
<meta charset="utf-8" /> <meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>CLI Reference &mdash; Common Python Library documentation</title> <title>CLI Reference &mdash; Common Python Library documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<!--[if lt IE 9]> <!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script> <script src="_static/js/html5shiv.min.js"></script>
<![endif]--> <![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script> <script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script> <script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script> <script src="_static/doctools.js"></script>
<script src="_static/js/theme.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" /> <link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" /> <link rel="search" title="Search" href="search.html" />
<link rel="next" title="CLI Overview and Command Reference" href="cli.overview.html" /> <link rel="next" title="CLI Overview and Command Reference" href="cli.overview.html" />
@ -22,12 +43,28 @@
</head> </head>
<body class="wy-body-for-nav"> <body class="wy-body-for-nav">
<div class="wy-grid-for-nav"> <div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side"> <nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll"> <div class="wy-side-scroll">
<div class="wy-side-nav-search" > <div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library <a href="index.html" class="icon icon-home"> Common Python Library
</a> </a>
<div role="search"> <div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get"> <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" /> <input type="text" name="q" placeholder="Search docs" />
@ -35,7 +72,18 @@
<input type="hidden" name="area" value="default" /> <input type="hidden" name="area" value="default" />
</form> </form>
</div> </div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current"> <ul class="current">
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li> <li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li> <li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
@ -59,32 +107,73 @@
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li> <li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li>
</ul> </ul>
</div> </div>
</div> </div>
</nav> </nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i> <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Common Python Library</a> <a href="index.html">Common Python Library</a>
</nav> </nav>
<div class="wy-nav-content"> <div class="wy-nav-content">
<div class="rst-content"> <div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs"> <ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li> <li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li>CLI Reference</li> <li>CLI Reference</li>
<li class="wy-breadcrumbs-aside"> <li class="wy-breadcrumbs-aside">
<a href="_sources/cpl_cli.rst.txt" rel="nofollow"> View page source</a> <a href="_sources/cpl_cli.rst.txt" rel="nofollow"> View page source</a>
</li> </li>
</ul> </ul>
<hr/> <hr/>
</div> </div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody"> <div itemprop="articleBody">
<div class="section" id="cli-reference"> <div class="section" id="cli-reference">
<h1>CLI Reference<a class="headerlink" href="#cli-reference" title="Permalink to this headline"></a></h1> <h1>CLI Reference<a class="headerlink" href="#cli-reference" title="Permalink to this headline"></a></h1>
<div class="toctree-wrapper compound"> <div class="toctree-wrapper compound">
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a><ul> <li class="toctree-l1"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a><ul>
@ -159,33 +248,50 @@
</div> </div>
</div> </div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> <footer>
<a href="setup.html" class="btn btn-neutral float-left" title="Setting up the local environment and workspace" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="cli.overview.html" class="btn btn-neutral float-right" title="CLI Overview and Command Reference" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> <a href="cli.overview.html" class="btn btn-neutral float-right" title="CLI Overview and Command Reference" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="setup.html" class="btn btn-neutral float-left" title="Setting up the local environment and workspace" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div> </div>
<hr/> <hr/>
<div role="contentinfo"> <div role="contentinfo">
<p>&#169; Copyright 2021, Sven Heidemann.</p> <p>
&#169; Copyright 2021, Sven Heidemann.
</p>
</div> </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>.
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> </footer>
</div> </div>
</div> </div>
</section> </section>
</div> </div>
<script>
<script type="text/javascript">
jQuery(function () { jQuery(function () {
SphinxRtdTheme.Navigation.enable(true); SphinxRtdTheme.Navigation.enable(true);
}); });
</script> </script>
</body> </body>
</html> </html>

View File

@ -1,20 +1,41 @@
<!DOCTYPE html> <!DOCTYPE html>
<html class="writer-html5" lang="en" > <html class="writer-html5" lang="en" >
<head> <head>
<meta charset="utf-8" /> <meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>cpl_core.application &mdash; Common Python Library documentation</title> <title>cpl_core.application &mdash; Common Python Library documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<!--[if lt IE 9]> <!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script> <script src="_static/js/html5shiv.min.js"></script>
<![endif]--> <![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script> <script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script> <script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script> <script src="_static/doctools.js"></script>
<script src="_static/js/theme.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" /> <link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" /> <link rel="search" title="Search" href="search.html" />
<link rel="next" title="cpl_core.configuration" href="cpl_core.configuration.html" /> <link rel="next" title="cpl_core.configuration" href="cpl_core.configuration.html" />
@ -22,12 +43,28 @@
</head> </head>
<body class="wy-body-for-nav"> <body class="wy-body-for-nav">
<div class="wy-grid-for-nav"> <div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side"> <nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll"> <div class="wy-side-scroll">
<div class="wy-side-nav-search" > <div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library <a href="index.html" class="icon icon-home"> Common Python Library
</a> </a>
<div role="search"> <div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get"> <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" /> <input type="text" name="q" placeholder="Search docs" />
@ -35,7 +72,18 @@
<input type="hidden" name="area" value="default" /> <input type="hidden" name="area" value="default" />
</form> </form>
</div> </div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current"> <ul class="current">
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li> <li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li> <li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
@ -62,38 +110,80 @@
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li> <li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li>
</ul> </ul>
</div> </div>
</div> </div>
</nav> </nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i> <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Common Python Library</a> <a href="index.html">Common Python Library</a>
</nav> </nav>
<div class="wy-nav-content"> <div class="wy-nav-content">
<div class="rst-content"> <div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs"> <ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li> <li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl_core.html">API Reference</a> &raquo;</li> <li><a href="cpl_core.html">API Reference</a> &raquo;</li>
<li>cpl_core.application</li> <li>cpl_core.application</li>
<li class="wy-breadcrumbs-aside"> <li class="wy-breadcrumbs-aside">
<a href="_sources/cpl_core.application.rst.txt" rel="nofollow"> View page source</a> <a href="_sources/cpl_core.application.rst.txt" rel="nofollow"> View page source</a>
</li> </li>
</ul> </ul>
<hr/> <hr/>
</div> </div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody"> <div itemprop="articleBody">
<div class="section" id="cpl-core-application"> <div class="section" id="cpl-core-application">
<h1>cpl_core.application<a class="headerlink" href="#cpl-core-application" title="Permalink to this headline"></a></h1> <h1>cpl_core.application<a class="headerlink" href="#cpl-core-application" title="Permalink to this headline"></a></h1>
<div class="section" id="module-cpl_core.application.application_abc"> <div class="section" id="module-cpl_core.application.application_abc">
<span id="cpl-core-application-application-abc"></span><h2>cpl_core.application.application_abc<a class="headerlink" href="#module-cpl_core.application.application_abc" title="Permalink to this headline"></a></h2> <span id="cpl-core-application-application-abc"></span><h2>cpl_core.application.application_abc<a class="headerlink" href="#module-cpl_core.application.application_abc" title="Permalink to this headline"></a></h2>
<dl class="py class"> <dl class="py class">
<dt class="sig sig-object py" id="cpl_core.application.application_abc.ApplicationABC"> <dt id="cpl_core.application.application_abc.ApplicationABC">
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">cpl_core.application.application_abc.</span></span><span class="sig-name descname"><span class="pre">ApplicationABC</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_abc.ConfigurationABC" title="cpl_core.configuration.configuration_abc.ConfigurationABC"><span class="pre">cpl_core.configuration.configuration_abc.ConfigurationABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">services</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC"><span class="pre">cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.application.application_abc.ApplicationABC" title="Permalink to this definition"></a></dt> <em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_core.application.application_abc.</span></code><code class="sig-name descname"><span class="pre">ApplicationABC</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_abc.ConfigurationABC" title="cpl_core.configuration.configuration_abc.ConfigurationABC"><span class="pre">cpl_core.configuration.configuration_abc.ConfigurationABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">services</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC"><span class="pre">cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.application.application_abc.ApplicationABC" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">abc.ABC</span></code></p> <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> <p>ABC for the Application class</p>
<blockquote> <blockquote>
@ -105,22 +195,29 @@
</dl> </dl>
</div></blockquote> </div></blockquote>
<dl class="py method"> <dl class="py method">
<dt class="sig sig-object py" id="cpl_core.application.application_abc.ApplicationABC.configure"> <dt id="cpl_core.application.application_abc.ApplicationABC.configure">
<em class="property"><span class="pre">abstract</span> </em><span class="sig-name descname"><span class="pre">configure</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.application.application_abc.ApplicationABC.configure" title="Permalink to this definition"></a></dt> <em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">configure</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.application.application_abc.ApplicationABC.configure" title="Permalink to this definition"></a></dt>
<dd><p>Configure the application</p> <dd><p>Configure the application</p>
<p>Called by <a class="reference internal" href="#cpl_core.application.application_abc.ApplicationABC.run" title="cpl_core.application.application_abc.ApplicationABC.run"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.application.application_abc.ApplicationABC.run</span></code></a></p> <p>Called by <a class="reference internal" href="#cpl_core.application.application_abc.ApplicationABC.run" title="cpl_core.application.application_abc.ApplicationABC.run"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.application.application_abc.ApplicationABC.run</span></code></a></p>
</dd></dl> </dd></dl>
<dl class="py method"> <dl class="py method">
<dt class="sig sig-object py" id="cpl_core.application.application_abc.ApplicationABC.main"> <dt id="cpl_core.application.application_abc.ApplicationABC.main">
<em class="property"><span class="pre">abstract</span> </em><span class="sig-name descname"><span class="pre">main</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.application.application_abc.ApplicationABC.main" title="Permalink to this definition"></a></dt> <em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">main</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.application.application_abc.ApplicationABC.main" title="Permalink to this definition"></a></dt>
<dd><p>Custom entry point</p> <dd><p>Custom entry point</p>
<p>Called by <a class="reference internal" href="#cpl_core.application.application_abc.ApplicationABC.run" title="cpl_core.application.application_abc.ApplicationABC.run"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.application.application_abc.ApplicationABC.run</span></code></a></p> <p>Called by <a class="reference internal" href="#cpl_core.application.application_abc.ApplicationABC.run" title="cpl_core.application.application_abc.ApplicationABC.run"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.application.application_abc.ApplicationABC.run</span></code></a></p>
</dd></dl> </dd></dl>
<dl class="py method"> <dl class="py method">
<dt class="sig sig-object py" id="cpl_core.application.application_abc.ApplicationABC.run"> <dt id="cpl_core.application.application_abc.ApplicationABC.run">
<span class="sig-name descname"><span class="pre">run</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.application.application_abc.ApplicationABC.run" title="Permalink to this definition"></a></dt> <code class="sig-name descname"><span class="pre">run</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.application.application_abc.ApplicationABC.run" title="Permalink to this definition"></a></dt>
<dd><p>Entry point</p>
<p>Called by custom Application.main</p>
</dd></dl>
<dl class="py method">
<dt id="cpl_core.application.application_abc.ApplicationABC.run_async">
<em class="property"><span class="pre">async</span> </em><code class="sig-name descname"><span class="pre">run_async</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.application.application_abc.ApplicationABC.run_async" title="Permalink to this definition"></a></dt>
<dd><p>Entry point</p> <dd><p>Entry point</p>
<p>Called by custom Application.main</p> <p>Called by custom Application.main</p>
</dd></dl> </dd></dl>
@ -129,10 +226,10 @@
</div> </div>
<div class="section" id="module-cpl_core.application.application_builder"> <div class="section" id="module-cpl_core.application.application_builder">
<span id="cpl-core-application-application-builder"></span><h2>cpl_core.application.application_builder<a class="headerlink" href="#module-cpl_core.application.application_builder" title="Permalink to this headline"></a></h2> <span id="cpl-core-application-application-builder"></span><h2>cpl_core.application.application_builder<a class="headerlink" href="#module-cpl_core.application.application_builder" title="Permalink to this headline"></a></h2>
<dl class="py class"> <dl class="py class">
<dt class="sig sig-object py" id="cpl_core.application.application_builder.ApplicationBuilder"> <dt id="cpl_core.application.application_builder.ApplicationBuilder">
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">cpl_core.application.application_builder.</span></span><span class="sig-name descname"><span class="pre">ApplicationBuilder</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">app</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cpl_core.application.application_abc.ApplicationABC" title="cpl_core.application.application_abc.ApplicationABC"><span class="pre">cpl_core.application.application_abc.ApplicationABC</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.application.application_builder.ApplicationBuilder" title="Permalink to this definition"></a></dt> <em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_core.application.application_builder.</span></code><code class="sig-name descname"><span class="pre">ApplicationBuilder</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">app</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cpl_core.application.application_abc.ApplicationABC" title="cpl_core.application.application_abc.ApplicationABC"><span class="pre">cpl_core.application.application_abc.ApplicationABC</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.application.application_builder.ApplicationBuilder" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#cpl_core.application.application_builder_abc.ApplicationBuilderABC" title="cpl_core.application.application_builder_abc.ApplicationBuilderABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.application.application_builder_abc.ApplicationBuilderABC</span></code></a></p> <dd><p>Bases: <a class="reference internal" href="#cpl_core.application.application_builder_abc.ApplicationBuilderABC" title="cpl_core.application.application_builder_abc.ApplicationBuilderABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.application.application_builder_abc.ApplicationBuilderABC</span></code></a></p>
<p>This is class is used to build a object of <a class="reference internal" href="#cpl_core.application.application_abc.ApplicationABC" title="cpl_core.application.application_abc.ApplicationABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.application.application_abc.ApplicationABC</span></code></a></p> <p>This is class is used to build a object of <a class="reference internal" href="#cpl_core.application.application_abc.ApplicationABC" title="cpl_core.application.application_abc.ApplicationABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.application.application_abc.ApplicationABC</span></code></a></p>
<blockquote> <blockquote>
@ -142,8 +239,8 @@
</dl> </dl>
</div></blockquote> </div></blockquote>
<dl class="py method"> <dl class="py method">
<dt class="sig sig-object py" id="cpl_core.application.application_builder.ApplicationBuilder.build"> <dt id="cpl_core.application.application_builder.ApplicationBuilder.build">
<span class="sig-name descname"><span class="pre">build</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_core.application.application_abc.ApplicationABC" title="cpl_core.application.application_abc.ApplicationABC"><span class="pre">cpl_core.application.application_abc.ApplicationABC</span></a></span></span><a class="headerlink" href="#cpl_core.application.application_builder.ApplicationBuilder.build" title="Permalink to this definition"></a></dt> <code class="sig-name descname"><span class="pre">build</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span> &#x2192; <a class="reference internal" href="#cpl_core.application.application_abc.ApplicationABC" title="cpl_core.application.application_abc.ApplicationABC"><span class="pre">cpl_core.application.application_abc.ApplicationABC</span></a><a class="headerlink" href="#cpl_core.application.application_builder.ApplicationBuilder.build" title="Permalink to this definition"></a></dt>
<dd><p>Creates custom application object</p> <dd><p>Creates custom application object</p>
<blockquote> <blockquote>
<div><p>Object of <a class="reference internal" href="#cpl_core.application.application_abc.ApplicationABC" title="cpl_core.application.application_abc.ApplicationABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.application.application_abc.ApplicationABC</span></code></a></p> <div><p>Object of <a class="reference internal" href="#cpl_core.application.application_abc.ApplicationABC" title="cpl_core.application.application_abc.ApplicationABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.application.application_abc.ApplicationABC</span></code></a></p>
@ -151,14 +248,23 @@
</dd></dl> </dd></dl>
<dl class="py method"> <dl class="py method">
<dt class="sig sig-object py" id="cpl_core.application.application_builder.ApplicationBuilder.use_extension"> <dt id="cpl_core.application.application_builder.ApplicationBuilder.build_async">
<span class="sig-name descname"><span class="pre">use_extension</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">extension</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><span class="pre">cpl_core.application.application_extension_abc.ApplicationExtensionABC</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.application.application_builder.ApplicationBuilder.use_extension" title="Permalink to this definition"></a></dt> <em class="property"><span class="pre">async</span> </em><code class="sig-name descname"><span class="pre">build_async</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span> &#x2192; <a class="reference internal" href="#cpl_core.application.application_abc.ApplicationABC" title="cpl_core.application.application_abc.ApplicationABC"><span class="pre">cpl_core.application.application_abc.ApplicationABC</span></a><a class="headerlink" href="#cpl_core.application.application_builder.ApplicationBuilder.build_async" title="Permalink to this definition"></a></dt>
<dd><p>Creates custom application object async</p>
<blockquote>
<div><p>Object of <a class="reference internal" href="#cpl_core.application.application_abc.ApplicationABC" title="cpl_core.application.application_abc.ApplicationABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.application.application_abc.ApplicationABC</span></code></a></p>
</div></blockquote>
</dd></dl>
<dl class="py method">
<dt id="cpl_core.application.application_builder.ApplicationBuilder.use_extension">
<code class="sig-name descname"><span class="pre">use_extension</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">extension</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><span class="pre">cpl_core.application.application_extension_abc.ApplicationExtensionABC</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.application.application_builder.ApplicationBuilder.use_extension" title="Permalink to this definition"></a></dt>
<dd></dd></dl> <dd></dd></dl>
<dl class="py method"> <dl class="py method">
<dt class="sig sig-object py" id="cpl_core.application.application_builder.ApplicationBuilder.use_startup"> <dt id="cpl_core.application.application_builder.ApplicationBuilder.use_startup">
<span class="sig-name descname"><span class="pre">use_startup</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">startup</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cpl_core.application.startup_abc.StartupABC" title="cpl_core.application.startup_abc.StartupABC"><span class="pre">cpl_core.application.startup_abc.StartupABC</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.application.application_builder.ApplicationBuilder.use_startup" title="Permalink to this definition"></a></dt> <code class="sig-name descname"><span class="pre">use_startup</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">startup</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cpl_core.application.startup_abc.StartupABC" title="cpl_core.application.startup_abc.StartupABC"><span class="pre">cpl_core.application.startup_abc.StartupABC</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.application.application_builder.ApplicationBuilder.use_startup" title="Permalink to this definition"></a></dt>
<dd><p>Sets the custom startup class to use</p> <dd><p>Sets the custom startup class to use async</p>
<blockquote> <blockquote>
<div><dl class="simple"> <div><dl class="simple">
<dt>startup: Type[<a class="reference internal" href="#cpl_core.application.startup_abc.StartupABC" title="cpl_core.application.startup_abc.StartupABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.application.startup_abc.StartupABC</span></code></a>]</dt><dd><p>Startup class to use</p> <dt>startup: Type[<a class="reference internal" href="#cpl_core.application.startup_abc.StartupABC" title="cpl_core.application.startup_abc.StartupABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.application.startup_abc.StartupABC</span></code></a>]</dt><dd><p>Startup class to use</p>
@ -171,15 +277,15 @@
</div> </div>
<div class="section" id="module-cpl_core.application.application_builder_abc"> <div class="section" id="module-cpl_core.application.application_builder_abc">
<span id="cpl-core-application-application-builder-abc"></span><h2>cpl_core.application.application_builder_abc<a class="headerlink" href="#module-cpl_core.application.application_builder_abc" title="Permalink to this headline"></a></h2> <span id="cpl-core-application-application-builder-abc"></span><h2>cpl_core.application.application_builder_abc<a class="headerlink" href="#module-cpl_core.application.application_builder_abc" title="Permalink to this headline"></a></h2>
<dl class="py class"> <dl class="py class">
<dt class="sig sig-object py" id="cpl_core.application.application_builder_abc.ApplicationBuilderABC"> <dt id="cpl_core.application.application_builder_abc.ApplicationBuilderABC">
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">cpl_core.application.application_builder_abc.</span></span><span class="sig-name descname"><span class="pre">ApplicationBuilderABC</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.application.application_builder_abc.ApplicationBuilderABC" title="Permalink to this definition"></a></dt> <em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_core.application.application_builder_abc.</span></code><code class="sig-name descname"><span class="pre">ApplicationBuilderABC</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.application.application_builder_abc.ApplicationBuilderABC" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">abc.ABC</span></code></p> <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">abc.ABC</span></code></p>
<p>ABC for the <a class="reference internal" href="#cpl_core.application.application_builder.ApplicationBuilder" title="cpl_core.application.application_builder.ApplicationBuilder"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.application.application_builder.ApplicationBuilder</span></code></a></p> <p>ABC for the <a class="reference internal" href="#cpl_core.application.application_builder.ApplicationBuilder" title="cpl_core.application.application_builder.ApplicationBuilder"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.application.application_builder.ApplicationBuilder</span></code></a></p>
<dl class="py method"> <dl class="py method">
<dt class="sig sig-object py" id="cpl_core.application.application_builder_abc.ApplicationBuilderABC.build"> <dt id="cpl_core.application.application_builder_abc.ApplicationBuilderABC.build">
<em class="property"><span class="pre">abstract</span> </em><span class="sig-name descname"><span class="pre">build</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_core.application.application_abc.ApplicationABC" title="cpl_core.application.application_abc.ApplicationABC"><span class="pre">cpl_core.application.application_abc.ApplicationABC</span></a></span></span><a class="headerlink" href="#cpl_core.application.application_builder_abc.ApplicationBuilderABC.build" title="Permalink to this definition"></a></dt> <em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">build</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span> &#x2192; <a class="reference internal" href="#cpl_core.application.application_abc.ApplicationABC" title="cpl_core.application.application_abc.ApplicationABC"><span class="pre">cpl_core.application.application_abc.ApplicationABC</span></a><a class="headerlink" href="#cpl_core.application.application_builder_abc.ApplicationBuilderABC.build" title="Permalink to this definition"></a></dt>
<dd><p>Creates custom application object</p> <dd><p>Creates custom application object</p>
<blockquote> <blockquote>
<div><p>Object of <a class="reference internal" href="#cpl_core.application.application_abc.ApplicationABC" title="cpl_core.application.application_abc.ApplicationABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.application.application_abc.ApplicationABC</span></code></a></p> <div><p>Object of <a class="reference internal" href="#cpl_core.application.application_abc.ApplicationABC" title="cpl_core.application.application_abc.ApplicationABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.application.application_abc.ApplicationABC</span></code></a></p>
@ -187,9 +293,18 @@
</dd></dl> </dd></dl>
<dl class="py method"> <dl class="py method">
<dt class="sig sig-object py" id="cpl_core.application.application_builder_abc.ApplicationBuilderABC.use_startup"> <dt id="cpl_core.application.application_builder_abc.ApplicationBuilderABC.build_async">
<em class="property"><span class="pre">abstract</span> </em><span class="sig-name descname"><span class="pre">use_startup</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">startup</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cpl_core.application.startup_abc.StartupABC" title="cpl_core.application.startup_abc.StartupABC"><span class="pre">cpl_core.application.startup_abc.StartupABC</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.application.application_builder_abc.ApplicationBuilderABC.use_startup" title="Permalink to this definition"></a></dt> <em class="property"><span class="pre">abstract</span> <span class="pre">async</span> </em><code class="sig-name descname"><span class="pre">build_async</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span> &#x2192; <a class="reference internal" href="#cpl_core.application.application_abc.ApplicationABC" title="cpl_core.application.application_abc.ApplicationABC"><span class="pre">cpl_core.application.application_abc.ApplicationABC</span></a><a class="headerlink" href="#cpl_core.application.application_builder_abc.ApplicationBuilderABC.build_async" title="Permalink to this definition"></a></dt>
<dd><p>Sets the custom startup class to use</p> <dd><p>Creates custom application object async</p>
<blockquote>
<div><p>Object of <a class="reference internal" href="#cpl_core.application.application_abc.ApplicationABC" title="cpl_core.application.application_abc.ApplicationABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.application.application_abc.ApplicationABC</span></code></a></p>
</div></blockquote>
</dd></dl>
<dl class="py method">
<dt id="cpl_core.application.application_builder_abc.ApplicationBuilderABC.use_startup">
<em class="property"><span class="pre">abstract</span> <span class="pre">async</span> </em><code class="sig-name descname"><span class="pre">use_startup</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">startup</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cpl_core.application.startup_abc.StartupABC" title="cpl_core.application.startup_abc.StartupABC"><span class="pre">cpl_core.application.startup_abc.StartupABC</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.application.application_builder_abc.ApplicationBuilderABC.use_startup" title="Permalink to this definition"></a></dt>
<dd><p>Sets the custom startup class to use async</p>
<blockquote> <blockquote>
<div><dl class="simple"> <div><dl class="simple">
<dt>startup: Type[<a class="reference internal" href="#cpl_core.application.startup_abc.StartupABC" title="cpl_core.application.startup_abc.StartupABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.application.startup_abc.StartupABC</span></code></a>]</dt><dd><p>Startup class to use</p> <dt>startup: Type[<a class="reference internal" href="#cpl_core.application.startup_abc.StartupABC" title="cpl_core.application.startup_abc.StartupABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.application.startup_abc.StartupABC</span></code></a>]</dt><dd><p>Startup class to use</p>
@ -202,15 +317,15 @@
</div> </div>
<div class="section" id="module-cpl_core.application.startup_abc"> <div class="section" id="module-cpl_core.application.startup_abc">
<span id="cpl-core-application-startup-abc"></span><h2>cpl_core.application.startup_abc<a class="headerlink" href="#module-cpl_core.application.startup_abc" title="Permalink to this headline"></a></h2> <span id="cpl-core-application-startup-abc"></span><h2>cpl_core.application.startup_abc<a class="headerlink" href="#module-cpl_core.application.startup_abc" title="Permalink to this headline"></a></h2>
<dl class="py class"> <dl class="py class">
<dt class="sig sig-object py" id="cpl_core.application.startup_abc.StartupABC"> <dt id="cpl_core.application.startup_abc.StartupABC">
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">cpl_core.application.startup_abc.</span></span><span class="sig-name descname"><span class="pre">StartupABC</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.application.startup_abc.StartupABC" title="Permalink to this definition"></a></dt> <em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_core.application.startup_abc.</span></code><code class="sig-name descname"><span class="pre">StartupABC</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.application.startup_abc.StartupABC" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">abc.ABC</span></code></p> <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> <p>ABC for the startup class</p>
<dl class="py method"> <dl class="py method">
<dt class="sig sig-object py" id="cpl_core.application.startup_abc.StartupABC.configure_configuration"> <dt id="cpl_core.application.startup_abc.StartupABC.configure_configuration">
<em class="property"><span class="pre">abstract</span> </em><span class="sig-name descname"><span class="pre">configure_configuration</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_abc.ConfigurationABC" title="cpl_core.configuration.configuration_abc.ConfigurationABC"><span class="pre">cpl_core.configuration.configuration_abc.ConfigurationABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">env</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl_core.environment.html#cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC" title="cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC"><span class="pre">cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_abc.ConfigurationABC" title="cpl_core.configuration.configuration_abc.ConfigurationABC"><span class="pre">cpl_core.configuration.configuration_abc.ConfigurationABC</span></a></span></span><a class="headerlink" href="#cpl_core.application.startup_abc.StartupABC.configure_configuration" title="Permalink to this definition"></a></dt> <em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">configure_configuration</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_abc.ConfigurationABC" title="cpl_core.configuration.configuration_abc.ConfigurationABC"><span class="pre">cpl_core.configuration.configuration_abc.ConfigurationABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">env</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl_core.environment.html#cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC" title="cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC"><span class="pre">cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC</span></a></span></em><span class="sig-paren">)</span> &#x2192; <a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_abc.ConfigurationABC" title="cpl_core.configuration.configuration_abc.ConfigurationABC"><span class="pre">cpl_core.configuration.configuration_abc.ConfigurationABC</span></a><a class="headerlink" href="#cpl_core.application.startup_abc.StartupABC.configure_configuration" title="Permalink to this definition"></a></dt>
<dd><p>Creates configuration of application</p> <dd><p>Creates configuration of application</p>
<blockquote> <blockquote>
<div><p>config: <a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_abc.ConfigurationABC" title="cpl_core.configuration.configuration_abc.ConfigurationABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.configuration.configuration_abc.ConfigurationABC</span></code></a> <div><p>config: <a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_abc.ConfigurationABC" title="cpl_core.configuration.configuration_abc.ConfigurationABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.configuration.configuration_abc.ConfigurationABC</span></code></a>
@ -222,8 +337,8 @@ env: <a class="reference internal" href="cpl_core.environment.html#module-cpl_co
</dd></dl> </dd></dl>
<dl class="py method"> <dl class="py method">
<dt class="sig sig-object py" id="cpl_core.application.startup_abc.StartupABC.configure_services"> <dt id="cpl_core.application.startup_abc.StartupABC.configure_services">
<em class="property"><span class="pre">abstract</span> </em><span class="sig-name descname"><span class="pre">configure_services</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC" title="cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC"><span class="pre">cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">env</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl_core.environment.html#cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC" title="cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC"><span class="pre">cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC"><span class="pre">cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC</span></a></span></span><a class="headerlink" href="#cpl_core.application.startup_abc.StartupABC.configure_services" title="Permalink to this definition"></a></dt> <em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">configure_services</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC" title="cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC"><span class="pre">cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">env</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl_core.environment.html#cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC" title="cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC"><span class="pre">cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC</span></a></span></em><span class="sig-paren">)</span> &#x2192; <a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC"><span class="pre">cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC</span></a><a class="headerlink" href="#cpl_core.application.startup_abc.StartupABC.configure_services" title="Permalink to this definition"></a></dt>
<dd><p>Creates service provider</p> <dd><p>Creates service provider</p>
<blockquote> <blockquote>
<div><p>services: <a class="reference internal" href="cpl_core.dependency_injection.html#module-cpl_core.dependency_injection.service_collection_abc" title="cpl_core.dependency_injection.service_collection_abc"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.dependency_injection.service_collection_abc</span></code></a> <div><p>services: <a class="reference internal" href="cpl_core.dependency_injection.html#module-cpl_core.dependency_injection.service_collection_abc" title="cpl_core.dependency_injection.service_collection_abc"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.dependency_injection.service_collection_abc</span></code></a>
@ -241,33 +356,50 @@ env: <a class="reference internal" href="cpl_core.environment.html#module-cpl_co
</div> </div>
</div> </div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> <footer>
<a href="cpl_core.html" class="btn btn-neutral float-left" title="API Reference" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="cpl_core.configuration.html" class="btn btn-neutral float-right" title="cpl_core.configuration" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> <a href="cpl_core.configuration.html" class="btn btn-neutral float-right" title="cpl_core.configuration" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="cpl_core.html" class="btn btn-neutral float-left" title="API Reference" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div> </div>
<hr/> <hr/>
<div role="contentinfo"> <div role="contentinfo">
<p>&#169; Copyright 2021, Sven Heidemann.</p> <p>
&#169; Copyright 2021, Sven Heidemann.
</p>
</div> </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>.
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> </footer>
</div> </div>
</div> </div>
</section> </section>
</div> </div>
<script>
<script type="text/javascript">
jQuery(function () { jQuery(function () {
SphinxRtdTheme.Navigation.enable(true); SphinxRtdTheme.Navigation.enable(true);
}); });
</script> </script>
</body> </body>
</html> </html>

View File

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

File diff suppressed because one or more lines are too long

View File

@ -1,20 +1,41 @@
<!DOCTYPE html> <!DOCTYPE html>
<html class="writer-html5" lang="en" > <html class="writer-html5" lang="en" >
<head> <head>
<meta charset="utf-8" /> <meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>cpl_core.database.connection &mdash; Common Python Library documentation</title> <title>cpl_core.database.connection &mdash; Common Python Library documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<!--[if lt IE 9]> <!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script> <script src="_static/js/html5shiv.min.js"></script>
<![endif]--> <![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script> <script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script> <script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script> <script src="_static/doctools.js"></script>
<script src="_static/js/theme.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" /> <link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" /> <link rel="search" title="Search" href="search.html" />
<link rel="next" title="cpl_core.database.context" href="cpl_core.database.context.html" /> <link rel="next" title="cpl_core.database.context" href="cpl_core.database.context.html" />
@ -22,12 +43,28 @@
</head> </head>
<body class="wy-body-for-nav"> <body class="wy-body-for-nav">
<div class="wy-grid-for-nav"> <div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side"> <nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll"> <div class="wy-side-scroll">
<div class="wy-side-nav-search" > <div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library <a href="index.html" class="icon icon-home"> Common Python Library
</a> </a>
<div role="search"> <div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get"> <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" /> <input type="text" name="q" placeholder="Search docs" />
@ -35,7 +72,18 @@
<input type="hidden" name="area" value="default" /> <input type="hidden" name="area" value="default" />
</form> </form>
</div> </div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current"> <ul class="current">
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li> <li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li> <li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
@ -52,7 +100,7 @@
</li> </li>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.context.html">cpl_core.database.context</a></li> <li class="toctree-l3"><a class="reference internal" href="cpl_core.database.context.html">cpl_core.database.context</a></li>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.html#submodules">Submodules</a></li> <li class="toctree-l3"><a class="reference internal" href="cpl_core.database.html#submodules">Submodules</a></li>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.html#module-cpl_core.database.database_model">cpl_core.database.database_model</a></li> <li class="toctree-l3"><a class="reference internal" href="cpl_core.database.html#cpl-core-database-database-model">cpl_core.database.database_model</a></li>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.html#module-cpl_core.database.database_settings">cpl_core.database.database_settings</a></li> <li class="toctree-l3"><a class="reference internal" href="cpl_core.database.html#module-cpl_core.database.database_settings">cpl_core.database.database_settings</a></li>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.html#module-cpl_core.database.database_settings_name_enum">cpl_core.database.database_settings_name_enum</a></li> <li class="toctree-l3"><a class="reference internal" href="cpl_core.database.html#module-cpl_core.database.database_settings_name_enum">cpl_core.database.database_settings_name_enum</a></li>
</ul> </ul>
@ -68,47 +116,87 @@
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li> <li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li>
</ul> </ul>
</div> </div>
</div> </div>
</nav> </nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i> <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Common Python Library</a> <a href="index.html">Common Python Library</a>
</nav> </nav>
<div class="wy-nav-content"> <div class="wy-nav-content">
<div class="rst-content"> <div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs"> <ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li> <li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl_core.html">API Reference</a> &raquo;</li> <li><a href="cpl_core.html">API Reference</a> &raquo;</li>
<li><a href="cpl_core.database.html">cpl_core.database</a> &raquo;</li> <li><a href="cpl_core.database.html">cpl_core.database</a> &raquo;</li>
<li>cpl_core.database.connection</li> <li>cpl_core.database.connection</li>
<li class="wy-breadcrumbs-aside"> <li class="wy-breadcrumbs-aside">
<a href="_sources/cpl_core.database.connection.rst.txt" rel="nofollow"> View page source</a> <a href="_sources/cpl_core.database.connection.rst.txt" rel="nofollow"> View page source</a>
</li> </li>
</ul> </ul>
<hr/> <hr/>
</div> </div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody"> <div itemprop="articleBody">
<div class="section" id="cpl-core-database-connection"> <div class="section" id="cpl-core-database-connection">
<h1>cpl_core.database.connection<a class="headerlink" href="#cpl-core-database-connection" title="Permalink to this headline"></a></h1> <h1>cpl_core.database.connection<a class="headerlink" href="#cpl-core-database-connection" title="Permalink to this headline"></a></h1>
<div class="section" id="module-cpl_core.database.connection.database_connection"> <div class="section" id="module-cpl_core.database.connection.database_connection">
<span id="cpl-core-database-connection-database-connection"></span><h2>cpl_core.database.connection.database_connection<a class="headerlink" href="#module-cpl_core.database.connection.database_connection" title="Permalink to this headline"></a></h2> <span id="cpl-core-database-connection-database-connection"></span><h2>cpl_core.database.connection.database_connection<a class="headerlink" href="#module-cpl_core.database.connection.database_connection" title="Permalink to this headline"></a></h2>
<dl class="py class"> <dl class="py class">
<dt class="sig sig-object py" id="cpl_core.database.connection.database_connection.DatabaseConnection"> <dt id="cpl_core.database.connection.database_connection.DatabaseConnection">
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">cpl_core.database.connection.database_connection.</span></span><span class="sig-name descname"><span class="pre">DatabaseConnection</span></span><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_core.database.html#cpl_core.database.database_settings.DatabaseSettings" title="cpl_core.database.database_settings.DatabaseSettings"><span class="pre">cpl_core.database.database_settings.DatabaseSettings</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.database.connection.database_connection.DatabaseConnection" title="Permalink to this definition"></a></dt> <em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_core.database.connection.database_connection.</span></code><code class="sig-name descname"><span class="pre">DatabaseConnection</span></code><a class="headerlink" href="#cpl_core.database.connection.database_connection.DatabaseConnection" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#cpl_core.database.connection.database_connection_abc.DatabaseConnectionABC" title="cpl_core.database.connection.database_connection_abc.DatabaseConnectionABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.database.connection.database_connection_abc.DatabaseConnectionABC</span></code></a></p> <dd><p>Bases: <a class="reference internal" href="#cpl_core.database.connection.database_connection_abc.DatabaseConnectionABC" title="cpl_core.database.connection.database_connection_abc.DatabaseConnectionABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.database.connection.database_connection_abc.DatabaseConnectionABC</span></code></a></p>
<p>Representation of the database connection</p> <p>Representation of the database connection</p>
<blockquote>
<div><p>database_settings: <a class="reference internal" href="cpl_core.database.html#cpl_core.database.database_settings.DatabaseSettings" title="cpl_core.database.database_settings.DatabaseSettings"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.database.database_settings.DatabaseSettings</span></code></a></p>
</div></blockquote>
<dl class="py method"> <dl class="py method">
<dt class="sig sig-object py" id="cpl_core.database.connection.database_connection.DatabaseConnection.connect"> <dt id="cpl_core.database.connection.database_connection.DatabaseConnection.connect">
<span class="sig-name descname"><span class="pre">connect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">connection_string</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.database.connection.database_connection.DatabaseConnection.connect" title="Permalink to this definition"></a></dt> <code class="sig-name descname"><span class="pre">connect</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_core.database.html#cpl_core.database.database_settings.DatabaseSettings" title="cpl_core.database.database_settings.DatabaseSettings"><span class="pre">cpl_core.database.database_settings.DatabaseSettings</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.database.connection.database_connection.DatabaseConnection.connect" title="Permalink to this definition"></a></dt>
<dd><p>Connects to a database by connection string</p> <dd><p>Connects to a database by connection string</p>
<blockquote> <blockquote>
<div><dl class="simple"> <div><dl class="simple">
@ -118,29 +206,29 @@
</div></blockquote> </div></blockquote>
</dd></dl> </dd></dl>
<dl class="py property"> <dl class="py method">
<dt class="sig sig-object py" id="cpl_core.database.connection.database_connection.DatabaseConnection.engine"> <dt id="cpl_core.database.connection.database_connection.DatabaseConnection.cursor">
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">engine</span></span><em class="property"><span class="pre">:</span> <span class="pre">&lt;module</span> <span class="pre">'sqlalchemy.engine'</span> <span class="pre">from</span> <span class="pre">'/home/sven/Nextcloud_Sven/Schreibtisch/git_sh-edraft_de/sh_cpl/cpl-env/lib/python3.9/site-packages/sqlalchemy/engine/__init__.py'&gt;</span></em><a class="headerlink" href="#cpl_core.database.connection.database_connection.DatabaseConnection.engine" title="Permalink to this definition"></a></dt> <em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">cursor</span></code><a class="headerlink" href="#cpl_core.database.connection.database_connection.DatabaseConnection.cursor" title="Permalink to this definition"></a></dt>
<dd></dd></dl> <dd></dd></dl>
<dl class="py property"> <dl class="py method">
<dt class="sig sig-object py" id="cpl_core.database.connection.database_connection.DatabaseConnection.session"> <dt id="cpl_core.database.connection.database_connection.DatabaseConnection.server">
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">session</span></span><em class="property"><span class="pre">:</span> <span class="pre">sqlalchemy.orm.session.Session</span></em><a class="headerlink" href="#cpl_core.database.connection.database_connection.DatabaseConnection.session" title="Permalink to this definition"></a></dt> <em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">server</span></code><a class="headerlink" href="#cpl_core.database.connection.database_connection.DatabaseConnection.server" title="Permalink to this definition"></a></dt>
<dd></dd></dl> <dd></dd></dl>
</dd></dl> </dd></dl>
</div> </div>
<div class="section" id="module-cpl_core.database.connection.database_connection_abc"> <div class="section" id="module-cpl_core.database.connection.database_connection_abc">
<span id="cpl-core-database-connection-database-connection-abc"></span><h2>cpl_core.database.connection.database_connection_abc<a class="headerlink" href="#module-cpl_core.database.connection.database_connection_abc" title="Permalink to this headline"></a></h2> <span id="cpl-core-database-connection-database-connection-abc"></span><h2>cpl_core.database.connection.database_connection_abc<a class="headerlink" href="#module-cpl_core.database.connection.database_connection_abc" title="Permalink to this headline"></a></h2>
<dl class="py class"> <dl class="py class">
<dt class="sig sig-object py" id="cpl_core.database.connection.database_connection_abc.DatabaseConnectionABC"> <dt id="cpl_core.database.connection.database_connection_abc.DatabaseConnectionABC">
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">cpl_core.database.connection.database_connection_abc.</span></span><span class="sig-name descname"><span class="pre">DatabaseConnectionABC</span></span><a class="headerlink" href="#cpl_core.database.connection.database_connection_abc.DatabaseConnectionABC" title="Permalink to this definition"></a></dt> <em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_core.database.connection.database_connection_abc.</span></code><code class="sig-name descname"><span class="pre">DatabaseConnectionABC</span></code><a class="headerlink" href="#cpl_core.database.connection.database_connection_abc.DatabaseConnectionABC" 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> <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">abc.ABC</span></code></p>
<p>ABC for the <a class="reference internal" href="#cpl_core.database.connection.database_connection.DatabaseConnection" title="cpl_core.database.connection.database_connection.DatabaseConnection"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.database.connection.database_connection.DatabaseConnection</span></code></a></p> <p>ABC for the <a class="reference internal" href="#cpl_core.database.connection.database_connection.DatabaseConnection" title="cpl_core.database.connection.database_connection.DatabaseConnection"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.database.connection.database_connection.DatabaseConnection</span></code></a></p>
<dl class="py method"> <dl class="py method">
<dt class="sig sig-object py" id="cpl_core.database.connection.database_connection_abc.DatabaseConnectionABC.connect"> <dt id="cpl_core.database.connection.database_connection_abc.DatabaseConnectionABC.connect">
<em class="property"><span class="pre">abstract</span> </em><span class="sig-name descname"><span class="pre">connect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">connection_string</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.database.connection.database_connection_abc.DatabaseConnectionABC.connect" title="Permalink to this definition"></a></dt> <em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">connect</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_core.database.html#cpl_core.database.database_settings.DatabaseSettings" title="cpl_core.database.database_settings.DatabaseSettings"><span class="pre">cpl_core.database.database_settings.DatabaseSettings</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.database.connection.database_connection_abc.DatabaseConnectionABC.connect" title="Permalink to this definition"></a></dt>
<dd><p>Connects to a database by connection string</p> <dd><p>Connects to a database by connection string</p>
<blockquote> <blockquote>
<div><dl class="simple"> <div><dl class="simple">
@ -150,14 +238,14 @@
</div></blockquote> </div></blockquote>
</dd></dl> </dd></dl>
<dl class="py property"> <dl class="py method">
<dt class="sig sig-object py" id="cpl_core.database.connection.database_connection_abc.DatabaseConnectionABC.engine"> <dt id="cpl_core.database.connection.database_connection_abc.DatabaseConnectionABC.cursor">
<em class="property"><span class="pre">abstract</span> <span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">engine</span></span><em class="property"><span class="pre">:</span> <span class="pre">&lt;module</span> <span class="pre">'sqlalchemy.engine'</span> <span class="pre">from</span> <span class="pre">'/home/sven/Nextcloud_Sven/Schreibtisch/git_sh-edraft_de/sh_cpl/cpl-env/lib/python3.9/site-packages/sqlalchemy/engine/__init__.py'&gt;</span></em><a class="headerlink" href="#cpl_core.database.connection.database_connection_abc.DatabaseConnectionABC.engine" title="Permalink to this definition"></a></dt> <em class="property"><span class="pre">abstract</span> <span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">cursor</span></code><a class="headerlink" href="#cpl_core.database.connection.database_connection_abc.DatabaseConnectionABC.cursor" title="Permalink to this definition"></a></dt>
<dd></dd></dl> <dd></dd></dl>
<dl class="py property"> <dl class="py method">
<dt class="sig sig-object py" id="cpl_core.database.connection.database_connection_abc.DatabaseConnectionABC.session"> <dt id="cpl_core.database.connection.database_connection_abc.DatabaseConnectionABC.server">
<em class="property"><span class="pre">abstract</span> <span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">session</span></span><em class="property"><span class="pre">:</span> <span class="pre">sqlalchemy.orm.session.Session</span></em><a class="headerlink" href="#cpl_core.database.connection.database_connection_abc.DatabaseConnectionABC.session" title="Permalink to this definition"></a></dt> <em class="property"><span class="pre">abstract</span> <span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">server</span></code><a class="headerlink" href="#cpl_core.database.connection.database_connection_abc.DatabaseConnectionABC.server" title="Permalink to this definition"></a></dt>
<dd></dd></dl> <dd></dd></dl>
</dd></dl> </dd></dl>
@ -167,33 +255,50 @@
</div> </div>
</div> </div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> <footer>
<a href="cpl_core.database.html" class="btn btn-neutral float-left" title="cpl_core.database" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="cpl_core.database.context.html" class="btn btn-neutral float-right" title="cpl_core.database.context" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> <a href="cpl_core.database.context.html" class="btn btn-neutral float-right" title="cpl_core.database.context" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="cpl_core.database.html" class="btn btn-neutral float-left" title="cpl_core.database" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div> </div>
<hr/> <hr/>
<div role="contentinfo"> <div role="contentinfo">
<p>&#169; Copyright 2021, Sven Heidemann.</p> <p>
&#169; Copyright 2021, Sven Heidemann.
</p>
</div> </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>.
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> </footer>
</div> </div>
</div> </div>
</section> </section>
</div> </div>
<script>
<script type="text/javascript">
jQuery(function () { jQuery(function () {
SphinxRtdTheme.Navigation.enable(true); SphinxRtdTheme.Navigation.enable(true);
}); });
</script> </script>
</body> </body>
</html> </html>

View File

@ -1,20 +1,41 @@
<!DOCTYPE html> <!DOCTYPE html>
<html class="writer-html5" lang="en" > <html class="writer-html5" lang="en" >
<head> <head>
<meta charset="utf-8" /> <meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>cpl_core.database.context &mdash; Common Python Library documentation</title> <title>cpl_core.database.context &mdash; Common Python Library documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<!--[if lt IE 9]> <!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script> <script src="_static/js/html5shiv.min.js"></script>
<![endif]--> <![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script> <script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script> <script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script> <script src="_static/doctools.js"></script>
<script src="_static/js/theme.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" /> <link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" /> <link rel="search" title="Search" href="search.html" />
<link rel="next" title="cpl_core.dependency_injection" href="cpl_core.dependency_injection.html" /> <link rel="next" title="cpl_core.dependency_injection" href="cpl_core.dependency_injection.html" />
@ -22,12 +43,28 @@
</head> </head>
<body class="wy-body-for-nav"> <body class="wy-body-for-nav">
<div class="wy-grid-for-nav"> <div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side"> <nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll"> <div class="wy-side-scroll">
<div class="wy-side-nav-search" > <div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library <a href="index.html" class="icon icon-home"> Common Python Library
</a> </a>
<div role="search"> <div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get"> <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" /> <input type="text" name="q" placeholder="Search docs" />
@ -35,7 +72,18 @@
<input type="hidden" name="area" value="default" /> <input type="hidden" name="area" value="default" />
</form> </form>
</div> </div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current"> <ul class="current">
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li> <li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li> <li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
@ -52,7 +100,7 @@
</ul> </ul>
</li> </li>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.html#submodules">Submodules</a></li> <li class="toctree-l3"><a class="reference internal" href="cpl_core.database.html#submodules">Submodules</a></li>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.html#module-cpl_core.database.database_model">cpl_core.database.database_model</a></li> <li class="toctree-l3"><a class="reference internal" href="cpl_core.database.html#cpl-core-database-database-model">cpl_core.database.database_model</a></li>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.html#module-cpl_core.database.database_settings">cpl_core.database.database_settings</a></li> <li class="toctree-l3"><a class="reference internal" href="cpl_core.database.html#module-cpl_core.database.database_settings">cpl_core.database.database_settings</a></li>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.html#module-cpl_core.database.database_settings_name_enum">cpl_core.database.database_settings_name_enum</a></li> <li class="toctree-l3"><a class="reference internal" href="cpl_core.database.html#module-cpl_core.database.database_settings_name_enum">cpl_core.database.database_settings_name_enum</a></li>
</ul> </ul>
@ -68,109 +116,160 @@
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li> <li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li>
</ul> </ul>
</div> </div>
</div> </div>
</nav> </nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i> <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Common Python Library</a> <a href="index.html">Common Python Library</a>
</nav> </nav>
<div class="wy-nav-content"> <div class="wy-nav-content">
<div class="rst-content"> <div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs"> <ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li> <li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl_core.html">API Reference</a> &raquo;</li> <li><a href="cpl_core.html">API Reference</a> &raquo;</li>
<li><a href="cpl_core.database.html">cpl_core.database</a> &raquo;</li> <li><a href="cpl_core.database.html">cpl_core.database</a> &raquo;</li>
<li>cpl_core.database.context</li> <li>cpl_core.database.context</li>
<li class="wy-breadcrumbs-aside"> <li class="wy-breadcrumbs-aside">
<a href="_sources/cpl_core.database.context.rst.txt" rel="nofollow"> View page source</a> <a href="_sources/cpl_core.database.context.rst.txt" rel="nofollow"> View page source</a>
</li> </li>
</ul> </ul>
<hr/> <hr/>
</div> </div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody"> <div itemprop="articleBody">
<div class="section" id="cpl-core-database-context"> <div class="section" id="cpl-core-database-context">
<h1>cpl_core.database.context<a class="headerlink" href="#cpl-core-database-context" title="Permalink to this headline"></a></h1> <h1>cpl_core.database.context<a class="headerlink" href="#cpl-core-database-context" title="Permalink to this headline"></a></h1>
<div class="section" id="module-cpl_core.database.context.database_context"> <div class="section" id="module-cpl_core.database.context.database_context">
<span id="cpl-core-database-context-database-context"></span><h2>cpl_core.database.context.database_context<a class="headerlink" href="#module-cpl_core.database.context.database_context" title="Permalink to this headline"></a></h2> <span id="cpl-core-database-context-database-context"></span><h2>cpl_core.database.context.database_context<a class="headerlink" href="#module-cpl_core.database.context.database_context" title="Permalink to this headline"></a></h2>
<dl class="py class"> <dl class="py class">
<dt class="sig sig-object py" id="cpl_core.database.context.database_context.DatabaseContext"> <dt id="cpl_core.database.context.database_context.DatabaseContext">
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">cpl_core.database.context.database_context.</span></span><span class="sig-name descname"><span class="pre">DatabaseContext</span></span><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_core.database.html#cpl_core.database.database_settings.DatabaseSettings" title="cpl_core.database.database_settings.DatabaseSettings"><span class="pre">cpl_core.database.database_settings.DatabaseSettings</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.database.context.database_context.DatabaseContext" title="Permalink to this definition"></a></dt> <em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_core.database.context.database_context.</span></code><code class="sig-name descname"><span class="pre">DatabaseContext</span></code><a class="headerlink" href="#cpl_core.database.context.database_context.DatabaseContext" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#cpl_core.database.context.database_context_abc.DatabaseContextABC" title="cpl_core.database.context.database_context_abc.DatabaseContextABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.database.context.database_context_abc.DatabaseContextABC</span></code></a></p> <dd><p>Bases: <a class="reference internal" href="#cpl_core.database.context.database_context_abc.DatabaseContextABC" title="cpl_core.database.context.database_context_abc.DatabaseContextABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.database.context.database_context_abc.DatabaseContextABC</span></code></a></p>
<p>Representation of the database context</p> <p>Representation of the database context</p>
<blockquote> <blockquote>
<div><p>database_settings: <a class="reference internal" href="cpl_core.database.html#cpl_core.database.database_settings.DatabaseSettings" title="cpl_core.database.database_settings.DatabaseSettings"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.database.database_settings.DatabaseSettings</span></code></a></p> <div><p>database_settings: <a class="reference internal" href="cpl_core.database.html#cpl_core.database.database_settings.DatabaseSettings" title="cpl_core.database.database_settings.DatabaseSettings"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.database.database_settings.DatabaseSettings</span></code></a></p>
</div></blockquote> </div></blockquote>
<dl class="py method"> <dl class="py method">
<dt class="sig sig-object py" id="cpl_core.database.context.database_context.DatabaseContext.connect"> <dt id="cpl_core.database.context.database_context.DatabaseContext.connect">
<span class="sig-name descname"><span class="pre">connect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">connection_string</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.database.context.database_context.DatabaseContext.connect" title="Permalink to this definition"></a></dt> <code class="sig-name descname"><span class="pre">connect</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_core.database.html#cpl_core.database.database_settings.DatabaseSettings" title="cpl_core.database.database_settings.DatabaseSettings"><span class="pre">cpl_core.database.database_settings.DatabaseSettings</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.database.context.database_context.DatabaseContext.connect" title="Permalink to this definition"></a></dt>
<dd><p>Connects to a database by connection string</p> <dd><p>Connects to a database by connection settings</p>
<blockquote> <blockquote>
<div><dl class="simple"> <div><p>database_settings <a class="reference internal" href="cpl_core.database.html#cpl_core.database.database_settings.DatabaseSettings" title="cpl_core.database.database_settings.DatabaseSettings"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.database.database_settings.DatabaseSettings</span></code></a></p>
<dt>connection_string: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>Database connection string, see: <a class="reference external" href="https://docs.sqlalchemy.org/en/14/core/engines.html">https://docs.sqlalchemy.org/en/14/core/engines.html</a></p>
</dd>
</dl>
</div></blockquote> </div></blockquote>
</dd></dl> </dd></dl>
<dl class="py property"> <dl class="py method">
<dt class="sig sig-object py" id="cpl_core.database.context.database_context.DatabaseContext.engine"> <dt id="cpl_core.database.context.database_context.DatabaseContext.cursor">
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">engine</span></span><em class="property"><span class="pre">:</span> <span class="pre">&lt;module</span> <span class="pre">'sqlalchemy.engine'</span> <span class="pre">from</span> <span class="pre">'/home/sven/Nextcloud_Sven/Schreibtisch/git_sh-edraft_de/sh_cpl/cpl-env/lib/python3.9/site-packages/sqlalchemy/engine/__init__.py'&gt;</span></em><a class="headerlink" href="#cpl_core.database.context.database_context.DatabaseContext.engine" title="Permalink to this definition"></a></dt> <em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">cursor</span></code><a class="headerlink" href="#cpl_core.database.context.database_context.DatabaseContext.cursor" title="Permalink to this definition"></a></dt>
<dd></dd></dl> <dd></dd></dl>
<dl class="py method"> <dl class="py method">
<dt class="sig sig-object py" id="cpl_core.database.context.database_context.DatabaseContext.save_changes"> <dt id="cpl_core.database.context.database_context.DatabaseContext.save_changes">
<span class="sig-name descname"><span class="pre">save_changes</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.database.context.database_context.DatabaseContext.save_changes" title="Permalink to this definition"></a></dt> <code class="sig-name descname"><span class="pre">save_changes</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.database.context.database_context.DatabaseContext.save_changes" title="Permalink to this definition"></a></dt>
<dd><p>Saves changes of the database</p> <dd><p>Saves changes of the database</p>
</dd></dl> </dd></dl>
<dl class="py property"> <dl class="py method">
<dt class="sig sig-object py" id="cpl_core.database.context.database_context.DatabaseContext.session"> <dt id="cpl_core.database.context.database_context.DatabaseContext.select">
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">session</span></span><em class="property"><span class="pre">:</span> <span class="pre">sqlalchemy.orm.session.Session</span></em><a class="headerlink" href="#cpl_core.database.context.database_context.DatabaseContext.session" title="Permalink to this definition"></a></dt> <code class="sig-name descname"><span class="pre">select</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">statement</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> &#x2192; <span class="pre">list</span><a class="headerlink" href="#cpl_core.database.context.database_context.DatabaseContext.select" title="Permalink to this definition"></a></dt>
<dd></dd></dl> <dd><p>Runs SQL Statements</p>
<blockquote>
<div><p>statement: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
</div></blockquote>
<blockquote>
<div><p>list: Fetched list of selected elements</p>
</div></blockquote>
</dd></dl>
</dd></dl> </dd></dl>
</div> </div>
<div class="section" id="module-cpl_core.database.context.database_context_abc"> <div class="section" id="module-cpl_core.database.context.database_context_abc">
<span id="cpl-core-database-context-database-context-abc"></span><h2>cpl_core.database.context.database_context_abc<a class="headerlink" href="#module-cpl_core.database.context.database_context_abc" title="Permalink to this headline"></a></h2> <span id="cpl-core-database-context-database-context-abc"></span><h2>cpl_core.database.context.database_context_abc<a class="headerlink" href="#module-cpl_core.database.context.database_context_abc" title="Permalink to this headline"></a></h2>
<dl class="py class"> <dl class="py class">
<dt class="sig sig-object py" id="cpl_core.database.context.database_context_abc.DatabaseContextABC"> <dt id="cpl_core.database.context.database_context_abc.DatabaseContextABC">
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">cpl_core.database.context.database_context_abc.</span></span><span class="sig-name descname"><span class="pre">DatabaseContextABC</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.database.context.database_context_abc.DatabaseContextABC" title="Permalink to this definition"></a></dt> <em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_core.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_core.database.context.database_context_abc.DatabaseContextABC" 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> <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">abc.ABC</span></code></p>
<p>ABC for the <a class="reference internal" href="#cpl_core.database.context.database_context.DatabaseContext" title="cpl_core.database.context.database_context.DatabaseContext"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.database.context.database_context.DatabaseContext</span></code></a></p> <p>ABC for the <a class="reference internal" href="#cpl_core.database.context.database_context.DatabaseContext" title="cpl_core.database.context.database_context.DatabaseContext"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.database.context.database_context.DatabaseContext</span></code></a></p>
<dl class="py method"> <dl class="py method">
<dt class="sig sig-object py" id="cpl_core.database.context.database_context_abc.DatabaseContextABC.connect"> <dt id="cpl_core.database.context.database_context_abc.DatabaseContextABC.connect">
<em class="property"><span class="pre">abstract</span> </em><span class="sig-name descname"><span class="pre">connect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">connection_string</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.database.context.database_context_abc.DatabaseContextABC.connect" title="Permalink to this definition"></a></dt> <em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">connect</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_core.database.html#cpl_core.database.database_settings.DatabaseSettings" title="cpl_core.database.database_settings.DatabaseSettings"><span class="pre">cpl_core.database.database_settings.DatabaseSettings</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.database.context.database_context_abc.DatabaseContextABC.connect" title="Permalink to this definition"></a></dt>
<dd><p>Connects to a database by connection string</p> <dd><p>Connects to a database by connection settings</p>
<blockquote> <blockquote>
<div><dl class="simple"> <div><p>database_settings <a class="reference internal" href="cpl_core.database.html#cpl_core.database.database_settings.DatabaseSettings" title="cpl_core.database.database_settings.DatabaseSettings"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.database.database_settings.DatabaseSettings</span></code></a></p>
<dt>connection_string: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>Database connection string, see: <a class="reference external" href="https://docs.sqlalchemy.org/en/14/core/engines.html">https://docs.sqlalchemy.org/en/14/core/engines.html</a></p>
</dd>
</dl>
</div></blockquote> </div></blockquote>
</dd></dl> </dd></dl>
<dl class="py property"> <dl class="py method">
<dt class="sig sig-object py" id="cpl_core.database.context.database_context_abc.DatabaseContextABC.engine"> <dt id="cpl_core.database.context.database_context_abc.DatabaseContextABC.cursor">
<em class="property"><span class="pre">abstract</span> <span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">engine</span></span><em class="property"><span class="pre">:</span> <span class="pre">&lt;module</span> <span class="pre">'sqlalchemy.engine'</span> <span class="pre">from</span> <span class="pre">'/home/sven/Nextcloud_Sven/Schreibtisch/git_sh-edraft_de/sh_cpl/cpl-env/lib/python3.9/site-packages/sqlalchemy/engine/__init__.py'&gt;</span></em><a class="headerlink" href="#cpl_core.database.context.database_context_abc.DatabaseContextABC.engine" title="Permalink to this definition"></a></dt> <em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">cursor</span></code><a class="headerlink" href="#cpl_core.database.context.database_context_abc.DatabaseContextABC.cursor" title="Permalink to this definition"></a></dt>
<dd></dd></dl> <dd></dd></dl>
<dl class="py method"> <dl class="py method">
<dt class="sig sig-object py" id="cpl_core.database.context.database_context_abc.DatabaseContextABC.save_changes"> <dt id="cpl_core.database.context.database_context_abc.DatabaseContextABC.save_changes">
<span class="sig-name descname"><span class="pre">save_changes</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.database.context.database_context_abc.DatabaseContextABC.save_changes" title="Permalink to this definition"></a></dt> <em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">save_changes</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.database.context.database_context_abc.DatabaseContextABC.save_changes" title="Permalink to this definition"></a></dt>
<dd><p>Saves changes of the database</p> <dd><p>Saves changes of the database</p>
</dd></dl> </dd></dl>
<dl class="py property"> <dl class="py method">
<dt class="sig sig-object py" id="cpl_core.database.context.database_context_abc.DatabaseContextABC.session"> <dt id="cpl_core.database.context.database_context_abc.DatabaseContextABC.select">
<em class="property"><span class="pre">abstract</span> <span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">session</span></span><em class="property"><span class="pre">:</span> <span class="pre">sqlalchemy.orm.session.Session</span></em><a class="headerlink" href="#cpl_core.database.context.database_context_abc.DatabaseContextABC.session" title="Permalink to this definition"></a></dt> <em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">select</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">statement</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> &#x2192; <span class="pre">list</span><a class="headerlink" href="#cpl_core.database.context.database_context_abc.DatabaseContextABC.select" title="Permalink to this definition"></a></dt>
<dd></dd></dl> <dd><p>Runs SQL Statements</p>
<blockquote>
<div><p>statement: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
</div></blockquote>
<blockquote>
<div><p>list: Fetched list of selected elements</p>
</div></blockquote>
</dd></dl>
</dd></dl> </dd></dl>
@ -179,33 +278,50 @@
</div> </div>
</div> </div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> <footer>
<a href="cpl_core.database.connection.html" class="btn btn-neutral float-left" title="cpl_core.database.connection" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="cpl_core.dependency_injection.html" class="btn btn-neutral float-right" title="cpl_core.dependency_injection" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> <a href="cpl_core.dependency_injection.html" class="btn btn-neutral float-right" title="cpl_core.dependency_injection" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="cpl_core.database.connection.html" class="btn btn-neutral float-left" title="cpl_core.database.connection" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div> </div>
<hr/> <hr/>
<div role="contentinfo"> <div role="contentinfo">
<p>&#169; Copyright 2021, Sven Heidemann.</p> <p>
&#169; Copyright 2021, Sven Heidemann.
</p>
</div> </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>.
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> </footer>
</div> </div>
</div> </div>
</section> </section>
</div> </div>
<script>
<script type="text/javascript">
jQuery(function () { jQuery(function () {
SphinxRtdTheme.Navigation.enable(true); SphinxRtdTheme.Navigation.enable(true);
}); });
</script> </script>
</body> </body>
</html> </html>

View File

@ -1,20 +1,41 @@
<!DOCTYPE html> <!DOCTYPE html>
<html class="writer-html5" lang="en" > <html class="writer-html5" lang="en" >
<head> <head>
<meta charset="utf-8" /> <meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>cpl_core.database &mdash; Common Python Library documentation</title> <title>cpl_core.database &mdash; Common Python Library documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<!--[if lt IE 9]> <!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script> <script src="_static/js/html5shiv.min.js"></script>
<![endif]--> <![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script> <script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script> <script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script> <script src="_static/doctools.js"></script>
<script src="_static/js/theme.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" /> <link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" /> <link rel="search" title="Search" href="search.html" />
<link rel="next" title="cpl_core.database.connection" href="cpl_core.database.connection.html" /> <link rel="next" title="cpl_core.database.connection" href="cpl_core.database.connection.html" />
@ -22,12 +43,28 @@
</head> </head>
<body class="wy-body-for-nav"> <body class="wy-body-for-nav">
<div class="wy-grid-for-nav"> <div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side"> <nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll"> <div class="wy-side-scroll">
<div class="wy-side-nav-search" > <div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library <a href="index.html" class="icon icon-home"> Common Python Library
</a> </a>
<div role="search"> <div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get"> <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" /> <input type="text" name="q" placeholder="Search docs" />
@ -35,7 +72,18 @@
<input type="hidden" name="area" value="default" /> <input type="hidden" name="area" value="default" />
</form> </form>
</div> </div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current"> <ul class="current">
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li> <li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li> <li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
@ -48,7 +96,7 @@
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.connection.html">cpl_core.database.connection</a></li> <li class="toctree-l3"><a class="reference internal" href="cpl_core.database.connection.html">cpl_core.database.connection</a></li>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.context.html">cpl_core.database.context</a></li> <li class="toctree-l3"><a class="reference internal" href="cpl_core.database.context.html">cpl_core.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="#submodules">Submodules</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.database.database_model">cpl_core.database.database_model</a></li> <li class="toctree-l3"><a class="reference internal" href="#cpl-core-database-database-model">cpl_core.database.database_model</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.database.database_settings">cpl_core.database.database_settings</a></li> <li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.database.database_settings">cpl_core.database.database_settings</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.database.database_settings_name_enum">cpl_core.database.database_settings_name_enum</a></li> <li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.database.database_settings_name_enum">cpl_core.database.database_settings_name_enum</a></li>
</ul> </ul>
@ -64,33 +112,75 @@
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li> <li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li>
</ul> </ul>
</div> </div>
</div> </div>
</nav> </nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i> <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Common Python Library</a> <a href="index.html">Common Python Library</a>
</nav> </nav>
<div class="wy-nav-content"> <div class="wy-nav-content">
<div class="rst-content"> <div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs"> <ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li> <li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl_core.html">API Reference</a> &raquo;</li> <li><a href="cpl_core.html">API Reference</a> &raquo;</li>
<li>cpl_core.database</li> <li>cpl_core.database</li>
<li class="wy-breadcrumbs-aside"> <li class="wy-breadcrumbs-aside">
<a href="_sources/cpl_core.database.rst.txt" rel="nofollow"> View page source</a> <a href="_sources/cpl_core.database.rst.txt" rel="nofollow"> View page source</a>
</li> </li>
</ul> </ul>
<hr/> <hr/>
</div> </div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody"> <div itemprop="articleBody">
<div class="section" id="cpl-core-database"> <div class="section" id="cpl-core-database">
<h1>cpl_core.database<a class="headerlink" href="#cpl-core-database" title="Permalink to this headline"></a></h1> <h1>cpl_core.database<a class="headerlink" href="#cpl-core-database" title="Permalink to this headline"></a></h1>
<div class="toctree-wrapper compound"> <div class="toctree-wrapper compound">
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="cpl_core.database.connection.html">cpl_core.database.connection</a><ul> <li class="toctree-l1"><a class="reference internal" href="cpl_core.database.connection.html">cpl_core.database.connection</a><ul>
@ -106,93 +196,113 @@
</ul> </ul>
</div> </div>
<div class="section" id="submodules"> <div class="section" id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline"></a></h2> <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline"></a></h2>
</div> </div>
<div class="section" id="module-cpl_core.database.database_model"> <div class="section" id="cpl-core-database-database-model">
<span id="cpl-core-database-database-model"></span><h2>cpl_core.database.database_model<a class="headerlink" href="#module-cpl_core.database.database_model" title="Permalink to this headline"></a></h2> <h2>cpl_core.database.database_model<a class="headerlink" href="#cpl-core-database-database-model" title="Permalink to this headline"></a></h2>
</div> </div>
<div class="section" id="module-cpl_core.database.database_settings"> <div class="section" id="module-cpl_core.database.database_settings">
<span id="cpl-core-database-database-settings"></span><h2>cpl_core.database.database_settings<a class="headerlink" href="#module-cpl_core.database.database_settings" title="Permalink to this headline"></a></h2> <span id="cpl-core-database-database-settings"></span><h2>cpl_core.database.database_settings<a class="headerlink" href="#module-cpl_core.database.database_settings" title="Permalink to this headline"></a></h2>
<dl class="py class"> <dl class="py class">
<dt class="sig sig-object py" id="cpl_core.database.database_settings.DatabaseSettings"> <dt id="cpl_core.database.database_settings.DatabaseSettings">
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">cpl_core.database.database_settings.</span></span><span class="sig-name descname"><span class="pre">DatabaseSettings</span></span><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings" title="Permalink to this definition"></a></dt> <em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_core.database.database_settings.</span></code><code class="sig-name descname"><span class="pre">DatabaseSettings</span></code><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl_core.configuration.configuration_model_abc.ConfigurationModelABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.configuration.configuration_model_abc.ConfigurationModelABC</span></code></a></p> <dd><p>Bases: <a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl_core.configuration.configuration_model_abc.ConfigurationModelABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.configuration.configuration_model_abc.ConfigurationModelABC</span></code></a></p>
<p>Represents settings for the database connection</p> <p>Represents settings for the database connection</p>
<dl class="py property"> <dl class="py method">
<dt class="sig sig-object py" id="cpl_core.database.database_settings.DatabaseSettings.auth_plugin"> <dt id="cpl_core.database.database_settings.DatabaseSettings.auth_plugin">
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">auth_plugin</span></span><em class="property"><span class="pre">:</span> <span class="pre">str</span></em><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.auth_plugin" title="Permalink to this definition"></a></dt> <em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">auth_plugin</span></code><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.auth_plugin" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="cpl_core.database.database_settings.DatabaseSettings.case_sensitive">
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">case_sensitive</span></span><em class="property"><span class="pre">:</span> <span class="pre">bool</span></em><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.case_sensitive" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="cpl_core.database.database_settings.DatabaseSettings.connection_string">
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">connection_string</span></span><em class="property"><span class="pre">:</span> <span class="pre">str</span></em><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.connection_string" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="cpl_core.database.database_settings.DatabaseSettings.credentials">
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">credentials</span></span><em class="property"><span class="pre">:</span> <span class="pre">str</span></em><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.credentials" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="cpl_core.database.database_settings.DatabaseSettings.echo">
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">echo</span></span><em class="property"><span class="pre">:</span> <span class="pre">bool</span></em><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.echo" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="cpl_core.database.database_settings.DatabaseSettings.encoding">
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">encoding</span></span><em class="property"><span class="pre">:</span> <span class="pre">str</span></em><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.encoding" title="Permalink to this definition"></a></dt>
<dd></dd></dl> <dd></dd></dl>
<dl class="py method"> <dl class="py method">
<dt class="sig sig-object py" id="cpl_core.database.database_settings.DatabaseSettings.from_dict"> <dt id="cpl_core.database.database_settings.DatabaseSettings.buffered">
<span class="sig-name descname"><span class="pre">from_dict</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">settings</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">dict</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.from_dict" title="Permalink to this definition"></a></dt> <em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">buffered</span></code><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.buffered" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="cpl_core.database.database_settings.DatabaseSettings.charset">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">charset</span></code><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.charset" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="cpl_core.database.database_settings.DatabaseSettings.database">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">database</span></code><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.database" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="cpl_core.database.database_settings.DatabaseSettings.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_core.database.database_settings.DatabaseSettings.from_dict" title="Permalink to this definition"></a></dt>
<dd><p>Sets attributes from given dict</p> <dd><p>Sets attributes from given dict</p>
<p>settings: <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></p> <p>settings: <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></p>
</dd></dl> </dd></dl>
<dl class="py method">
<dt id="cpl_core.database.database_settings.DatabaseSettings.host">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">host</span></code><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.host" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="cpl_core.database.database_settings.DatabaseSettings.password">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">password</span></code><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.password" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="cpl_core.database.database_settings.DatabaseSettings.use_unicode">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">use_unicode</span></code><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.use_unicode" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="cpl_core.database.database_settings.DatabaseSettings.user">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">user</span></code><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.user" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl> </dd></dl>
</div> </div>
<div class="section" id="module-cpl_core.database.database_settings_name_enum"> <div class="section" id="module-cpl_core.database.database_settings_name_enum">
<span id="cpl-core-database-database-settings-name-enum"></span><h2>cpl_core.database.database_settings_name_enum<a class="headerlink" href="#module-cpl_core.database.database_settings_name_enum" title="Permalink to this headline"></a></h2> <span id="cpl-core-database-database-settings-name-enum"></span><h2>cpl_core.database.database_settings_name_enum<a class="headerlink" href="#module-cpl_core.database.database_settings_name_enum" title="Permalink to this headline"></a></h2>
<dl class="py class"> <dl class="py class">
<dt class="sig sig-object py" id="cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum"> <dt id="cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum">
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">cpl_core.database.database_settings_name_enum.</span></span><span class="sig-name descname"><span class="pre">DatabaseSettingsNameEnum</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum" title="Permalink to this definition"></a></dt> <em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_core.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_core.database.database_settings_name_enum.DatabaseSettingsNameEnum" 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> <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">enum.Enum</span></code></p>
<p>An enumeration.</p> <p>An enumeration.</p>
<dl class="py attribute"> <dl class="py attribute">
<dt class="sig sig-object py" id="cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.auth_plugin"> <dt id="cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.auth_plugin">
<span class="sig-name descname"><span class="pre">auth_plugin</span></span><em class="property"> <span class="pre">=</span> <span class="pre">'AuthPlugin'</span></em><a class="headerlink" href="#cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.auth_plugin" title="Permalink to this definition"></a></dt> <code class="sig-name descname"><span class="pre">auth_plugin</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'AuthPlugin'</span></em><a class="headerlink" href="#cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.auth_plugin" title="Permalink to this definition"></a></dt>
<dd></dd></dl> <dd></dd></dl>
<dl class="py attribute"> <dl class="py attribute">
<dt class="sig sig-object py" id="cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.case_sensitive"> <dt id="cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.buffered">
<span class="sig-name descname"><span class="pre">case_sensitive</span></span><em class="property"> <span class="pre">=</span> <span class="pre">'CaseSensitive'</span></em><a class="headerlink" href="#cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.case_sensitive" title="Permalink to this definition"></a></dt> <code class="sig-name descname"><span class="pre">buffered</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'Buffered'</span></em><a class="headerlink" href="#cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.buffered" title="Permalink to this definition"></a></dt>
<dd></dd></dl> <dd></dd></dl>
<dl class="py attribute"> <dl class="py attribute">
<dt class="sig sig-object py" id="cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.connection_string"> <dt id="cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.charset">
<span class="sig-name descname"><span class="pre">connection_string</span></span><em class="property"> <span class="pre">=</span> <span class="pre">'ConnectionString'</span></em><a class="headerlink" href="#cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.connection_string" title="Permalink to this definition"></a></dt> <code class="sig-name descname"><span class="pre">charset</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'Charset'</span></em><a class="headerlink" href="#cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.charset" title="Permalink to this definition"></a></dt>
<dd></dd></dl> <dd></dd></dl>
<dl class="py attribute"> <dl class="py attribute">
<dt class="sig sig-object py" id="cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.credentials"> <dt id="cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.database">
<span class="sig-name descname"><span class="pre">credentials</span></span><em class="property"> <span class="pre">=</span> <span class="pre">'Credentials'</span></em><a class="headerlink" href="#cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.credentials" title="Permalink to this definition"></a></dt> <code class="sig-name descname"><span class="pre">database</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'Database'</span></em><a class="headerlink" href="#cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.database" title="Permalink to this definition"></a></dt>
<dd></dd></dl> <dd></dd></dl>
<dl class="py attribute"> <dl class="py attribute">
<dt class="sig sig-object py" id="cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.echo"> <dt id="cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.host">
<span class="sig-name descname"><span class="pre">echo</span></span><em class="property"> <span class="pre">=</span> <span class="pre">'Echo'</span></em><a class="headerlink" href="#cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.echo" title="Permalink to this definition"></a></dt> <code class="sig-name descname"><span class="pre">host</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'Host'</span></em><a class="headerlink" href="#cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.host" title="Permalink to this definition"></a></dt>
<dd></dd></dl> <dd></dd></dl>
<dl class="py attribute"> <dl class="py attribute">
<dt class="sig sig-object py" id="cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.encoding"> <dt id="cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.password">
<span class="sig-name descname"><span class="pre">encoding</span></span><em class="property"> <span class="pre">=</span> <span class="pre">'Encoding'</span></em><a class="headerlink" href="#cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.encoding" title="Permalink to this definition"></a></dt> <code class="sig-name descname"><span class="pre">password</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'Password'</span></em><a class="headerlink" href="#cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.password" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.use_unicode">
<code class="sig-name descname"><span class="pre">use_unicode</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'UseUnicode'</span></em><a class="headerlink" href="#cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.use_unicode" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.user">
<code class="sig-name descname"><span class="pre">user</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'User'</span></em><a class="headerlink" href="#cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.user" title="Permalink to this definition"></a></dt>
<dd></dd></dl> <dd></dd></dl>
</dd></dl> </dd></dl>
@ -202,33 +312,50 @@
</div> </div>
</div> </div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> <footer>
<a href="cpl_core.console.html" class="btn btn-neutral float-left" title="cpl_core.console" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="cpl_core.database.connection.html" class="btn btn-neutral float-right" title="cpl_core.database.connection" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> <a href="cpl_core.database.connection.html" class="btn btn-neutral float-right" title="cpl_core.database.connection" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="cpl_core.console.html" class="btn btn-neutral float-left" title="cpl_core.console" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div> </div>
<hr/> <hr/>
<div role="contentinfo"> <div role="contentinfo">
<p>&#169; Copyright 2021, Sven Heidemann.</p> <p>
&#169; Copyright 2021, Sven Heidemann.
</p>
</div> </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>.
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> </footer>
</div> </div>
</div> </div>
</section> </section>
</div> </div>
<script>
<script type="text/javascript">
jQuery(function () { jQuery(function () {
SphinxRtdTheme.Navigation.enable(true); SphinxRtdTheme.Navigation.enable(true);
}); });
</script> </script>
</body> </body>
</html> </html>

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