Create generic any easy way to manage Configs for your project

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for sgeist from gravatar.com sgeist

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: Other/Proprietary License (Apache2.0)
  • Author: Semjon Geist
  • Requires: Python >=3.8, <4.0
Classifiers

Project description

cornflakes logo

PyPI Python Version License Read the documentation at https://cornflakes.readthedocs.io Build Package Status Run Tests Status Codecov

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

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.

In addition to a dataclass decorator with additional functionality, there is also a config decorator. This makes it possible to read the dataclass from configuration files. This can be very useful if you want to save your application configurations to a file.

The module also has a click wrapper that simplifies the implementation of command line applications. By integrating the Rich module, the application is additionally equipped with colors and other functions.

There are other useful methods in the base of the module that are generally useful for Python development. These can help you develop your projects faster and more efficiently.

Short Term RoadMap

  • Add autocompletion support for click CLI (automatically)

  • Enrich json methods

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+

  • gh (optional) GitHub’s official command line tool

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

Install pre-commit:

pre-commit install

Update pre-commit:

pre-commit update -a

Run pre-commit:

pre-commit run -a

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for sgeist from gravatar.com sgeist

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: Other/Proprietary License (Apache2.0)
  • Author: Semjon Geist
  • Requires: Python >=3.8, <4.0
Classifiers

Release history Release notifications | RSS feed

This version

3.3.28

3.3.27

3.3.26

3.3.25

3.3.24

3.3.23

3.3.22

3.3.21

3.3.20

3.3.19

3.3.18

3.3.17

3.3.16

3.3.15

3.3.14

3.3.13

3.3.12

3.3.11

3.3.10

3.3.9

3.3.8

3.3.7

3.3.6

3.3.5

3.3.4

3.3.3

3.3.2

3.3.1

3.3.0

3.2.9

3.2.8

3.2.7

3.2.6

3.2.5

3.2.4

3.2.3

3.2.2

3.2.1

3.2.0

3.1.9

3.1.8

3.1.7

3.1.6

3.1.5

3.1.4

3.1.3

3.1.2

3.1.1

3.1.0

3.0.9

3.0.8

3.0.7

3.0.6

3.0.5

3.0.4

3.0.2

3.0.1

3.0.0

2.9.8

2.9.7

2.9.6

2.9.5

2.9.4

2.9.3

2.9.2

2.9.1

2.9.0

2.8.9

2.8.8

2.8.7

2.8.6

2.8.5

2.8.4

2.8.3

2.8.2

2.8.1

2.8.0

2.7.9

2.7.8

2.7.7

2.7.6

2.7.5

2.7.4

2.7.3

2.7.2

2.7.1

2.7.0

2.6.9

2.6.8

2.6.7

2.6.6

2.6.5

2.6.4

2.6.3

2.6.2

2.6.1

2.6.0

2.5.9

2.5.8

2.5.7

2.5.6

2.5.5

2.5.4

2.5.3

2.5.2

2.5.1

2.5.0

2.4.9

2.4.8

2.4.7

2.4.6

2.4.5

2.4.4

2.4.3

2.4.2

2.4.1

2.4.0

2.3.9

2.3.8

2.3.7

2.3.6

2.3.5

2.3.4

2.3.3

2.3.2

2.3.1

2.3.0

2.2.9

2.2.8

2.2.7

2.2.6

2.2.5

2.2.4

2.2.3

2.2.2

2.2.1

2.2.0

2.1.9

2.1.8

2.1.7

2.1.6

2.1.5

2.1.4

2.1.3

2.1.2

2.1.1

2.1.0

2.0.9

2.0.8

2.0.7

2.0.6

2.0.5

2.0.4

2.0.3

2.0.2

2.0.1

2.0.0

1.5.9

1.5.8

1.5.7

1.5.6

1.5.5

1.5.4

1.5.3

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cornflakes-3.3.28.tar.gz (3.2 MB view hashes)

Uploaded Source

Built Distributions

