ZConfig Tooling

ZConfig ships with some tools that can be helpful to anyone either writing configurations or writing programs that read configurations.

Schema and Configuration Validation

When ZConfig is installed, it installs a program called zconfig that can validate both schemas and configurations written against those schemas:

  File "/tmp/B.e5xzrwua/BUILD/python3-ZConfig-4.2-build/zconfig-4.2/src/ZConfig/validator.py", line 67
    print(str(e), file=sys.stderr)
                      ^
SyntaxError: invalid syntax

Documenting Schemas

ZConfig also installs a tool called zconfig_schema2html that can print schemas in a simple HTML format.

Hint

To document components in reStructuredText, e.g., with Sphinx, see Documenting Components.

Traceback (most recent call last):
  File "/tmp/B.e5xzrwua/BUILD/python3-ZConfig-4.2-build/zconfig-4.2/src/ZConfig/schema2html.py", line 20, in <module>
    from ZConfig._schema_utils import MARKER
  File "/tmp/B.e5xzrwua/BUILD/python3-ZConfig-4.2-build/zconfig-4.2/src/ZConfig/__init__.py", line 198
    s = f"{self.message} (line {self.lineno}"
                                            ^
SyntaxError: invalid syntax