README.md 4.11 KB
Newer Older
temporal's avatar
temporal committed
1
Protocol Buffers - Google's data interchange format
2 3 4 5
===================================================

[![Build Status](https://travis-ci.org/google/protobuf.svg?branch=master)](https://travis-ci.org/google/protobuf)

temporal's avatar
temporal committed
6 7 8 9
Copyright 2008 Google Inc.

This directory contains the Python Protocol Buffers runtime library.

temporal's avatar
temporal committed
10 11 12
Normally, this directory comes as part of the protobuf package, available
from:

13
  https://developers.google.com/protocol-buffers/
temporal's avatar
temporal committed
14 15 16 17 18 19 20 21

The complete package includes the C++ source code, which includes the
Protocol Compiler (protoc).  If you downloaded this package from PyPI
or some other Python-specific source, you may have received only the
Python part of the code.  In this case, you will need to obtain the
Protocol Compiler from some other source before you can use this
package.

temporal's avatar
temporal committed
22 23 24 25 26 27 28 29
Development Warning
===================

The Python implementation of Protocol Buffers is not as mature as the C++
and Java implementations.  It may be more buggy, and it is known to be
pretty slow at this time.  If you would like to help fix these issues,
join the Protocol Buffers discussion list and let us know!

temporal's avatar
temporal committed
30 31 32
Installation
============

33
1) Make sure you have Python 2.6 or newer.  If in doubt, run:
temporal's avatar
temporal committed
34

35
       $ python -V
temporal's avatar
temporal committed
36 37

2) If you do not have setuptools installed, note that it will be
38
   downloaded and installed automatically as soon as you run `setup.py`.
temporal's avatar
temporal committed
39
   If you would rather install it manually, you may do so by following
40
   the instructions on [this page](https://packaging.python.org/en/latest/installing.html#setup-for-installing-packages).
temporal's avatar
temporal committed
41

42
3) Build the C++ code, or install a binary distribution of `protoc`.  If
temporal's avatar
temporal committed
43 44 45
   you install a binary distribution, make sure that it is the same
   version as this package.  If in doubt, run:

46
       $ protoc --version
temporal's avatar
temporal committed
47

48
4) Build and run the tests:
temporal's avatar
temporal committed
49

50 51 52 53 54 55 56 57 58 59 60 61 62 63
       $ python setup.py build
       $ python setup.py test

   To build, test, and use the C++ implementation, you must first compile
   `libprotobuf.so`:

       $ (cd .. && make)

   On OS X:

   If you are running a Homebrew-provided Python, you must make sure another
   version of protobuf is not already installed, as Homebrew's Python will
   search `/usr/local/lib` for `libprotobuf.so` before it searches
   `../src/.libs`.
64

65 66
   You can either unlink Homebrew's protobuf or install the `libprotobuf` you
   built earlier:
67

68
       $ brew unlink protobuf
69

70
   or
71

72
       $ (cd .. && make install)
73

74
    On other *nix:
75

76 77
    You must make `libprotobuf.so` dynamically available. You can either
    install libprotobuf you built earlier, or set `LD_LIBRARY_PATH`:
78

79
       $ export LD_LIBRARY_PATH=../src/.libs
80

81
    or
82

83
       $ (cd .. && make install)
84

85 86 87 88 89 90 91
   To build the C++ implementation run:

       $ python setup.py build --cpp_implementation

   Then run the tests like so:

       $ python setup.py test --cpp_implementation
temporal's avatar
temporal committed
92 93 94 95 96 97

   If some tests fail, this library may not work correctly on your
   system.  Continue at your own risk.

   Please note that there is a known problem with some versions of
   Python on Cygwin which causes the tests to fail after printing the
98 99 100 101
   error:  `sem_init: Resource temporarily unavailable`.  This appears
   to be a [bug either in Cygwin or in
   Python](http://www.cygwin.com/ml/cygwin/2005-07/msg01378.html).

Ian Hunter's avatar
Ian Hunter committed
102
   We do not know if or when it might be fixed.  We also do not know
temporal's avatar
temporal committed
103 104 105 106
   how likely it is that this bug will affect users in practice.

5) Install:

107
       $ python setup.py install
108

109
   or:
110

111 112
       $ (cd .. && make install)
       $ python setup.py install --cpp_implementation
temporal's avatar
temporal committed
113 114

   This step may require superuser privileges.
115 116 117
   NOTE: To use C++ implementation, you need to export an environment
   variable before running your program.  See the "C++ Implementation"
   section below for more details.
temporal's avatar
temporal committed
118 119 120 121 122 123 124

Usage
=====

The complete documentation for Protocol Buffers is available via the
web at:

125
  https://developers.google.com/protocol-buffers/
126 127 128 129 130 131 132

C++ Implementation
==================

The C++ implementation for Python messages is built as a Python extension to
improve the overall protobuf Python performance.

133 134
To use the C++ implementation, you need to install the C++ protobuf runtime
library, please see instructions in the parent directory.