[](https://pypi.org/project/doorstop-edit)
[](https://github.com/ownbee/doorstop-edit/actions/workflows/test.yml)
[](https://codecov.io/gh/ownbee/doorstop-edit)
# Doorstop Edit
_A cross-platform GUI editor for [Doorstop](https://github.com/doorstop-dev/doorstop) powered by PySide6 (Qt)._
The goal of this GUI is to provide all the tools needed to efficiently work with a larger set of
requirements within the editor and at the same time have full control of what is happening. The
editor use the doorstop API whenever possible to behave the same way as doorstop.
**Features:**
* **Resizable and movable modern views** for custom layout.
* **Dark theme**.
* Item tree with **status colors** and **search function** for good overview and fast location.
* **Live markdown-HTML** rendering.
* **Section or single mode** reading.
* **Review** and **clear suspect links**.
* Edit additional attributes with `boolean` and `string` types.
* Built-in **item diff tool** to review changes made on disk.
* **Markdown formatting tool** powered by `mdformat` for the text attribute.
* **Pin feature** for easy access to work-in-progress items.
* And more...
**TODO list:**
* Add and remove document.
* Validating documents and items in a user-friendly manner.
* File watcher for syncing/refreshing when changes made on disk.
* Ability to change project root.
## Install
Automatic install with pip:
```sh
pip install doorstop-edit
```
For source installation see *Contributing* section.
## Demo/Testing
There is a python script that generates a document tree which can be useful when testing this
application.
```sh
python3 tools/gen_sample_tree.py
# Output will be located in the dist/ folder.
```
## Other doorstop GUI's
There exists at least two well known GUI's for doorstop editing,
[doorhole](https://github.com/sevendays/doorhole) and the build-in GUI in doorstop.
Since both are pretty basic and have missing features when working with a large and complex set of
requrements, this new GUI was created to fill in some gaps.
## Contributing
See [CONTRIBUTING.md](https://github.com/ownbee/doorstop-edit/blob/main/CONTRIBUTING.md).
Raw data
{
"_id": null,
"home_page": "https://github.com/ownbee/doorstop-edit",
"name": "doorstop-edit",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9,<3.12",
"maintainer_email": "",
"keywords": "doorstop,requirements-management,documentation,gui",
"author": "Alexander Ernfridsson",
"author_email": "ernfridsson@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/7a/19/020cce34d7350ea0485d3325a8b986f6379bdc11f226ce89e078cdb638d8/doorstop_edit-0.1.1.tar.gz",
"platform": null,
"description": "[](https://pypi.org/project/doorstop-edit)\n[](https://github.com/ownbee/doorstop-edit/actions/workflows/test.yml)\n[](https://codecov.io/gh/ownbee/doorstop-edit)\n\n# Doorstop Edit\n\n_A cross-platform GUI editor for [Doorstop](https://github.com/doorstop-dev/doorstop) powered by PySide6 (Qt)._\n\nThe goal of this GUI is to provide all the tools needed to efficiently work with a larger set of\nrequirements within the editor and at the same time have full control of what is happening. The\neditor use the doorstop API whenever possible to behave the same way as doorstop.\n\n\n\n**Features:**\n\n* **Resizable and movable modern views** for custom layout.\n* **Dark theme**.\n* Item tree with **status colors** and **search function** for good overview and fast location.\n* **Live markdown-HTML** rendering.\n* **Section or single mode** reading.\n* **Review** and **clear suspect links**.\n* Edit additional attributes with `boolean` and `string` types.\n* Built-in **item diff tool** to review changes made on disk.\n* **Markdown formatting tool** powered by `mdformat` for the text attribute.\n* **Pin feature** for easy access to work-in-progress items.\n* And more...\n\n\n**TODO list:**\n\n* Add and remove document.\n* Validating documents and items in a user-friendly manner.\n* File watcher for syncing/refreshing when changes made on disk.\n* Ability to change project root.\n\n## Install\n\nAutomatic install with pip:\n\n```sh\npip install doorstop-edit\n```\n\nFor source installation see *Contributing* section.\n\n## Demo/Testing\n\nThere is a python script that generates a document tree which can be useful when testing this\napplication.\n\n```sh\npython3 tools/gen_sample_tree.py\n\n# Output will be located in the dist/ folder.\n```\n\n\n## Other doorstop GUI's\n\nThere exists at least two well known GUI's for doorstop editing,\n[doorhole](https://github.com/sevendays/doorhole) and the build-in GUI in doorstop.\n\nSince both are pretty basic and have missing features when working with a large and complex set of\nrequrements, this new GUI was created to fill in some gaps.\n\n\n## Contributing\n\nSee [CONTRIBUTING.md](https://github.com/ownbee/doorstop-edit/blob/main/CONTRIBUTING.md).\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Cross-platform doorstop GUI editor",
"version": "0.1.1",
"split_keywords": [
"doorstop",
"requirements-management",
"documentation",
"gui"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "95113818142dd66b7ce4227e9389a9865379def43c8996288e4fd2d217de64fe",
"md5": "4842f19e9ffdcdf359fc3831b96a665e",
"sha256": "bfe7dd51e274c8f218cf6ea6ed8d53e000c041d87e4bd6c2201667495a1119b9"
},
"downloads": -1,
"filename": "doorstop_edit-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4842f19e9ffdcdf359fc3831b96a665e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9,<3.12",
"size": 174547,
"upload_time": "2023-01-18T20:03:11",
"upload_time_iso_8601": "2023-01-18T20:03:11.223026Z",
"url": "https://files.pythonhosted.org/packages/95/11/3818142dd66b7ce4227e9389a9865379def43c8996288e4fd2d217de64fe/doorstop_edit-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7a19020cce34d7350ea0485d3325a8b986f6379bdc11f226ce89e078cdb638d8",
"md5": "2e00d21406b44aa56fdb6eb708949579",
"sha256": "5d114921296e83f0d7c450754bb699f17f5a1083d6ef95c131c8d009a75472fe"
},
"downloads": -1,
"filename": "doorstop_edit-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "2e00d21406b44aa56fdb6eb708949579",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9,<3.12",
"size": 157350,
"upload_time": "2023-01-18T20:03:13",
"upload_time_iso_8601": "2023-01-18T20:03:13.894578Z",
"url": "https://files.pythonhosted.org/packages/7a/19/020cce34d7350ea0485d3325a8b986f6379bdc11f226ce89e078cdb638d8/doorstop_edit-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-18 20:03:13",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "ownbee",
"github_project": "doorstop-edit",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "doorstop-edit"
}
JSON
