Create living documentation from BDD specs
Project description
Using a Python BDD test runner like behave, create living documentation from your BDD feature files. This library will create documents that contain up-to-date information about your BDD specs and helps generate a static site for your living documentation.
Current supported document types:
*.mmark files (to be used by Hugo)
Installation
pip install livingdocs
You should also install the Hugo binaries in order to generate your static site: https://gohugo.io/overview/installing/
Quick Start
Use the CLI command livingdocs to configure your Hugo site:
$ livingdocs Your site's title: <enter title> Your site's description: <enter description> ....
This will create a livingdocs folder in your root directory which will have a Hugo skeleton to create a static site.
Using a test runner like behave, you can generate documents for each feature, scenario and step. In environment.py, you can use the DocsMaker to capture this information:
from livingdocs.maker import DocsMaker
def before_all(context):
context.docs = DocsMaker('feature')
def before_scenario(context, scenario):
context.docs.start_scenario(context, scenario)
def after_scenario(context, scenario):
context.docs.end_scenario(context, scenario)
def before_feature(context, feature):
context.docs.start_feature(context, feature)
def after_feature(context, feature):
context.docs.end_feature(context, feature)
def before_step(context, step):
context.docs.start_step(context, step)
def after_step(context, step):
"""
if context.browser is an instance
of Selenium Webdriver, then it will
take a snapshot of this step.
"""
context.docs.end_step(context, step)
Development
First create a virtual env, then to run the tests use:
tox -e py27
License
BSD License
Changelog
0.2.0 (2016-09-16)
Feature - added cli command to generate static site
0.1.3 (2016-09-13)
Bugfix - Feature filename path can be nested directories
0.1.2 (2016-08-21)
Don’t include Pillow (or PIL) in basic install setup.
0.1.1 (2016-08-21)
Requirements are installed during setup.
0.1.0 (2016-08-21)
First release on PyPI.
