Create living documentation from BDD specs
Project description
tests |
|
---|---|
package |
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.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.
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
Built Distribution
Hashes for livingdocs-0.1.2-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | cf3742de5194f3b6d18a6fb38da6b629741a2b21d36581b73b12d5d1108eeb23 |
|
MD5 | 74e50a11be095811a794655e9d9a83b1 |
|
BLAKE2b-256 | d2bf847a2d7a0b50094b62defa59b49426a03089078ae057d10a1d4224a297d3 |