Getting Started - RealA10N/configTemplate Wiki

In this section, we will go over everything you need to know to start creating your own templates using the Python validit module.

Installation

validit is tested on CPython 3.6, 3.7, 3.8, and 3.9. Simply install using pip:

pip install validit

Support for additional file formats

By default, validit only supports JSON configuration files, or already loaded data (not directly from a configuration file). However, using additional dependencies, validit supports the following file formats:

To install validit with the additional required dependencies to support your preferred file format, use:

pip install validit[yaml]        # install dependencies for yaml files
pip install validit[toml]        # toml files
pip install validit[json,toml]   # json and toml files
pip install validit[all]         # all available file formats

Using validit as a dependency

validit is still under active development, and some core features may change substantially in the near future.

If you are planning to use validit as a dependency for your project, we highly recommend specifying the exact version of the module you are using in the requirements.txt file or setup.py scripts.

For example, to pinpoint version v1.0.0 use the following line in your requirements.txt file:

validit==1.0.0
validit[yaml]==1.0.0     # If using extra file formats