Requirements

[Witoso]

It's necessary to add minimal requirements of the app in the documentation/README.

For example:

• python version (i.e. documentation generation fails with Python 3.5.1)
• OS (I guess it's debian based app)

[kwarunek]

Fair point. The application has only one requirement (besides python modules): python3.5+ . It runs on different distros without any hassle. Windows and macOS and other are supported just like python itself on these platforms.

[Witoso]

1. Are you sure about 3.5? PostgresDrivers (https://github.com/DreamLab/vmshepherd-runtime-postgres-driver):

Library requires (as well as VmShepherd itself) python 3.6 or later.

2. As for the OS requirement, we need to figure out how to install graphviz in make (sudo apt-get install -y graphviz libgraphviz-dev pkg-config) because now it fails on other platforms.

[Witoso]

Not sure, but I think source env/bin/activate; will fail on Windows. Also running Makefile will not be trivial on that platform.

[kwarunek]

Requirements of the plugins may differ, the Postgres is thrid-party one.. so it does not apply to this docs.

And my bad, to be correct 3.6 is required :) even without pg.

[kwarunek]

graphviz is not required to run VmShepherd

[kwarunek]

Makefile is a completely different subject. Since Makefile can be run (and source will work as well) with cygwin or nmake or ... I've not seen a much of docs in other projects to handle this matter.

Target audience is tech-aware.

[kwarunek]

I understand that it needs a bit more changes (especially in docs), but as a quick hint I added some info in the README.rst in #45

[evemorgen]

I bet we do not have any interest in supporting this app under Windows, however it should be pointed out in docs. Most other Linux based OSes are fine, probably

[kwarunek]

It isn't a matter of interest, rather than does it require more effort - currently VmShpeherd is working under windows (https://vimeo.com/274380573 - I know you wouldn't believe that I run it on Windows ;) ). Linux-based statement is biased IMHO.

I will update travis.yml to include mac, win, bsd as well

[Witoso]

I think we can draw a few things from this discussion.

1. VmShepherd is awesome ;)
2. We need a requirements section for running the app.
3. We need a requirements section for developing the app. BTW. if a developer will run the make run command on a non debian linuxes, it will fail (graphviz package).
4. Ergo, we need to separate doc buidling (and doc requirements) from running the app.