README.md

   1 [![Build Status](http://jenkins.sonata-nfv.eu/buildStatus/icon?job=son-emu)](http://jenkins.sonata-nfv.eu/job/son-emu)
   2
   3 # son-emu
   4 Here comes a brief description of the repository and the code inside.
   5
   6 ## Development
   7 (if applicable)
   8
   9 ### Building
  10 Describe briefly how to build the software.
  11
  12 ### Dependencies
  13 Name all the dependencies needed by the software, including version, license (!), and a link. For example
  14
  15 * [pyaml](https://pypi.python.org/pypi/pyaml) >=15.8.2 (WTFPL)
  16 * [zerorpc](http://www.zerorpc.io) >= 0.5.2 (MIT)
  17 * [tabulate](https://pypi.python.org/pypi/tabulate) >= 0.7.5 (public domain)
  18 * [argparse](https://pypi.python.org/pypi/argparse) >= 1.4.0 (Python software foundation License)
  19 * [networkx](https://pypi.python.org/pypi/networkx/) >= 1.11  (BSD)
  20 * [six](https://pypi.python.org/pypi/six/) >=1.9 (MIT)
  21 * [ryu](https://pypi.python.org/pypi/ryu/4.4) >= 4.4 (Apache 2.0)
  22 * [oslo.config](http://docs.openstack.org/developer/oslo.config/) >= 3.9.0  (Apache 2.0)
  23 * [pytest](https://pypi.python.org/pypi/pytest) >= 2.9 (MIT)
  24 * [pytest-runner](https://pypi.python.org/pypi/pytest-runner) >= 2.8 (MIT)
  25 * [Flask](https://pypi.python.org/pypi/Flask) >= 0.11 (BSD)
  26 * [flask_restful](https://pypi.python.org/pypi/Flask-RESTful) >= 0.3 (BSD)
  27 * [requests](https://pypi.python.org/pypi/requests) >= 2.10 (Apache 2.0)
  28 * [docker-py](https://pypi.python.org/pypi/docker-py) == 1.7.1(Apache 2.0)
  29 * [paramiko](https://pypi.python.org/pypi/paramiko/1.16.0) >= 1.6 (LGPL)
  30 * [prometheus_client](https://pypi.python.org/pypi/prometheus_client) >= 0.0.13 (Apache 2.0)
  31 * [urllib3](https://pypi.python.org/pypi/urllib3) >= 1.15 (MIT)
  32
  33 ### Contributing
  34 (if applicable) Description (encouraging) how to contribute to this project/repository.
  35
  36 ## Installation
  37 (if applicable) Describe briefly how to install the software. You may want to put a link to son-install instead:
  38
  39 The installation of this component can be done using the [son-install](https://github.com/sonata-nfv/son-install) script.
  40
  41 ## Usage
  42 (if applicable) Describe briefly how to use the software.
  43
  44 ## License
  45
  46 This [SOFTWARE] is published under Apache 2.0 license. Please see the LICENSE file for more details.
  47
  48 ## Useful Links
  49
  50 * Any useful link and brief description. For example:
  51 * http://www.google/ Don't be evil.
  52
  53 ---
  54 #### Lead Developers
  55
  56 The following lead developers are responsible for this repository and have admin rights. They can, for example, merge pull requests.
  57
  58 * Manuel Peuster (mpeuster)
  59 * Steven Van Rossem (stevenvanrossem)
  60
  61 #### Feedback-Chanel
  62
  63 * You may use the mailing list sonata-dev@lists.atosresearch.eu
  64 * Please use the GitHub issues to report bugs.