cornflakes-3.3.28-cp311-cp311-win_amd64.whl (278.4 kB view hashes)

Uploaded CPython 3.11 Windows x86-64

cornflakes-3.3.28-cp311-cp311-manylinux_2_35_x86_64.whl (408.9 kB view hashes)

Uploaded CPython 3.11 manylinux: glibc 2.35+ x86-64

cornflakes-3.3.28-cp311-cp311-manylinux_2_28_x86_64.manylinux_2_24_x86_64.whl (418.1 kB view hashes)

Uploaded CPython 3.11 manylinux: glibc 2.24+ x86-64 manylinux: glibc 2.28+ x86-64

cornflakes-3.3.28-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (435.1 kB view hashes)

Uploaded CPython 3.11 manylinux: glibc 2.17+ x86-64

cornflakes-3.3.28-cp311-cp311-macosx_12_0_x86_64.whl (583.3 kB view hashes)

Uploaded CPython 3.11 macOS 12.0+ x86-64

cornflakes-3.3.28-cp310-cp310-win_amd64.whl (277.0 kB view hashes)

Uploaded CPython 3.10 Windows x86-64

cornflakes-3.3.28-cp310-cp310-manylinux_2_35_x86_64.whl (408.1 kB view hashes)

Uploaded CPython 3.10 manylinux: glibc 2.35+ x86-64

cornflakes-3.3.28-cp310-cp310-manylinux_2_28_x86_64.manylinux_2_24_x86_64.whl (415.7 kB view hashes)

Uploaded CPython 3.10 manylinux: glibc 2.24+ x86-64 manylinux: glibc 2.28+ x86-64

cornflakes-3.3.28-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (433.3 kB view hashes)

Uploaded CPython 3.10 manylinux: glibc 2.17+ x86-64

cornflakes-3.3.28-cp310-cp310-macosx_12_0_x86_64.whl (350.7 kB view hashes)

Uploaded CPython 3.10 macOS 12.0+ x86-64

cornflakes-3.3.28-cp39-cp39-win_amd64.whl (277.0 kB view hashes)

Uploaded CPython 3.9 Windows x86-64

cornflakes-3.3.28-cp39-cp39-manylinux_2_35_x86_64.whl (408.4 kB view hashes)

Uploaded CPython 3.9 manylinux: glibc 2.35+ x86-64

cornflakes-3.3.28-cp39-cp39-manylinux_2_28_x86_64.manylinux_2_24_x86_64.whl (415.8 kB view hashes)

Uploaded CPython 3.9 manylinux: glibc 2.24+ x86-64 manylinux: glibc 2.28+ x86-64

cornflakes-3.3.28-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (433.5 kB view hashes)

Uploaded CPython 3.9 manylinux: glibc 2.17+ x86-64

cornflakes-3.3.28-cp39-cp39-macosx_12_0_x86_64.whl (350.9 kB view hashes)

Uploaded CPython 3.9 macOS 12.0+ x86-64

cornflakes-3.3.28-cp38-cp38-win_amd64.whl (277.0 kB view hashes)

Uploaded CPython 3.8 Windows x86-64

cornflakes-3.3.28-cp38-cp38-manylinux_2_35_x86_64.whl (407.6 kB view hashes)

Uploaded CPython 3.8 manylinux: glibc 2.35+ x86-64

cornflakes-3.3.28-cp38-cp38-manylinux_2_28_x86_64.manylinux_2_24_x86_64.whl (415.7 kB view hashes)

Uploaded CPython 3.8 manylinux: glibc 2.24+ x86-64 manylinux: glibc 2.28+ x86-64

cornflakes-3.3.28-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (433.1 kB view hashes)

Uploaded CPython 3.8 manylinux: glibc 2.17+ x86-64

cornflakes-3.3.28-cp38-cp38-macosx_12_0_x86_64.whl (350.7 kB view hashes)

Uploaded CPython 3.8 macOS 12.0+ x86-64

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page