Tool for generating test documentation
Project description
k3testdocumentation-generator
Tool for generating test documentation out of a test hierarchy or test.son
##Installation (use within viruatlenv or equivalent)
pip install k3testdocumentation-generator
###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.
##Usage:
usage: k3testdocumentation-generator [-h] [-te {jinja2}] [-to {html,latex}]
[-ot {pdf,json,raw}] [-o OUTPUT]
[--template TEMPLATE] [-v] [-vv]
input
CLI tool for creating a test document from a test directory or JSON
Author: Joachim Kestner <joachim.kestner@khoch3.de>
Version: 0.1.3
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
-te {jinja2}, --template_engine {jinja2}
The templating engine. Currently only jinja2 is
supported.
-to {html,latex}, --template_output {html,latex}
The content language within the template. Only html is
supported.
-ot {pdf,json,raw}, --output_type {pdf,json,raw}
The output format. JSON would output the data before
it goes into the templating engine. Raw is the raw
result after the templating engine has run. Default is
'pdf'
-o OUTPUT, --output OUTPUT
Output file path. If not set a name will be generated
by: basename(input) + '.' + output_type.lower()
--template TEMPLATE The path to an alternative template
-v, --verbose Enable info logging
-vv, --extra_verbose Enable debug logging
##Example:
Create a the test directory structure (example included in src).
This structure works with the inbuilt template. To support a different
structure create a custom template and pass it using the --template parameter.
Note: any json file will be opened and interpreted. In the default structure
all json files need contain a list of strings
example_test_dir/
├── TC.XX.01
│ ├── precondition.md
│ ├── required_equiptment.json
│ ├── requirements_fully_tested.json
│ ├── requirements_partially_tested.json
│ ├── test_descrition.md
│ └── test_name.txt
└── TC.XX.02
├── test_descrition.md
└── __test__.json (Abbreviated form allowing the direct instanciation of
keys in one file. Will be overwritten if the file also
exists)
Corresponding example command:
k3testdocumentation-generator .../example_test_dir/ -v -o 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.2.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8edb7123d5e1152dd7d90f94a29dbdbd237a1218e5631f2c2a62a765656f6db4 |
|
MD5 | b3488c8eef931ea0e531fa2783a15adc |
|
BLAKE2b-256 | 1e381bd681c7be16ed38bce622befcace4c08ca9b91ee9b83691f7092aa3038c |
Close
Hashes for k3testdocumentation_generator-0.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d120b640ae34946030278b9f08e091f34ef082167d5d32f8745b3002dfe34bec |
|
MD5 | 9d8e343b5aa7d35132c31bdfbe10a3a2 |
|
BLAKE2b-256 | f08f2648bd149a3298ba5bbe35ba659cf8b36bc7cf9b1b4862263d0fa825871c |