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.1.tar.gz
(11.2 kB
view hashes)
Built Distribution
Close
Hashes for livingdocs-0.1.1-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e71d0b2a00a514d9dc8994ad91873a4706418722457d087b082f5cee99a1f3c8 |
|
MD5 | e755f84d517b22f9ce9be0437e813ace |
|
BLAKE2b-256 | cb013daa7e4ed1f1f26d2b03231288328cfc42994512954923d6d499148a7244 |