使用版本控制的需求管理。
doorstop的Python项目详细描述
概述
doorstop是一个requirements management工具,它有助于在版本控制中存储文本需求和源代码。
当一个项目利用这个工具时,每个可链接的项(需求、测试用例等)都作为一个yaml文件存储在指定的目录中。每个目录中的项构成一个文档。文档之间的关系形成树层次结构。doorstop提供了修改此树、验证项目可跟踪性以及以多种格式发布文档的机制。
门站正在积极发展中,我们欢迎大家的贡献。 该项目被授权为LGPLv3。 若要报告问题或安全漏洞,请raise an issue。 其他参考资料:
- 出版物:JSEA Paper
- 会谈:GRDevDay,BarCamp
- 示例:Generated HTML
设置
要求
- Python3.5+
- 用于需求存储的版本控制系统
安装
用PIP安装车门挡块:
$ pip install doorstop
或者将其添加到您的Poetry项目:
$ poetry add doorstop
安装完成后,可在命令行中使用DoorStop:
$ doorstop --help
这个包裹的名字叫“门站”:
$ python >>> import doorstop >>> doorstop.__version__
用法
切换到现有版本控制工作目录,或创建一个:
$ git init .
创建文档
创建新的父级需求文档:
$ doorstop create SRD ./reqs/srd
在该文档中添加一些项目:
$ doorstop add SRD $ doorstop add SRD $ doorstop add SRD
链接项目
创建子文档以链接到父文档:
$ doorstop create HLTC ./tests/hl --parent SRD $ doorstop add HLTC
在文档之间链接项目:
$ doorstop link HLTC001 SRD002
发布报告
在文档树上运行完整性检查:
$ doorstop
将文档发布为html:
$ doorstop publish all ./public