Metadata-Version: 2.3
Name: sorema
Version: 0.0.1
Summary: SOftware REquirements MAnagement
Author: Dennis Brinkman
Author-email: Dennis Brinkman <dennis_brinky@hotmail.com>
Requires-Dist: click>=8.3.3
Requires-Dist: pytest>=9.0.3 ; extra == 'pytest'
Requires-Python: >=3.13
Provides-Extra: pytest
Description-Content-Type: text/markdown

# SoReMa: Software Requirements Management

Simple software requirement tracking that integrates with Python and python testing frameworks.

## Goals

The goal of SoReMa is to be a very simple requirement tracking tool that links requirements to (automatic) tests and to provide an easy interface to determine which requirements do not have a corresponding test.

## Documentation

### Usage

```sh
> sorema --help
Usage: sorema [OPTIONS] COMMAND [ARGS]...

Options:
  --help  Show this message and exit.

Commands:
  new-req  Create a new requirement template using configured settings.
  run      Run requirements checker.
```

#### Create new requirements

```sh

```

### Configuration

SoReMa has configuration options that change default values. Below all options are shown together with its defaults. Note that `project_prefix` should only be used if `project.name` is not suitable.

```toml
[tool.sorema]
    file_prefix         = "REQ" # Requirement file prefix
    project_prefix      = "SOREMA" # Requirement name prefix. Optional, be default uses name of the project
    requirements_folder = "requirements" # Name of the requirements folder
    test_folder         = "tests" # Name of the test folder
```
