Turns folder of gherkin feature files into a docx file.
Project description
Feature reporter
"Feature reporter" comes from the need to provide MS Word reports to customer.
It aims to pretty print a set of plain text .feature
files into one shareable document.
Optionally, it adds the last automated execution of these scenarios.
Please note! This package heavily relies on the Behave package in order to process feature file and execution results format.
Installation
pip install eaiscenarioreporter
Usage
From a python shell
from featurereporter import ExportUtilities
my_export = ExportUtilities()
my_export.feature_repository = "path/to/the/feature/files/folder"
my_export.create_application_documentation()
# Create the demo.docx document in the current folder.
From the command line
GUI (experimental)
You can start the reporter's GUI using the following command :
python3 -m featurereporter
CLI
Feature reporter can be called directly from the command line.
# Display help
> python3 -m featurereporter -h
usage: featurereporter.py [-h] [--tag TAG] [--title TITLE] [--repository REPOSITORY] [--output OUTPUT] [--execution EXECUTION] [--license]
optional arguments:
-h, --help show this help message and exit
--tag TAG Invariant pointing to a user story
--title TITLE The document's title
--repository REPOSITORY
The folder where the feature files are
--output OUTPUT
--execution EXECUTION
Behave plain test output in order to also print the last execution result
--license Display the license.
python3 -m featurereporter --repository path/to/the/feature/files/folder
Disclaimer
This tool is still under development. There is currently no arguments control nor formal tests.
I use it in my daily work to produce report.
Please contact me for any concern.
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
Hashes for eaiscenarioreporter-0.0.20.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e9ab9e6abac2e686d1be0c0cf0bc72aadb6511ab5a1fd981ef5df5f7677618f6 |
|
MD5 | 56d134add31953f95bbfd356b55b1df7 |
|
BLAKE2b-256 | bacb9ca46a91e73cc5c022a84741d18226aca93b1c049945aff941a79da461ed |
Hashes for eaiscenarioreporter-0.0.20-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9b16454e60e4c97d185d0233e2649cac568f7b5b30bf40579de50456954dfb89 |
|
MD5 | b01ceb428fbe4ca374362fd844a960af |
|
BLAKE2b-256 | d368d14782d7665cea3a6d5d8463174818b8b3433c25f4a8f21030531a99745b |