Use JSON Schema to validate directory structures
Project description
directory_schema
Use JSON Schema to validate directory structures:
The specified directory is translated into a JSON structure like the output from tree -J
,
and is validated against a JSON Schema, provided as a dict inside Python,
or as a JSON or YAML file through the CLI.
Sample schemas and directories are in the test fixtures.
Instructions for contributors are here.
CLI
$ directory_schema -h
usage: directory_schema [-h] DIRECTORY SCHEMA
positional arguments:
DIRECTORY Directory to validate
SCHEMA Schema (JSON or YAML) to validate against
optional arguments:
-h, --help show this help message and exit
Python
>>> from directory_schema import directory_schema
>>> directory_schema.validate_dir(
... 'tests/fixtures/just-a-placeholder',
... {'items':
... {'properties':
... {'name':
... {'pattern': 'not-placeholder'}}}}
... )
Traceback (most recent call last):
...
raise DirectoryValidationErrors(errors)
directory_schema.directory_schema.DirectoryValidationErrors: This string:
placeholder
fails this "pattern" check:
not-placeholder
...
Thank you
This package was created with Cookiecutter and the cs01/cookiecutter-pypackage
project template.
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
directory_schema-0.0.1.tar.gz
(5.3 kB
view hashes)
Built Distribution
Close
Hashes for directory_schema-0.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 73c2bb0bbeb525eba617338e49fd7f540e7709213999df2cc3d6fb8aebbcbee9 |
|
MD5 | 110618cbaebe118a22b22cd282acebc6 |
|
BLAKE2b-256 | 620897848bc0088c8f2eff77ce0d5d72650508ed0bc6ceeb8738e6c59188aba4 |