Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/reala10n/validit
Easily define configuration file structures, and validate files using the templates. 🍒📂
https://github.com/reala10n/validit
config configuration json pip pypi pypi-package python python3 python36 template templates toml toml-config toml-parsing toml-validation validit yaml yaml-configuration yml yml-configuration
Last synced: about 2 months ago
JSON representation
Easily define configuration file structures, and validate files using the templates. 🍒📂
- Host: GitHub
- URL: https://github.com/reala10n/validit
- Owner: RealA10N
- Created: 2021-05-24T21:38:12.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-09-14T01:09:01.000Z (over 1 year ago)
- Last Synced: 2024-10-12T08:08:09.075Z (2 months ago)
- Topics: config, configuration, json, pip, pypi, pypi-package, python, python3, python36, template, templates, toml, toml-config, toml-parsing, toml-validation, validit, yaml, yaml-configuration, yml, yml-configuration
- Language: Python
- Homepage: https://tinyurl.com/validit-wiki
- Size: 702 KB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# validit
[](https://github.com/RealA10N/validit/actions/workflows/test.yaml)
[](https://pypi.org/project/validit/)
[](https://pypi.org/project/validit/)
[](https://github.com/RealA10N/validit)
_Easily define configuration file structures, and validate files using the templates. 🍒📂_
- [Installation](#installation)
- [Support for additional file formats](#support-for-additional-file-formats)
- [Usage](#usage)
- [Defining a template](#defining-a-template)
- [Validating data](#validating-data)
- [Validating data from files](#validating-data-from-files)
- [Using validit as a dependency](#using-validit-as-a-dependency)
## Installation
**validit** is tested on CPython 3.6, 3.7, 3.8, and 3.9.
Simply install using pip:
```bash
$ (sudo) 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:
- `JSON`
- `YAML`
- `TOML`
To install _validit_ with the additional required dependencies to support
your preferred file format, use:
```yaml
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
```
## Usage
### Defining a template
To create a template, you will need the basic `Template` module, and usually the
other three basic modules `TemplateList`, `TemplateDict`, and `Optional`.
In the following example, we will create a basic template that represents a single user:
```python
from validit import Template, TemplateList, TemplateDict, Optional
TemplateUser = TemplateDict( # a dictionary with 2 required values
username=Template(str), # username must be a string
passcode=Template(int, str), # can be a string or an integer.
nickname=Optional(Template(str)), # optional - if provided, must be a string.
)
```
### Validating data
To validate your data with a template, you should use the `Validate` object.
```python
from validit import Template, TemplateDict, Optional, Validate
template = TemplateDict(
username=Template(str),
passcode=Template(int, str),
nickname=Optional(Template(str)),
)
data = {
'username': 'RealA10N',
'passcode': 123,
}
valid = Validate(template, data)
if valid.errors: # if one or more errors found
print(valid.errors) # print errors to console
exit(1) # exit the script with exit code 1
else: # if data matches the template
run_script(valid.data) # run the script with the loaded data
```
#### Validating data from files
If your data is stored in a file, it is possible to use the `ValidateFromJSON`,
`ValidateFromYAML` or `ValidateFromTOML` objects instead:
```python
from validit import Template, TemplateDict, Optional, ValidateFromYAML
filepath = '/path/to/data.yaml'
template = TemplateDict(
username=Template(str),
passcode=Template(int, str),
nickname=Optional(Template(str)),
)
with open(filepath, 'r') as file:
# load and validate data from the file
valid = ValidateFromYAML(file, template)
if valid.errors: # if one or more errors found
print(valid.errors) # print errors to console
exit(1) # exit the script with exit code 1
else: # if data matches the template
run_script(valid.data) # run the script with the loaded data
```
## 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.3.2_ use the following line in your
`requirements.txt` file:
```yaml
validit==1.3.2
validit[yaml]==1.3.2 # If using extra file formats
```