Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rflo/master #39

Open
wants to merge 28 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
6cb9b13
Configure project with pyproject.toml PEP518
kown7 May 21, 2020
b06e59f
Deploy automatically from travis-CI to PyPI
kown7 May 23, 2020
55eee61
rename licensing file
kown7 May 23, 2020
eb98305
Code coverage measurements
kown7 May 23, 2020
d94c14f
add contrib files to distribution
kown7 May 23, 2020
83223b5
src type
kown7 May 23, 2020
c2b3c92
tests in seperate directory
kown7 May 23, 2020
6cc9c43
isolated build/test
kown7 May 23, 2020
a2b018a
Missing lib in tests
kown7 May 30, 2020
b49444a
Fix coverage when running in isolated mode
kown7 May 30, 2020
8749db9
! fix most tests
kown7 May 30, 2020
5621779
! fix test BB001
kown7 May 30, 2020
edb099e
! fix test BB002
kown7 May 30, 2020
3bb8dac
! fix test BB006
kown7 May 30, 2020
41711d8
! fix test BB007
kown7 May 30, 2020
4ff49fb
! fix test for template engine
kown7 Jun 15, 2020
74bb4e1
- files
kown7 May 23, 2020
1272e8b
build and deploy using flit / travis
kown7 Jun 19, 2020
86eaf85
fix reference to license file
kown7 Jul 26, 2020
4aa7152
move template project and documentation to where it belongs
kown7 Sep 28, 2020
6b3bd73
corrected the paths
kown7 Sep 28, 2020
cf9a54c
Move contrib directory for flit to find it. Get location programmatic…
kown7 Sep 28, 2020
c851c96
fix tests and documentation due to new location
kown7 Sep 28, 2020
ee68418
collection has been moved
kown7 Sep 28, 2020
225e2df
Building E-Mail Client example with new contrib location
kown7 Sep 28, 2020
868180c
Adapt documentation
kown7 Sep 28, 2020
f962aa0
purge not needed files
kown7 Sep 28, 2020
8ef7ff6
Merge remote-tracking branch 'florath/master' into rflo/master
kown7 Sep 28, 2020
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
15 changes: 9 additions & 6 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,12 @@ artifacts
build
build-stamp
configure-stamp
contrib/template_project/.rmtoo_dependencies
contrib/template_project/latex/requirements.aux
contrib/template_project/latex/requirements.log
contrib/template_project/latex/requirements.out
contrib/template_project/latex/requirements.pdf
contrib/template_project/latex/requirements.toc
doc/template_project/.rmtoo_dependencies
doc/template_project/latex/requirements.aux
doc/template_project/latex/requirements.log
doc/template_project/latex/requirements.out
doc/template_project/latex/requirements.pdf
doc/template_project/latex/requirements.toc
debian/files
debian/rmtoo
debian/rmtoo.debhelper.log
Expand All @@ -27,5 +27,8 @@ doc/presentations/reqspricing.png
make_tests.log
result.xml
rmtoo.egg-info/
.tox
MANIFEST
dist
rmtoo/coverage.xml
rmtoo/result.xml
17 changes: 0 additions & 17 deletions .project

This file was deleted.

10 changes: 0 additions & 10 deletions .pydevproject

This file was deleted.

4 changes: 0 additions & 4 deletions .settings/org.eclipse.core.resources.prefs

This file was deleted.

19 changes: 18 additions & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,26 @@ python:
- "3.8"

# Required to run the respective python env in tox
install: pip install tox-travis
install: pip install tox-travis flit

# command to run tests
script:
- tox
- tox -e pep8

