# 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](https://github.com/prompt-toolkit/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://github.com/Opus10/git-tidy):
Check out the [docs](https://formaldict.readthedocs.io/) for a tutorial on how to use `formaldict` as the backbone for parsing structured input in your library.
## Documentation
[View the formaldict docs here](https://formaldict.readthedocs.io/).
## Installation
Install formaldict with:
pip3 install formaldict
## Contributing Guide
For information on setting up formaldict for development and contributing changes, view [CONTRIBUTING.md](CONTRIBUTING.md).
## Compatibility
`formaldict` is compatible with Python 3.9 - 3.13.
## Creators
- @wesleykendall (Wes Kendall)
Raw data
{
"_id": null,
"home_page": "https://github.com/Opus10/formaldict",
"name": "formaldict",
"maintainer": null,
"docs_url": null,
"requires_python": "<4,>=3.9.0",
"maintainer_email": null,
"keywords": null,
"author": "Wes Kendall",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/13/11/36b1e38916a08a85ca411059b853bb349f7b8a4cd0e9f1a985d5600d6a20/formaldict-1.1.0.tar.gz",
"platform": null,
"description": "# formaldict\n\n`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](https://github.com/prompt-toolkit/python-prompt-toolkit). This integration allows users to easily construct flows for command line interfaces (CLIs) when parsing structured user input.\n\nBelow is an example user input flow constructed with a `formaldict` schema used by [git-tidy](https://github.com/Opus10/git-tidy):\n\n\n\nCheck out the [docs](https://formaldict.readthedocs.io/) for a tutorial on how to use `formaldict` as the backbone for parsing structured input in your library.\n\n## Documentation\n\n[View the formaldict docs here](https://formaldict.readthedocs.io/).\n\n## Installation\n\nInstall formaldict with:\n\n pip3 install formaldict\n\n## Contributing Guide\n\nFor information on setting up formaldict for development and contributing changes, view [CONTRIBUTING.md](CONTRIBUTING.md).\n\n## Compatibility\n\n`formaldict` is compatible with Python 3.9 - 3.13.\n\n## Creators\n\n- @wesleykendall (Wes Kendall)\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "Formal structured dictionaries parsed from a schema",
"version": "1.1.0",
"project_urls": {
"Documentation": "https://formaldict.readthedocs.io",
"Homepage": "https://github.com/Opus10/formaldict",
"Repository": "https://github.com/Opus10/formaldict"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6ddc88a38f5118c960ca3de5f7d163b8dd0a0771ca1851ecb25c7cb3d1768c7e",
"md5": "202713302e658c1d96be9c3ee7cc7eb8",
"sha256": "a0d1881157ca529109d69f7e5f41673150ef1746161e5d0782f5b2e02827bcb8"
},
"downloads": -1,
"filename": "formaldict-1.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "202713302e658c1d96be9c3ee7cc7eb8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.9.0",
"size": 8892,
"upload_time": "2024-11-02T19:53:55",
"upload_time_iso_8601": "2024-11-02T19:53:55.218162Z",
"url": "https://files.pythonhosted.org/packages/6d/dc/88a38f5118c960ca3de5f7d163b8dd0a0771ca1851ecb25c7cb3d1768c7e/formaldict-1.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "131136b1e38916a08a85ca411059b853bb349f7b8a4cd0e9f1a985d5600d6a20",
"md5": "470b02104c5828c2d24748d159014dc4",
"sha256": "79f1954a540560dd572a34de6f525d61c1c0331079a537008eb72e34a70abd00"
},
"downloads": -1,
"filename": "formaldict-1.1.0.tar.gz",
"has_sig": false,
"md5_digest": "470b02104c5828c2d24748d159014dc4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.9.0",
"size": 8886,
"upload_time": "2024-11-02T19:53:56",
"upload_time_iso_8601": "2024-11-02T19:53:56.409366Z",
"url": "https://files.pythonhosted.org/packages/13/11/36b1e38916a08a85ca411059b853bb349f7b8a4cd0e9f1a985d5600d6a20/formaldict-1.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-02 19:53:56",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Opus10",
"github_project": "formaldict",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"circle": true,
"tox": true,
"lcname": "formaldict"
}
JSON
