summaryrefslogtreecommitdiff
path: root/Documentation/topics/language-bindings.rst
blob: 414f7c73fa38fc4a983af5d39395316728cbed06 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
..
      Licensed under the Apache License, Version 2.0 (the "License"); you may
      not use this file except in compliance with the License. You may obtain
      a copy of the License at

          http://www.apache.org/licenses/LICENSE-2.0

      Unless required by applicable law or agreed to in writing, software
      distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
      WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
      License for the specific language governing permissions and limitations
      under the License.

      Convention for heading levels in Open vSwitch documentation:

      =======  Heading 0 (reserved for the title in a document)
      -------  Heading 1
      ~~~~~~~  Heading 2
      +++++++  Heading 3
      '''''''  Heading 4

      Avoid deeper levels because they do not render well.

=================
Language Bindings
=================

Bindings exist for Open vSwitch in a variety of languages.

Official Bindings
-----------------

Python
~~~~~~

The Python bindings are part of the `Open vSwitch package`__. You can install
the bindings using ``pip``:

::

   $ pip install ovs

The Python bindings include an optional flow parsing library. To install it's
required dependencies, run:

::

   $ pip install ovs[flow]

or install `python3-netaddr` and `python3-pyparsing`.

__ https://github.com/openvswitch/ovs/tree/master/python/ovs

Third-Party Bindings
--------------------

Lua
~~~

- `LJIT2ovs:`__ LuaJIT binding for Open vSwitch

__ https://github.com/wiladams/LJIT2ovs

Go
~~

- `go-odp:`__ A Go library to control the Open vSwitch in-kernel datapath

__ https://github.com/weaveworks/go-odp