after_success:
- bash <(curl -s https://codecov.io/bash)

# The FLIT_PASSWORD environment variable needs to be set in travis with a
# working pypi token, see https://pypi.org/help/#apitoken
jobs:
include:
- stage: deploy
python: 3.8
env:
- FLIT_USERNAME=__token__
deploy:
provider: script
script: flit publish
on:
tags: true
2 changes: 1 addition & 1 deletion CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Contributor License Agreement
When you actively push changes to one of our development platforms,
e.g. using a pull or merge request, you agree that your contribution
is placed under GPL3 for the complete project - except the contents of
the contrib/template_project folder which is placed under Apache 2
the doc/template_project folder which is placed under Apache 2
license.

New files must include an appropriate license header - including the
Expand Down
3 changes: 2 additions & 1 deletion COPYING
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,5 @@ Raerener Strasse 10b
D-52076 Aachen
[email protected]

It can be distributed using the GPL v3 (see gpl-3.0.txt).
and others. It can be distributed using the GPL v3 (see LICENSE).

File renamed without changes.
3 changes: 1 addition & 2 deletions MANIFEST.in
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
include *.txt
include *.rst
recursive-include doc *
recursive-include contrib *
recursive-include share *
recursive-include rmtoo/collection *
recursive-include collection *
prune *~
prune *.pyc
4 changes: 2 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -40,10 +40,10 @@ artifacts/req-graph2.png: artifacts/req-graph2.dot
# backlog creation.
artifacts/requirements.pdf: ${REQS_LATEX2} doc/latex2/requirements.tex
(cd artifacts && \
gnuplot ../contrib/gnuplot_stats_reqs_cnt.inc && \
gnuplot ../src/rmtoo/contrib/gnuplot_stats_reqs_cnt.inc && \
epstopdf stats_reqs_cnt.eps)
(cd artifacts && \
gnuplot ../contrib/gnuplot_stats_burndown.inc && \
gnuplot ../src/rmtoo/contrib/gnuplot_stats_burndown.inc && \
epstopdf stats_burndown.eps)
(cd artifacts && pdflatex ../doc/latex2/requirements.tex; \
pdflatex ../doc/latex2/requirements.tex; \
Expand Down
15 changes: 7 additions & 8 deletions Readme.rst
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ possibility to use Amazon AWS EC2 preinstalled VMs.

More details are available in a dedicated Readme_.

.. _Readme: contrib/vmsetup/Readme.rst
.. _Readme: doc/vmsetup/Readme.rst


Installation
Expand Down Expand Up @@ -135,7 +135,6 @@ 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
Expand Down Expand Up @@ -180,7 +179,8 @@ is needed only once.

# cd to virtualenv directory - if not already there
$ cd RMTOO
$ cp -r venv/rmtoo/contrib/template_project MyNewProject
$ git clone https://github.com/florath/rmtoo.git
$ cp -r rmtoo/doc/template_project MyNewProject

Usage
-----
Expand All @@ -190,7 +190,6 @@ To create all the artifacts for the template project, execute
.. code:: bash

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

Expand All @@ -206,21 +205,21 @@ When using the virtualenv, use

.. code:: bash

$ man -l venv/rmtoo/share/man/man7/rmtoo.7
$ man -l 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:

.. code:: bash

$ man -l venv/rmtoo/share/man/man7/rmtoo-analytics.7
$ man -l 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).
``RMTOO/rmtoo/doc`` (especially the Readme files).

Other Documentation
===================
Expand Down Expand Up @@ -268,7 +267,7 @@ 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``
point to ``RMTOO/rmtoo/src/rmtoo/contrib/req-mode.el``
All files with suffix ``.req`` will now use the requirements editing
mode.

Expand Down
53 changes: 0 additions & 53 deletions build_tar.sh

This file was deleted.

3 changes: 0 additions & 3 deletions contrib/template_project/make.sh

This file was deleted.

36 changes: 0 additions & 36 deletions contrib/template_project/setenv.sh

This file was deleted.

6 changes: 3 additions & 3 deletions doc/Config1.json
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
"requirements_dirs": [ "doc/requirements" ],
"topics_dirs": [ "doc/topics" ],
"topic_root_node": "ReqsDocument",
"constraints_dirs": [ "rmtoo/collection/constraints" ] }
"constraints_dirs": [ "collection/constraints" ] }
],
[
"ignore:git", {
Expand All @@ -56,15 +56,15 @@
"requirements_dirs": [ "doc/requirements" ],
"topics_dirs": [ "doc/topics"] ,
"topic_root_node": "ReqsDocument",
"constraints_dirs": [ "rmtoo/collection/constraints" ] }
"constraints_dirs": [ "collection/constraints" ] }
],
[
"filesystem", {
"requirements_dirs": [ "doc/requirements" ],
"testcases_dirs": [ "doc/testcases" ],
"topics_dirs": [ "doc/topics" ],
"topic_root_node": "ReqsDocument",
"constraints_dirs": [ "rmtoo/collection/constraints" ] }
"constraints_dirs": [ "collection/constraints" ] }
]
],
"output": {
Expand Down
6 changes: 0 additions & 6 deletions doc/examples/EMailClient/.gitlab-ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,6 @@ cache:
- /var/cache/apt/archives/
- ./downloads

before_script:
# copy rmtoo's default Makefile and setenv.sh if the repo doesn't have them.
- if ! test -f "./setenv.sh"; then cp /usr/share/doc/rmtoo/contrib/template_project/setenv.sh .; fi
- source ./setenv.sh DEB
- if ! test -f "./Makefile"; then cp ${RMTOO_CONTRIB_DIR}/rmtoo/contrib/template_project/Makefile .; fi

createArtifacts:
stage: build
#tags: rmtoo #add this in when you create a custom runner
Expand Down
2 changes: 1 addition & 1 deletion doc/examples/EMailClient/Config.json
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
"requirements_dirs": [ "requirements" ],
"topics_dirs": [ "topics" ],
"topic_root_node": "EMailClient",
"constraints_dirs": [ "../../../rmtoo/collection/constraints" ] }
"constraints_dirs": [ "../../../collection/constraints" ] }
]
],
"output": {
Expand Down
8 changes: 5 additions & 3 deletions doc/examples/EMailClient/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,10 @@ force:
# ie:
# make RMTOO_CONFIG=YourConfig.json
#
RMTOO_CALL ?= rmtoo
RMTOO_CONFIG=Config.json
CALL_RMTOO=${RMTOO_CALL} -j file://${RMTOO_CONFIG}
RMTOO_CONTRIB_DIR ?= $(shell rmtoo-contrib-dir)

#
# Dependency handling
Expand All @@ -46,13 +48,13 @@ artifacts/req-graph2.png: artifacts/req-graph2.dot
# backlog creation.
artifacts/requirements.pdf: ${REQS_LATEX2} latex/requirements.tex
(cd artifacts && \
gnuplot ${RMTOO_CONTRIB_DIR}/contrib/gnuplot_stats_reqs_cnt.inc && \
gnuplot ${RMTOO_CONTRIB_DIR}/gnuplot_stats_reqs_cnt.inc && \
epstopdf stats_reqs_cnt.eps)
(cd artifacts && \
gnuplot ${RMTOO_CONTRIB_DIR}/contrib/gnuplot_stats_burndown.inc && \
gnuplot ${RMTOO_CONTRIB_DIR}/gnuplot_stats_burndown.inc && \
epstopdf stats_burndown.eps)
(cd artifacts && \
gnuplot ${RMTOO_CONTRIB_DIR}/contrib/gnuplot_stats_sprint_burndown.inc && \
gnuplot ${RMTOO_CONTRIB_DIR}/gnuplot_stats_sprint_burndown.inc && \
epstopdf stats_sprint_burndown.eps)
(cd artifacts && pdflatex ../latex/requirements.tex; \
pdflatex ../latex/requirements.tex; \
Expand Down
Loading