{ "info": { "author": "Andreas Florath", "author_email": "rmtoo@florath.net", "bugtrack_url": null, "classifiers": [ "Development Status :: 6 - Mature", "Environment :: Console", "Intended Audience :: Developers", "Intended Audience :: Education", "Intended Audience :: End Users/Desktop", "Intended Audience :: Manufacturing", "Intended Audience :: Telecommunications Industry", "License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)", "Operating System :: MacOS", "Operating System :: Microsoft :: Windows", "Operating System :: OS Independent", "Operating System :: POSIX :: Linux", "Programming Language :: Python", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Topic :: Scientific/Engineering", "Topic :: Software Development :: Quality Assurance" ], "description": "rmToo\n+++++\n\nOpen Source Requirements Management Tool\n\n.. image:: https://img.shields.io/github/release/florath/rmtoo.svg\n :target: https://github.com/florath/rmtoo/releases\n.. image:: https://travis-ci.org/florath/rmtoo.svg?branch=master\n :target: https://travis-ci.org/florath/rmtoo\n.. image:: https://img.shields.io/badge/License-GPL%20v3-blue.svg\n :target: http://www.gnu.org/licenses/gpl-3.0\n.. image:: https://img.shields.io/codecov/c/github/codecov/example-python.svg\n :target: https://codecov.io/gh/florath/rmtoo\n.. image:: https://img.shields.io/github/downloads/florath/rmtoo/total.svg\n :target: http://rmtoo.florath.net\n.. image:: https://img.shields.io/pypi/v/rmtoo.svg\n :target: https://pypi.python.org/pypi/rmtoo\n.. image:: https://sonarqube.com/api/badges/measure?key=rmtoo:rmtoo&metric=sqale_debt_ratio\n :target: https://sonarqube.com/dashboard?id=rmtoo\n.. image:: https://img.shields.io/coverity/scan/12488.svg\n :target: https://scan.coverity.com/projects/rmtoo\n.. image:: https://codeclimate.com/github/florath/rmtoo/badges/gpa.svg\n :target: https://codeclimate.com/github/florath/rmtoo\n :alt: Code Climate\n.. image:: https://codeclimate.com/github/florath/rmtoo/badges/coverage.svg\n :target: https://codeclimate.com/github/florath/rmtoo/coverage\n :alt: Test Coverage\n.. image:: https://codeclimate.com/github/florath/rmtoo/badges/issue_count.svg\n :target: https://codeclimate.com/github/florath/rmtoo\n :alt: Issue Count\n\n.. COMMENT pypi stats are not working\n.. COMMENT .. image:: https://img.shields.io/pypi/dm/rmtoo.svg\n.. COMMENT :target: https://pypi.python.org/pypi/rmtoo\n\t \nIntroduction\n============\n\nThis Readme gives a short overview over the available online\ndocumentation for rmtoo.\n\nContent\n=======\n\nThis file contains the following chapters:\n\n.. contents:: Table of Contents\n\n\nConventions\n===========\n\n``YY``\n names the version of rmtoo. You have to replace this with the real\n version number.\n\n``$ cmd``\n This is a command you have to type in. The ``$`` is a replacement for\n the shell prompt - do not enter it as a part of the command.\n\n\nOperating System Support\n========================\n\nrmtoo is fully supported under Linux. Nevertheless, because it is\nwritten in computer independent programming languages (such as\npython), is also works on other operating systems.\n\nMac OS X users might want to read ``Readme-OS-X.txt``.\n\nWindows users might want to read the ``Readme-Windows.txt``.\n\n\nInstallation\n============\n\nThe following sections assume, that you are using Linux. Please\nrefer to the appropriate Readme file for your operating system for\nmore information if you do not use Linux.\n\nDependencies\n------------\n\nTo use rmtoo, other software packages must be installed.\n\nrmtoo is written in python. At least version 2.7 of python is needed.\nStarting with version 24 python >3.4 is also supported.\n\nWhen you want to create LaTeX or PDF documentation, LaTeX is needed.\n\nFor the requirements dependency graph, graphviz is used.\n\nFor statistics plot gnuplot is used. For the estimation module the\npython-scipy package is needed.\n\nTypically the packages from your distribution will work.\n\nFirst Project\n-------------\n\nThe recommended way of starting is to copy the provided template\nproject.\n\nThe basic steps are:\n\n1) Copy over the template project to some other directory.\n2) Set up the environment\n3) Run ``make``\n4) Check, if everything worked\n5) Start changing / adapting things to your needs\n\nNote that during this document the project will be called\n'MyNewProject'. Please adapt the name for your needs.\n\n\nInstallation using virtualenv / pip\n===================================\n\nThis is the preferred installation method - it takes care that\nat least the python dependencies are correctly installed.\n\nInstallation\n------------\n\nTo install ``rmtoo`` in a virtualenv, execute the following steps:\n\n.. code:: bash\n\n $ mkdir RMTOO\n $ cd RMTOO\n $ virtualenv venv\n $ source venv/bin/activate\n $ pip install --upgrade pip setuptools wheel\n $ pip install --only-binary=numpy,scipy numpy scipy\n $ pip install rmtoo\n\nThis has only to be done once.\n\nFirst Project\n=============\n\nInstallation\n------------\n\nChange to a directory where you want to create the new project. This\nis needed only once.\n\n.. code:: bash\n\n # cd to virtualenv directory - if not already there\n $ cd RMTOO\n $ cp -r venv/rmtoo/contrib/template_project MyNewProject\n\nUsage\n-----\n\nTo create all the artifacts for the template project, execute\n\n.. code:: bash\n\n $ cd MyNewProject\n $ source ./setenv.sh VENV\n $ make\n $ ls artifacts\n\nIn the artifacts directory there are all the generated files.\nA typical workflow is, to change or add requirements, topics or the\nconfiguration in the ``MyNewProject`` directory, run ``make`` again\nand check the artifacts.\n\nMan Pages\n=========\n\nWhen using the virtualenv, use\n\n.. code:: bash\n\n $ man -l venv/rmtoo/share/man/man7/rmtoo.7\n\nto get an overview over all available man pages.\nThose other man pages you can read also with man. Replace the\nfile name with the appropriate manual page, like:\n\n.. code:: bash\n\n $ man -l venv/rmtoo/share/man/man7/rmtoo-analytics.7\n\nAdditional Documentation\n------------------------\n\nAdditional documentation can be found in the directories\n``RMTOO/venv/rmtoo/doc`` (especially the Readme files).\n\nOther Documentation\n===================\n\nFAQ\n---\nFrequently asked questions\nA collection of questions which were ask in the past - including\nthe answers.\n\nPresentations\n-------------\nThere are also two presentations about the design and features of\nrmtoo. Theese presentations can be found in the download section of\nthe sourceforge project page. Please visit the projects home page\nhttp://rmtoo.florath.net\n\nReadme-Overview.txt\n-------------------\nDescription of the features of rmtoo.\n\nReadme-Hacking.txt\n------------------\nSmall (and yet unfinished) document how to develop functionality\nand modules for rmtoo.\n\nReadme-OS-X.txt\n---------------\nHints for Mac Users.\n\nReadme-Windows.txt\n------------------\nHints for Windows users.\n\nReadme-RmtooOnRmtoo.txt\n-----------------------\nRun rmtoo to get the documentation for rmtoo itself.\n\nReadme-GitPython.txt\n--------------------\nSome note about the (internal) use of GitPython.\n\nEmacs Mode for Editing Requirements\n===================================\n\nWhen using the tar package, emacs mode can be loaded in emacs by:\n``M-x load-file``\npoint to ``RMTOO/venv/rmtoo/contrib/req-mode.el``\nAll files with suffix ``.req`` will now use the requirements editing\nmode.\n\nFooter\n======\n\nIf you have some problems, remarks or feature request, you're welcome\nto visit the project home page\n\nhttp://rmtoo.florath.net\n\n| flonatel GmbH & Co. KG\n| Andreas Florath\n| rmtoo@florath.net\n| 2017-04-14\n", "description_content_type": null, "docs_url": null, "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "http://rmtoo.florath.net", "keywords": "requirements management", "license": "GPL V3", "maintainer": null, "maintainer_email": null, "name": "rmtoo", "package_url": "https://pypi.org/project/rmtoo/", "platform": "all", "project_url": "https://pypi.org/project/rmtoo/", "project_urls": { "Download": "UNKNOWN", "Homepage": "http://rmtoo.florath.net" }, "release_url": "https://pypi.org/project/rmtoo/24.3.0/", "requires_dist": null, "requires_python": null, "summary": "Free and OpenSource Requirements Management Tool", "version": "24.3.0" }, "last_serial": 2887465, "releases": { "23.90.2": [ { "comment_text": "", "digests": { "md5": "8ec9a1fb5a5ab6c8a8aa612f97bf749e", "sha256": "49b11013971779e7ed19d141cf61bc508ffa2452a9521e6764877170e84e33d7" }, "downloads": -1, "filename": "rmtoo-23.90.2.tar.gz", "has_sig": false, "md5_digest": "8ec9a1fb5a5ab6c8a8aa612f97bf749e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 2665491, "upload_time": "2017-04-18T22:04:14", "url": "https://files.pythonhosted.org/packages/f9/2e/4df0e4105f6b311cf2618eebd94c361efaea3054e9ab7229b572a4a82870/rmtoo-23.90.2.tar.gz" } ], "24.0.0": [ { "comment_text": "", "digests": { "md5": "32185d8397060ca7771c900207b75d75", "sha256": "7ab7db984f3ce30b20521481dd259a82018d76615a443b775aae4067b44adbe7" }, "downloads": -1, "filename": "rmtoo-24.0.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "32185d8397060ca7771c900207b75d75", "packagetype": "bdist_wheel", "python_version": "2.7", "requires_python": null, "size": 3178611, "upload_time": "2017-04-22T11:51:20", "url": "https://files.pythonhosted.org/packages/29/d4/994d34620255f877d105df57529fc3900e3124f9d5622d552854ba02ecb4/rmtoo-24.0.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "7951178ac47a103e68f2bed9ffff582c", "sha256": "f6c57582f10287e25c8facc374ab42d7657cca001ed684c0f6f72373ffb759f1" }, "downloads": -1, "filename": "rmtoo-24.0.0.tar.gz", "has_sig": false, "md5_digest": "7951178ac47a103e68f2bed9ffff582c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 2730654, "upload_time": "2017-04-22T05:56:24", "url": "https://files.pythonhosted.org/packages/09/da/4c9c9f73aea56aa8030357a43fbb925b668a6507ff92b8c765bf65e114e4/rmtoo-24.0.0.tar.gz" } ], "24.2.0": [ { "comment_text": "", "digests": { "md5": "c50c03055aeb42c51673020f84242cea", "sha256": "91c4d9bcd3a485b13c91ad4ed2b28154262aa9501199a64678df0837662cda6c" }, "downloads": -1, "filename": "rmtoo-24.2.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "c50c03055aeb42c51673020f84242cea", "packagetype": "bdist_wheel", "python_version": "2.7", "requires_python": null, "size": 275636, "upload_time": "2017-05-13T19:48:05", "url": "https://files.pythonhosted.org/packages/06/f3/852b4e4d90bb94e9368a6074425e020557a642bd452ba8fbdd1d599838ed/rmtoo-24.2.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "5e1c5920efa7fdda37c913703c2e9b4c", "sha256": "9af20ebd174a9536d6609b5289c3b48f69ff79cd59cf665121802ad9feec4996" }, "downloads": -1, "filename": "rmtoo-24.2.0.tar.gz", "has_sig": false, "md5_digest": "5e1c5920efa7fdda37c913703c2e9b4c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 2681199, "upload_time": "2017-05-13T16:48:27", "url": "https://files.pythonhosted.org/packages/94/18/55d17061269aee50ada797f757683017995476cfade5eab907879efd1658/rmtoo-24.2.0.tar.gz" } ], "24.3.0": [ { "comment_text": "", "digests": { "md5": "00b17da78d6aae4306ead03df14cf36b", "sha256": "de5f746c5ea7aa0096f614356cbff604bef23e7c30f33406cbe9000ac95b5cf3" }, "downloads": -1, "filename": "rmtoo-24.3.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "00b17da78d6aae4306ead03df14cf36b", "packagetype": "bdist_wheel", "python_version": "2.7", "requires_python": null, "size": 559587, "upload_time": "2017-05-20T16:03:09", "url": "https://files.pythonhosted.org/packages/e4/e7/835325eb13676b9b4c74f2c11253471c105bf683bb53f9640b68ea724b8a/rmtoo-24.3.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "5e405a8be69d0b488f766a501551601f", "sha256": "b76ae2a4823dad34038530445f18e2b7c2e4a9ef41a888eaf7977a084954b67d" }, "downloads": -1, "filename": "rmtoo-24.3.0.tar.gz", "has_sig": false, "md5_digest": "5e405a8be69d0b488f766a501551601f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 2790245, "upload_time": "2017-05-20T16:01:59", "url": "https://files.pythonhosted.org/packages/82/83/aa84cc65b978e5b877d67ffb7f993396f9456281ad5d41ffa53ddfbf4026/rmtoo-24.3.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "00b17da78d6aae4306ead03df14cf36b", "sha256": "de5f746c5ea7aa0096f614356cbff604bef23e7c30f33406cbe9000ac95b5cf3" }, "downloads": -1, "filename": "rmtoo-24.3.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "00b17da78d6aae4306ead03df14cf36b", "packagetype": "bdist_wheel", "python_version": "2.7", "requires_python": null, "size": 559587, "upload_time": "2017-05-20T16:03:09", "url": "https://files.pythonhosted.org/packages/e4/e7/835325eb13676b9b4c74f2c11253471c105bf683bb53f9640b68ea724b8a/rmtoo-24.3.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "5e405a8be69d0b488f766a501551601f", "sha256": "b76ae2a4823dad34038530445f18e2b7c2e4a9ef41a888eaf7977a084954b67d" }, "downloads": -1, "filename": "rmtoo-24.3.0.tar.gz", "has_sig": false, "md5_digest": "5e405a8be69d0b488f766a501551601f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 2790245, "upload_time": "2017-05-20T16:01:59", "url": "https://files.pythonhosted.org/packages/82/83/aa84cc65b978e5b877d67ffb7f993396f9456281ad5d41ffa53ddfbf4026/rmtoo-24.3.0.tar.gz" } ] }