Merge tag 'v0.1' into dev

Because some additional changes had to be inserted into the merge commit to
v0.1, dev needs to merge them back now. These include
 - adding a MANIFEST.in
 - some changes in the setup.py (like version string)
Update doc/README

The doc/README was written in markdown, but has not markdown file ending, which
results in Github not recognising it. I changed it and linked the old name to
it, in case some code relies on the old file name.

See Github Issue #33.

Signed-off-by: Erik Bernoth <bernoth@dresearch-fe.de>
Acked-by: Steffen Sledz <sledz@dresearch-fe.de>
Acked-by: Eik Binschek <binschek@dresearch-fe.de>
building with requirements

adding requirements to setup.py

Based on the Travis-CI documentation we started to track requirements in the
requirements.txt file. This solution is easy to use from the repository with

    $ pip install -r requirements.txt

But if you want installs from the pypi repository also install required
packages, a requirement.txt files is not sufficient. The general usecase for
requirements.txt files should be the development environment. For the user
environment there is another way to add required packages, which is to add an
attribute to the setup() function call in the setup.py file in the following
way:

    setup(
        #[...]
        install_requires = [
            'package-name-a ==1.0',
            'package-name-b >=2.5'
        ]
    )

Following this, it is quite likely, that an installation from the repositories
with

    $ pip install monk_tf

should be sufficient to install MONK with all it's requirements.

This was tested with creating a so called distribution package and trying to
install that. Another upload to the repositories should contain the same
package and should result in the same successes and errors.

    $ cd $MONK
    $ python setup.py sdist
    $ cd dist/
    $ pip install monk-0.1.1.tar.gz
    Unpacking ./monk_tf-0.1.1.tar.gz
      Running setup.py egg_info for package from <location>

    Downloading/unpacking pylibssh2==1.0.1 (from monk-tf==0.1.1)
      Downloading pylibssh2-1.0.1.tar.gz
      Running setup.py egg_info for package pylibssh2

    Downloading/unpacking pyserial==2.5 (from monk-tf==0.1.1)
      Downloading pyserial-2.5.tar.gz (106Kb): 106Kb downloaded
      Running setup.py egg_info for package pyserial

        warning: no files found matching 'test/test_io_lib.py'
    Installing collected packages: pylibssh2, pyserial
      Running setup.py install for pylibssh2

    <some lines omitted>

    Running setup.py install for pyserial
        changing mode of build/scripts-2.7/miniterm.py from 644 to 755

        warning: no files found matching 'test/test_io_lib.py'
        changing mode of /usr/local/bin/miniterm.py to 755
    Successfully installed pylibssh2 pyserial
    Cleaning up...

The test ran successfully.

Read issue #31 for more information.

Signed-off-by: Erik Bernoth <bernoth@dresearch-fe.de>
Acked-by: Steffen Sledz <sledz@dresearch-fe.de>
Acked-by: Eik Binschek <binschek@dresearch-fe.de>
Merge branch 'f-setup-with-requirements' into dev
environment variable for no reboot at start

The devicetestcase.py is changed in order to not do a reboot if it is not
necessary. To configure the reboot at the start of a devicetestcase you
use the environment variable "MONK_NEED_START_REBOOT". Value 1 means
reboot necessary and 0 means reboot not necessary. In default the device
is rebooting at start of the test.

Signed-off-by: Johannes Kroop <johkroop@gmail.com>
Acked-by: Erik Bernoth <bernoth@dresearch-fe.de>
Acked-by: Steffen Sledz <sledz@dresearch-fe.de>
environment variable for no reboot at the end

The device.py is changed in order to not do a reboot if it is not
necessary. To configure the reboot at the end of a devicetestcase you
use the environment variable "MONK_NEED_END_REBOOT". Value 1 means
reboot necessary and 0 means reboot not necessary. In default the device
is rebooting at start of the test.

Signed-off-by: Johannes Kroop <johkroop@gmail.com>
Acked-by: Erik Bernoth <bernoth@dresearch-fe.de>
Acked-by: Steffen Sledz <sledz@dresearch-fe.de>
rename test subdir according to the community habits

implements issue #25

Signed-off-by: Steffen Sledz <sledz@dresearch-fe.de>
Acked-by: Erik Bernoth <bernoth@dresearch-fe.de>
[doc] updating conf.py

A lot of texts in conf.py were still talking about the old HidaV sub project,
mostly these parts were rewritten and some minor changes to the configuration
itself were made.

This task was done in connection with Github Issue #26.

Signed-off-by: Erik Bernoth <bernoth@dresearch-fe.de>
Acked-by: Angelika Tobisch <tobisch@dresearch-fe.de>
Acked-by: Andrea Schönfeldt <schoenfeldt@dresearch-fe.de>
[doc] complete rewrite of index.rst

