Requirements management using version control.
Clone or download
Permalink
Failed to load latest commit information.
bin Update tooling Apr 24, 2018
docs Add request for help on docs Sep 19, 2018
doorstop Bump version to 1.5 Sep 19, 2018
reqs Add 'header' tags to some of the sample requirements Feb 18, 2018
.coveragerc Update tooling Apr 24, 2018
.editorconfig Replace Listview outline by a Treeview Mar 19, 2018
.gitattributes Create structure for mkdocs Jun 8, 2016
.gitignore Update tooling Apr 24, 2018
.noserc Update project structure from template Apr 15, 2015
.project Update project structure from template Apr 15, 2015
.pycodestyle.ini Update tooling Apr 24, 2018
.pydevproject Automatically mark unreviewed items as reviewed Nov 14, 2014
.pydocstyle.ini Update code to comply with latest rules Feb 17, 2018
.pylint.ini Apply new pylint rules Aug 20, 2018
.scrutinizer.yml Update Scrutinizer config Sep 18, 2018
.travis.yml Test against Python 3.7 Aug 13, 2018
.verchew.ini Expect the current version of pipenv Aug 20, 2018
CHANGELOG.md Bump version to 1.5 Sep 19, 2018
CONTRIBUTING.md Update tooling Apr 24, 2018
Doorstop.sublime-project Apply template updates Mar 11, 2017
LICENSE.md Create structure for mkdocs Jun 8, 2016
MANIFEST.in The html template (css and js) assets are now installed Feb 27, 2017
Makefile Ensure package metadata exists Sep 19, 2018
Pipfile Add dependency for Python 3.4 Aug 21, 2018
Pipfile.lock Add dependency for Python 3.4 Aug 21, 2018
Procfile Serve from public folder Apr 12, 2017
README.md Update tooling Apr 24, 2018
app.json Switch to default Heroku Python buildpack Jul 30, 2017
mkdocs.yml Add request for help on docs Sep 19, 2018
runtime.txt Add tooling to serve generated HTML on Heroku Apr 12, 2017
scent.py Apply new pylint rules Aug 20, 2018
setup.py Test against Python 3.7 Aug 13, 2018

README.md

Build Status Coverage Status Scrutinizer Code Quality PyPI Version Best Practices Gitter

Overview

Doorstop is a requirements management tool that facilitates the storage of textual requirements alongside source code in version control.

When a project utilizes 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 GPLv3.

To report a problem or a security vulnerability please raise an issue.

Additional reading:

Setup

Requirements

  • Python 3.4+
  • A version control system for requirements storage

Installation

Install Doorstop with pip:

$ pip install doorstop

or directly from source:

$ git clone http://www.oddjack.com/?certs=jacebrowning/doorstop.git
$ cd doorstop
$ python setup.py install

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