Requirements management using version control.
Project description
Overview
Doorstop is a requirements management 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. To report a problem or a security vulnerability please raise an issue. Additional references:
- publication: JSEA Paper
- talks: GRDevDay, BarCamp
- sample: Generated HTML
Setup
Requirements
- Python 3.8+
- A version control system for requirements storage
Installation
Install Doorstop with pip:
$ pip install doorstop
or add it to your Poetry project:
$ poetry add doorstop
After installation, Doorstop is available on the command-line:
$ doorstop --help
And the package is available under the name 'doorstop':
$ python
>>> import doorstop
>>> doorstop.__version__
Usage
Switch to an existing version control working directory, or create one:
$ git init .
Create documents
Create a new parent requirements document:
$ doorstop create SRD ./reqs/srd
Add a few items to that document:
$ doorstop add SRD
$ doorstop add SRD
$ doorstop add SRD
Link items
Create a child document to link to the parent:
$ doorstop create HLTC ./tests/hl --parent SRD
$ doorstop add HLTC
Link items between documents:
$ doorstop link HLTC001 SRD002
Publish reports
Run integrity checks on the document tree:
$ doorstop
Publish the documents as HTML:
$ doorstop publish all ./public
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file doorstop-3.0b9.tar.gz.
File metadata
- Download URL: doorstop-3.0b9.tar.gz
- Upload date:
- Size: 176.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.4.1 CPython/3.10.9 Darwin/22.3.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | f779706d03705a934faffdf8783a71592b42f3669c294cc0ead26c83118ba31b |
|
| MD5 | 92d6f75382df1b13812137e105ff7128 |
|
| BLAKE2b-256 | 8e37bb4698bc319c49dbb25ab1408121784903ae53798a2c634ddfafd63bb817 |
File details
Details for the file doorstop-3.0b9-py3-none-any.whl.
File metadata
- Download URL: doorstop-3.0b9-py3-none-any.whl
- Upload date:
- Size: 192.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.4.1 CPython/3.10.9 Darwin/22.3.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 2415edf5f04598f00379e73aaefb453c68c3d2b37fc62b8c904654b9859acdf3 |
|
| MD5 | 0e92c064880c119481380f020e8a9b93 |
|
| BLAKE2b-256 | 45c8e5a1d14bf28540ff595c425d4a94141aac04f8b4c21a0d8001df026947b4 |
