Added cli docs

This commit is contained in:
Sven Heidemann 2021-05-17 18:32:09 +02:00
parent 850d44a105
commit 654fb69295
113 changed files with 7024 additions and 50 deletions

BIN
docs/build/doctrees/cli.add.doctree vendored Normal file

Binary file not shown.

BIN
docs/build/doctrees/cli.build.doctree vendored Normal file

Binary file not shown.

BIN
docs/build/doctrees/cli.generate.doctree vendored Normal file

Binary file not shown.

BIN
docs/build/doctrees/cli.help.doctree vendored Normal file

Binary file not shown.

BIN
docs/build/doctrees/cli.install.doctree vendored Normal file

Binary file not shown.

BIN
docs/build/doctrees/cli.new.doctree vendored Normal file

Binary file not shown.

BIN
docs/build/doctrees/cli.overview.doctree vendored Normal file

Binary file not shown.

BIN
docs/build/doctrees/cli.publish.doctree vendored Normal file

Binary file not shown.

BIN
docs/build/doctrees/cli.remove.doctree vendored Normal file

Binary file not shown.

BIN
docs/build/doctrees/cli.start.doctree vendored Normal file

Binary file not shown.

Binary file not shown.

BIN
docs/build/doctrees/cli.update.doctree vendored Normal file

Binary file not shown.

BIN
docs/build/doctrees/cli.version.doctree vendored Normal file

Binary file not shown.

BIN
docs/build/doctrees/contributing.doctree vendored Normal file

Binary file not shown.

Binary file not shown.

BIN
docs/build/doctrees/cpl_cli.doctree vendored Normal file

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

BIN
docs/build/doctrees/introduction.doctree vendored Normal file

Binary file not shown.

Binary file not shown.

BIN
docs/build/doctrees/quickstart.doctree vendored Normal file

Binary file not shown.

BIN
docs/build/doctrees/setup.doctree vendored Normal file

Binary file not shown.

BIN
docs/build/html/_images/ide-emulate.png vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 55 KiB

BIN
docs/build/html/_images/ide-src.png vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 54 KiB

BIN
docs/build/html/_images/ide.png vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 28 KiB

25
docs/build/html/_sources/cli.add.md.txt vendored Normal file
View File

