Metadata-Version: 2.0
Name: vipe
Version: 0.3.0
Summary: Tool for visualizing Apache Oozie pipelines
Home-page: https://github.com/openaire/vipe
Author: Mateusz Kobos
Author-email: mkobos@icm.edu.pl
License: Apache License, Version 2.0
Keywords: Oozie,workflow visualization,pipeline visualization
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.4
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Topic :: Scientific/Engineering :: Visualization
Requires-Dist: pyyaml
Requires-Dist: pytest

About
=====

|Build Status|

This is a tool for visualizing Apache Oozie workflows as data flow
pipelines.

License
=======

The code is licensed under Apache License, Version 2.0

Dependencies
============

Python packages that the application depends on are listed in the
``requirements.txt`` file. Note that:

-  The project uses Python 3, so you need to install Python 3 version of
   these dependencies (on Ubuntu 14.04 system you can do it by
   executing, e.g. ``sudo pip3 install pytest``).
-  ``pyyaml`` package requires ``libyaml`` library to be installed in
   the system. On Ubuntu 14.04 system, this can be installed by running
   ``apt-get install libyaml-dev``

Apart from that, `GraphViz <graphiz.org>`__ library has to be installed
in the system. On Ubuntu 14.04 system, this can installed by running
``apt-get install graphviz``.

Code development
================

The **docstrings** in the code follow `Google style
guide <https://google-styleguide.googlecode.com/svn/trunk/pyguide.html#Comments>`__
with types declared in accordance to
`Sphinx <http://sphinx-doc.org/>`__'s `type annotating
conventions <http://sphinx-doc.org/latest/ext/example_google.html>`__.
Note that you have to use Sphinx version at least 1.3 if you want to
generate documentation with type annotations.

.. |Build Status| image:: https://travis-ci.org/openaire/vipe.png?branch=master
   :target: https://travis-ci.org/openaire/vipe


