Compile and render schema-validated configuration data.
sphinx-apidoc?)pydoc?)This package is tested with the following Python minor versions:
This package is tested on the following platforms:
ubuntu-latestmacos-latestwindows-latestGood software is composable and configurable, but the complexity of managing configuration data scales with its complexity.
This package simplifies data curation and partitioning for uses in rendering templates, or just rendering final sets of serialized data.
$ ./venv3.11/bin/dz -h
usage: dz [-h] [--version] [-v] [-q] [--curses] [--no-uvloop] [-C DIR]
[--line-ending {unix,dos,unix}] [-m MANIFEST] [-c] [--sync] [-d]
[targets ...]
Compile and render schema-validated configuration data.
positional arguments:
targets target(s) to execute
options:
-h, --help show this help message and exit
--version show program's version number and exit
-v, --verbose set to increase logging verbosity
-q, --quiet set to reduce output
--curses whether or not to use curses.wrapper when starting
--no-uvloop whether or not to disable uvloop as event loop driver
-C DIR, --dir DIR execute from a specific directory
--line-ending {unix,dos,unix}
line-ending option to use by default (default: 'unix')
-m MANIFEST, --manifest MANIFEST
manifest to execute tasks from (default:
'manifest.yaml')
-c, --clean clean the manifest's cache and exit
--sync sync the manifest's cache (write-through) with the
state of the file system before execution
-d, --describe describe the manifest's cache and exit
A manifest is provided to datazen to establish the set of targets
that should be executed based on defaults or the command-line invocation.
A boolean flag specifying whether or not to load directories relative to the current manifest file that coincide with names of load-able data types (e.g. "configs" loaded as configs, "variables" loaded as variables). By default these are loaded into the global namespace.
Setting this false will not automatically load these directories.
default_dirs:
type: boolean
default: true
Include additional files to build the final, root manifest with. This same schema applies to included files.
includes: paths
Override the default output directory (i.e. datazen-out).
output_dir:
type: string
Override the default cache directory (i.e. .manifest_cache).
cache_dir:
type: string
For each of these keys, add paths that should be loaded globally.
configs: paths
schemas: paths
schema_types: paths
templates: paths
variables: paths
Manifests themselves are Jinja templates that are rendered with the data contained in this key.
params:
type: dict
The target to execute by default if none is provided.
default_target:
type: string
Target definitions for compilation tasks.
compiles:
type: list
schema:
type: dict
schema:
configs: paths
schemas: paths
schema_types: paths
variables: paths
dependencies: deps
name:
type: string
key:
type: string
override_path:
type: string
output_type:
type: string
output_path:
type: string
output_dir:
type: string
index_path:
type: string
merge_deps:
type: boolean
default: false
append:
type: boolean
Target definitions for command-line command tasks.
commands:
type: list
schema:
type: dict
schema:
file:
type: string
name:
type: string
command:
type: string
force:
type: boolean
replace_newlines:
type: boolean
arguments: deps
dependencies: deps
Target definitions for render tasks. Renders can create output files based on Jinja templates, or just String data to be used as a dependency for another task.
renders:
type: list
schema:
type: dict
schema:
templates: paths
children: deps
child_delimeter:
type: string
child_indent:
type: integer
dependencies: deps
name:
type: string
override_path:
type: string
as:
type: string
key:
type: string
output_dir:
type: string
output_path:
type: string
no_dynamic_fingerprint:
type: boolean
no_file:
type: boolean
indent:
type: integer
template_dependencies:
type: list
schema:
type: string
Target definitions for group tasks. Groups declare a set of dependencies and nothing else. Groups can be used as dependencies for any other target.
groups:
type: list
schema:
type: dict
schema:
name:
type: string
dependencies: deps
These items may appear in the manifest schema.
Dependencies are lists of Strings.
They should be formatted as (compiles,renders,...)-target.
type: list
schema:
type: string
Paths are lists of Strings and can use / or \\ as delimeters.
Paths are relative to the directory that a manifest file is in, but for
manifest includes, all "loaded" directories are relative to the root
manifest's directory. Paths can also be absolute.
type: list
schema:
type: string
A coarse view of the internal structure and scale of
datazen's source.
Generated using pydeps (via
mk python-deps).
This entire document is generated by this package.
FAQs
Compile and render schema-validated configuration data.
We found that datazen demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.