cornflakes 3.0.6

Create generic any easy to manage Configs for your Project

---

pip install cornflakes

pip install git+https://github.com/semmjon/cornflakes

Information

This package was created by starting C ++ methods to incorporate into my python implementations. To make things easier for me, lightweight public libraries were included (especially to carry out string operations):

• hash-library

• strtk

• rapidjson

Features:

The following features have currently been implemented:

• config management system

  • based on dataclass

  • alternative Implementation for pydantic (BaseSettings)

  • ini support files by a lightweight and fast parser (-> ini_load)

  • yaml support (based on PyYAML)

  • environment variables

  • (future) support json (based on orjson)

• command line interface management

  • method: click_cli (decorator)

  • based on click and rich

  • easy to use and start with

• eval_type

  • method to parse strings in python-types e.g. int | bool | timestamp

• simple_hmac

  • vectorized c++ hmac implementation

• default_ca_path

  • python function to find a default ssl / ca certificate path

Currently, the package is tested for Linux, Mac and Windows

Development

Prerequisites

• A compiler with C++17 support

• Pip 10+ or CMake >= 3.4 (or 3.8+ on Windows, which was the first version to support VS 2015)

• Python 3.8+

• doxygen

• cppcheck

• clang-tools-extra or clang-tidy

Commands

Just clone this repository and pip install. Note the --recursive option which is needed for the pybind11 submodule:

git clone --recursive https://gitlab.blubblub.tech/sgeist/cornflakes.git

Install the package using makefiles:

make install

Build dist using makefiles:

make dist

Run tests (pytest) using makefiles:

make test

Run all tests using makefiles:

make test-all

Run lint using makefiles:

make lint

Create dev venv:

python -m venv .venv
source .venv/bin/activate
pip install cookietemple ninja pre-commit poetry

Bump Version using cookietemple:

cookietemple bump-version "<version(e.g 0.0.1)>"

Run lint using cookietemple:

cookietemple lint .

Install pre-commit:

pre-commit install

Update pre-commit:

pre-commit update -a

Run pre-commit:

pre-commit run -a

Publish

Its not recommended publish manually (use git-ci or github workflows instead).

make publish