Metadata-Version: 2.4
Name: rmtoo
Version: 26.0.2
Summary: Free and OpenSource Requirements Management Tool
Home-page: http://rmtoo.florath.net
Author: Andreas Florath
Author-email: rmtoo@florath.net
License: GPL-3.0-or-later
Keywords: requirements management
Platform: all
Classifier: Development Status :: 6 - Mature
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: End Users/Desktop
Classifier: Intended Audience :: Manufacturing
Classifier: Intended Audience :: Telecommunications Industry
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: OS Independent
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Software Development :: Quality Assurance
Classifier: Topic :: Scientific/Engineering
Description-Content-Type: text/markdown
License-File: COPYING
Requires-Dist: numpy>=1.12.0
Requires-Dist: scipy>=0.19.0
Requires-Dist: gitdb>=4.0.1
Requires-Dist: gitpython>=3.1.41
Requires-Dist: pyyaml>=3.12
Requires-Dist: stevedore>=1.21
Requires-Dist: pylint>=1.7.1
Requires-Dist: odfpy==1.3.4
Requires-Dist: jinja2>=2.10
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: keywords
Dynamic: license
Dynamic: license-file
Dynamic: platform
Dynamic: requires-dist
Dynamic: summary

[//]: # (copyright 2010-2012,2017,2020,2022,2025 by flonatel GmbH & Co. KG / Andreas Florath)
[//]: # ( )
[//]: # (SPDX-License-Identifier: GPL-3.0-or-later)
[//]: # ( )
[//]: # (This file is part of rmtoo.)
[//]: # ( )  
[//]: # (rmtoo is free software: you can redistribute it and/or modify)
[//]: # (it under the terms of the GNU General Public License as published by)
[//]: # (the Free Software Foundation, either version 3 of the License, or)
[//]: # (at your option any later version.)
[//]: # ( )
[//]: # (rmtoo is distributed in the hope that it will be useful,)
[//]: # (but WITHOUT ANY WARRANTY; without even the implied warranty of)
[//]: # (MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the)
[//]: # (GNU General Public License for more details.)
[//]: # ( )  
[//]: # (You should have received a copy of the GNU General Public License)
[//]: # (along with rmtoo.  If not, see <https://www.gnu.org/licenses/>.)

# rmToo

Open Source Requirements Management Tool

[![image](https://img.shields.io/github/release/florath/rmtoo.svg)](https://github.com/florath/rmtoo/releases)
[![Build Status](https://github.com/florath/rmtoo/workflows/CI/badge.svg)](https://github.com/florath/rmtoo/actions)
[![image](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](http://www.gnu.org/licenses/gpl-3.0)
[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=florath_rmtoo&metric=coverage)](https://sonarcloud.io/summary/new_code?id=florath_rmtoo)
[![PyPI version](https://img.shields.io/pypi/v/rmtoo)](https://pypi.org/project/rmtoo/)
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=florath_rmtoo&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=florath_rmtoo)

## What is rmToo?

rmToo is a free and open-source requirements management tool written in Python. It processes requirements and topics from text files and generates various artifacts like HTML documentation, LaTeX/PDF documents, dependency graphs, and statistical reports.

## Quick Start

```bash
# Install rmToo
pip install rmtoo

# Create your first project
cp -r "$(rmtoo-contrib-dir)/template_project" MyProject
cd MyProject
source ./setenv.sh VENV
make

# View generated artifacts
ls artifacts/
```

## 📚 Documentation

**Complete documentation is available in the [`docs/`](docs/) directory:**

- **[📖 User Guide](docs/user-guide/)** - Installation, getting started, and usage
- **[🔧 Developer Guide](docs/developer-guide/)** - Contributing and development
- **[❓ FAQ](docs/faq.md)** - Frequently asked questions

### Quick Links

- **[Installation Guide](docs/user-guide/installation/)** - Install on Linux, macOS, or Windows
- **[Getting Started](docs/user-guide/getting-started/overview.md)** - Overview and features
- **[Requirements vs Constraints](docs/user-guide/requirements/constraints.md)** - Core concepts

## Platform Support

- **Linux**: Full support
- **macOS**: Community supported
- **Windows**: Community supported (via Cygwin or WSL)

## Key Features

- **Text-based requirements**: Use your favorite editor
- **Multiple output formats**: HTML, PDF, graphs, statistics
- **Git integration**: Full version control support
- **Quality analytics**: Automated requirement quality checks
- **Dependency management**: Automatic dependency tracking
- **Template projects**: Ready-to-use project templates

## Getting Help

- **Documentation**: See [`docs/`](docs/) directory
- **Issues**: [GitHub Issues](https://github.com/florath/rmtoo/issues)
- **Contact**: rmtoo@florath.net

## License

Copyright (c) 2010-2012,2017,2020,2022,2025 by flonatel GmbH & Co. KG

rmToo is free software licensed under the GNU General Public License v3.0 or later.
See [COPYING](COPYING) for details.
