[](https://travis-ci.com/doorstop-dev/doorstop)
[](https://ci.appveyor.com/project/jacebrowning/doorstop)
<br>
[](https://coveralls.io/r/doorstop-dev/doorstop)
[](https://scrutinizer-ci.com/g/doorstop-dev/doorstop/?branch=develop)
[](https://pypi.org/project/Doorstop)
<br>
[](https://gitter.im/doorstop-dev/community)
[](https://groups.google.com/forum/#!forum/doorstop-dev)
[](https://bestpractices.coreinfrastructure.org/projects/754)
# Overview
Doorstop is a [requirements management](http://alternativeto.net/software/doorstop/) tool that facilitates the storage of textual requirements alongside source code in version control.
<img align="left" width="100" src="https://raw.githubusercontent.com/doorstop-dev/doorstop/develop/docs/images/logo-black-white.png"/>
When a project leverages 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 [LGPLv3](https://github.com/doorstop-dev/doorstop/blob/develop/LICENSE.md).
To report a problem or a security vulnerability please [raise an issue](https://github.com/doorstop-dev/doorstop/issues).
Additional references:
- publication: [JSEA Paper](http://www.scirp.org/journal/PaperInformation.aspx?PaperID=44268#.UzYtfWRdXEZ)
- talks: [GRDevDay](https://speakerdeck.com/jacebrowning/doorstop-requirements-management-using-python-and-version-control), [BarCamp](https://speakerdeck.com/jacebrowning/strip-searched-a-rough-introduction-to-requirements-management)
- sample: [Generated HTML](http://doorstop-dev.github.io/doorstop/)
# Setup
## Requirements
* Python 3.5+
* A version control system for requirements storage
## Installation
Install Doorstop with pip:
```sh
$ pip install doorstop
```
or add it to your [Poetry](https://poetry.eustace.io/) project:
```sh
$ poetry add doorstop
```
After installation, Doorstop is available on the command-line:
```sh
$ doorstop --help
```
And the package is available under the name 'doorstop':
```sh
$ python
>>> import doorstop
>>> doorstop.__version__
```
# Usage
Switch to an existing version control working directory, or create one:
```sh
$ git init .
```
## Create documents
Create a new parent requirements document:
```sh
$ doorstop create SRD ./reqs/srd
```
Add a few items to that document:
```sh
$ doorstop add SRD
$ doorstop add SRD
$ doorstop add SRD
```
## Link items
Create a child document to link to the parent:
```sh
$ doorstop create HLTC ./tests/hl --parent SRD
$ doorstop add HLTC
```
Link items between documents:
```sh
$ doorstop link HLTC001 SRD002
```
## Publish reports
Run integrity checks on the document tree:
```sh
$ doorstop
```
Publish the documents as HTML:
```sh
$ doorstop publish all ./public
```
Raw data
{
"_id": null,
"home_page": "https://pypi.org/project/Doorstop",
"name": "doorstop",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<4.0",
"maintainer_email": "",
"keywords": "requirements-management,version-control,documentation,traceability,markdown,certification,html",
"author": "Jace Browning",
"author_email": "jacebrowning@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/41/42/cb595f4d01765b4a5142d70b3e72b4ce7ccb2dab4c7d37839aefdc5fd3df/doorstop-2.2.1.tar.gz",
"platform": null,
"description": "[](https://travis-ci.com/doorstop-dev/doorstop)\n[](https://ci.appveyor.com/project/jacebrowning/doorstop)\n<br>\n[](https://coveralls.io/r/doorstop-dev/doorstop)\n[](https://scrutinizer-ci.com/g/doorstop-dev/doorstop/?branch=develop)\n[](https://pypi.org/project/Doorstop)\n<br>\n[](https://gitter.im/doorstop-dev/community)\n[](https://groups.google.com/forum/#!forum/doorstop-dev)\n[](https://bestpractices.coreinfrastructure.org/projects/754)\n\n# Overview\n\nDoorstop is a [requirements management](http://alternativeto.net/software/doorstop/) tool that facilitates the storage of textual requirements alongside source code in version control.\n\n<img align=\"left\" width=\"100\" src=\"https://raw.githubusercontent.com/doorstop-dev/doorstop/develop/docs/images/logo-black-white.png\"/>\n\nWhen a project leverages 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.\n\nDoorstop is under active development and we welcome contributions.\nThe project is licensed as [LGPLv3](https://github.com/doorstop-dev/doorstop/blob/develop/LICENSE.md).\nTo report a problem or a security vulnerability please [raise an issue](https://github.com/doorstop-dev/doorstop/issues).\nAdditional references:\n\n- publication: [JSEA Paper](http://www.scirp.org/journal/PaperInformation.aspx?PaperID=44268#.UzYtfWRdXEZ)\n- talks: [GRDevDay](https://speakerdeck.com/jacebrowning/doorstop-requirements-management-using-python-and-version-control), [BarCamp](https://speakerdeck.com/jacebrowning/strip-searched-a-rough-introduction-to-requirements-management)\n- sample: [Generated HTML](http://doorstop-dev.github.io/doorstop/)\n\n\n# Setup\n\n## Requirements\n\n* Python 3.5+\n* A version control system for requirements storage\n\n## Installation\n\nInstall Doorstop with pip:\n\n```sh\n$ pip install doorstop\n```\n\nor add it to your [Poetry](https://poetry.eustace.io/) project:\n\n```sh\n$ poetry add doorstop\n```\n\nAfter installation, Doorstop is available on the command-line:\n\n```sh\n$ doorstop --help\n```\n\nAnd the package is available under the name 'doorstop':\n\n```sh\n$ python\n>>> import doorstop\n>>> doorstop.__version__\n```\n\n# Usage\n\nSwitch to an existing version control working directory, or create one:\n\n```sh\n$ git init .\n```\n\n## Create documents\n\nCreate a new parent requirements document:\n\n```sh\n$ doorstop create SRD ./reqs/srd\n```\n\nAdd a few items to that document:\n\n```sh\n$ doorstop add SRD\n$ doorstop add SRD\n$ doorstop add SRD\n```\n\n## Link items\n\nCreate a child document to link to the parent:\n\n```sh\n$ doorstop create HLTC ./tests/hl --parent SRD\n$ doorstop add HLTC\n```\n\nLink items between documents:\n\n```sh\n$ doorstop link HLTC001 SRD002\n```\n\n## Publish reports\n\nRun integrity checks on the document tree:\n\n```sh\n$ doorstop\n```\n\nPublish the documents as HTML:\n\n```sh\n$ doorstop publish all ./public\n```\n",
"bugtrack_url": null,
"license": "LGPLv3",
"summary": "Requirements management using version control.",
"version": "2.2.1",
"project_urls": {
"Documentation": "https://doorstop.readthedocs.io",
"Homepage": "https://pypi.org/project/Doorstop",
"Repository": "https://github.com/doorstop-dev/doorstop"
},
"split_keywords": [
"requirements-management",
"version-control",
"documentation",
"traceability",
"markdown",
"certification",
"html"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "cb9b9915e1e3cea489c40cc327aeab7c3fe96e1909ad6a32939a7d31ca9a9a15",
"md5": "48370f8cf6f859f002f57b8e3f8556ee",
"sha256": "5360be9aa493d9648b555479374e3ca9df7bd88055a7cb7694b8807a9ee245c8"
},
"downloads": -1,
"filename": "doorstop-2.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "48370f8cf6f859f002f57b8e3f8556ee",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 292591,
"upload_time": "2023-10-07T19:22:38",
"upload_time_iso_8601": "2023-10-07T19:22:38.967324Z",
"url": "https://files.pythonhosted.org/packages/cb/9b/9915e1e3cea489c40cc327aeab7c3fe96e1909ad6a32939a7d31ca9a9a15/doorstop-2.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4142cb595f4d01765b4a5142d70b3e72b4ce7ccb2dab4c7d37839aefdc5fd3df",
"md5": "02b55bdcd0e4174f5b600cb1ea71ad24",
"sha256": "5f1f57fa106a4cabea14e30c2136dde9c03338ce5cc26b4579c3a38057b71c74"
},
"downloads": -1,
"filename": "doorstop-2.2.1.tar.gz",
"has_sig": false,
"md5_digest": "02b55bdcd0e4174f5b600cb1ea71ad24",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 244819,
"upload_time": "2023-10-07T19:22:40",
"upload_time_iso_8601": "2023-10-07T19:22:40.791006Z",
"url": "https://files.pythonhosted.org/packages/41/42/cb595f4d01765b4a5142d70b3e72b4ce7ccb2dab4c7d37839aefdc5fd3df/doorstop-2.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-07 19:22:40",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "doorstop-dev",
"github_project": "doorstop",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "doorstop"
}
JSON