@ -0,0 +1,25 @@
# cpl add
## Contents
- [Description](#description)
- [Arguments](#arguments)
Removes a project from workspace.
cpl **add** *&lt;source-project&gt;* *&lt;target-project&gt;* <br>
cpl **a** *&lt;source-project&gt;* *&lt;target-project&gt;* <br>
cpl **A** *&lt;source-project&gt;* *&lt;target-project&gt;*
## Description
Adds a project reference to given project.
If you call the command in a CPL workspace, you can use the project names. Otherwise the paths of the projects must be specified.
## Arguments
| Argument | Description | Value type |
| ------------------------- |:---------------------------------------------------------------:|:----------------:|
| ```<source-project>``` | Name of the project to which the reference has to be added | ```str```
| ```<target-project>``` | Name of the project to be referenced | ```str```

View File

@ -0,0 +1,26 @@
# cpl build
## Contents
- [Description](#description)
<!-- - [Arguments](#arguments) -->
Copies an python app into an output directory named build/ at the given output path. Must be executed within a CPL workspace or project directory
cpl **build** <br>
cpl **b** <br>
cpl **B**
## Description
The command can be used to build a project of type "console" or "library".
The build command copies all included source files to the output directory. You can run the source files in the output directory directly.
The command is used to prepare the source files for the publish command or to copy them to an target for execution.
<!-- ## Arguments
| Argument | Description | Value type |
| ------------- |:-------------:|:----------------:|
| ```<project>``` | The name of the project to build. Can be an console or a library. | ```str``` -->

View File

@ -0,0 +1,35 @@
# cpl generate
## Contents
- [Description](#description)
- [Arguments](#arguments)
- [Schematics](#schematics)
Generate a file based on schematic.
cpl **generate** *&lt;schematic&gt;* *&lt;name&gt;* <br>
cpl **g** *&lt;schematic&gt;* *&lt;name&gt;* <br>
cpl **G** *&lt;schematic&gt;* *&lt;name&gt;*
## Description
Generates files based on a schematic.
## Arguments
| Argument | Description | Value type |
| ----------------- |:---------------------------------:|:-------------:|
| ```<schematic>``` | The schematic to generate. | ```str``` |
| ```<name>``` | The name of the generated file. | ```str``` |
## Schematics
| Schematic | Description | Arguments |
| ----------------- |:-------------------:|:----------------:|
| ```abc``` | Abstract base class | ```<name>```
| ```class``` | Class | ```<name>```
| ```enum``` | Enum class | ```<name>```
| ```service``` | Service class | ```<name>```
| ```settings``` | [Configmodel](cpl.configuration) | ```<name>```
| ```thread``` | Thread class | ```<name>```

View File

@ -0,0 +1,22 @@
# cpl help
<!-- ## Contents
- [Description](#description) -->
<!-- - [Arguments](#arguments) -->
Lists available command and their short descriptions.
cpl **help** *&lt;command&gt;* <br>
cpl **h** *&lt;command&gt;* <br>
cpl **H** *&lt;command&gt;*
## Description
Lists available command and their short descriptions.
## Arguments
| Argument | Description | Value type |
| ----------------- |:-----------------------------:|:-------------:|
| ```<command>``` | Shows a help message for this command in the console. | ```str``` |

View File

@ -0,0 +1,23 @@
# cpl install
## Contents
- [Description](#description)
- [Arguments](#arguments)
Installs given package via pip
cpl **install** *&lt;package&gt;* <br>
cpl **i** *&lt;package&gt;* <br>
cpl **I** *&lt;package&gt;*
## Description
Install given package to project via pip.
Without given package it will install the depedencies of the CPL project your in.
## Arguments
| Argument | Description | Value type |
| ----------------- |:-----------------------------:|:-------------:|
| ```<package>``` | The package to install | ```str``` |

31
docs/build/html/_sources/cli.new.md.txt vendored Normal file
View File

@ -0,0 +1,31 @@
# cpl new
## Contents
- [Description](#description)
- [Arguments](#arguments)
- [Project types](#project-types)
Generates a workspace and initial project or add a project to workspace.
cpl **new** *&lt;type&gt;* *&lt;name&gt;*<br>
cpl **n** *&lt;type&gt;* *&lt;name&gt;* <br>
cpl **N** *&lt;type&gt;* *&lt;name&gt;*
## Description
Generates a workspace and initial project or add a project to workspace.
If the command is running in a CPL workspace, it will add the new project to the workspace.
| Argument | Description | Value type |
| ----------------- |:-----------------------------------------------------:|:-------------:|
| ```<type>``` | The type of the project, see [types](#project-types) | ```str``` |
| ```<name>``` | The name of the project | ```str``` |
## Project types
| Project type | Description |
| ----------------- |:-----------------------------:|
| ```console``` | A simple console application |
| ```library``` | A package |

View File

@ -0,0 +1,53 @@
# CLI Overview and Command Reference
## Table of Contents
1. [Install CPL](setup#install-the-package)
2. [Install CPL CLI](setup#install-the-cli)
3. [Basic workflow](#basic-workflow)
4. [CLI command-language syntax](#cli-command-language-syntax)
5. [Command overview](#command-overview)
## Basic workflow
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:
```sh
cpl new console my-first-project
cd my-first-project
cpl start
```
In the terminal you will the output of the app.
## CLI command-language syntax
```cpl``` commandNameOrAlias requiredArg ```[optionalsArgs]```
- Most commands, and some options, have aliases. Aliases are shown in the syntax statement for each command.
- Arguments are not prefixed.
### Relative paths
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.
### Schematics
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.
## Command overview
| Command | Alias | Description |
| ----------------------------- |:-------------:|:----------------:|
| [add](cli.add) | a or a | Adds a project reference to given project.
| [build](cli.build) | b or B | Prepares files for publish into an output directory named dist/ at the given output path. Must be executed from within a workspace directory.
| [generate](cli.generate) | g or G | Generate a new file.
| [help](cli.help) | h or H | Lists available command and their short descriptions.
| [install](cli.install) | i or I | With argument installs packages to project, without argument installs project dependencies.
| [new](cli.new) | n or N | Creates new CPL project.
| [publish](cli.publish) | p or P | Prepares files for publish into an output directory named dist/ at the given output path and executes ```setup.py```. Must be executed from within a library workspace directory.
| [remove](cli.remove) | r or R | Removes a project from workspace.
| [start](cli.start) | s or S | Starts CPL project, restarting on file changes.
| [uninstall](cli.uninstall) | ui or UI | Uninstalls packages from project.
| [update](cli.update) | u or U | Update CPL and project dependencies.
| [version](cli.version) | v or V | Outputs CPL CLI version.

View File

@ -0,0 +1,27 @@
# cpl publish
## Contents
- [Description](#description)
<!-- - [Arguments](#arguments) -->
Prepares files for publish into an output directory named dist/ at the given output path and executes ```setup.py```.
cpl **publish** <br>
cpl **p** <br>
cpl **P**
## Description
The command can be used to publish a project of type "console" or "library".
The publish command builds the source files and then creates an ```setup.py``` with data from ```cpl.json```.
The command executes the ```setup.py``` and removes all source files with the ```setup.py``` from the 'publish/' directory.
Generated files of ```setup.py``` are in the 'publish/setup/' directory.
<!-- ## Arguments
| Argument | Description | Value type |
| ------------- |:-------------:|:----------------:|
| ```<project>``` | The name of the project to build. Can be an console or a library. | ```str``` -->

View File

@ -0,0 +1,27 @@
# cpl remove
## Contents
- [Description](#description)
- [Arguments](#arguments)
Removes a project from workspace.
cpl **remove** *&lt;project&gt;* <br>
cpl **r** *&lt;project&gt;* <br>
cpl **R** *&lt;project&gt;*
## Description
The command can be used to publish a project of type "console" or "library".
The publish command builds the source files and then creates an ```setup.py``` with data from ```cpl.json```.
The command executes the ```setup.py``` and removes all source files with the ```setup.py``` from the 'publish/' directory.
Generated files of ```setup.py``` are in the 'publish/setup/' directory.
## Arguments
| Argument | Description | Value type |
| ------------------------- |:-------------------------------------:|:----------------:|
| ```<project>``` | The name of the project to delete | ```str```

View File

@ -0,0 +1,7 @@
# cpl start
Starts your application, restarting on file changes.
cpl **start** <br>
cpl **s** <br>
cpl **S**

View File

@ -0,0 +1,22 @@
# cpl uninstall
## Contents
- [Description](#description)
- [Arguments](#arguments)
Uninstalls given package via pip
cpl **uninstall** *&lt;package&gt;* <br>
cpl **ui** *&lt;package&gt;* <br>
cpl **UI** *&lt;package&gt;*
## Description
Uninstall given package from project via pip.
## Arguments
| Argument | Description | Value type |
| ----------------- |:-----------------------------:|:-------------:|
| ```<package>``` | The package to uninstall | ```str``` |

View File

@ -0,0 +1,7 @@
# cpl update
Updates the CPL and project dependencies.
cpl **update** <br>
cpl **u** <br>
cpl **U**

View File

@ -0,0 +1,7 @@
# cpl version
Lists the version of CPL, CPL CLI and all installed packages from pip.
cpl **version** <br>
cpl **v** <br>
cpl **V**

View File

@ -0,0 +1,111 @@
# Contributing to CPL
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:
- [Issuses and Bugs](#found-a-bug)
- [Feature Request](#feature-request)
- [Submission Guidelines](#submission-guidelines)
- [Coding Rules](#coding-rules)
- [License](#license)
## Found a Bug?
If you find a bug in the source code, you can help us by [submitting an issue](#submitting-an-issue) to our [Gitea Repository][gitea-repo]. Even better, you can [submit a Pull Request](#submitting-a-pull-request) with a fix.
## Feature Request
You can request a new feature by submitting an issue to our [Gitea Repository][gitea-repo]. 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:
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.
Note: Adding a new topic to the documentation, or significantly re-writing a topic, counts as a major feature.
Small Features can be crafted and directly submitted as a [Pull Request](#submit-pr).
## Submission Guidelines
### Submitting an Issue
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.
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.
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.
We require a minimal reproduction to save maintainers' time and ultimately be able to fix more bugs. Often, developers find coding problems themselves while preparing a minimal reproduction. We understand that sometimes it might be hard to extract essential bits of code from a larger codebase but we really need to isolate the problem before we can fix it.
Unfortunately, we are not able to investigate / fix bugs without a minimal reproduction, so if we don't hear back from you, we are going to close an issue that doesn't have enough info to be reproduced.
### Submitting a Pull Request
Before you submit your Pull Request (PR) consider the following guidelines:
1. Search the [repository][gitea-repo] for an open or closed PR that relates to your submission. You don't want to duplicate existing efforts.
2. Be sure that an issue describes the problem you're fixing, or documents the design for the feature you'd like to add. Discussing the design upfront helps to ensure that we're ready to accept your work.
3. Fork the sh-edraft.de/sh_cpl repo.
4. In your forked repository, make your changes in a new git branch:
```sh
git checkout -b my-fix-branch master
```
5. Create your patch, including appropriate test cases.
<!-- 6. Follow our [Coding Rules](coding-rules). -->
6. Commit your changes.
```sh
git commit --all
```
Note: the optional commit ```-a``` command line option will automatically "add" and "rm" edited files.
7. Push your branch to the [repository][gitea-repo]:
```sh
git push origin my-fix-branch
```
8. In Gitea, send a pull request to sh_cpl:master
### Reviewing a Pull Request
The sh-edraft.de team reserves the right not to accept pull requests from community members who haven't been good citizens of the community. Such behavior includes not following the CPL [coding rules](#coding-rules) and applies within or outside of CPL managed channels.
#### Addressing review feedback
If we ask for changes via code reviews then:
1. Make the required updates to the code.
2. Create a fixup commit and push to your repository (this will update your Pull Request):
```sh
git commit --all --fixup HEAD
git push
```
That's it! Thank you for your contribution!
## Coding Rules
To ensure consistency throughout the source code, keep these rules in mind as you are working:
- All features or bug fixes must be tested by one or more unit-tests.
- All public API methods must be documented.
- We follow [PEP 8 -- Style Guide for Python Code](https://www.python.org/dev/peps/pep-0008/).
## License
By contributing, you agree that your contributions will be licensed under its MIT License.
See [LICENSE](https://git.sh-edraft.de/sh-edraft.de/sh_cpl/src/branch/master/LICENSE)
<!-- LINKS -->
[gitea-repo]: https://git.sh-edraft.de/sh-edraft.de/sh_cpl/
[coding-rules]: /

View File

@ -1,4 +1,4 @@
CPL
API Reference
===========
.. toctree::
@ -14,4 +14,3 @@ CPL
cpl.mailing
cpl.time
cpl.utils

View File

@ -0,0 +1,19 @@
CLI Reference
=============
.. toctree::
:maxdepth: 4
cli.overview
cli.add
cli.build
cli.generate
cli.help
cli.install
cli.new
cli.publish
cli.remove
cli.start
cli.uninstall
cli.update
cli.version

View File

@ -0,0 +1,9 @@
Getting started
===============
.. toctree::
:maxdepth: 4
quickstart
setup

View File

@ -4,7 +4,7 @@
contain the root `toctree` directive.
Introduction to the CPL Docs
===========================
============================
The Common Python Library (CPL) is a package for python and a development platform meant to help you create simple and efficient server and desktop applications.
@ -18,4 +18,7 @@ These pages go into great detail about everything the Library can do.
.. toctree::
:maxdepth: 1
introduction
getting_started
cpl
cpl_cli

View File

@ -0,0 +1,12 @@
# Introduction to the CPL Docs
The Common Python Library (CPL) is a package for python and a development platform meant to help you create simple and efficient server and desktop applications.
This CPL docs help you learn, understand and use the package. From your first application to complex apps for enterprises.
## Explore
- [Getting started](quickstart)
- [Setup](setup)
- [API Reference](cpl)
- [CLI Reference](cli.overview)

View File

@ -4,4 +4,6 @@ cpl
.. toctree::
:maxdepth: 4
getting_started
cpl
cpl_cli

View File

@ -0,0 +1,210 @@
# Getting started with CPL
Welcome to CPL!
This tutorial introduces you to the essentials of the CPL package by walking through building an console based app.
## Table of Contents
1. [Prerequisites](#prerequisites)
2. [Create the project](#create-the-project)
3. [Create a menu](#create-a-menu)
4. [What's next](#whats-next)
## Prerequisites
To get most out of this tutorial you should already have a basic understanding of the following.
- [Python][python]
Also you need to have the following installed.
- [Python][python]
- [Pip][pip-url]
- [CPL](setup)
- [CPL-CLI](setup)
## Create the project
To create the sample project to the following:
1. Open a terminal
2. Run
```sh
cpl new console sample-project
```
3. We don't want to use Application base or Dependency injection:
```sh
Do you want to use application base? (y/n) n
Do you want to use service providing? (y/n) n
```
The ouput should look like this:
```sh
Creating sample-project/LICENSE done
Creating sample-project/README.md done
Creating sample-project/src/tests/__init__.py done
Creating sample-project/appsettings.json done
Creating sample-project/src/sample-project/__init__.py done
Creating sample-project/src/sample-projectmain.py done
```
4. Open the project with an IDE like VS Code or PyCharm
![IDE](images/ide.png)
5. Set the 'src' directory as source folder
![IDE set src folder](images/ide-src.png)
6. Run the application
You should see an output like:
```sh
Hello World
```
7. In PyCharm you have to enable ```Emulate terminal in output console```!
![IDE emulate console](images/ide-emulate.png)
## Create a menu
1. Open the 'sample-project/main.py'
2. Change 'Hello World' to 'Password generator:' in line 5
3. Add ```Console.select``` as follows:
```py
from cpl.console import Console
def main():
Console.write_line('Password generator:')
options = [
'Only lower case',
'Only upper case',
'Lower and upper case'
'Exit'
]
option = Console.select('>', 'Select option: ', options)
if __name__ == '__main__':
main()
```
4. Get Id of the selected option:
```py
index = options.index(option)
```
5. Create the generate function as follows:
```py
def generate_password(letters: str, length: int) -> str:
return ''.join(random.choice(letters) for i in range(length))
```
Add imports:
```py
import random
import string
```
6. Get length of the password:
```py
length = int(Console.read('Length: '))
```
7. Validate the selected option:
```py
index = options.index(option)
letters = ''
if index == 0:
letters = string.ascii_lowercase
elif index == 1:
letters = string.ascii_uppercase
elif index == 2:
letters = string.ascii_letters
elif index == len(options) - 1:
exit()
```
8. Print the generated password:
```py
Console.write_line('Password: ', generate_password(letters, length))
```
9. The full 'sample-project/main.py':
```py
import random
import string
from cpl.console import Console
def generate_password(letters: str, length: int) -> str:
return ''.join(random.choice(letters) for i in range(length))
def main():
Console.write_line('Password generator:')
options = [
'Only lower case',
'Only upper case',
'Lower and upper case',
'Exit'
]
option = Console.select('>', 'Select option: ', options)
length = int(Console.read('Length: '))
index = options.index(option)
letters = ''
if index == 0:
letters = string.ascii_lowercase
elif index == 1:
letters = string.ascii_uppercase
elif index == 2:
letters = string.ascii_letters
elif index == len(options) - 1:
exit()
Console.write_line('Password: ', generate_password(letters, length))
if __name__ == '__main__':
main()
```
## What's next
In this section, you've created an application that uses user input to generate a password.
To continue exploring CPL and developing applications:
- [Application base](cpl.application)
- [Dependency injection](cpl.dependency_injection)
- [Console](cpl.console)
<!-- LINKS -->
[pip-url]: https://pip.sh-edraft.de
[python]: https://www.python.org/
[pip]: https://pypi.org/project/pip/

104
docs/build/html/_sources/setup.md.txt vendored Normal file
View File

@ -0,0 +1,104 @@
# Setting up the local environment and workspace
## Table of Contents
1. [Prerequisites](#prerequisites)
2. [Install the package](#install-the-package)
3. [Install the CLI](#install-the-cli)
4. [Create a initial application](#create-initial-console-app)
5. [Create a initial library](#create-initial-library)
6. [Start the application](#start-the-app)
7. [What's next](#whats-next)
## Prerequisites
To get most out of this tutorial you should already have a basic understanding of the following.
- [Python][python]
Also you need to have the following installed.
- [Python][python]
- [Pip][pip-url]
## Install the package
To install the package, open a terminal window and run the following command:
```sh
pip install sh_cpl --extra-index-url https://pip.sh-edraft.de
```
## Install the CLI
You use the CPL CLI to create projects, generate application and library code. You also use the CLI to build and publish your python packages.
To install the CLI, open a terminal window and run the following command:
```sh
pip install sh_cpl-cli --extra-index-url https://pip.sh-edraft.de
```
## Create initial console app
You develop apps and packages in the context of an CPL project which is defined in an cpl.json.
1. Run the CLI command ```cpl new console``` and provide the name my-app, as shown here:
```sh
cpl new console my-app
```
2. The cpl new command prompts you for information about features to include in the initial app. Decline the defaults by enter 'n' and press the Enter key.
The CLI create a new workspace and a simple 'Hello World' app, ready to run.
## Create initial library
You develop apps and packages in the context of an CPL project which is defined in an cpl.json.
1. Run the CLI command ```cpl new library``` and provide the name my-lib, as shown here:
```sh
cpl new library my-lib
```
2. The cpl new command prompts you for information about features to include in the initial library. Decline the defaults by enter 'n' and press the Enter key.
The CLI create a new workspace and a simple 'Hello World' library with CLI, ready to run.
## Start the app
The CLI includes a live development server, so that you can run your app locally.
1. Open a terminal window
2. To navigate to your project workspace, run the following command:
```sh
cd /path/to/project/name
```
3. To run the app run:
```sh
cpl start
```
The ```cpl start``` command launches the server, watches your source files, and restarts the app as you make chnages to thoses source files.
If your installation and setup was successful, you should see a output similar to the following:
```sh
Hello World
```
## What's next
- To learn more about the CPL CLI, see the [CLI Overview](cli.overview)
- Fore more informations about the Pyhton files generated by ```cpl new```, see [New Command](cli.new)
<!-- LINKS -->
[pip-url]: https://pip.sh-edraft.de
[python]: https://www.python.org/
[pip]: https://pypi.org/project/pip/

270
docs/build/html/cli.add.html vendored Normal file
View File

@ -0,0 +1,270 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>cpl add &mdash; Common Python Library documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="cpl build" href="cli.build.html" />
<link rel="prev" title="CLI Overview and Command Reference" href="cli.overview.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="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="cpl.html">API Reference</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI Reference</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl add</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#contents">Contents</a></li>
<li class="toctree-l3"><a class="reference internal" href="#description">Description</a></li>
<li class="toctree-l3"><a class="reference internal" href="#arguments">Arguments</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cli.build.html">cpl build</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.generate.html">cpl generate</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.help.html">cpl help</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.install.html">cpl install</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.new.html">cpl new</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.publish.html">cpl publish</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.remove.html">cpl remove</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.start.html">cpl start</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.uninstall.html">cpl uninstall</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.update.html">cpl update</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li>
</ul>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Common Python Library</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl_cli.html">CLI Reference</a> &raquo;</li>
<li>cpl add</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/cli.add.md.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="cpl-add">
<h1>cpl add<a class="headerlink" href="#cpl-add" title="Permalink to this headline"></a></h1>
<div class="section" id="contents">
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li><p><a class="reference external" href="#description">Description</a></p></li>
<li><p><a class="reference external" href="#arguments">Arguments</a></p></li>
</ul>
<p>Removes a project from workspace.</p>
<p>cpl <strong>add</strong> <em>&lt;source-project&gt;</em> <em>&lt;target-project&gt;</em> <br>
cpl <strong>a</strong> <em>&lt;source-project&gt;</em> <em>&lt;target-project&gt;</em> <br>
cpl <strong>A</strong> <em>&lt;source-project&gt;</em> <em>&lt;target-project&gt;</em></p>
</div>
<div class="section" id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>Adds a project reference to given project.</p>
<p>If you call the command in a CPL workspace, you can use the project names. Otherwise the paths of the projects must be specified.</p>
</div>
<div class="section" id="arguments">
<h2>Arguments<a class="headerlink" href="#arguments" title="Permalink to this headline"></a></h2>
<table class="colwidths-auto docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>Argument</p></th>
<th class="text-align:center head"><p>Description</p></th>
<th class="text-align:center head"><p>Value type</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">&lt;source-project&gt;</span></code></p></td>
<td class="text-align:center"><p>Name of the project to which the reference has to be added</p></td>
<td class="text-align:center"><p><code class="docutils literal notranslate"><span class="pre">str</span></code></p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">&lt;target-project&gt;</span></code></p></td>
<td class="text-align:center"><p>Name of the project to be referenced</p></td>
<td class="text-align:center"><p><code class="docutils literal notranslate"><span class="pre">str</span></code></p></td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="cli.build.html" class="btn btn-neutral float-right" title="cpl build" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="cli.overview.html" class="btn btn-neutral float-left" title="CLI Overview and Command Reference" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&#169; Copyright 2021, Sven Heidemann.
</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>

254
docs/build/html/cli.build.html vendored Normal file
View File

@ -0,0 +1,254 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>cpl build &mdash; Common Python Library documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="cpl generate" href="cli.generate.html" />
<link rel="prev" title="cpl add" href="cli.add.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="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="cpl.html">API Reference</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI Reference</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.add.html">cpl add</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl build</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#contents">Contents</a></li>
<li class="toctree-l3"><a class="reference internal" href="#description">Description</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cli.generate.html">cpl generate</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.help.html">cpl help</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.install.html">cpl install</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.new.html">cpl new</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.publish.html">cpl publish</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.remove.html">cpl remove</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.start.html">cpl start</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.uninstall.html">cpl uninstall</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.update.html">cpl update</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li>
</ul>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Common Python Library</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl_cli.html">CLI Reference</a> &raquo;</li>
<li>cpl build</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/cli.build.md.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="cpl-build">
<h1>cpl build<a class="headerlink" href="#cpl-build" title="Permalink to this headline"></a></h1>
<div class="section" id="contents">
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li><p><a class="reference external" href="#description">Description</a></p></li>
</ul>
<!-- - [Arguments](#arguments) -->
<p>Copies an python app into an output directory named build/ at the given output path. Must be executed within a CPL workspace or project directory</p>
<p>cpl <strong>build</strong> <br>
cpl <strong>b</strong> <br>
cpl <strong>B</strong></p>
</div>
<div class="section" id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>The command can be used to build a project of type “console” or “library”.</p>
<p>The build command copies all included source files to the output directory. You can run the source files in the output directory directly.</p>
<p>The command is used to prepare the source files for the publish command or to copy them to an target for execution.</p>
<!-- ## Arguments
| Argument | Description | Value type |
| ------------- |:-------------:|:----------------:|
| ```<project>``` | The name of the project to build. Can be an console or a library. | ```str``` -->
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="cli.generate.html" class="btn btn-neutral float-right" title="cpl generate" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="cli.add.html" class="btn btn-neutral float-left" title="cpl add" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&#169; Copyright 2021, Sven Heidemann.
</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>

308
docs/build/html/cli.generate.html vendored Normal file
View File

@ -0,0 +1,308 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>cpl generate &mdash; Common Python Library documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="cpl help" href="cli.help.html" />
<link rel="prev" title="cpl build" href="cli.build.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="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="cpl.html">API Reference</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI Reference</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.add.html">cpl add</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.build.html">cpl build</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl generate</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#contents">Contents</a></li>
<li class="toctree-l3"><a class="reference internal" href="#description">Description</a></li>
<li class="toctree-l3"><a class="reference internal" href="#arguments">Arguments</a></li>
<li class="toctree-l3"><a class="reference internal" href="#schematics">Schematics</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cli.help.html">cpl help</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.install.html">cpl install</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.new.html">cpl new</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.publish.html">cpl publish</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.remove.html">cpl remove</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.start.html">cpl start</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.uninstall.html">cpl uninstall</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.update.html">cpl update</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li>
</ul>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Common Python Library</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl_cli.html">CLI Reference</a> &raquo;</li>
<li>cpl generate</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/cli.generate.md.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="cpl-generate">
<h1>cpl generate<a class="headerlink" href="#cpl-generate" title="Permalink to this headline"></a></h1>
<div class="section" id="contents">
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li><p><a class="reference external" href="#description">Description</a></p></li>
<li><p><a class="reference external" href="#arguments">Arguments</a></p></li>
<li><p><a class="reference external" href="#schematics">Schematics</a></p></li>
</ul>
<p>Generate a file based on schematic.</p>
<p>cpl <strong>generate</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> <br>
cpl <strong>G</strong> <em>&lt;schematic&gt;</em> <em>&lt;name&gt;</em></p>
</div>
<div class="section" id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>Generates files based on a schematic.</p>
</div>
<div class="section" id="arguments">
<h2>Arguments<a class="headerlink" href="#arguments" title="Permalink to this headline"></a></h2>
<table class="colwidths-auto docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>Argument</p></th>
<th class="text-align:center head"><p>Description</p></th>
<th class="text-align:center head"><p>Value type</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">&lt;schematic&gt;</span></code></p></td>
<td class="text-align:center"><p>The schematic to generate.</p></td>
<td class="text-align:center"><p><code class="docutils literal notranslate"><span class="pre">str</span></code></p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">&lt;name&gt;</span></code></p></td>
<td class="text-align:center"><p>The name of the generated file.</p></td>
<td class="text-align:center"><p><code class="docutils literal notranslate"><span class="pre">str</span></code></p></td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="schematics">
<h2>Schematics<a class="headerlink" href="#schematics" title="Permalink to this headline"></a></h2>
<table class="colwidths-auto docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>Schematic</p></th>
<th class="text-align:center head"><p>Description</p></th>
<th class="text-align:center head"><p>Arguments</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">abc</span></code></p></td>
<td class="text-align:center"><p>Abstract base class</p></td>
<td class="text-align:center"><p><code class="docutils literal notranslate"><span class="pre">&lt;name&gt;</span></code></p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">class</span></code></p></td>
<td class="text-align:center"><p>Class</p></td>
<td class="text-align:center"><p><code class="docutils literal notranslate"><span class="pre">&lt;name&gt;</span></code></p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">enum</span></code></p></td>
<td class="text-align:center"><p>Enum class</p></td>
<td class="text-align:center"><p><code class="docutils literal notranslate"><span class="pre">&lt;name&gt;</span></code></p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">service</span></code></p></td>
<td class="text-align:center"><p>Service class</p></td>
<td class="text-align:center"><p><code class="docutils literal notranslate"><span class="pre">&lt;name&gt;</span></code></p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">settings</span></code></p></td>
<td class="text-align:center"><p><a class="reference internal" href="cpl.configuration.html"><span class="doc std std-doc">Configmodel</span></a></p></td>
<td class="text-align:center"><p><code class="docutils literal notranslate"><span class="pre">&lt;name&gt;</span></code></p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">thread</span></code></p></td>
<td class="text-align:center"><p>Thread class</p></td>
<td class="text-align:center"><p><code class="docutils literal notranslate"><span class="pre">&lt;name&gt;</span></code></p></td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="cli.help.html" class="btn btn-neutral float-right" title="cpl help" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="cli.build.html" class="btn btn-neutral float-left" title="cpl build" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&#169; Copyright 2021, Sven Heidemann.
</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>

261
docs/build/html/cli.help.html vendored Normal file
View File

@ -0,0 +1,261 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>cpl help &mdash; Common Python Library documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="cpl install" href="cli.install.html" />
<link rel="prev" title="cpl generate" href="cli.generate.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="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="cpl.html">API Reference</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI Reference</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.add.html">cpl add</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.build.html">cpl build</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.generate.html">cpl generate</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl help</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#description">Description</a></li>
<li class="toctree-l3"><a class="reference internal" href="#arguments">Arguments</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cli.install.html">cpl install</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.new.html">cpl new</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.publish.html">cpl publish</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.remove.html">cpl remove</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.start.html">cpl start</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.uninstall.html">cpl uninstall</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.update.html">cpl update</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li>
</ul>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Common Python Library</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl_cli.html">CLI Reference</a> &raquo;</li>
<li>cpl help</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/cli.help.md.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="cpl-help">
<h1>cpl help<a class="headerlink" href="#cpl-help" title="Permalink to this headline"></a></h1>
<!-- ## Contents
- [Description](#description) -->
<!-- - [Arguments](#arguments) -->
<p>Lists available command and their short descriptions.</p>
<p>cpl <strong>help</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>
<div class="section" id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>Lists available command and their short descriptions.</p>
</div>
<div class="section" id="arguments">
<h2>Arguments<a class="headerlink" href="#arguments" title="Permalink to this headline"></a></h2>
<table class="colwidths-auto docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>Argument</p></th>
<th class="text-align:center head"><p>Description</p></th>
<th class="text-align:center head"><p>Value type</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">&lt;command&gt;</span></code></p></td>
<td class="text-align:center"><p>Shows a help message for this command in the console.</p></td>
<td class="text-align:center"><p><code class="docutils literal notranslate"><span class="pre">str</span></code></p></td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="cli.install.html" class="btn btn-neutral float-right" title="cpl install" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="cli.generate.html" class="btn btn-neutral float-left" title="cpl generate" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&#169; Copyright 2021, Sven Heidemann.
</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>

266
docs/build/html/cli.install.html vendored Normal file
View File

@ -0,0 +1,266 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>cpl install &mdash; Common Python Library documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="cpl new" href="cli.new.html" />
<link rel="prev" title="cpl help" href="cli.help.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="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="cpl.html">API Reference</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI Reference</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.add.html">cpl add</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.build.html">cpl build</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.generate.html">cpl generate</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.help.html">cpl help</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl install</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#contents">Contents</a></li>
<li class="toctree-l3"><a class="reference internal" href="#description">Description</a></li>
<li class="toctree-l3"><a class="reference internal" href="#arguments">Arguments</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cli.new.html">cpl new</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.publish.html">cpl publish</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.remove.html">cpl remove</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.start.html">cpl start</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.uninstall.html">cpl uninstall</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.update.html">cpl update</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li>
</ul>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Common Python Library</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl_cli.html">CLI Reference</a> &raquo;</li>
<li>cpl install</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/cli.install.md.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="cpl-install">
<h1>cpl install<a class="headerlink" href="#cpl-install" title="Permalink to this headline"></a></h1>
<div class="section" id="contents">
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li><p><a class="reference external" href="#description">Description</a></p></li>
<li><p><a class="reference external" href="#arguments">Arguments</a></p></li>
</ul>
<p>Installs given package via pip</p>
<p>cpl <strong>install</strong> <em>&lt;package&gt;</em> <br>
cpl <strong>i</strong> <em>&lt;package&gt;</em> <br>
cpl <strong>I</strong> <em>&lt;package&gt;</em></p>
</div>
<div class="section" id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>Install given package to project via pip.
Without given package it will install the depedencies of the CPL project your in.</p>
</div>
<div class="section" id="arguments">
<h2>Arguments<a class="headerlink" href="#arguments" title="Permalink to this headline"></a></h2>
<table class="colwidths-auto docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>Argument</p></th>
<th class="text-align:center head"><p>Description</p></th>
<th class="text-align:center head"><p>Value type</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">&lt;package&gt;</span></code></p></td>
<td class="text-align:center"><p>The package to install</p></td>
<td class="text-align:center"><p><code class="docutils literal notranslate"><span class="pre">str</span></code></p></td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="cli.new.html" class="btn btn-neutral float-right" title="cpl new" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="cli.help.html" class="btn btn-neutral float-left" title="cpl help" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&#169; Copyright 2021, Sven Heidemann.
</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>

286
docs/build/html/cli.new.html vendored Normal file
View File

@ -0,0 +1,286 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>cpl new &mdash; Common Python Library documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="cpl publish" href="cli.publish.html" />
<link rel="prev" title="cpl install" href="cli.install.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="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="cpl.html">API Reference</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI Reference</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.add.html">cpl add</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.build.html">cpl build</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.generate.html">cpl generate</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.help.html">cpl help</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.install.html">cpl install</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl new</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#contents">Contents</a></li>
<li class="toctree-l3"><a class="reference internal" href="#description">Description</a></li>
<li class="toctree-l3"><a class="reference internal" href="#project-types">Project types</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cli.publish.html">cpl publish</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.remove.html">cpl remove</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.start.html">cpl start</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.uninstall.html">cpl uninstall</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.update.html">cpl update</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li>
</ul>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Common Python Library</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl_cli.html">CLI Reference</a> &raquo;</li>
<li>cpl new</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/cli.new.md.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="cpl-new">
<h1>cpl new<a class="headerlink" href="#cpl-new" title="Permalink to this headline"></a></h1>
<div class="section" id="contents">
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li><p><a class="reference external" href="#description">Description</a></p></li>
<li><p><a class="reference external" href="#arguments">Arguments</a></p></li>
<li><p><a class="reference external" href="#project-types">Project types</a></p></li>
</ul>
<p>Generates a workspace and initial project or add a project to workspace.</p>
<p>cpl <strong>new</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> <br>
cpl <strong>N</strong> <em>&lt;type&gt;</em> <em>&lt;name&gt;</em></p>
</div>
<div class="section" id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>Generates a workspace and initial project or add a project to workspace.</p>
<p>If the command is running in a CPL workspace, it will add the new project to the workspace.</p>
<table class="colwidths-auto docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>Argument</p></th>
<th class="text-align:center head"><p>Description</p></th>
<th class="text-align:center head"><p>Value type</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">&lt;type&gt;</span></code></p></td>
<td class="text-align:center"><p>The type of the project, see <a class="reference external" href="#project-types">types</a></p></td>
<td class="text-align:center"><p><code class="docutils literal notranslate"><span class="pre">str</span></code></p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">&lt;name&gt;</span></code></p></td>
<td class="text-align:center"><p>The name of the project</p></td>
<td class="text-align:center"><p><code class="docutils literal notranslate"><span class="pre">str</span></code></p></td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="project-types">
<h2>Project types<a class="headerlink" href="#project-types" title="Permalink to this headline"></a></h2>
<table class="colwidths-auto docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>Project type</p></th>
<th class="text-align:center head"><p>Description</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">console</span></code></p></td>
<td class="text-align:center"><p>A simple console application</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">library</span></code></p></td>
<td class="text-align:center"><p>A package</p></td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="cli.publish.html" class="btn btn-neutral float-right" title="cpl publish" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="cli.install.html" class="btn btn-neutral float-left" title="cpl install" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&#169; Copyright 2021, Sven Heidemann.
</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>

335
docs/build/html/cli.overview.html vendored Normal file
View File

@ -0,0 +1,335 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>CLI Overview and Command Reference &mdash; Common Python Library documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="cpl add" href="cli.add.html" />
<link rel="prev" title="CLI Reference" href="cpl_cli.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="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="cpl.html">API Reference</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI Reference</a><ul class="current">
<li class="toctree-l2 current"><a class="current reference internal" href="#">CLI Overview and Command Reference</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#table-of-contents">Table of Contents</a></li>
<li class="toctree-l3"><a class="reference internal" href="#basic-workflow">Basic workflow</a></li>
<li class="toctree-l3"><a class="reference internal" href="#cli-command-language-syntax">CLI command-language syntax</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#relative-paths">Relative paths</a></li>
<li class="toctree-l4"><a class="reference internal" href="#schematics">Schematics</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#command-overview">Command overview</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cli.add.html">cpl add</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.build.html">cpl build</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.generate.html">cpl generate</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.help.html">cpl help</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.install.html">cpl install</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.new.html">cpl new</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.publish.html">cpl publish</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.remove.html">cpl remove</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.start.html">cpl start</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.uninstall.html">cpl uninstall</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.update.html">cpl update</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li>
</ul>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Common Python Library</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl_cli.html">CLI Reference</a> &raquo;</li>
<li>CLI Overview and Command Reference</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/cli.overview.md.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="cli-overview-and-command-reference">
<h1>CLI Overview and Command Reference<a class="headerlink" href="#cli-overview-and-command-reference" title="Permalink to this headline"></a></h1>
<div class="section" id="table-of-contents">
<h2>Table of Contents<a class="headerlink" href="#table-of-contents" title="Permalink to this headline"></a></h2>
<ol class="simple">
<li><p><a class="reference external" href="setup#install-the-package">Install CPL</a></p></li>
<li><p><a class="reference external" href="setup#install-the-cli">Install CPL CLI</a></p></li>
<li><p><a class="reference external" href="#basic-workflow">Basic workflow</a></p></li>
<li><p><a class="reference external" href="#cli-command-language-syntax">CLI command-language syntax</a></p></li>
<li><p><a class="reference external" href="#command-overview">Command overview</a></p></li>
</ol>
</div>
<div class="section" id="basic-workflow">
<h2>Basic workflow<a class="headerlink" href="#basic-workflow" title="Permalink to this headline"></a></h2>
<p>To create, build, and serve a new, basic CPL project on a development server, go to the parent directory of your new workspace use the following commands:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>cpl new console my-first-project
<span class="nb">cd</span> my-first-project
cpl start
</pre></div>
</div>
<p>In the terminal you will the output of the app.</p>
</div>
<div class="section" id="cli-command-language-syntax">
<h2>CLI command-language syntax<a class="headerlink" href="#cli-command-language-syntax" title="Permalink to this headline"></a></h2>
<p><code class="docutils literal notranslate"><span class="pre">cpl</span></code> commandNameOrAlias requiredArg <code class="docutils literal notranslate"><span class="pre">[optionalsArgs]</span></code></p>
<ul class="simple">
<li><p>Most commands, and some options, have aliases. Aliases are shown in the syntax statement for each command.</p></li>
<li><p>Arguments are not prefixed.</p></li>
</ul>
<div class="section" id="relative-paths">
<h3>Relative paths<a class="headerlink" href="#relative-paths" title="Permalink to this headline"></a></h3>
<p>Options that specify files can be given as absolute paths, or as paths relative to the current working directory, which is generally either the workspace or project root.</p>
</div>
<div class="section" id="schematics">
<h3>Schematics<a class="headerlink" href="#schematics" title="Permalink to this headline"></a></h3>
<p>The cpl generate command takes as an argument the artifact to be generated. In addition to any general options, each artifact defines its own options in a schematic. Schematic options are supplied to the command in the same format as immediate command options.</p>
</div>
</div>
<div class="section" id="command-overview">
<h2>Command overview<a class="headerlink" href="#command-overview" title="Permalink to this headline"></a></h2>
<table class="colwidths-auto docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>Command</p></th>
<th class="text-align:center head"><p>Alias</p></th>
<th class="text-align:center head"><p>Description</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p><a class="reference internal" href="cli.add.html"><span class="doc std std-doc">add</span></a></p></td>
<td class="text-align:center"><p>a or a</p></td>
<td class="text-align:center"><p>Adds a project reference to given project.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="cli.build.html"><span class="doc std std-doc">build</span></a></p></td>
<td class="text-align:center"><p>b or B</p></td>
<td class="text-align:center"><p>Prepares files for publish into an output directory named dist/ at the given output path. Must be executed from within a workspace directory.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="cli.generate.html"><span class="doc std std-doc">generate</span></a></p></td>
<td class="text-align:center"><p>g or G</p></td>
<td class="text-align:center"><p>Generate a new file.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="cli.help.html"><span class="doc std std-doc">help</span></a></p></td>
<td class="text-align:center"><p>h or H</p></td>
<td class="text-align:center"><p>Lists available command and their short descriptions.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="cli.install.html"><span class="doc std std-doc">install</span></a></p></td>
<td class="text-align:center"><p>i or I</p></td>
<td class="text-align:center"><p>With argument installs packages to project, without argument installs project dependencies.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="cli.new.html"><span class="doc std std-doc">new</span></a></p></td>
<td class="text-align:center"><p>n or N</p></td>
<td class="text-align:center"><p>Creates new CPL project.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="cli.publish.html"><span class="doc std std-doc">publish</span></a></p></td>
<td class="text-align:center"><p>p or P</p></td>
<td class="text-align:center"><p>Prepares files for publish into an output directory named dist/ at the given output path and executes <code class="docutils literal notranslate"><span class="pre">setup.py</span></code>. Must be executed from within a library workspace directory.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="cli.remove.html"><span class="doc std std-doc">remove</span></a></p></td>
<td class="text-align:center"><p>r or R</p></td>
<td class="text-align:center"><p>Removes a project from workspace.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="cli.start.html"><span class="doc std std-doc">start</span></a></p></td>
<td class="text-align:center"><p>s or S</p></td>
<td class="text-align:center"><p>Starts CPL project, restarting on file changes.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="cli.uninstall.html"><span class="doc std std-doc">uninstall</span></a></p></td>
<td class="text-align:center"><p>ui or UI</p></td>
<td class="text-align:center"><p>Uninstalls packages from project.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="cli.update.html"><span class="doc std std-doc">update</span></a></p></td>
<td class="text-align:center"><p>u or U</p></td>
<td class="text-align:center"><p>Update CPL and project dependencies.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="cli.version.html"><span class="doc std std-doc">version</span></a></p></td>
<td class="text-align:center"><p>v or V</p></td>
<td class="text-align:center"><p>Outputs CPL CLI version.</p></td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="cli.add.html" class="btn btn-neutral float-right" title="cpl add" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="cpl_cli.html" class="btn btn-neutral float-left" title="CLI Reference" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&#169; Copyright 2021, Sven Heidemann.
</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>

254
docs/build/html/cli.publish.html vendored Normal file
View File

@ -0,0 +1,254 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>cpl publish &mdash; Common Python Library documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="cpl remove" href="cli.remove.html" />
<link rel="prev" title="cpl new" href="cli.new.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="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="cpl.html">API Reference</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI Reference</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.add.html">cpl add</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.build.html">cpl build</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.generate.html">cpl generate</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.help.html">cpl help</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.install.html">cpl install</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.new.html">cpl new</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl publish</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#contents">Contents</a></li>
<li class="toctree-l3"><a class="reference internal" href="#description">Description</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cli.remove.html">cpl remove</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.start.html">cpl start</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.uninstall.html">cpl uninstall</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.update.html">cpl update</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li>
</ul>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Common Python Library</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl_cli.html">CLI Reference</a> &raquo;</li>
<li>cpl publish</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/cli.publish.md.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="cpl-publish">
<h1>cpl publish<a class="headerlink" href="#cpl-publish" title="Permalink to this headline"></a></h1>
<div class="section" id="contents">
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li><p><a class="reference external" href="#description">Description</a></p></li>
</ul>
<!-- - [Arguments](#arguments) -->
<p>Prepares files for publish into an output directory named dist/ at the given output path and executes <code class="docutils literal notranslate"><span class="pre">setup.py</span></code>.</p>
<p>cpl <strong>publish</strong> <br>
cpl <strong>p</strong> <br>
cpl <strong>P</strong></p>
</div>
<div class="section" id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<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.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>
<p>Generated files of <code class="docutils literal notranslate"><span class="pre">setup.py</span></code> are in the publish/setup/ directory.</p>
<!-- ## Arguments
| Argument | Description | Value type |
| ------------- |:-------------:|:----------------:|
| ```<project>``` | The name of the project to build. Can be an console or a library. | ```str``` --></div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="cli.remove.html" class="btn btn-neutral float-right" title="cpl remove" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="cli.new.html" class="btn btn-neutral float-left" title="cpl new" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&#169; Copyright 2021, Sven Heidemann.
</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>

268
docs/build/html/cli.remove.html vendored Normal file
View File

@ -0,0 +1,268 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>cpl remove &mdash; Common Python Library documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="cpl start" href="cli.start.html" />
<link rel="prev" title="cpl publish" href="cli.publish.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="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="cpl.html">API Reference</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI Reference</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.add.html">cpl add</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.build.html">cpl build</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.generate.html">cpl generate</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.help.html">cpl help</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.install.html">cpl install</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.new.html">cpl new</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.publish.html">cpl publish</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl remove</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#contents">Contents</a></li>
<li class="toctree-l3"><a class="reference internal" href="#description">Description</a></li>
<li class="toctree-l3"><a class="reference internal" href="#arguments">Arguments</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cli.start.html">cpl start</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.uninstall.html">cpl uninstall</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.update.html">cpl update</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li>
</ul>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Common Python Library</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl_cli.html">CLI Reference</a> &raquo;</li>
<li>cpl remove</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/cli.remove.md.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="cpl-remove">
<h1>cpl remove<a class="headerlink" href="#cpl-remove" title="Permalink to this headline"></a></h1>
<div class="section" id="contents">
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li><p><a class="reference external" href="#description">Description</a></p></li>
<li><p><a class="reference external" href="#arguments">Arguments</a></p></li>
</ul>
<p>Removes a project from workspace.</p>
<p>cpl <strong>remove</strong> <em>&lt;project&gt;</em> <br>
cpl <strong>r</strong> <em>&lt;project&gt;</em> <br>
cpl <strong>R</strong> <em>&lt;project&gt;</em></p>
</div>
<div class="section" id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<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.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>
<p>Generated files of <code class="docutils literal notranslate"><span class="pre">setup.py</span></code> are in the publish/setup/ directory.</p>
</div>
<div class="section" id="arguments">
<h2>Arguments<a class="headerlink" href="#arguments" title="Permalink to this headline"></a></h2>
<table class="colwidths-auto docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>Argument</p></th>
<th class="text-align:center head"><p>Description</p></th>
<th class="text-align:center head"><p>Value type</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">&lt;project&gt;</span></code></p></td>
<td class="text-align:center"><p>The name of the project to delete</p></td>
<td class="text-align:center"><p><code class="docutils literal notranslate"><span class="pre">str</span></code></p></td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="cli.start.html" class="btn btn-neutral float-right" title="cpl start" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="cli.publish.html" class="btn btn-neutral float-left" title="cpl publish" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&#169; Copyright 2021, Sven Heidemann.
</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>

232
docs/build/html/cli.start.html vendored Normal file
View File

@ -0,0 +1,232 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>cpl start &mdash; Common Python Library documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="cpl uninstall" href="cli.uninstall.html" />
<link rel="prev" title="cpl remove" href="cli.remove.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="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="cpl.html">API Reference</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI Reference</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.add.html">cpl add</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.build.html">cpl build</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.generate.html">cpl generate</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.help.html">cpl help</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.install.html">cpl install</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.new.html">cpl new</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.publish.html">cpl publish</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.remove.html">cpl remove</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl start</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.uninstall.html">cpl uninstall</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.update.html">cpl update</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li>
</ul>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Common Python Library</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl_cli.html">CLI Reference</a> &raquo;</li>
<li>cpl start</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/cli.start.md.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="cpl-start">
<h1>cpl start<a class="headerlink" href="#cpl-start" title="Permalink to this headline"></a></h1>
<p>Starts your application, restarting on file changes.</p>
<p>cpl <strong>start</strong> <br>
cpl <strong>s</strong> <br>
cpl <strong>S</strong></p>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="cli.uninstall.html" class="btn btn-neutral float-right" title="cpl uninstall" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="cli.remove.html" class="btn btn-neutral float-left" title="cpl remove" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&#169; Copyright 2021, Sven Heidemann.
</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>

265
docs/build/html/cli.uninstall.html vendored Normal file
View File

@ -0,0 +1,265 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>cpl uninstall &mdash; Common Python Library documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="cpl update" href="cli.update.html" />
<link rel="prev" title="cpl start" href="cli.start.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="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="cpl.html">API Reference</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI Reference</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.add.html">cpl add</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.build.html">cpl build</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.generate.html">cpl generate</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.help.html">cpl help</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.install.html">cpl install</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.new.html">cpl new</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.publish.html">cpl publish</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.remove.html">cpl remove</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.start.html">cpl start</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl uninstall</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#contents">Contents</a></li>
<li class="toctree-l3"><a class="reference internal" href="#description">Description</a></li>
<li class="toctree-l3"><a class="reference internal" href="#arguments">Arguments</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cli.update.html">cpl update</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li>
</ul>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Common Python Library</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl_cli.html">CLI Reference</a> &raquo;</li>
<li>cpl uninstall</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/cli.uninstall.md.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="cpl-uninstall">
<h1>cpl uninstall<a class="headerlink" href="#cpl-uninstall" title="Permalink to this headline"></a></h1>
<div class="section" id="contents">
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li><p><a class="reference external" href="#description">Description</a></p></li>
<li><p><a class="reference external" href="#arguments">Arguments</a></p></li>
</ul>
<p>Uninstalls given package via pip</p>
<p>cpl <strong>uninstall</strong> <em>&lt;package&gt;</em> <br>
cpl <strong>ui</strong> <em>&lt;package&gt;</em> <br>
cpl <strong>UI</strong> <em>&lt;package&gt;</em></p>
</div>
<div class="section" id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>Uninstall given package from project via pip.</p>
</div>
<div class="section" id="arguments">
<h2>Arguments<a class="headerlink" href="#arguments" title="Permalink to this headline"></a></h2>
<table class="colwidths-auto docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>Argument</p></th>
<th class="text-align:center head"><p>Description</p></th>
<th class="text-align:center head"><p>Value type</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">&lt;package&gt;</span></code></p></td>
<td class="text-align:center"><p>The package to uninstall</p></td>
<td class="text-align:center"><p><code class="docutils literal notranslate"><span class="pre">str</span></code></p></td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="cli.update.html" class="btn btn-neutral float-right" title="cpl update" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="cli.start.html" class="btn btn-neutral float-left" title="cpl start" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&#169; Copyright 2021, Sven Heidemann.
</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>

232
docs/build/html/cli.update.html vendored Normal file
View File

@ -0,0 +1,232 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>cpl update &mdash; Common Python Library documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="cpl version" href="cli.version.html" />
<link rel="prev" title="cpl uninstall" href="cli.uninstall.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="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="cpl.html">API Reference</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI Reference</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.add.html">cpl add</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.build.html">cpl build</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.generate.html">cpl generate</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.help.html">cpl help</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.install.html">cpl install</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.new.html">cpl new</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.publish.html">cpl publish</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.remove.html">cpl remove</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.start.html">cpl start</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.uninstall.html">cpl uninstall</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl update</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li>
</ul>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Common Python Library</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl_cli.html">CLI Reference</a> &raquo;</li>
<li>cpl update</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/cli.update.md.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="cpl-update">
<h1>cpl update<a class="headerlink" href="#cpl-update" title="Permalink to this headline"></a></h1>
<p>Updates the CPL and project dependencies.</p>
<p>cpl <strong>update</strong> <br>
cpl <strong>u</strong> <br>
cpl <strong>U</strong></p>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="cli.version.html" class="btn btn-neutral float-right" title="cpl version" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="cli.uninstall.html" class="btn btn-neutral float-left" title="cpl uninstall" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&#169; Copyright 2021, Sven Heidemann.
</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>

230
docs/build/html/cli.version.html vendored Normal file
View File

@ -0,0 +1,230 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>cpl version &mdash; Common Python Library documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="prev" title="cpl update" href="cli.update.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="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="cpl.html">API Reference</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI Reference</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.add.html">cpl add</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.build.html">cpl build</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.generate.html">cpl generate</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.help.html">cpl help</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.install.html">cpl install</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.new.html">cpl new</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.publish.html">cpl publish</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.remove.html">cpl remove</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.start.html">cpl start</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.uninstall.html">cpl uninstall</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.update.html">cpl update</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl version</a></li>
</ul>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Common Python Library</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl_cli.html">CLI Reference</a> &raquo;</li>
<li>cpl version</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/cli.version.md.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="cpl-version">
<h1>cpl version<a class="headerlink" href="#cpl-version" title="Permalink to this headline"></a></h1>
<p>Lists the version of CPL, CPL CLI and all installed packages from pip.</p>
<p>cpl <strong>version</strong> <br>
cpl <strong>v</strong> <br>
cpl <strong>V</strong></p>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="cli.update.html" class="btn btn-neutral float-left" title="cpl update" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&#169; Copyright 2021, Sven Heidemann.
</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>

298
docs/build/html/contributing.html vendored Normal file
View File

@ -0,0 +1,298 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Contributing to CPL &mdash; Common Python Library documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul>
<li class="toctree-l1"><a class="reference internal" href="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="cpl.html">API Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI Reference</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Common Python Library</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li>Contributing to CPL</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/contributing.md.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="contributing-to-cpl">
<h1>Contributing to CPL<a class="headerlink" href="#contributing-to-cpl" title="Permalink to this headline"></a></h1>
<p>We would love for you to contribute to CPL and help make it even better than it is today! As a contributor, here are the guidelines we would like you to follow:</p>
<ul class="simple">
<li><p><a class="reference external" href="#found-a-bug">Issuses and Bugs</a></p></li>
<li><p><a class="reference external" href="#feature-request">Feature Request</a></p></li>
<li><p><a class="reference external" href="#submission-guidelines">Submission Guidelines</a></p></li>
<li><p><a class="reference external" href="#coding-rules">Coding Rules</a></p></li>
<li><p><a class="reference external" href="#license">License</a></p></li>
</ul>
<div class="section" id="found-a-bug">
<h2>Found a Bug?<a class="headerlink" href="#found-a-bug" title="Permalink to this headline"></a></h2>
<p>If you find a bug in the source code, you can help us by <a class="reference external" href="#submitting-an-issue">submitting an issue</a> to our <a class="reference external" href="https://git.sh-edraft.de/sh-edraft.de/sh_cpl/">Gitea Repository</a>. Even better, you can <a class="reference external" href="#submitting-a-pull-request">submit a Pull Request</a> with a fix.</p>
</div>
<div class="section" id="feature-request">
<h2>Feature Request<a class="headerlink" href="#feature-request" title="Permalink to this headline"></a></h2>
<p>You can request a new feature by submitting an issue to our <a class="reference external" href="https://git.sh-edraft.de/sh-edraft.de/sh_cpl/">Gitea Repository</a>. If you would like to implement a new feature, please consider the size of the change in order to determine the right steps to proceed:</p>
<p>For a Major Feature, first open an issue and outline your proposal so that it can be discussed. This process allows us to better coordinate our efforts, prevent duplication of work, and help you to craft the change so that it is successfully accepted into the project.</p>
<p>Note: Adding a new topic to the documentation, or significantly re-writing a topic, counts as a major feature.</p>
<p>Small Features can be crafted and directly submitted as a <a class="reference external" href="#submit-pr">Pull Request</a>.</p>
</div>
<div class="section" id="submission-guidelines">
<h2>Submission Guidelines<a class="headerlink" href="#submission-guidelines" title="Permalink to this headline"></a></h2>
<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>
<p>Before you submit an issue, please search the issue tracker, maybe an issue for your problem already exists and the discussion might inform you of workarounds readily available.</p>
<p>We want to fix all the issues as soon as possible, but before fixing a bug we need to reproduce and confirm it. In order to reproduce bugs, we require that you provide a minimal reproduction. Having a minimal reproducible scenario gives us a wealth of important information without going back and forth to you with additional questions.</p>
<p>A minimal reproduction allows us to quickly confirm a bug (or point out a coding problem) as well as confirm that we are fixing the right problem.</p>
<p>We require a minimal reproduction to save maintainers time and ultimately be able to fix more bugs. Often, developers find coding problems themselves while preparing a minimal reproduction. We understand that sometimes it might be hard to extract essential bits of code from a larger codebase but we really need to isolate the problem before we can fix it.</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 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>
<p>Before you submit your Pull Request (PR) consider the following guidelines:</p>
<ol>
<li><p>Search the <a class="reference external" href="https://git.sh-edraft.de/sh-edraft.de/sh_cpl/">repository</a> for an open or closed PR that relates to your submission. You dont want to duplicate existing efforts.</p></li>
<li><p>Be sure that an issue describes the problem youre fixing, or documents the design for the feature youd like to add. Discussing the design upfront helps to ensure that were ready to accept your work.</p></li>
<li><p>Fork the sh-edraft.de/sh_cpl repo.</p></li>
<li><p>In your forked repository, make your changes in a new git branch:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>git checkout -b my-fix-branch master
</pre></div>
</div>
</li>
<li><p>Create your patch, including appropriate test cases.</p></li>
</ol>
<!-- 6. Follow our [Coding Rules](coding-rules). -->
<ol>
<li><p>Commit your changes.</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>git commit --all
</pre></div>
</div>
<p>Note: the optional commit <code class="docutils literal notranslate"><span class="pre">-a</span></code> command line option will automatically “add” and “rm” edited files.</p>
</li>
<li><p>Push your branch to the <a class="reference external" href="https://git.sh-edraft.de/sh-edraft.de/sh_cpl/">repository</a>:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>git push origin my-fix-branch
</pre></div>
</div>
</li>
<li><p>In Gitea, send a pull request to sh_cpl:master</p></li>
</ol>
</div>
<div class="section" id="reviewing-a-pull-request">
<h3>Reviewing a Pull Request<a class="headerlink" href="#reviewing-a-pull-request" title="Permalink to this headline"></a></h3>
<p>The sh-edraft.de team reserves the right not to accept pull requests from community members who havent been good citizens of the community. Such behavior includes not following the CPL <a class="reference external" href="#coding-rules">coding rules</a> and applies within or outside of CPL managed channels.</p>
<div class="section" id="addressing-review-feedback">
<h4>Addressing review feedback<a class="headerlink" href="#addressing-review-feedback" title="Permalink to this headline"></a></h4>
<p>If we ask for changes via code reviews then:</p>
<ol>
<li><p>Make the required updates to the code.</p></li>
<li><p>Create a fixup commit and push to your repository (this will update your Pull Request):</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>git commit --all --fixup HEAD
git push
</pre></div>
</div>
</li>
</ol>
<p>Thats it! Thank you for your contribution!</p>
</div>
</div>
</div>
<div class="section" id="coding-rules">
<h2>Coding Rules<a class="headerlink" href="#coding-rules" title="Permalink to this headline"></a></h2>
<p>To ensure consistency throughout the source code, keep these rules in mind as you are working:</p>
<ul class="simple">
<li><p>All features or bug fixes must be tested by one or more unit-tests.</p></li>
<li><p>All public API methods must be documented.</p></li>
<li><p>We follow <a class="reference external" href="https://www.python.org/dev/peps/pep-0008/">PEP 8 Style Guide for Python Code</a>.</p></li>
</ul>
</div>
<div class="section" id="license">
<h2>License<a class="headerlink" href="#license" title="Permalink to this headline"></a></h2>
<p>By contributing, you agree that your contributions will be licensed under its MIT License.
See <a class="reference external" href="https://git.sh-edraft.de/sh-edraft.de/sh_cpl/src/branch/master/LICENSE">LICENSE</a></p>
<!-- LINKS -->
</div>
</div>
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>
&#169; Copyright 2021, Sven Heidemann.
</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>

View File

@ -39,7 +39,7 @@
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="cpl.configuration" href="cpl.configuration.html" />
<link rel="prev" title="CPL" href="cpl.html" />
<link rel="prev" title="API Reference" href="cpl.html" />
</head>
<body class="wy-body-for-nav">
@ -85,7 +85,9 @@
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="cpl.html">CPL</a><ul class="current">
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="cpl.html">API Reference</a><ul class="current">
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl.application</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.application.application_abc">cpl.application.application_abc</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.application.application_builder">cpl.application.application_builder</a></li>
@ -104,6 +106,7 @@
<li class="toctree-l2"><a class="reference internal" href="cpl.utils.html">cpl.utils</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI Reference</a></li>
</ul>
@ -152,7 +155,7 @@
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl.html">CPL</a> &raquo;</li>
<li><a href="cpl.html">API Reference</a> &raquo;</li>
<li>cpl.application</li>
@ -319,7 +322,7 @@
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="cpl.configuration.html" class="btn btn-neutral float-right" title="cpl.configuration" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="cpl.html" class="btn btn-neutral float-left" title="CPL" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="cpl.html" class="btn btn-neutral float-left" title="API Reference" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div>
<hr/>

View File

@ -85,7 +85,9 @@
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="cpl.html">CPL</a><ul class="current">
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="cpl.html">API Reference</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="cpl.application.html">cpl.application</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl.configuration</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.configuration.configuration">cpl.configuration.configuration</a></li>
@ -105,6 +107,7 @@
<li class="toctree-l2"><a class="reference internal" href="cpl.utils.html">cpl.utils</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI Reference</a></li>
</ul>
@ -153,7 +156,7 @@
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl.html">CPL</a> &raquo;</li>
<li><a href="cpl.html">API Reference</a> &raquo;</li>
<li>cpl.configuration</li>

View File

@ -85,7 +85,9 @@
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="cpl.html">CPL</a><ul class="current">
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="cpl.html">API Reference</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="cpl.application.html">cpl.application</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl.configuration.html">cpl.configuration</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl.console</a><ul>
@ -105,6 +107,7 @@
<li class="toctree-l2"><a class="reference internal" href="cpl.utils.html">cpl.utils</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI Reference</a></li>
</ul>
@ -153,7 +156,7 @@
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl.html">CPL</a> &raquo;</li>
<li><a href="cpl.html">API Reference</a> &raquo;</li>
<li>cpl.console</li>

View File

@ -85,7 +85,9 @@
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="cpl.html">CPL</a><ul class="current">
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="cpl.html">API Reference</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="cpl.application.html">cpl.application</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl.configuration.html">cpl.configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl.console.html">cpl.console</a></li>
@ -110,6 +112,7 @@
<li class="toctree-l2"><a class="reference internal" href="cpl.utils.html">cpl.utils</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI Reference</a></li>
</ul>
@ -158,7 +161,7 @@
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl.html">CPL</a> &raquo;</li>
<li><a href="cpl.html">API Reference</a> &raquo;</li>
<li><a href="cpl.database.html">cpl.database</a> &raquo;</li>

View File

@ -85,7 +85,9 @@
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="cpl.html">CPL</a><ul class="current">
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="cpl.html">API Reference</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="cpl.application.html">cpl.application</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl.configuration.html">cpl.configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl.console.html">cpl.console</a></li>
@ -110,6 +112,7 @@
<li class="toctree-l2"><a class="reference internal" href="cpl.utils.html">cpl.utils</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI Reference</a></li>
</ul>
@ -158,7 +161,7 @@
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl.html">CPL</a> &raquo;</li>
<li><a href="cpl.html">API Reference</a> &raquo;</li>
<li><a href="cpl.database.html">cpl.database</a> &raquo;</li>

View File

@ -85,7 +85,9 @@
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="cpl.html">CPL</a><ul class="current">
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="cpl.html">API Reference</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="cpl.application.html">cpl.application</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl.configuration.html">cpl.configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl.console.html">cpl.console</a></li>
@ -106,6 +108,7 @@
<li class="toctree-l2"><a class="reference internal" href="cpl.utils.html">cpl.utils</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI Reference</a></li>
</ul>
@ -154,7 +157,7 @@
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl.html">CPL</a> &raquo;</li>
<li><a href="cpl.html">API Reference</a> &raquo;</li>
<li>cpl.database</li>

View File

@ -85,7 +85,9 @@
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="cpl.html">CPL</a><ul class="current">
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="cpl.html">API Reference</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="cpl.application.html">cpl.application</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl.configuration.html">cpl.configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl.console.html">cpl.console</a></li>
@ -106,6 +108,7 @@
<li class="toctree-l2"><a class="reference internal" href="cpl.utils.html">cpl.utils</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI Reference</a></li>
</ul>
@ -154,7 +157,7 @@
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl.html">CPL</a> &raquo;</li>
<li><a href="cpl.html">API Reference</a> &raquo;</li>
<li>cpl.dependency_injection</li>

View File

@ -85,7 +85,9 @@
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="cpl.html">CPL</a><ul class="current">
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="cpl.html">API Reference</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="cpl.application.html">cpl.application</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl.configuration.html">cpl.configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl.console.html">cpl.console</a></li>
@ -103,6 +105,7 @@
<li class="toctree-l2"><a class="reference internal" href="cpl.utils.html">cpl.utils</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI Reference</a></li>
</ul>
@ -151,7 +154,7 @@
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl.html">CPL</a> &raquo;</li>
<li><a href="cpl.html">API Reference</a> &raquo;</li>
<li>cpl.environment</li>

View File

@ -7,7 +7,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>CPL &mdash; Common Python Library documentation</title>
<title>API Reference &mdash; Common Python Library documentation</title>
@ -39,7 +39,7 @@
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="cpl.application" href="cpl.application.html" />
<link rel="prev" title="Introduction to the CPL Docs" href="index.html" />
<link rel="prev" title="Setting up the local environment and workspace" href="setup.html" />
</head>
<body class="wy-body-for-nav">
@ -85,7 +85,9 @@
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">CPL</a><ul>
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">API Reference</a><ul>
<li class="toctree-l2"><a class="reference internal" href="cpl.application.html">cpl.application</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl.configuration.html">cpl.configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl.console.html">cpl.console</a></li>
@ -98,6 +100,7 @@
<li class="toctree-l2"><a class="reference internal" href="cpl.utils.html">cpl.utils</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI Reference</a></li>
</ul>
@ -146,7 +149,7 @@
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li>CPL</li>
<li>API Reference</li>
<li class="wy-breadcrumbs-aside">
@ -165,8 +168,8 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="cpl">
<h1>CPL<a class="headerlink" href="#cpl" title="Permalink to this headline"></a></h1>
<div class="section" id="api-reference">
<h1>API Reference<a class="headerlink" href="#api-reference" title="Permalink to this headline"></a></h1>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="cpl.application.html">cpl.application</a><ul>
@ -262,7 +265,7 @@
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="cpl.application.html" class="btn btn-neutral float-right" title="cpl.application" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="index.html" class="btn btn-neutral float-left" title="Introduction to the CPL Docs" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="setup.html" class="btn btn-neutral float-left" title="Setting up the local environment and workspace" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div>
<hr/>

View File

@ -85,7 +85,9 @@
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="cpl.html">CPL</a><ul class="current">
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="cpl.html">API Reference</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="cpl.application.html">cpl.application</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl.configuration.html">cpl.configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl.console.html">cpl.console</a></li>
@ -105,6 +107,7 @@
<li class="toctree-l2"><a class="reference internal" href="cpl.utils.html">cpl.utils</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI Reference</a></li>
</ul>
@ -153,7 +156,7 @@
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl.html">CPL</a> &raquo;</li>
<li><a href="cpl.html">API Reference</a> &raquo;</li>
<li>cpl.logging</li>

View File

@ -85,7 +85,9 @@
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="cpl.html">CPL</a><ul class="current">
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="cpl.html">API Reference</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="cpl.application.html">cpl.application</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl.configuration.html">cpl.configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl.console.html">cpl.console</a></li>
@ -105,6 +107,7 @@
<li class="toctree-l2"><a class="reference internal" href="cpl.utils.html">cpl.utils</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI Reference</a></li>
</ul>
@ -153,7 +156,7 @@
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl.html">CPL</a> &raquo;</li>
<li><a href="cpl.html">API Reference</a> &raquo;</li>
<li>cpl.mailing</li>

View File

@ -85,7 +85,9 @@
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="cpl.html">CPL</a><ul class="current">
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="cpl.html">API Reference</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="cpl.application.html">cpl.application</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl.configuration.html">cpl.configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl.console.html">cpl.console</a></li>
@ -102,6 +104,7 @@
<li class="toctree-l2"><a class="reference internal" href="cpl.utils.html">cpl.utils</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI Reference</a></li>
</ul>
@ -150,7 +153,7 @@
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl.html">CPL</a> &raquo;</li>
<li><a href="cpl.html">API Reference</a> &raquo;</li>
<li>cpl.time</li>

View File

@ -38,6 +38,7 @@
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="CLI Reference" href="cpl_cli.html" />
<link rel="prev" title="cpl.time" href="cpl.time.html" />
</head>
@ -84,7 +85,9 @@
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="cpl.html">CPL</a><ul class="current">
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="cpl.html">API Reference</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="cpl.application.html">cpl.application</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl.configuration.html">cpl.configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl.console.html">cpl.console</a></li>
@ -102,6 +105,7 @@
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI Reference</a></li>
</ul>
@ -150,7 +154,7 @@
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl.html">CPL</a> &raquo;</li>
<li><a href="cpl.html">API Reference</a> &raquo;</li>
<li>cpl.utils</li>
@ -407,6 +411,7 @@
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="cpl_cli.html" class="btn btn-neutral float-right" title="CLI Reference" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="cpl.time.html" class="btn btn-neutral float-left" title="cpl.time" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div>

296
docs/build/html/cpl_cli.html vendored Normal file
View File

@ -0,0 +1,296 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>CLI Reference &mdash; Common Python Library documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="CLI Overview and Command Reference" href="cli.overview.html" />
<link rel="prev" title="cpl.utils" href="cpl.utils.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="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="cpl.html">API Reference</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">CLI Reference</a><ul>
<li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.add.html">cpl add</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.build.html">cpl build</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.generate.html">cpl generate</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.help.html">cpl help</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.install.html">cpl install</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.new.html">cpl new</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.publish.html">cpl publish</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.remove.html">cpl remove</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.start.html">cpl start</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.uninstall.html">cpl uninstall</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.update.html">cpl update</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li>
</ul>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Common Python Library</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li>CLI Reference</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/cpl_cli.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="cli-reference">
<h1>CLI Reference<a class="headerlink" href="#cli-reference" title="Permalink to this headline"></a></h1>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a><ul>
<li class="toctree-l2"><a class="reference internal" href="cli.overview.html#table-of-contents">Table of Contents</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.overview.html#basic-workflow">Basic workflow</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.overview.html#cli-command-language-syntax">CLI command-language syntax</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cli.overview.html#relative-paths">Relative paths</a></li>
<li class="toctree-l3"><a class="reference internal" href="cli.overview.html#schematics">Schematics</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cli.overview.html#command-overview">Command overview</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="cli.add.html">cpl add</a><ul>
<li class="toctree-l2"><a class="reference internal" href="cli.add.html#contents">Contents</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.add.html#description">Description</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.add.html#arguments">Arguments</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="cli.build.html">cpl build</a><ul>
<li class="toctree-l2"><a class="reference internal" href="cli.build.html#contents">Contents</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.build.html#description">Description</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="cli.generate.html">cpl generate</a><ul>
<li class="toctree-l2"><a class="reference internal" href="cli.generate.html#contents">Contents</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.generate.html#description">Description</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.generate.html#arguments">Arguments</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.generate.html#schematics">Schematics</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="cli.help.html">cpl help</a><ul>
<li class="toctree-l2"><a class="reference internal" href="cli.help.html#description">Description</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.help.html#arguments">Arguments</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="cli.install.html">cpl install</a><ul>
<li class="toctree-l2"><a class="reference internal" href="cli.install.html#contents">Contents</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.install.html#description">Description</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.install.html#arguments">Arguments</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="cli.new.html">cpl new</a><ul>
<li class="toctree-l2"><a class="reference internal" href="cli.new.html#contents">Contents</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.new.html#description">Description</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.new.html#project-types">Project types</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="cli.publish.html">cpl publish</a><ul>
<li class="toctree-l2"><a class="reference internal" href="cli.publish.html#contents">Contents</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.publish.html#description">Description</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="cli.remove.html">cpl remove</a><ul>
<li class="toctree-l2"><a class="reference internal" href="cli.remove.html#contents">Contents</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.remove.html#description">Description</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.remove.html#arguments">Arguments</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="cli.start.html">cpl start</a></li>
<li class="toctree-l1"><a class="reference internal" href="cli.uninstall.html">cpl uninstall</a><ul>
<li class="toctree-l2"><a class="reference internal" href="cli.uninstall.html#contents">Contents</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.uninstall.html#description">Description</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.uninstall.html#arguments">Arguments</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="cli.update.html">cpl update</a></li>
<li class="toctree-l1"><a class="reference internal" href="cli.version.html">cpl version</a></li>
</ul>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="cli.overview.html" class="btn btn-neutral float-right" title="CLI Overview and Command Reference" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="cpl.utils.html" class="btn btn-neutral float-left" title="cpl.utils" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&#169; Copyright 2021, Sven Heidemann.
</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>

View File

@ -83,7 +83,10 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="cpl.html">CPL</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="cpl.html">API Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI Reference</a></li>
</ul>

238
docs/build/html/getting_started.html vendored Normal file
View File

@ -0,0 +1,238 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Getting started &mdash; Common Python Library documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Getting started with CPL" href="quickstart.html" />
<link rel="prev" title="Introduction to the CPL Docs" href="introduction.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Getting started</a><ul>
<li class="toctree-l2"><a class="reference internal" href="quickstart.html">Getting started with CPL</a></li>
<li class="toctree-l2"><a class="reference internal" href="setup.html">Setting up the local environment and workspace</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="cpl.html">API Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI Reference</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Common Python Library</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li>Getting started</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/getting_started.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="getting-started">
<h1>Getting started<a class="headerlink" href="#getting-started" title="Permalink to this headline"></a></h1>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="quickstart.html">Getting started with CPL</a><ul>
<li class="toctree-l2"><a class="reference internal" href="quickstart.html#table-of-contents">Table of Contents</a></li>
<li class="toctree-l2"><a class="reference internal" href="quickstart.html#prerequisites">Prerequisites</a></li>
<li class="toctree-l2"><a class="reference internal" href="quickstart.html#create-the-project">Create the project</a></li>
<li class="toctree-l2"><a class="reference internal" href="quickstart.html#create-a-menu">Create a menu</a></li>
<li class="toctree-l2"><a class="reference internal" href="quickstart.html#what-s-next">Whats next</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="setup.html">Setting up the local environment and workspace</a><ul>
<li class="toctree-l2"><a class="reference internal" href="setup.html#table-of-contents">Table of Contents</a></li>
<li class="toctree-l2"><a class="reference internal" href="setup.html#prerequisites">Prerequisites</a></li>
<li class="toctree-l2"><a class="reference internal" href="setup.html#install-the-package">Install the package</a></li>
<li class="toctree-l2"><a class="reference internal" href="setup.html#install-the-cli">Install the CLI</a></li>
<li class="toctree-l2"><a class="reference internal" href="setup.html#create-initial-console-app">Create initial console app</a></li>
<li class="toctree-l2"><a class="reference internal" href="setup.html#create-initial-library">Create initial library</a></li>
<li class="toctree-l2"><a class="reference internal" href="setup.html#start-the-app">Start the app</a></li>
<li class="toctree-l2"><a class="reference internal" href="setup.html#what-s-next">Whats next</a></li>
</ul>
</li>
</ul>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="quickstart.html" class="btn btn-neutral float-right" title="Getting started with CPL" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="introduction.html" class="btn btn-neutral float-left" title="Introduction to the CPL Docs" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&#169; Copyright 2021, Sven Heidemann.
</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>

View File

@ -38,7 +38,7 @@
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="CPL" href="cpl.html" />
<link rel="next" title="Introduction to the CPL Docs" href="introduction.html" />
</head>
<body class="wy-body-for-nav">
@ -84,7 +84,10 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="cpl.html">CPL</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="cpl.html">API Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI Reference</a></li>
</ul>
@ -161,7 +164,10 @@
<p>These pages go into great detail about everything the Library can do.</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="cpl.html">CPL</a></li>
<li class="toctree-l1"><a class="reference internal" href="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="cpl.html">API Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI Reference</a></li>
</ul>
</div>
</div>
@ -173,7 +179,7 @@
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="cpl.html" class="btn btn-neutral float-right" title="CPL" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="introduction.html" class="btn btn-neutral float-right" title="Introduction to the CPL Docs" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>

225
docs/build/html/introduction.html vendored Normal file
View File

@ -0,0 +1,225 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Introduction to the CPL Docs &mdash; Common Python Library documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Getting started" href="getting_started.html" />
<link rel="prev" title="Introduction to the CPL Docs" href="index.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">Introduction to the CPL Docs</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#explore">Explore</a></li>
</ul>
</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="cpl.html">API Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI Reference</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Common Python Library</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li>Introduction to the CPL Docs</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/introduction.md.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="introduction-to-the-cpl-docs">
<h1>Introduction to the CPL Docs<a class="headerlink" href="#introduction-to-the-cpl-docs" title="Permalink to this headline"></a></h1>
<p>The Common Python Library (CPL) is a package for python and a development platform meant to help you create simple and efficient server and desktop applications.</p>
<p>This CPL docs help you learn, understand and use the package. From your first application to complex apps for enterprises.</p>
<div class="section" id="explore">
<h2>Explore<a class="headerlink" href="#explore" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li><p><a class="reference internal" href="quickstart.html"><span class="doc std std-doc">Getting started</span></a></p></li>
<li><p><a class="reference internal" href="setup.html"><span class="doc std std-doc">Setup</span></a></p></li>
<li><p><a class="reference internal" href="cpl.html"><span class="doc std std-doc">API Reference</span></a></p></li>
<li><p><a class="reference internal" href="cli.overview.html"><span class="doc std std-doc">CLI Reference</span></a></p></li>
</ul>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="getting_started.html" class="btn btn-neutral float-right" title="Getting started" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="index.html" class="btn btn-neutral float-left" title="Introduction to the CPL Docs" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&#169; Copyright 2021, Sven Heidemann.
</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>

View File

@ -83,7 +83,10 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="cpl.html">CPL</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="cpl.html">API Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI Reference</a></li>
</ul>
@ -155,7 +158,29 @@
<h1>cpl<a class="headerlink" href="#cpl" title="Permalink to this headline"></a></h1>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="cpl.html">CPL</a><ul>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a><ul>
<li class="toctree-l2"><a class="reference internal" href="quickstart.html">Getting started with CPL</a><ul>
<li class="toctree-l3"><a class="reference internal" href="quickstart.html#table-of-contents">Table of Contents</a></li>
<li class="toctree-l3"><a class="reference internal" href="quickstart.html#prerequisites">Prerequisites</a></li>
<li class="toctree-l3"><a class="reference internal" href="quickstart.html#create-the-project">Create the project</a></li>
<li class="toctree-l3"><a class="reference internal" href="quickstart.html#create-a-menu">Create a menu</a></li>
<li class="toctree-l3"><a class="reference internal" href="quickstart.html#what-s-next">Whats next</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="setup.html">Setting up the local environment and workspace</a><ul>
<li class="toctree-l3"><a class="reference internal" href="setup.html#table-of-contents">Table of Contents</a></li>
<li class="toctree-l3"><a class="reference internal" href="setup.html#prerequisites">Prerequisites</a></li>
<li class="toctree-l3"><a class="reference internal" href="setup.html#install-the-package">Install the package</a></li>
<li class="toctree-l3"><a class="reference internal" href="setup.html#install-the-cli">Install the CLI</a></li>
<li class="toctree-l3"><a class="reference internal" href="setup.html#create-initial-console-app">Create initial console app</a></li>
<li class="toctree-l3"><a class="reference internal" href="setup.html#create-initial-library">Create initial library</a></li>
<li class="toctree-l3"><a class="reference internal" href="setup.html#start-the-app">Start the app</a></li>
<li class="toctree-l3"><a class="reference internal" href="setup.html#what-s-next">Whats next</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="cpl.html">API Reference</a><ul>
<li class="toctree-l2"><a class="reference internal" href="cpl.application.html">cpl.application</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl.application.html#module-cpl.application.application_abc">cpl.application.application_abc</a></li>
<li class="toctree-l3"><a class="reference internal" href="cpl.application.html#module-cpl.application.application_builder">cpl.application.application_builder</a></li>
@ -240,6 +265,75 @@
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI Reference</a><ul>
<li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cli.overview.html#table-of-contents">Table of Contents</a></li>
<li class="toctree-l3"><a class="reference internal" href="cli.overview.html#basic-workflow">Basic workflow</a></li>
<li class="toctree-l3"><a class="reference internal" href="cli.overview.html#cli-command-language-syntax">CLI command-language syntax</a><ul>
<li class="toctree-l4"><a class="reference internal" href="cli.overview.html#relative-paths">Relative paths</a></li>
<li class="toctree-l4"><a class="reference internal" href="cli.overview.html#schematics">Schematics</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="cli.overview.html#command-overview">Command overview</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cli.add.html">cpl add</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cli.add.html#contents">Contents</a></li>
<li class="toctree-l3"><a class="reference internal" href="cli.add.html#description">Description</a></li>
<li class="toctree-l3"><a class="reference internal" href="cli.add.html#arguments">Arguments</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cli.build.html">cpl build</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cli.build.html#contents">Contents</a></li>
<li class="toctree-l3"><a class="reference internal" href="cli.build.html#description">Description</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cli.generate.html">cpl generate</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cli.generate.html#contents">Contents</a></li>
<li class="toctree-l3"><a class="reference internal" href="cli.generate.html#description">Description</a></li>
<li class="toctree-l3"><a class="reference internal" href="cli.generate.html#arguments">Arguments</a></li>
<li class="toctree-l3"><a class="reference internal" href="cli.generate.html#schematics">Schematics</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cli.help.html">cpl help</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cli.help.html#description">Description</a></li>
<li class="toctree-l3"><a class="reference internal" href="cli.help.html#arguments">Arguments</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cli.install.html">cpl install</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cli.install.html#contents">Contents</a></li>
<li class="toctree-l3"><a class="reference internal" href="cli.install.html#description">Description</a></li>
<li class="toctree-l3"><a class="reference internal" href="cli.install.html#arguments">Arguments</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cli.new.html">cpl new</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cli.new.html#contents">Contents</a></li>
<li class="toctree-l3"><a class="reference internal" href="cli.new.html#description">Description</a></li>
<li class="toctree-l3"><a class="reference internal" href="cli.new.html#project-types">Project types</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cli.publish.html">cpl publish</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cli.publish.html#contents">Contents</a></li>
<li class="toctree-l3"><a class="reference internal" href="cli.publish.html#description">Description</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cli.remove.html">cpl remove</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cli.remove.html#contents">Contents</a></li>
<li class="toctree-l3"><a class="reference internal" href="cli.remove.html#description">Description</a></li>
<li class="toctree-l3"><a class="reference internal" href="cli.remove.html#arguments">Arguments</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cli.start.html">cpl start</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.uninstall.html">cpl uninstall</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cli.uninstall.html#contents">Contents</a></li>
<li class="toctree-l3"><a class="reference internal" href="cli.uninstall.html#description">Description</a></li>
<li class="toctree-l3"><a class="reference internal" href="cli.uninstall.html#arguments">Arguments</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cli.update.html">cpl update</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li>
</ul>
</li>
</ul>
</div>
</div>

Binary file not shown.

View File

@ -86,7 +86,10 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="cpl.html">CPL</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="cpl.html">API Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI Reference</a></li>
</ul>

415
docs/build/html/quickstart.html vendored Normal file
View File

@ -0,0 +1,415 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Getting started with CPL &mdash; Common Python Library documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Setting up the local environment and workspace" href="setup.html" />
<link rel="prev" title="Getting started" href="getting_started.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="getting_started.html">Getting started</a><ul class="current">
<li class="toctree-l2 current"><a class="current reference internal" href="#">Getting started with CPL</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#table-of-contents">Table of Contents</a></li>
<li class="toctree-l3"><a class="reference internal" href="#prerequisites">Prerequisites</a></li>
<li class="toctree-l3"><a class="reference internal" href="#create-the-project">Create the project</a></li>
<li class="toctree-l3"><a class="reference internal" href="#create-a-menu">Create a menu</a></li>
<li class="toctree-l3"><a class="reference internal" href="#what-s-next">Whats next</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="setup.html">Setting up the local environment and workspace</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="cpl.html">API Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI Reference</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Common Python Library</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="getting_started.html">Getting started</a> &raquo;</li>
<li>Getting started with CPL</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/quickstart.md.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="getting-started-with-cpl">
<h1>Getting started with CPL<a class="headerlink" href="#getting-started-with-cpl" title="Permalink to this headline"></a></h1>
<p>Welcome to CPL!</p>
<p>This tutorial introduces you to the essentials of the CPL package by walking through building an console based app.</p>
<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>
<ol class="simple">
<li><p><a class="reference external" href="#prerequisites">Prerequisites</a></p></li>
<li><p><a class="reference external" href="#create-the-project">Create the project</a></p></li>
<li><p><a class="reference external" href="#create-a-menu">Create a menu</a></p></li>
<li><p><a class="reference external" href="#whats-next">Whats next</a></p></li>
</ol>
</div>
<div class="section" id="prerequisites">
<h2>Prerequisites<a class="headerlink" href="#prerequisites" title="Permalink to this headline"></a></h2>
<p>To get most out of this tutorial you should already have a basic understanding of the following.</p>
<ul class="simple">
<li><p><a class="reference external" href="https://www.python.org/">Python</a></p></li>
</ul>
<p>Also you need to have the following installed.</p>
<ul class="simple">
<li><p><a class="reference external" href="https://www.python.org/">Python</a></p></li>
<li><p><a class="reference external" href="https://pip.sh-edraft.de">Pip</a></p></li>
<li><p><a class="reference internal" href="setup.html"><span class="doc std std-doc">CPL</span></a></p></li>
<li><p><a class="reference internal" href="setup.html"><span class="doc std std-doc">CPL-CLI</span></a></p></li>
</ul>
</div>
<div class="section" id="create-the-project">
<h2>Create the project<a class="headerlink" href="#create-the-project" title="Permalink to this headline"></a></h2>
<p>To create the sample project to the following:</p>
<ol>
<li><p>Open a terminal</p></li>
<li><p>Run</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>cpl new console sample-project
</pre></div>
</div>
</li>
<li><p>We dont want to use Application base or Dependency injection:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>Do you want to use application base? <span class="o">(</span>y/n<span class="o">)</span> n
Do you want to use service providing? <span class="o">(</span>y/n<span class="o">)</span> n
</pre></div>
</div>
<p>The ouput should look like this:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>Creating sample-project/LICENSE <span class="k">done</span>
Creating sample-project/README.md <span class="k">done</span>
Creating sample-project/src/tests/__init__.py <span class="k">done</span>
Creating sample-project/appsettings.json <span class="k">done</span>
Creating sample-project/src/sample-project/__init__.py <span class="k">done</span>
Creating sample-project/src/sample-projectmain.py <span class="k">done</span>
</pre></div>
</div>
</li>
<li><p>Open the project with an IDE like VS Code or PyCharm</p>
<p><img alt="IDE" src="_images/ide.png" /></p>
</li>
<li><p>Set the src directory as source folder</p>
<p><img alt="IDE set src folder" src="_images/ide-src.png" /></p>
</li>
<li><p>Run the application</p>
<p>You should see an output like:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>Hello World
</pre></div>
</div>
</li>
<li><p>In PyCharm you have to enable <code class="docutils literal notranslate"><span class="pre">Emulate</span> <span class="pre">terminal</span> <span class="pre">in</span> <span class="pre">output</span> <span class="pre">console</span></code>!</p>
<p><img alt="IDE emulate console" src="_images/ide-emulate.png" /></p>
</li>
</ol>
</div>
<div class="section" id="create-a-menu">
<h2>Create a menu<a class="headerlink" href="#create-a-menu" title="Permalink to this headline"></a></h2>
<ol>
<li><p>Open the sample-project/main.py</p></li>
<li><p>Change Hello World to Password generator: in line 5</p></li>
<li><p>Add <code class="docutils literal notranslate"><span class="pre">Console.select</span></code> as follows:</p>
<div class="highlight-py notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">cpl.console</span> <span class="kn">import</span> <span class="n">Console</span>
<span class="k">def</span> <span class="nf">main</span><span class="p">():</span>
<span class="n">Console</span><span class="o">.</span><span class="n">write_line</span><span class="p">(</span><span class="s1">&#39;Password generator:&#39;</span><span class="p">)</span>
<span class="n">options</span> <span class="o">=</span> <span class="p">[</span>
<span class="s1">&#39;Only lower case&#39;</span><span class="p">,</span>
<span class="s1">&#39;Only upper case&#39;</span><span class="p">,</span>
<span class="s1">&#39;Lower and upper case&#39;</span>
<span class="s1">&#39;Exit&#39;</span>
<span class="p">]</span>
<span class="n">option</span> <span class="o">=</span> <span class="n">Console</span><span class="o">.</span><span class="n">select</span><span class="p">(</span><span class="s1">&#39;&gt;&#39;</span><span class="p">,</span> <span class="s1">&#39;Select option: &#39;</span><span class="p">,</span> <span class="n">options</span><span class="p">)</span>
<span class="k">if</span> <span class="vm">__name__</span> <span class="o">==</span> <span class="s1">&#39;__main__&#39;</span><span class="p">:</span>
<span class="n">main</span><span class="p">()</span>
</pre></div>
</div>
</li>
<li><p>Get Id of the selected option:</p>
<div class="highlight-py notranslate"><div class="highlight"><pre><span></span><span class="n">index</span> <span class="o">=</span> <span class="n">options</span><span class="o">.</span><span class="n">index</span><span class="p">(</span><span class="n">option</span><span class="p">)</span>
</pre></div>
</div>
</li>
<li><p>Create the generate function as follows:</p>
<div class="highlight-py notranslate"><div class="highlight"><pre><span></span><span class="k">def</span> <span class="nf">generate_password</span><span class="p">(</span><span class="n">letters</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">length</span><span class="p">:</span> <span class="nb">int</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
<span class="k">return</span> <span class="s1">&#39;&#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">random</span><span class="o">.</span><span class="n">choice</span><span class="p">(</span><span class="n">letters</span><span class="p">)</span> <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">length</span><span class="p">))</span>
</pre></div>
</div>
<p>Add imports:</p>
<div class="highlight-py notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">random</span>
<span class="kn">import</span> <span class="nn">string</span>
</pre></div>
</div>
</li>
<li><p>Get length of the password:</p>
<div class="highlight-py notranslate"><div class="highlight"><pre><span></span><span class="n">length</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">Console</span><span class="o">.</span><span class="n">read</span><span class="p">(</span><span class="s1">&#39;Length: &#39;</span><span class="p">))</span>
</pre></div>
</div>
</li>
<li><p>Validate the selected option:</p>
<div class="highlight-py notranslate"><div class="highlight"><pre><span></span><span class="n">index</span> <span class="o">=</span> <span class="n">options</span><span class="o">.</span><span class="n">index</span><span class="p">(</span><span class="n">option</span><span class="p">)</span>
<span class="n">letters</span> <span class="o">=</span> <span class="s1">&#39;&#39;</span>
<span class="k">if</span> <span class="n">index</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="n">letters</span> <span class="o">=</span> <span class="n">string</span><span class="o">.</span><span class="n">ascii_lowercase</span>
<span class="k">elif</span> <span class="n">index</span> <span class="o">==</span> <span class="mi">1</span><span class="p">:</span>
<span class="n">letters</span> <span class="o">=</span> <span class="n">string</span><span class="o">.</span><span class="n">ascii_uppercase</span>
<span class="k">elif</span> <span class="n">index</span> <span class="o">==</span> <span class="mi">2</span><span class="p">:</span>
<span class="n">letters</span> <span class="o">=</span> <span class="n">string</span><span class="o">.</span><span class="n">ascii_letters</span>
<span class="k">elif</span> <span class="n">index</span> <span class="o">==</span> <span class="nb">len</span><span class="p">(</span><span class="n">options</span><span class="p">)</span> <span class="o">-</span> <span class="mi">1</span><span class="p">:</span>
<span class="n">exit</span><span class="p">()</span>
</pre></div>
</div>
</li>
<li><p>Print the generated password:</p>
<div class="highlight-py notranslate"><div class="highlight"><pre><span></span><span class="n">Console</span><span class="o">.</span><span class="n">write_line</span><span class="p">(</span><span class="s1">&#39;Password: &#39;</span><span class="p">,</span> <span class="n">generate_password</span><span class="p">(</span><span class="n">letters</span><span class="p">,</span> <span class="n">length</span><span class="p">))</span>
</pre></div>
</div>
</li>
<li><p>The full sample-project/main.py:</p>
<div class="highlight-py notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">random</span>
<span class="kn">import</span> <span class="nn">string</span>
<span class="kn">from</span> <span class="nn">cpl.console</span> <span class="kn">import</span> <span class="n">Console</span>
<span class="k">def</span> <span class="nf">generate_password</span><span class="p">(</span><span class="n">letters</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">length</span><span class="p">:</span> <span class="nb">int</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
<span class="k">return</span> <span class="s1">&#39;&#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">random</span><span class="o">.</span><span class="n">choice</span><span class="p">(</span><span class="n">letters</span><span class="p">)</span> <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">length</span><span class="p">))</span>
<span class="k">def</span> <span class="nf">main</span><span class="p">():</span>
<span class="n">Console</span><span class="o">.</span><span class="n">write_line</span><span class="p">(</span><span class="s1">&#39;Password generator:&#39;</span><span class="p">)</span>
<span class="n">options</span> <span class="o">=</span> <span class="p">[</span>
<span class="s1">&#39;Only lower case&#39;</span><span class="p">,</span>
<span class="s1">&#39;Only upper case&#39;</span><span class="p">,</span>
<span class="s1">&#39;Lower and upper case&#39;</span><span class="p">,</span>
<span class="s1">&#39;Exit&#39;</span>
<span class="p">]</span>
<span class="n">option</span> <span class="o">=</span> <span class="n">Console</span><span class="o">.</span><span class="n">select</span><span class="p">(</span><span class="s1">&#39;&gt;&#39;</span><span class="p">,</span> <span class="s1">&#39;Select option: &#39;</span><span class="p">,</span> <span class="n">options</span><span class="p">)</span>
<span class="n">length</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">Console</span><span class="o">.</span><span class="n">read</span><span class="p">(</span><span class="s1">&#39;Length: &#39;</span><span class="p">))</span>
<span class="n">index</span> <span class="o">=</span> <span class="n">options</span><span class="o">.</span><span class="n">index</span><span class="p">(</span><span class="n">option</span><span class="p">)</span>
<span class="n">letters</span> <span class="o">=</span> <span class="s1">&#39;&#39;</span>
<span class="k">if</span> <span class="n">index</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="n">letters</span> <span class="o">=</span> <span class="n">string</span><span class="o">.</span><span class="n">ascii_lowercase</span>
<span class="k">elif</span> <span class="n">index</span> <span class="o">==</span> <span class="mi">1</span><span class="p">:</span>
<span class="n">letters</span> <span class="o">=</span> <span class="n">string</span><span class="o">.</span><span class="n">ascii_uppercase</span>
<span class="k">elif</span> <span class="n">index</span> <span class="o">==</span> <span class="mi">2</span><span class="p">:</span>
<span class="n">letters</span> <span class="o">=</span> <span class="n">string</span><span class="o">.</span><span class="n">ascii_letters</span>
<span class="k">elif</span> <span class="n">index</span> <span class="o">==</span> <span class="nb">len</span><span class="p">(</span><span class="n">options</span><span class="p">)</span> <span class="o">-</span> <span class="mi">1</span><span class="p">:</span>
<span class="n">exit</span><span class="p">()</span>
<span class="n">Console</span><span class="o">.</span><span class="n">write_line</span><span class="p">(</span><span class="s1">&#39;Password: &#39;</span><span class="p">,</span> <span class="n">generate_password</span><span class="p">(</span><span class="n">letters</span><span class="p">,</span> <span class="n">length</span><span class="p">))</span>
<span class="k">if</span> <span class="vm">__name__</span> <span class="o">==</span> <span class="s1">&#39;__main__&#39;</span><span class="p">:</span>
<span class="n">main</span><span class="p">()</span>
</pre></div>
</div>
</li>
</ol>
</div>
<div class="section" id="what-s-next">
<h2>Whats next<a class="headerlink" href="#what-s-next" title="Permalink to this headline"></a></h2>
<p>In this section, youve created an application that uses user input to generate a password.</p>
<p>To continue exploring CPL and developing applications:</p>
<ul class="simple">
<li><p><a class="reference internal" href="cpl.application.html"><span class="doc std std-doc">Application base</span></a></p></li>
<li><p><a class="reference internal" href="cpl.dependency_injection.html"><span class="doc std std-doc">Dependency injection</span></a></p></li>
<li><p><a class="reference internal" href="cpl.console.html"><span class="doc std std-doc">Console</span></a></p></li>
</ul>
<!-- LINKS -->
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="setup.html" class="btn btn-neutral float-right" title="Setting up the local environment and workspace" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="getting_started.html" class="btn btn-neutral float-left" title="Getting started" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&#169; Copyright 2021, Sven Heidemann.
</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>

View File

@ -86,7 +86,10 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="cpl.html">CPL</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="cpl.html">API Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI Reference</a></li>
</ul>

File diff suppressed because one or more lines are too long

322
docs/build/html/setup.html vendored Normal file
View File

@ -0,0 +1,322 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Setting up the local environment and workspace &mdash; Common Python Library documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="API Reference" href="cpl.html" />
<link rel="prev" title="Getting started with CPL" href="quickstart.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="getting_started.html">Getting started</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="quickstart.html">Getting started with CPL</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Setting up the local environment and workspace</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#table-of-contents">Table of Contents</a></li>
<li class="toctree-l3"><a class="reference internal" href="#prerequisites">Prerequisites</a></li>
<li class="toctree-l3"><a class="reference internal" href="#install-the-package">Install the package</a></li>
<li class="toctree-l3"><a class="reference internal" href="#install-the-cli">Install the CLI</a></li>
<li class="toctree-l3"><a class="reference internal" href="#create-initial-console-app">Create initial console app</a></li>
<li class="toctree-l3"><a class="reference internal" href="#create-initial-library">Create initial library</a></li>
<li class="toctree-l3"><a class="reference internal" href="#start-the-app">Start the app</a></li>
<li class="toctree-l3"><a class="reference internal" href="#what-s-next">Whats next</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="cpl.html">API Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI Reference</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Common Python Library</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="getting_started.html">Getting started</a> &raquo;</li>
<li>Setting up the local environment and workspace</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/setup.md.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="setting-up-the-local-environment-and-workspace">
<h1>Setting up the local environment and workspace<a class="headerlink" href="#setting-up-the-local-environment-and-workspace" title="Permalink to this headline"></a></h1>
<div class="section" id="table-of-contents">
<h2>Table of Contents<a class="headerlink" href="#table-of-contents" title="Permalink to this headline"></a></h2>
<ol class="simple">
<li><p><a class="reference external" href="#prerequisites">Prerequisites</a></p></li>
<li><p><a class="reference external" href="#install-the-package">Install the package</a></p></li>
<li><p><a class="reference external" href="#install-the-cli">Install the CLI</a></p></li>
<li><p><a class="reference external" href="#create-initial-console-app">Create a initial application</a></p></li>
<li><p><a class="reference external" href="#create-initial-library">Create a initial library</a></p></li>
<li><p><a class="reference external" href="#start-the-app">Start the application</a></p></li>
<li><p><a class="reference external" href="#whats-next">Whats next</a></p></li>
</ol>
</div>
<div class="section" id="prerequisites">
<h2>Prerequisites<a class="headerlink" href="#prerequisites" title="Permalink to this headline"></a></h2>
<p>To get most out of this tutorial you should already have a basic understanding of the following.</p>
<ul class="simple">
<li><p><a class="reference external" href="https://www.python.org/">Python</a></p></li>
</ul>
<p>Also you need to have the following installed.</p>
<ul class="simple">
<li><p><a class="reference external" href="https://www.python.org/">Python</a></p></li>
<li><p><a class="reference external" href="https://pip.sh-edraft.de">Pip</a></p></li>
</ul>
</div>
<div class="section" id="install-the-package">
<h2>Install the package<a class="headerlink" href="#install-the-package" title="Permalink to this headline"></a></h2>
<p>To install the package, open a terminal window and run the following command:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>pip install sh_cpl --extra-index-url https://pip.sh-edraft.de
</pre></div>
</div>
</div>
<div class="section" id="install-the-cli">
<h2>Install the CLI<a class="headerlink" href="#install-the-cli" title="Permalink to this headline"></a></h2>
<p>You use the CPL CLI to create projects, generate application and library code. You also use the CLI to build and publish your python packages.</p>
<p>To install the CLI, open a terminal window and run the following command:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>pip install sh_cpl-cli --extra-index-url https://pip.sh-edraft.de
</pre></div>
</div>
</div>
<div class="section" id="create-initial-console-app">
<h2>Create initial console app<a class="headerlink" href="#create-initial-console-app" title="Permalink to this headline"></a></h2>
<p>You develop apps and packages in the context of an CPL project which is defined in an cpl.json.</p>
<ol>
<li><p>Run the CLI command <code class="docutils literal notranslate"><span class="pre">cpl</span> <span class="pre">new</span> <span class="pre">console</span></code> and provide the name my-app, as shown here:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>cpl new console my-app
</pre></div>
</div>
</li>
<li><p>The cpl new command prompts you for information about features to include in the initial app. Decline the defaults by enter n and press the Enter key.</p></li>
</ol>
<p>The CLI create a new workspace and a simple Hello World app, ready to run.</p>
</div>
<div class="section" id="create-initial-library">
<h2>Create initial library<a class="headerlink" href="#create-initial-library" title="Permalink to this headline"></a></h2>
<p>You develop apps and packages in the context of an CPL project which is defined in an cpl.json.</p>
<ol>
<li><p>Run the CLI command <code class="docutils literal notranslate"><span class="pre">cpl</span> <span class="pre">new</span> <span class="pre">library</span></code> and provide the name my-lib, as shown here:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>cpl new library my-lib
</pre></div>
</div>
</li>
<li><p>The cpl new command prompts you for information about features to include in the initial library. Decline the defaults by enter n and press the Enter key.</p></li>
</ol>
<p>The CLI create a new workspace and a simple Hello World library with CLI, ready to run.</p>
</div>
<div class="section" id="start-the-app">
<h2>Start the app<a class="headerlink" href="#start-the-app" title="Permalink to this headline"></a></h2>
<p>The CLI includes a live development server, so that you can run your app locally.</p>
<ol>
<li><p>Open a terminal window</p></li>
<li><p>To navigate to your project workspace, run the following command:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="nb">cd</span> /path/to/project/name
</pre></div>
</div>
</li>
<li><p>To run the app run:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>cpl start
</pre></div>
</div>
</li>
</ol>
<p>The <code class="docutils literal notranslate"><span class="pre">cpl</span> <span class="pre">start</span></code> command launches the server, watches your source files, and restarts the app as you make chnages to thoses source files.</p>
<p>If your installation and setup was successful, you should see a output similar to the following:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>Hello World
</pre></div>
</div>
</div>
<div class="section" id="what-s-next">
<h2>Whats next<a class="headerlink" href="#what-s-next" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li><p>To learn more about the CPL CLI, see the <a class="reference internal" href="cli.overview.html"><span class="doc std std-doc">CLI Overview</span></a></p></li>
<li><p>Fore more informations about the Pyhton files generated by <code class="docutils literal notranslate"><span class="pre">cpl</span> <span class="pre">new</span></code>, see <a class="reference internal" href="cli.new.html"><span class="doc std std-doc">New Command</span></a></p></li>
</ul>
<!-- LINKS -->
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="cpl.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="quickstart.html" class="btn btn-neutral float-left" title="Getting started with CPL" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&#169; Copyright 2021, Sven Heidemann.
</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>

25
docs/source/cli.add.md Normal file
View File

@ -0,0 +1,25 @@
# cpl add
## Contents
- [Description](#description)
- [Arguments](#arguments)
Removes a project from workspace.
cpl **add** *&lt;source-project&gt;* *&lt;target-project&gt;* <br>
cpl **a** *&lt;source-project&gt;* *&lt;target-project&gt;* <br>
cpl **A** *&lt;source-project&gt;* *&lt;target-project&gt;*
## Description
Adds a project reference to given project.
If you call the command in a CPL workspace, you can use the project names. Otherwise the paths of the projects must be specified.
## Arguments
| Argument | Description | Value type |
| ------------------------- |:---------------------------------------------------------------:|:----------------:|
| ```<source-project>``` | Name of the project to which the reference has to be added | ```str```
| ```<target-project>``` | Name of the project to be referenced | ```str```

26
docs/source/cli.build.md Normal file
View File

@ -0,0 +1,26 @@
# cpl build
## Contents
- [Description](#description)
<!-- - [Arguments](#arguments) -->
Copies an python app into an output directory named build/ at the given output path. Must be executed within a CPL workspace or project directory
cpl **build** <br>
cpl **b** <br>
cpl **B**
## Description
The command can be used to build a project of type "console" or "library".
The build command copies all included source files to the output directory. You can run the source files in the output directory directly.
The command is used to prepare the source files for the publish command or to copy them to an target for execution.
<!-- ## Arguments
| Argument | Description | Value type |
| ------------- |:-------------:|:----------------:|
| ```<project>``` | The name of the project to build. Can be an console or a library. | ```str``` -->

View File

@ -0,0 +1,35 @@
# cpl generate
## Contents
- [Description](#description)
- [Arguments](#arguments)
- [Schematics](#schematics)
Generate a file based on schematic.
cpl **generate** *&lt;schematic&gt;* *&lt;name&gt;* <br>
cpl **g** *&lt;schematic&gt;* *&lt;name&gt;* <br>
cpl **G** *&lt;schematic&gt;* *&lt;name&gt;*
## Description
Generates files based on a schematic.
## Arguments
| Argument | Description | Value type |
| ----------------- |:---------------------------------:|:-------------:|
| ```<schematic>``` | The schematic to generate. | ```str``` |
| ```<name>``` | The name of the generated file. | ```str``` |
## Schematics
| Schematic | Description | Arguments |
| ----------------- |:-------------------:|:----------------:|
| ```abc``` | Abstract base class | ```<name>```
| ```class``` | Class | ```<name>```
| ```enum``` | Enum class | ```<name>```
| ```service``` | Service class | ```<name>```
| ```settings``` | [Configmodel](cpl.configuration) | ```<name>```
| ```thread``` | Thread class | ```<name>```

22
docs/source/cli.help.md Normal file
View File

@ -0,0 +1,22 @@
# cpl help
<!-- ## Contents
- [Description](#description) -->
<!-- - [Arguments](#arguments) -->
Lists available command and their short descriptions.
cpl **help** *&lt;command&gt;* <br>
cpl **h** *&lt;command&gt;* <br>
cpl **H** *&lt;command&gt;*
## Description
Lists available command and their short descriptions.
## Arguments
| Argument | Description | Value type |
| ----------------- |:-----------------------------:|:-------------:|
| ```<command>``` | Shows a help message for this command in the console. | ```str``` |

View File

@ -0,0 +1,23 @@
# cpl install
## Contents
- [Description](#description)
- [Arguments](#arguments)
Installs given package via pip
cpl **install** *&lt;package&gt;* <br>
cpl **i** *&lt;package&gt;* <br>
cpl **I** *&lt;package&gt;*
## Description
Install given package to project via pip.
Without given package it will install the depedencies of the CPL project your in.
## Arguments
| Argument | Description | Value type |
| ----------------- |:-----------------------------:|:-------------:|
| ```<package>``` | The package to install | ```str``` |

31
docs/source/cli.new.md Normal file
View File

@ -0,0 +1,31 @@
# cpl new
## Contents
- [Description](#description)
- [Arguments](#arguments)
- [Project types](#project-types)
Generates a workspace and initial project or add a project to workspace.
cpl **new** *&lt;type&gt;* *&lt;name&gt;*<br>
cpl **n** *&lt;type&gt;* *&lt;name&gt;* <br>
cpl **N** *&lt;type&gt;* *&lt;name&gt;*
## Description
Generates a workspace and initial project or add a project to workspace.
If the command is running in a CPL workspace, it will add the new project to the workspace.
| Argument | Description | Value type |
| ----------------- |:-----------------------------------------------------:|:-------------:|
| ```<type>``` | The type of the project, see [types](#project-types) | ```str``` |
| ```<name>``` | The name of the project | ```str``` |
## Project types
| Project type | Description |
| ----------------- |:-----------------------------:|
| ```console``` | A simple console application |
| ```library``` | A package |

View File

@ -0,0 +1,53 @@
# CLI Overview and Command Reference
## Table of Contents
1. [Install CPL](setup#install-the-package)
2. [Install CPL CLI](setup#install-the-cli)
3. [Basic workflow](#basic-workflow)
4. [CLI command-language syntax](#cli-command-language-syntax)
5. [Command overview](#command-overview)
## Basic workflow
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:
```sh
cpl new console my-first-project
cd my-first-project
cpl start
```
In the terminal you will the output of the app.
## CLI command-language syntax
```cpl``` commandNameOrAlias requiredArg ```[optionalsArgs]```
- Most commands, and some options, have aliases. Aliases are shown in the syntax statement for each command.
- Arguments are not prefixed.
### Relative paths
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.
### Schematics
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.
## Command overview
| Command | Alias | Description |
| ----------------------------- |:-------------:|:----------------:|
| [add](cli.add) | a or a | Adds a project reference to given project.
| [build](cli.build) | b or B | Prepares files for publish into an output directory named dist/ at the given output path. Must be executed from within a workspace directory.
| [generate](cli.generate) | g or G | Generate a new file.
| [help](cli.help) | h or H | Lists available command and their short descriptions.
| [install](cli.install) | i or I | With argument installs packages to project, without argument installs project dependencies.
| [new](cli.new) | n or N | Creates new CPL project.
| [publish](cli.publish) | p or P | Prepares files for publish into an output directory named dist/ at the given output path and executes ```setup.py```. Must be executed from within a library workspace directory.
| [remove](cli.remove) | r or R | Removes a project from workspace.
| [start](cli.start) | s or S | Starts CPL project, restarting on file changes.
| [uninstall](cli.uninstall) | ui or UI | Uninstalls packages from project.
| [update](cli.update) | u or U | Update CPL and project dependencies.
| [version](cli.version) | v or V | Outputs CPL CLI version.

View File

@ -0,0 +1,27 @@
# cpl publish
## Contents
- [Description](#description)
<!-- - [Arguments](#arguments) -->
Prepares files for publish into an output directory named dist/ at the given output path and executes ```setup.py```.
cpl **publish** <br>
cpl **p** <br>
cpl **P**
## Description
The command can be used to publish a project of type "console" or "library".
The publish command builds the source files and then creates an ```setup.py``` with data from ```cpl.json```.
The command executes the ```setup.py``` and removes all source files with the ```setup.py``` from the 'publish/' directory.
Generated files of ```setup.py``` are in the 'publish/setup/' directory.
<!-- ## Arguments
| Argument | Description | Value type |
| ------------- |:-------------:|:----------------:|
| ```<project>``` | The name of the project to build. Can be an console or a library. | ```str``` -->

27
docs/source/cli.remove.md Normal file
View File

@ -0,0 +1,27 @@
# cpl remove
## Contents
- [Description](#description)
- [Arguments](#arguments)
Removes a project from workspace.
cpl **remove** *&lt;project&gt;* <br>
cpl **r** *&lt;project&gt;* <br>
cpl **R** *&lt;project&gt;*
## Description
The command can be used to publish a project of type "console" or "library".
The publish command builds the source files and then creates an ```setup.py``` with data from ```cpl.json```.
The command executes the ```setup.py``` and removes all source files with the ```setup.py``` from the 'publish/' directory.
Generated files of ```setup.py``` are in the 'publish/setup/' directory.
## Arguments
| Argument | Description | Value type |
| ------------------------- |:-------------------------------------:|:----------------:|
| ```<project>``` | The name of the project to delete | ```str```

7
docs/source/cli.start.md Normal file
View File

@ -0,0 +1,7 @@
# cpl start
Starts your application, restarting on file changes.
cpl **start** <br>
cpl **s** <br>
cpl **S**

View File

@ -0,0 +1,22 @@
# cpl uninstall
## Contents
- [Description](#description)
- [Arguments](#arguments)
Uninstalls given package via pip
cpl **uninstall** *&lt;package&gt;* <br>
cpl **ui** *&lt;package&gt;* <br>
cpl **UI** *&lt;package&gt;*
## Description
Uninstall given package from project via pip.
## Arguments
| Argument | Description | Value type |
| ----------------- |:-----------------------------:|:-------------:|
| ```<package>``` | The package to uninstall | ```str``` |

View File

@ -0,0 +1,7 @@
# cpl update
Updates the CPL and project dependencies.
cpl **update** <br>
cpl **u** <br>
cpl **U**

View File

@ -0,0 +1,7 @@
# cpl version
Lists the version of CPL, CPL CLI and all installed packages from pip.
cpl **version** <br>
cpl **v** <br>
cpl **V**

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