Configuration format validator for CSV, INI, JSON, TOML, XML, and YAML.
Project description
gelee
Gelee - a finer confiture.
Configuration linter for typical formats.
Status
Experimental.
Note: The default branch is default
.
Use
- Examples
- Version
- General Help
- Cook Help
- Cook
- Command Line API
gelee
gelee cook
gelee version
Examples
Version
$ gelee version
Gelee - a finer confiture. version 2021.10.24
General Help
$ gelee
Usage: gelee [OPTIONS] COMMAND [ARGS]...
Gelee - a finer confiture.
Validate configuration files against their format and maybe schema.
Options:
-V, --version Display the gelee version and exit [default: False]
-h, --help Show this message and exit.
Commands:
cook Cook the gelee from the files in the tree below path.
version Display the gelee version and exit
Cook Help
$ gelee cook --help
Usage: gelee cook [OPTIONS] UNIQUE_TREES...
Cook the gelee from the files in the tree below path.
Arguments:
UNIQUE_TREES... [required]
Options:
-a, --abort Flag to abort execution on first fail (default is False)
[default: False]
-d, --debug Flag to debug execution by adding more context info (default is
False) [default: False]
-h, --help Show this message and exit.
Cook
$ gelee cook tests/fixtures
2021-10-23T18:47:18.979 INFO [gelee]: Starting validation visiting a forest with 1 tree
2021-10-23T18:47:18.994 ERROR [gelee]: Failed validation for path tests/fixtures/invalid/toml/key_group_not_on_dedicated_line.toml with error: Key group not on a line by itself. (line 1 column 1 char 0)
2021-10-23T18:47:18.994 ERROR [gelee]: Failed validation for path tests/fixtures/invalid/xml/empty.xml with error: ERROR: Empty XML file
2021-10-23T18:47:18.996 ERROR [gelee]: Failed validation for path tests/fixtures/invalid/ini/duplicate_section.ini with error: While reading from PosixPath('tests/fixtures/invalid/ini/duplicate_section.ini') [line 3]: section 'section' already exists
2021-10-23T18:47:18.997 ERROR [gelee]: Failed validation for path tests/fixtures/invalid/ini/missing_section_header.ini with error: File contains no section headers.file: PosixPath('tests/fixtures/invalid/ini/missing_section_header.ini'), line: 1'[section\n'
2021-10-23T18:47:18.998 ERROR [gelee]: Failed validation for path tests/fixtures/invalid/json/invalid.json with error: Expecting property name enclosed in double quotes: line 2 column 1 (char 2)
2021-10-23T18:47:18.998 ERROR [gelee]: Failed validation for path tests/fixtures/invalid/json/empty.geojson with error: Expecting value: line 1 column 1 (char 0)
2021-10-23T18:47:18.999 ERROR [gelee]: Failed validation for path tests/fixtures/invalid/csv/empty.csv with error: ERROR: Empty CSV file
2021-10-23T18:47:19.000 ERROR [gelee]: Failed validation for path tests/fixtures/invalid/yaml/unexpected-dash.yml with error: while parsing a block mapping in "tests/fixtures/invalid/yaml/unexpected-dash.yml", line 1, column 1did not find expected key in "tests/fixtures/invalid/yaml/unexpected-dash.yml", line 3, column 1
2021-10-23T18:47:19.001 ERROR [gelee]: Failed validation for path tests/fixtures/invalid/yaml/unexpected-dash.yaml with error: while parsing a block mapping in "tests/fixtures/invalid/yaml/unexpected-dash.yaml", line 1, column 1did not find expected key in "tests/fixtures/invalid/yaml/unexpected-dash.yaml", line 3, column 1
2021-10-23T18:47:19.001 INFO [gelee]: - Successfully validated 1 total CSV file.
2021-10-23T18:47:19.001 INFO [gelee]: - Successfully validated 1 total INI file.
2021-10-23T18:47:19.001 INFO [gelee]: - Successfully validated 1 total JSON file.
2021-10-23T18:47:19.001 INFO [gelee]: - Successfully validated 1 total TOML file.
2021-10-23T18:47:19.001 INFO [gelee]: - Successfully validated 1 total XML file.
2021-10-23T18:47:19.001 INFO [gelee]: - Successfully validated 1 total YAML file.
2021-10-23T18:47:19.001 INFO [gelee]: Finished validation of 6 configuration files with 9 failures visiting 33 paths (ignored 1 non-config file in 17 folders)
FAIL
Command Line API
gelee
gelee cook
gelee version
gelee
Gelee - a finer confiture.
Validate configuration files against their format and maybe schema.
Usage:
$ gelee [OPTIONS] COMMAND [ARGS]...
Options:
-V, --version
: Display the gelee version and exit [default: False]-h, --help
: Show this message and exit.
Commands:
cook
: Cook the gelee from the files in the tree...version
: Display the gelee version and exit
gelee cook
Cook the gelee from the files in the tree below path.
Usage:
$ gelee cook [OPTIONS] UNIQUE_TREES...
Arguments:
UNIQUE_TREES...
: [required]
Options:
-a, --abort
: Flag to abort execution on first fail (default is False) [default: False]-d, --debug
: Flag to debug execution by adding more context info (default is False) [default: False]-h, --help
: Show this message and exit.
gelee version
Display the gelee version and exit
Usage:
$ gelee version [OPTIONS]
Options:
-h, --help
: Show this message and exit.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
gelee-2021.10.24.tar.gz
(11.6 kB
view hashes)
Built Distribution
Close
Hashes for gelee-2021.10.24-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6342ac4189fe627a36fbc796f4e87a98d2a0b9b7c380f2f10d3804fa84c47d44 |
|
MD5 | fcc7dd6d90384c97cc0bf4e945bd195a |
|
BLAKE2b-256 | e52a46f1afd49f7f25e9b4ae89920fc00741a546d21d711c8f9fc8a129c7dcdd |