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.
Current supported document types:
*.mmark files (to be used by Hugo)
Installation
pip install livingdocs
Quick Start
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.1.0 (2016-08-21)
First release on PyPI.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
livingdocs-0.1.0.tar.gz
(14.0 kB
view hashes)
Built Distribution
Close
Hashes for livingdocs-0.1.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b8ad9348280c810a1cf9ebb9627d86e2d4a56375c4f032e5a16b09c7720f3189 |
|
MD5 | b5bdbcc4ab8f6bc5c7aaa391d6d22b16 |
|
BLAKE2b-256 | 53f6d807853dfa5cc0eee338e96b640d22e3a3c1532e940595ae9e1a8186e155 |