Improved docs

This commit is contained in:
2022-07-31 11:30:05 +02:00
parent b2ce8a6924
commit e0d89f967f
67 changed files with 422 additions and 22 deletions

View File

@@ -4,6 +4,7 @@
- [Description](#description)
- [Arguments](#arguments)
- [Flags](#flags)
Removes a project from workspace.

View File

@@ -1,9 +1,9 @@
# cpl help
<!-- ## Contents
## Contents
- [Description](#description) -->
<!-- - [Arguments](#arguments) -->
- [Description](#description)
- [Arguments](#arguments)
Lists available command and their short descriptions.

View File

@@ -10,6 +10,72 @@ The Common Python Library (CPL) is a package for python and a development platfo
This CPL docs help you learn, understand and use the package. From your first application to complex apps for enterprises.
Features
--------
- cpl-core
- Expandle
- Application base
- Standardized application classes
- Application object builder
- Application extension classes
- Startup classes
- Startup extension classes
- Configuration
- Configure via object mapped JSON
- Console argument handling
- Console class for in and output
- Banner
- Spinner
- Options (menu)
- Table
- Write
- Write_at
- Write_line
- Write_line_at
- Dependency injection
- Service lifetimes: singleton, scoped and transient
- Providing of application environment
- Environment (development, staging, testing, production)
- Appname
- Customer
- Hostname
- Runtime directory
- Working directory
- Logging
- Standardized logger
- Log-level (FATAL, ERROR, WARN, INFO, DEBUG & TRACE)
- Mail handling
- Send mails
- Pipe classes
- Convert input
- Utils
- Credential manager
- Encryption via BASE64
- PIP wrapper class based on subprocess
- Run pip commands
- String converter to different variants
- to_lower_case
- to_camel_case
- ...
- cpl-cli
- Expandle
- Code generation
- Package managing
- Build & Publishing
- cpl-discord
- Utils for discord.py
- Connector between cpl-core and discord.py
- Prepared services for dependency injection
- cpl-query
- Python list extensions
- Functions for sorting and filtering
- Like linq from C# but in python xD
- cpl-translate
- Generic translations
- Prepared translation service and translate pipe
- Get translation from JSON files key dot.key notation
Manuals
---------
@@ -20,6 +86,7 @@ These pages go into great detail about everything the Library can do.
introduction
getting_started
contributing
cpl_cli
cpl_core
cpl_query

View File

@@ -7,4 +7,6 @@ cpl
getting_started
cpl_cli
cpl_core
cpl_discord
cpl_query
cpl_translate