Which had to be done, because the changes to the old version were just way too
big.

Also see Github Issue #26.

Signed-off-by: Erik Bernoth <bernoth@dresearch-fe.de>
Acked-by: Angelika Tobisch <tobisch@dresearch-fe.de>
Acked-by: Andrea Schönfeldt <schoenfeldt@dresearch-fe.de>
[doc] new page getting-started

Added a page that explains a MONK user what he can do with MONK.

Belongs to Github Issue #27.

Signed-off-by: Erik Bernoth <bernoth@dresearch-fe.de>
Acked-by: Angelika Tobisch <tobisch@dresearch-fe.de>
Acked-by: Andrea Schönfeldt <schoenfeldt@dresearch-fe.de>
[doc] new page contributing

which describes the development process and ways to interact with the
MONK community.

See Github Issue #28 for more info.
Also some of the changes are more about the policies, thus look at Github Issue
 #30 for more details.

This change also includes the changes from Github Issue #21, which added some
info about the environment variables configuration to the old docs.

Signed-off-by: Erik Bernoth <bernoth@dresearch-fe.de>
Acked-by: Angelika Tobisch <tobisch@dresearch-fe.de>
Acked-by: Andrea Schönfeldt <schoenfeldt@dresearch-fe.de>
Review from Angelika

There also is a comment on GitHub that should be considered.

Signed-off-by: Angelika Tobisch <tobisch@dresearch-fe.de>
Acked-by: Erik Bernoth <bernoth@dresearch-fe.de>
Acked-by: Andrea Schönfeldt <schoenfeldt@dresearch-fe.de>
Review from Andrea

Signed-off-by: Erik Bernoth <bernoth@dresearch-fe.de>
Acked-by: Andrea Schönfeldt <schoenfeldt@dresearch-fe.de>
Acked-by: Angelika Tobisch <tobisch@dresearch-fe.de>
Merge branch 'f-docs-overhaul' into dev

close #26
close #27
close #28
close #30
debug doc project

conf.py:

This file was completely rewritten for the purpose of getting Sphinx to accept
the restructured and renamed project. I simply wasn't able to figure out what
things would have been required to change to get Sphinx to understand the
structural changes.

Makefile:

 * Added automatical apidoc coverage. The manual way might have been more
   beautiful, but also meant a lot of manual maintenance, which we try to avoid
   at the moment.
 * made sure that the `clean:` task also cleans automatically generated api doc
   files
 * made `latexpdf:` and `html:` tasks require `clean` and `apidoc` for a
   complete rebuild of these parts.
 * add a task `all:` which builds html and latexpdf automatically

index.rst:
 * included the files generated by apidoc
 * changed one headline markup

pictures:
 * moved to _static folder
 * gif changed to png, because latexpdf doesn't seem to handle gif at all

Others:
 * some small changes, like renaming of :term: values

See #37 for more details.

Signed-off-by: Erik Bernoth <bernoth@dresearch-fe.de>
Acked-by: Angelika Tobisch <tobisch@dresearch-fe.de>
Acked-by: Steffen Sledz <sledz@dresearch-fe.de>
Remove uuid_.py

This file seems to be unused and copies a uuid.py file from the standard
python2.7 distribution. Because no file of MONK contains the text uuid, it can
be deleted.

Also see Issue #38 on Github.

Signed-off-by: Erik Bernoth <bernoth@dresearch-fe.de>
Acked-by: Steffen Sledz <sledz@dresearch-fe.de>
Acked-by: Eik Binschek <binschek@dresearch-fe.de>
Merge branch 'f-remove-uuid' into dev
docs: changed pictures

Also changed how the pictures are used in the index.rst file. Now they are
centered and minimized a little. This way it is more clear to see what is the
label for the figures, which again makes it possible to remove the "figure x:"
text before the figure labes. Removing them makes the PDF labeling more
beautiful.

See Github Issue #40 for more details.

Pictures created by Zhang, Mengqiao. Update to color space by Binschek, Eik.

Signed-off-by: Mengqiao Zhang <mengqiao.zhang@gmail.com>
Signed-off-by: Eik Binschek <binschek@dresearch-fe.de>
Acked-by: Erik Bernoth <bernoth@dresearch-fe.de>
Acked-by: Johannes Kroop <kroop@dresearch-fe.de>
Merge branch 'f-mengqiaos-diagrams' into dev

finishes Github Issue #40.
SshConn: wrong call in main() corrected

In the Function main() the SshConn is called with a wrong number of argumentes. One of the argumentes is a logger. This logger is not expected anymore and is removed.

See Issue #42 on Github for details.

Signed-off-by: Johannes Kroop <johkroop@gmail.com>
Acked-by: Steffen Sledz <sledz@dresearch-fe.com>
Acked-by: Eik Binschek <binschek@dresearch-fe.com>