Manage your text-based requirements using version control.
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
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
Built Distribution
File details
Details for the file Doorstop-0.0.5.zip.
File metadata
- Download URL: Doorstop-0.0.5.zip
- Upload date:
- Size: 38.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 0c39b915c01da81a4852c476f6fe722b2e1fbc2f12b34561837f9e4c6e310002 |
|
| MD5 | 65136245be027e1772143eb00671ec91 |
|
| BLAKE2b-256 | ab927d8e51b9be18eb078421aa4b1fee2042c3802b41230155209553bb1ee77f |
File details
Details for the file Doorstop-0.0.5-py2.py3-none-any.whl.
File metadata
- Download URL: Doorstop-0.0.5-py2.py3-none-any.whl
- Upload date:
- Size: 107.5 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | ccbf27bacc6d1f4acd535b867a43c4d0c95218076538f6d584ad890a55e173a3 |
|
| MD5 | 0fdb29cfdf0d7bd25ce0e89e9c6a8b65 |
|
| BLAKE2b-256 | 149bdd1db3ff6ec29624328aa55314c4109389b5fd7c9dff326e6b989e1fc44b |
