Tool for generating test documentation
Project description
k3testdocumentation-generator
Tool for generating test documentation out of a test hierarchy or test.son
Prerequisites/Limitations:
wkhtmltopdf needs to be installed when generating PDFs (required by the pdfkit library). It is available in the package managers of the common linux distributions.
May require running a virtual X server on a headless environment.
Installation (use within viruatlenv or equivalent)
pip install k3testdocumentation-generator
Usage:
k3testdocumentation-generator -h
usage: k3testdocumentation-generator [-h] [-t {PDF,JSON,HTML}] [-o OUTPUT]
[-v] [-vv]
input
CLI tool for creating a test document from an test directory or JSON
Author: Joachim Kestner <joachim.kestner@khoch3.de>
Version: 0.1.0
positional arguments:
input Input to generate documentation from. Can either be a
directory containing the specified structure or an
appropriate JSON
optional arguments:
-h, --help show this help message and exit
-t {PDF,JSON,HTML}, --output_type {PDF,JSON,HTML}
The output format. Default is PDF
-o OUTPUT, --output OUTPUT
Output file path. If not set a name will be generated
by: basename(input) + output_type.lower()
-v, --verbose Enable info logging
-vv, --extra_verbose Enable debug logging
Example: k3testdocumentation-generator ../he_platform_module_test_documentation/base_tests_documentation/ -v -t PDF
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
Built Distribution
Close
Hashes for k3testdocumentation-generator-0.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0e72be5392f0e2410b25261d9cfdc8a66c59acb7f25748a989ab1f527f4e6a1e |
|
MD5 | 35680afd383ee9c4a15d1e1a774b4284 |
|
BLAKE2b-256 | d5cb56230e072c3600dd218a3db328a1085dc38c51c639269f77e819d232d85b |
Close
Hashes for k3testdocumentation_generator-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0667e36b5beb2df9f3780c54b7b328d81244a86889c83b567c39f4ed9ac2fd78 |
|
MD5 | 7c15d3b69371730b3b083e091801066f |
|
BLAKE2b-256 | 768ed6c098bdc84f2bf2f8520cdd6ba4ab08d3ed788b3a71a072968e5f8136d3 |