Free and Open Source Requirements Management TooL
Python HTML Roff TeX Shell Makefile Other
Clone or download
Latest commit 5c54b45 Jul 13, 2018
Permalink
Failed to load latest commit information.
.settings Added eclipse project files Mar 6, 2012
artifacts Created artifacts dir - which is empty when started Nov 17, 2010
contrib Merge pull request #10 from CogPy/latexJinja Mar 29, 2018
debian Fixed email address Apr 14, 2017
doc Replace nosetest with pytest May 20, 2018
etc Refactored xmlcmp Oct 25, 2011
rmtoo Use pytest instead of nose, as it's not maintained anymore Mar 28, 2018
share/man Added preinstalled GUI VM May 20, 2017
.gitignore Hopefully the next release May 12, 2017
.project Added eclipse project files Mar 6, 2012
.pydevproject Added eclipse project files Mar 6, 2012
.travis.yml Run all tests in tox environment. Remove sonar stuff, it's not compat… Mar 28, 2018
COPYING Fixed email address Apr 14, 2017
MANIFEST.in Hopefully the next release May 12, 2017
Makefile Fix Makefile to do the same thing as tox Mar 28, 2018
RMTEx.txt Added (fav)icon May 1, 2017
Readme-GitPython.txt Fixed / rewrote Readme.txt file Nov 26, 2011
Readme-Hacking.txt Refactored BBTestCases Apr 22, 2017
Readme-OS-X.txt Added Readme for OsX Apr 27, 2011
Readme-Overview.txt Fixed / rewrote Readme.txt file Nov 26, 2011
Readme-RmtooOnRmtoo.txt Cleaned up Readme / documentation Nov 26, 2011
Readme-Windows.txt Fixed email address Apr 14, 2017
Readme.rst Updated Readme: added AWS Ec2 preinstalled VMs Jan 3, 2018
RequirementVsConstraint.txt First major changes implementing constraints Mar 2, 2011
Roadmap.txt Update GUI VM May 20, 2017
build_tar.sh binaries are now entry points Apr 15, 2017
gpl-3.0.txt Added license details; Added ReqType module Feb 7, 2010
pylint.cfg Using stevedore for markup handling Apr 30, 2017
requirements.txt Remove unused dependencies Mar 28, 2018
setenv.sh Added sys.path magic to get the correct git-python version Jul 31, 2010
setup.py Fix automatic install in venv Jan 23, 2018
sonar-project.properties Removed language setting from sonar-properties Apr 18, 2017
tox.ini Fix Makefile to do the same thing as tox Mar 28, 2018

Readme.rst

rmToo

Open Source Requirements Management Tool

https://travis-ci.org/florath/rmtoo.svg?branch=master https://sonarqube.com/api/badges/measure?key=rmtoo:rmtoo&metric=sqale_debt_ratio Code Climate Test Coverage Issue Count

Introduction

This Readme gives a short overview over the available online documentation for rmtoo.

Content

This file contains the following chapters:

Conventions

YY
names the version of rmtoo. You have to replace this with the real version number.
$ cmd
This is a command you have to type in. The $ is a replacement for the shell prompt - do not enter it as a part of the command.

Operating System Support

rmtoo is fully supported under Linux. Nevertheless, because it is written in computer independent programming languages (such as python), is also works on other operating systems.

Mac OS X users might want to read Readme-OS-X.txt.

Windows users might want to read the Readme-Windows.txt.

Preinstalled VMs

For evaluation proposes and running small projects there is the possibility to use Amazon AWS EC2 preinstalled VMs.

More details are available in a dedicated Readme.

Installation

The following sections assume, that you are using Linux. Please refer to the appropriate Readme file for your operating system for more information if you do not use Linux.

Dependencies

To use rmtoo, other software packages must be installed.

rmtoo is written in python. At least version 2.7 of python is needed. Starting with version 24 python >3.4 is also supported.

When you want to create LaTeX or PDF documentation, LaTeX is needed.

For the requirements dependency graph, graphviz is used.

For statistics plot gnuplot is used. For the estimation module the python-scipy package is needed.

Typically the packages from your distribution will work.

First Project

The recommended way of starting is to copy the provided template project.

The basic steps are:

  1. Copy over the template project to some other directory.
  2. Set up the environment
  3. Run make
  4. Check, if everything worked
  5. Start changing / adapting things to your needs

Note that during this document the project will be called 'MyNewProject'. Please adapt the name for your needs.

Installation using virtualenv / pip

This is the preferred installation method - it takes care that at least the python dependencies are correctly installed.

Installation

To install rmtoo in a virtualenv, execute the following steps:

$ mkdir RMTOO
$ cd RMTOO
$ virtualenv venv
$ source venv/bin/activate
$ pip install --upgrade pip setuptools wheel
$ pip install --only-binary=numpy,scipy numpy scipy
$ pip install rmtoo

This has only to be done once.

First Project

Installation

Change to a directory where you want to create the new project. This is needed only once.

# cd to virtualenv directory - if not already there
$ cd RMTOO
$ cp -r venv/rmtoo/contrib/template_project MyNewProject

Usage

To create all the artifacts for the template project, execute

$ cd MyNewProject
$ source ./setenv.sh VENV
$ make
$ ls artifacts

In the artifacts directory there are all the generated files. A typical workflow is, to change or add requirements, topics or the configuration in the MyNewProject directory, run make again and check the artifacts.

Man Pages

When using the virtualenv, use

$ man -l venv/rmtoo/share/man/man7/rmtoo.7

to get an overview over all available man pages. Those other man pages you can read also with man. Replace the file name with the appropriate manual page, like:

$ man -l venv/rmtoo/share/man/man7/rmtoo-analytics.7

Additional Documentation

Additional documentation can be found in the directories RMTOO/venv/rmtoo/doc (especially the Readme files).

Other Documentation

FAQ

Frequently asked questions A collection of questions which were ask in the past - including the answers.

Presentations

There are also two presentations about the design and features of rmtoo. Theese presentations can be found in the download section of the sourceforge project page. Please visit the projects home page http://rmtoo.florath.net

Readme-Overview.txt

Description of the features of rmtoo.

Readme-Hacking.txt

Small (and yet unfinished) document how to develop functionality and modules for rmtoo.

Readme-OS-X.txt

Hints for Mac Users.

Readme-Windows.txt

Hints for Windows users.

Readme-RmtooOnRmtoo.txt

Run rmtoo to get the documentation for rmtoo itself.

Readme-GitPython.txt

Some note about the (internal) use of GitPython.

Emacs Mode for Editing Requirements

When using the tar package, emacs mode can be loaded in emacs by: M-x load-file point to RMTOO/venv/rmtoo/contrib/req-mode.el All files with suffix .req will now use the requirements editing mode.

Footer

If you have some problems, remarks or feature request, you're welcome to visit the project home page

http://rmtoo.florath.net

flonatel GmbH & Co. KG
Andreas Florath
2017-04-14