4 Summary: Component-based Software-defined Networking Framework
5 Home-page: http://osrg.github.io/ryu/
6 Author: Ryu project team
7 Author-email: ryu-devel@lists.sourceforge.net
8 License: Apache License 2.0
9 Description: What's Ryu
11 Ryu is a component-based software defined networking framework.
13 Ryu provides software components with well defined API's that make it
14 easy for developers to create new network management and control
15 applications. Ryu supports various protocols for managing network
16 devices, such as OpenFlow, Netconf, OF-config, etc. About OpenFlow,
17 Ryu supports fully 1.0, 1.2, 1.3, 1.4, 1.5 and Nicira Extensions.
19 All of the code is freely available under the Apache 2.0 license. Ryu
20 is fully written in Python.
25 Installing Ryu is quite easy::
29 If you prefer to install Ryu from the source code::
31 % git clone git://github.com/osrg/ryu.git
32 % cd ryu; pip install .
34 If you want to write your Ryu application, have a look at
35 `Writing ryu application <http://ryu.readthedocs.io/en/latest/writing_ryu_app.html>`_ document.
36 After writing your application, just type::
38 % ryu-manager yourapp.py
44 Some functions of ryu require extra packages:
46 - OF-Config requires lxml and ncclient
47 - NETCONF requires paramiko
48 - BGP speaker (SSH console) requires paramiko
49 - Zebra protocol service (database) requires SQLAlchemy
51 If you want to use these functions, please install the requirements::
53 % pip install -r tools/optional-requires
55 Please refer to tools/optional-requires for details.
60 If you got some error messages at the installation stage, please confirm
61 dependencies for building the required Python packages.
63 On Ubuntu(16.04 LTS or later)::
65 % apt install gcc python-dev libffi-dev libssl-dev libxml2-dev libxslt1-dev zlib1g-dev
70 Ryu Official site is `<http://osrg.github.io/ryu/>`_.
73 questions, suggestions, and patches, the mailing list is available at
75 <https://lists.sourceforge.net/lists/listinfo/ryu-devel>`_.
76 `The ML archive at Gmane <http://dir.gmane.org/gmane.network.ryu.devel>`_
80 Keywords: openflow,openvswitch,openstack
82 Classifier: Development Status :: 5 - Production/Stable
83 Classifier: License :: OSI Approved :: Apache Software License
84 Classifier: Topic :: System :: Networking
85 Classifier: Natural Language :: English
86 Classifier: Programming Language :: Python
87 Classifier: Programming Language :: Python :: 2.7
88 Classifier: Programming Language :: Python :: 3
89 Classifier: Programming Language :: Python :: 3.4
90 Classifier: Programming Language :: Python :: 3.5
91 Classifier: Programming Language :: Python :: 3.6
92 Classifier: Programming Language :: Python :: 3.7
93 Classifier: Operating System :: Unix