Skip to main content

Requirements management using version control.

Project description

Linux Tests macOS Tests Windows Tests
Coverage Status Scrutinizer Code Quality PyPI Version
Gitter Google Best Practices

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:

Setup

Requirements

  • Python 3.9+
  • 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

Project details


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

doorstop-3.0.2.tar.gz (1.4 MB view details)

Uploaded Source

Built Distribution

doorstop-3.0.2-py3-none-any.whl (1.4 MB view details)

Uploaded Python 3

File details

Details for the file doorstop-3.0.2.tar.gz.

File metadata

  • Download URL: doorstop-3.0.2.tar.gz
  • Upload date:
  • Size: 1.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.1 CPython/3.13.2 Darwin/23.6.0

File hashes

Hashes for doorstop-3.0.2.tar.gz
Algorithm Hash digest
SHA256 b444fd4bafe67a7f265bee714e1c0ade844b9490f79947946f91efd343f74772
MD5 5d5dfe729b68231c92661c1657b52596
BLAKE2b-256 0052758c5c2955b64c32fb029a537ff307eca8940ee22ec165ae5d671c55590a

See more details on using hashes here.

File details

Details for the file doorstop-3.0.2-py3-none-any.whl.

File metadata

  • Download URL: doorstop-3.0.2-py3-none-any.whl
  • Upload date:
  • Size: 1.4 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.1 CPython/3.13.2 Darwin/23.6.0

File hashes

Hashes for doorstop-3.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 366054bef70c5d2f27f5d4b0eea056eb3244cc6fdbcb434e0b1ba83f324f4ca4
MD5 1ea6edda989bcab56e9a3aa7bab3bbca
BLAKE2b-256 dc65337211babe5bd4d2660abf0e594f4e7fe1af2a8848154509442ed5310746

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page