Text-based requirements management using version control.
Doorstop is a tool to manage the storage of textual 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 hierarchy. Doorstop provides mechanisms for modifying this hierarchy, checking the tree for consistency, and publishing documents in several formats.
0.0.x releases are experimental and interfaces will likely change.
- Python 3
- Git or Veracity (for requirements storage)
Doorstop can be installed with pip or easy_install:
$ 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__
After configuring version control, a new parent document can be created:
$ doorstop new REQ ./reqs created: REQ (@/reqs)
Items can be added to the document and edited:
$ doorstop add REQ added: REQ001 (@/reqs/REQ001.yml) $ doorstop edit REQ1 opened: REQ001 (@/reqs/REQ001.yml)
Additional documents can be created that link to other documents:
$ doorstop new TST ./reqs/tests --parent REQ created: TST (@/reqs/tests)
Items can be added and linked to parent items:
$ doorstop add TST added: TST001 (@/reqs/tests/TST001.yml) $ doorstop link TST1 REQ1 linked: TST001 (@/reqs/tests/TST001.yml) -> REQ001 (@/reqs/REQ001.yml)
To check a document hierarchy for consistency, run the main command:
$ doorstop validated: REQ <- [ TST ]
A text report of a document can be created:
$ doorstop publish TST 1 TST001 Verify the foobar will foo and bar. Links: REQ001
Other formats are also supported:
$ doorstop publish TST --html <h1>1 (TST001)</h1> <p>Verify the foobar will foo and bar.</p> <p><em>Links: REQ001</em></p>
Release history Release notifications
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
|Filename, size & hash SHA256 hash help||File type||Python version||Upload date|
|Doorstop-0.0.8-py33-none-any.whl (43.8 kB) Copy SHA256 hash SHA256||Wheel||3.3||Jan 17, 2014|
|Doorstop-0.0.8.tar.gz (32.4 kB) Copy SHA256 hash SHA256||Source||None||Jan 17, 2014|