跳转到主要内容

使用版本控制进行需求管理。

项目描述

Unix Build Status Windows Build Status
Coverage Status Scrutinizer Code Quality PyPI Version
Gitter Google Best Practices

概述

Doorstop是一个需求管理工具,它便于在版本控制中存储文本需求和源代码。

当项目使用此工具时,每个可链接项(需求、测试用例等)都被存储为指定目录中的YAML文件。每个目录中的项目形成一个文档。文档之间的关系形成一个树状层次结构。Doorstop提供修改此树、验证项目可追溯性以及以多种格式发布文档的机制。

Doorstop正处于积极开发中,我们欢迎贡献。项目以LGPLv3许可。如需报告问题或安全漏洞,请提交问题。更多信息

设置

需求

  • Python 3.5+
  • 用于需求存储的版本控制系统

安装

使用pip安装Doorstop

$ pip install doorstop

或将它添加到你的Poetry项目中

$ poetry add doorstop

安装后,Doorstop将在命令行上可用

$ doorstop --help

并且该包名称为'doorstop'

$ 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

项目详情


发行历史 发行通知 | RSS源

下载文件

下载您平台对应的文件。如果您不确定该选择哪个,请了解更多关于安装包的信息。

源分布

doorstop-2.2.1.tar.gz (244.8 kB 查看哈希值)

上传时间

构建分布

doorstop-2.2.1-py3-none-any.whl (292.6 kB 查看哈希值)

上传时间 Python 3

由以下支持

AWS AWS 云计算和安全赞助商 Datadog Datadog 监控 Fastly Fastly CDN Google Google 下载分析 Microsoft Microsoft PSF 赞助商 Pingdom Pingdom 监控 Sentry Sentry 错误记录 StatusPage StatusPage 状态页面