Manage your text-based requirements using version control.

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for jacebrowning from gravatar.com jacebrowning

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: GNU Lesser General Public License v3 (LGPLv3) (LGPL)
  • Author: Jace Browning
Classifiers
Report project as malware

Project description

Introduction

Doorstop is a tool to manage the storage of texual requirements alongside source code in version control.

Each requirement item is stored as a YAML file in a designated directory. The items in each designated directory form a document. Document items can be linked to one another to form a document hiearchy. Doorstop provides mechanisms for modifying this hiearchy and checking the tree for consistency.

Getting Started

Requirements

  • Python 3

  • Git or Veracity (for requirements storage)

Installation

Doorstop can be installed with pip:

pip install 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__

Document Creation

Parent Document

After configuring version control, a new parent document can be created:

doorstop new REQ ./reqs

Items can be added to the document and edited:

doorstop add REQ

doorstop edit REQ1

Child Documents

Additional documents can be created that will link to the parent:

doorstop new TST ./reqs/tests --parent REQ

Items can be added and linked to parent items:

doorstop add TST

doorstop link TST1 REQ1

Document Validation

To check a document hiearchy for consistency, run the main command:

doorstop

Supported by

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