Skip to main content

Formal structured dictionaries parsed from a schema

Project description

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:

https://raw.githubusercontent.com/jyveapp/formaldict/master/docs/_static/prompt.gif

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.rst.

Primary Authors

  • @wesleykendall (Wes Kendall)

Project details


Download files

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

Source Distribution

formaldict-1.0.4.tar.gz (12.0 kB view hashes)

Uploaded Source

Built Distribution

formaldict-1.0.4-py3-none-any.whl (12.4 kB view hashes)

Uploaded Python 3

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