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.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e3577fc8bba5d89474f56282b91619bfb6615c001cce82b838751ecd114db395 |
|
MD5 | c5f8f7eb1fd1f8e770b1f90b7eb5d846 |
|
BLAKE2b-256 | dd9721a7baf4734c8e9bd30474d852b958d1ce135eecec728fc3789b3404b46e |
Close
Hashes for k3testdocumentation_generator-0.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5931054f4c657c6d6f72608112a8831a8189b5d5dd2636b0acf7f2da27d3a2c3 |
|
MD5 | 5bba2e403486a15b446b53c36437ccbe |
|
BLAKE2b-256 | f0cd3ea29146acbc8a79102d3a6a3520542d31eab0bd5d1bcaba8ed2222d0b2c |