Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/doorstop-dev/doorstop
Requirements management using version control.
https://github.com/doorstop-dev/doorstop
certification documentation html markdown requirements-management traceability version-control
Last synced: 3 months ago
JSON representation
Requirements management using version control.
- Host: GitHub
- URL: https://github.com/doorstop-dev/doorstop
- Owner: doorstop-dev
- License: other
- Created: 2013-04-01T03:29:26.000Z (over 11 years ago)
- Default Branch: develop
- Last Pushed: 2024-07-15T19:19:58.000Z (4 months ago)
- Last Synced: 2024-07-20T19:43:28.943Z (4 months ago)
- Topics: certification, documentation, html, markdown, requirements-management, traceability, version-control
- Language: Python
- Homepage: https://doorstop.readthedocs.io
- Size: 12 MB
- Stars: 464
- Watchers: 37
- Forks: 127
- Open Issues: 65
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-robotic-tooling - doorstop - Requirements management using version control. (Requirements and Safety)
README
[](https://github.com/doorstop-dev/doorstop/actions/workflows/test-linux.yml)
[](https://github.com/doorstop-dev/doorstop/actions/workflows/test-osx.yml)
[](https://github.com/doorstop-dev/doorstop/actions/workflows/test-windows.yml)
[](https://codecov.io/gh/doorstop-dev/doorstop)
[](https://scrutinizer-ci.com/g/doorstop-dev/doorstop/?branch=develop)
[](https://pypi.org/project/Doorstop)
[](https://gitter.im/doorstop-dev/community)
[](https://groups.google.com/forum/#!forum/doorstop-dev)
[](https://bestpractices.coreinfrastructure.org/projects/754)
# Overview
Doorstop is a [requirements management](http://alternativeto.net/software/doorstop/) tool that facilitates the storage of textual requirements alongside source code in version control.
When a project leverages this tool, each linkable item (requirement, test case, etc.) is stored as a YAML file in a designated directory. The items in each directory form a document. The relationship between documents forms a tree hierarchy. Doorstop provides mechanisms for modifying this tree, validating item traceability, and publishing documents in several formats.
Doorstop is under active development and we welcome contributions.
The project is licensed as [LGPLv3](https://github.com/doorstop-dev/doorstop/blob/develop/LICENSE.md).
To report a problem or a security vulnerability please [raise an issue](https://github.com/doorstop-dev/doorstop/issues).
Additional references:
- Publication: [JSEA Paper](http://www.scirp.org/journal/PaperInformation.aspx?PaperID=44268#.UzYtfWRdXEZ)
- Talks: [GRDevDay](https://speakerdeck.com/jacebrowning/doorstop-requirements-management-using-python-and-version-control), [BarCamp](https://speakerdeck.com/jacebrowning/strip-searched-a-rough-introduction-to-requirements-management)
- Sample: [Generated HTML](http://doorstop-dev.github.io/doorstop/)
# Setup
## Requirements
- Python 3.9+
- A version control system for requirements storage
## Installation
Install Doorstop with pip:
```sh
$ pip install doorstop
```
or add it to your [Poetry](https://poetry.eustace.io/) project:
```sh
$ poetry add doorstop
```
After installation, Doorstop is available on the command-line:
```sh
$ doorstop --help
```
And the package is available under the name 'doorstop':
```sh
$ python
>>> import doorstop
>>> doorstop.__version__
```
# Usage
Switch to an existing version control working directory, or create one:
```sh
$ git init .
```
## Create documents
Create a new parent requirements document:
```sh
$ doorstop create SRD ./reqs/srd
```
Add a few items to that document:
```sh
$ doorstop add SRD
$ doorstop add SRD
$ doorstop add SRD
```
## Link items
Create a child document to link to the parent:
```sh
$ doorstop create HLTC ./tests/hl --parent SRD
$ doorstop add HLTC
```
Link items between documents:
```sh
$ doorstop link HLTC001 SRD002
```
## Publish reports
Run integrity checks on the document tree:
```sh
$ doorstop
```
Publish the documents as HTML:
```sh
$ doorstop publish all ./public
```