Common Python Library https://www.sh-edraft.de
Go to file
Sven Heidemann c7e2f8609c Merge pull request '2022.10.3 - Removed duplicated schematic name in generate command #92' (#111) from 2022.10.3 into 2022.10
Reviewed-on: #111
Closes #92
2022-09-17 12:12:52 +02:00
docs Renamed sh_cpl to cpl in docs 2022-07-31 11:33:45 +02:00
notices Added upload script 2021-10-04 09:30:27 +02:00
scripts Added scripts to workspace 2022-05-19 20:49:48 +02:00
src Removed duplicated schematic name in generate command #92 2022-09-17 12:09:05 +02:00
tools Fixed settings error 2022-07-16 19:37:40 +02:00
unittests Improved version command & fixed unittests 2022-09-15 19:16:52 +02:00
.gitignore Improved gitignore 2022-05-26 23:03:18 +02:00
LICENSE Updated packages 2022-04-30 16:33:30 +02:00
README.md Improved readme 2022-06-29 17:40:05 +02:00
cpl-workspace.json Added cpl-discord project 2022-07-16 12:12:52 +02:00

README.md

CPL - Common python library


CPL is a development platform for python server applications
using Python.

Table of Contents

  1. Features
  2. Getting Started
  3. Roadmap
  4. Contributing
  5. License
  6. Contact

Features

  • Expandle
  • Application base
    • Standardized application classes
    • Application object builder
    • Application extension classes
    • Startup classes
    • Startup extension classes
  • Configuration
    • Configure via object mapped JSON
    • Console argument handling
  • Console class for in and output
    • Banner
    • Spinner
    • Options (menu)
    • Table
    • Write
    • Write_at
    • Write_line
    • Write_line_at
  • Dependency injection
    • Service lifetimes: singleton, scoped and transient
  • Providing of application environment
    • Environment (development, staging, testing, production)
    • Appname
    • Customer
    • Hostname
    • Runtime directory
    • Working directory
  • Logging
    • Standardized logger
    • Log-level (FATAL, ERROR, WARN, INFO, DEBUG & TRACE)
  • Mail handling
    • Send mails
  • Pipe classes
    • Convert input
  • Utils
    • Credential manager
      • Encryption via BASE64
    • PIP wrapper class based on subprocess
      • Run pip commands
    • String converter to different variants
      • to_lower_case
      • to_camel_case
      • ...

Getting Started

Get started with CPL.

Prerequisites

Installation

Install the CPL package

pip install sh_cpl --extra-index-url https://pip.sh-edraft.de

Install the CPL CLI

pip install sh_cpl-cli --extra-index-url https://pip.sh-edraft.de

Create workspace:

cpl new <console|library> <PROJECT NAME>

Run the application:

cd <PROJECT NAME>
cpl start

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributing Guidelines

Read through our contributing guidelines to learn about our submission process, coding rules and more.

Want to Help?

Want to file a bug, contribute some code, or improve documentation? Excellent! Read up on our guidelines for contributing.

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Sven Heidemann - sven.heidemann@sh-edraft.de

Project link: https://git.sh-edraft.de/sh-edraft.de/sh_common_py_lib