从bdd规范创建动态文档

livingdocs的Python项目详细描述


使用python bdd测试运行程序,如behave,创建living 来自bdd功能文件的文档。此库将创建 包含有关bdd规范和 有助于为您的实时文档生成一个静态站点。

当前支持的文档类型:

  • *.mmark文件(由Hugo使用)

安装

pip install livingdocs

您还应该安装hugo二进制文件,以便生成 静态站点:https://gohugo.io/overview/installing/

快速启动

使用cli命令livingdocs配置hugo站点:

$ livingdocs
  Your site's title: <enter title>
  Your site's description: <enter description>
  ....

这将在根目录中创建一个livingdocs文件夹 将有一个雨果骨架创建一个静态网站。

使用像behave这样的测试运行程序,可以为每个 功能、场景和步骤。在environment.py中,可以使用 获取此信息的接线员:

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)

开发

首先创建一个虚拟环境,然后要运行测试,请使用:

tox -e py27

许可证

  • BSD许可证

变更日志

0.2.0(2016-09-16)

  • 功能-添加了cli命令以生成静态站点

0.1.3(2016-09-13)

  • 错误修复-功能文件名路径可以是嵌套目录

0.1.2(2016-08-21)

  • 不要在基本安装设置中包含枕头(或PIL)。

0.1.1(2016-08-21)

  • 安装期间安装了要求。

0.1.0(2016-08-21)

  • pypi上的第一个版本。

欢迎加入QQ群-->: 979659372 Python中文网_新手群

推荐PyPI第三方库


热门话题
使用applets查询的多人java游戏?   java如何基于字符串生成数组   基于java多边形的路径查找   java如何对多列ArrayList排序   java批处理更新从更新中返回了意外的行数(Spring/Hibernate)   java如何使用SeleniumWebDriver列出<tr>标记内的所有<td>   java如何使用SimpleFlatMapper将前缀为CSV的列别名到映射?   java为什么通过eclipse运行/调试TomCat时会出现ClassNotFoundException   java Android滚动视图上次视图未显示内部线性布局   替换字符串中不带空格的字符序列   调用方法时Java Swing GUI冻结   java是否允许/建议重用收集器?   在同步方法中使用java hashmap迭代器时   在java XMLDecoder XMLEncoder中写入XMLdatabase   java I无法在活动的片段中填充recyclerview   java Jitsi在调用过程中播放WAV文件如果可能,与音频混合   java JPA为什么我看到DB中每行有两个实体实例?