从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第三方库


热门话题
java画布矩形位置   Java类文件未在Android Studio上编译或运行   Java“null”值从未分配给我的Runnable   java Jsp使用URL“保存或打开”访问pdf窗口在单击时显示错误   组件之间的Java swing通信   属性值的java正则表达式   java无法从myFile加载MainClass清单属性。震击器错误   Java内存碎片和大型阵列的分配   java是NullPointerException的一个问题   java如何使用鳄梨酱进行sftp的二次开发   新手程序员需要建议:“字符串索引超出范围”Java   基于页面的java Birt组头   使用集合时出错。使用ArrayList和类排序()。(爪哇)   在foursquare中使用多个单词进行带查询的java场馆搜索   有了新的Java14记录功能,是否可以为同一记录创建多个构造函数?   java创建自己的文件扩展名   java组织。阿帕奇。xml。安全性在Spring Boot下不工作   java谷歌地图标记标题安卓   java为什么选项卡小部件在安卓中位于内容之上?