Skip to content

Opus10/formaldict

Repository files navigation

formaldict

formaldict provides the constructs for parsing structured dictionaries that adhere to a schema. Along with a simple and flexible schema definition to parse and validate dictionaries, formaldict is integrated with python-prompt-toolkit. This integration allows users to easily construct flows for command line interfaces (CLIs) when parsing structured user input.

Below is an example user input flow constructed with a formaldict schema used by git-tidy:

Usage

Check out the docs for a tutorial on how to use formaldict as the backbone for parsing structured input in your library.

Documentation

View the formaldict docs here.

Installation

Install formaldict with:

pip3 install formaldict

Contributing Guide

For information on setting up formaldict for development and contributing changes, view CONTRIBUTING.md.

Compatibility

formaldict is compatible with Python 3.8 - 3.12.

Creators

  • @wesleykendall (Wes Kendall)