cornflakes 3.3.13

Create generic any easy way to manage Configs for your project

pip install cornflakes

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

:warning: Warning: Please be careful when using this Python module. Currently, it is only developed / tested by me, which is why it has a high update / change rate. I'm actually trying to be compatible with implementations, but I can't guarantee this at the moment. The module is currently still in a beta state and is not recommended for productive use.

---

Information

The Python module "cornflakes" was started as a hobby project and offers an alternative to Pydantic for managing configurations and data structures. It allows creating generic and easy to manage configurations for your project. Unlike Pydantic, which is based on inheritance, "cornflakes" uses a decorator (similar to dataclass) to map data structures.

Short Term RoadMap

• Add autocompletion support for click CLI (automatically)
• Change Code Annotations
  • remove Any annotations if possible
  • change Protocol Annotations to specific type classes
• Enrich json methods
• Fix / Test the to_ Methods (specially yaml)

---

Development

Prerequisites

• A compiler with C++17 support
• Pip 10+ or CMake >= 3.4
• Python 3.8+
• doxygen
• cppcheck
• clang-tools-extra or clang-tidy

Commands

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 ninja pre-commit poetry

Install pre-commit:

pre-commit install

Update pre-commit:

pre-commit update -a

Run pre-commit:

pre-commit run -a