A free and open source requirement management tool.
I need a light-weight, free, Caliber (a Borland software) like requirement management tool. But I didn't find one. So I wrote such a software.
FreeReq can organize requirement document as tree structure. A requirement entry can have its sub requirement entry.
The name, ID, and content are the basic information of a requirement entry.
- The name will show as the node name in tree view
- The ID is a unique identifier of a requirement entry, which can be referenced in discussion.
- The content is the main description of a requirement entry.
More requirement entry information can be added by editing the metadata. The editor ui will automatically generate the editing controls.
You can download the packaged release exe and run it directly. However, the display effect of markdown is not good, and the plug-in function is not supported.
The recommended way is to run FreeReq.py directly using python, as QtWebEngine will be lost after packaging as exe, causing the HTML rendering to look bad.
You can use pip install -r requirements.txt to install all dependency.
Or just run "run.bat" to create virtual environment and install requirements automatically (Suggest).
FreeReq supports extensions. You can rename "doc/config_example.json" to "config.json" and put it in the root folder.
You can edit to enable more plugins.
Click "Template" button to open scratch paper window. You can save preset text in the scratch paper. The text will be saved automatically.
It will add a combobox to select the Markdown render style (actually the HTML css style).
You can put more styles in plugin/MarkdownStyle folder.
Based on KeyFaiss that using embedding to index requirement items. You can search content by nature language.
Note that embedding models will affect search results. Based on different languages, you should choose the corresponding embedding model.
Need faiss and text2vec library support.
Based on EmbeddingIndexing. Using LLM to analysis search result to make it more readable.
In theory, with the embedding searching result and correct prompts. We can use any LLM to implement this feature. The more powerful LLM, the better result.
Now we're using chatglm-6b-int4-qe which can be run on 12G vram (but OOM if the context is too long). And hf library is required.
- Add style selector.
- Fix the cursor issue.
- Add build (pack) script.
- Known issue: The pyinstaller pack missing QtWebEngine. So the web view is not available in exe.
- Add CTRL+F to search whole tree and all content (F3 Find Next, SHIFT + F3 Find Previous)
- The editor can accept file dropping. You can select the following action.
- The editor supports image and table pasting. You can select the following action.
- Use QWebEngineView for markdown preview (optional) which is better looking than QTextView.
- Debug and update the ChatReq plugin using Chat-GLM2
- Add print tree feature. Note that this feature depends on QWebEngineView
- Add MarkdownStyle selector plugin.
