Python HTML Makefile Other
Latest commit 175d36b Nov 12, 2017 @jacebrowning jacebrowning Add examples section
Closes #284
Permalink
Failed to load latest commit information.
bin Merge branch 'develop' into jmac/html_navigation_3 Apr 12, 2017
docs Add examples section Nov 12, 2017
doorstop Bump version to 1.4 Oct 22, 2017
reqs Add some information on headings and markdown formatting, from https:… Jan 19, 2017
.coveragerc Apply template updates Mar 11, 2017
.gitattributes Create structure for mkdocs Jun 8, 2016
.gitignore Apply template updates Mar 11, 2017
.noserc Update project structure from template Apr 15, 2015
.project Update project structure from template Apr 15, 2015
.pycodestyle.ini Remove comment about E741 in .pycodestyle.ini Apr 19, 2017
.pydevproject Automatically mark unreviewed items as reviewed Nov 14, 2014
.pydocstyle Apply template updates Mar 11, 2017
.pylint.ini Disable pylint rules to match existing code Mar 12, 2017
.scrutinizer.yml Use custom pylint configuration file Mar 13, 2017
.travis.yml Run tests against Python 3.6 on Travis CI Mar 25, 2017
.verchew.ini Update development dependencies Oct 22, 2017
CHANGELOG.md Bump version to 1.4 Oct 22, 2017
CONTRIBUTING.md Apply template updates Mar 11, 2017
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 Use Python 3.6 as the default on new environments Mar 25, 2017
Pipfile Pin pydocstyle to < 2.0 Apr 19, 2017
Pipfile.lock Update development dependencies Oct 22, 2017
Procfile Serve from public folder Apr 12, 2017
README.md Fixes #242 - add cii badge Mar 16, 2017
app.json Switch to default Heroku Python buildpack Jul 30, 2017
mkdocs.yml Add examples section Nov 12, 2017
runtime.txt Add tooling to serve generated HTML on Heroku Apr 12, 2017
scent.py Remove warning assertions with Python 3.3 Mar 23, 2017
setup.py Move views directory inside doorstop package Aug 26, 2017

README.md

Build Status Coverage Status Scrutinizer Code Quality PyPI Version 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 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.3+
  • 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