Skip to main content

Tool for generating test documentation

Project description


Tool for generating test documentation & test coverage out of a file/folder hierarchy (or an equivalent json file). A default file/folder hierarchy is defined below with which the tool will work without customisations/custom templates.

Tool for generationg the Documentation: k3testdocumentation-generator

Tool for generationg the Coverage: k3testdocumentation-generate-coverage

Installation (use within viruatlenv or equivalent)

pip install k3testdocumentation-generator


When generating PDFs from HTML wkhtmltopdf needs to be installed (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.

When generating PDFs from LATEX pdflatex needs to be installed. It is also available in the package managers of the common linux distributions.

Default File/Folder Hierarchy

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 

├── TC.XX.01
│   ├──
│   ├── required_equiptment.json
│   ├── requirements_fully_tested.json
│   ├── requirements_partially_tested.json
│   ├──
│   └── test_name.txt
└── TC.XX.02
    └── __test__.json (Abbreviated form allowing the direct instanciation of
                       keys in one file. Will be overwritten if the file also

Corresponding k3testdocumentation-generator command:

k3testdocumentation-generator example_test_dir/ -v -o output.pdf

Corresponding k3testdocumentation-generate-coverage command:
and a required json file exists with requirements in the folling format

k3testdocumentation-generate-coverage requirements_list.json example_test_dir/ -v -o output.pdf

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for k3testdocumentation-generator, version 0.2.4
Filename, size File type Python version Upload date Hashes
Filename, size k3testdocumentation_generator-0.2.4-py3-none-any.whl (12.4 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size k3testdocumentation-generator-0.2.4.tar.gz (8.9 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page