Merge branch 'release/0.3.6'

MANIFEST.in

@@ -1 +1,2 @@
 include README.md
+include requirements.txt

README.md

@@ -1,8 +1,10 @@
 #capnpc-python-cpp
 
+More thorough docs are available at [http://jparyani.github.io/capnpc-python-cpp/](http://jparyani.github.io/capnpc-python-cpp/).
+
 ## Requirements
 
-First you need a system-wide installation of the Capnproto C++ library >= 0.3. Unfortunately, as of now, that means you have to build from the HEAD of Cap'n Proto. Follow these instructions to do so:
+First you need a system-wide installation of the Cap'n Proto C++ library >= 0.3. Unfortunately, as of now, that means you have to build from the HEAD of Cap'n Proto. Follow these instructions to do so:
 
 ```bash
 wget https://github.com/kentonv/capnproto/archive/master.zip

capnp/__init__.py

@@ -1,2 +1,37 @@
+"""A python library wrapping the Cap'n Proto C++ library
+
+Example Usage::
+    
+    import capnp
+
+    addressbook = capnp.load('addressbook.capnp')
+
+    # Building
+    message = capnp.MallocMessageBuilder()
+    addressBook = message.initRoot(addressbook.AddressBook)
+    people = addressBook.init('people', 2)
+
+    alice = people[0]
+    alice.id = 123
+    alice.name = 'Alice'
+    alice.email = 'alice@example.com'
+    alicePhone = alice.init('phones', 1)[0]
+    alicePhone.type = 'mobile'
+
+    f = open('example.bin', 'w')
+    capnp.writePackedMessageToFd(f.fileno(), message)
+    f.close()
+
+    # Reading
+    f = open('example.bin')
+    message = capnp.PackedFdMessageReader(f.fileno())
+
+    addressBook = message.getRoot(addressbook.AddressBook)
+
+    for person in addressBook.people:
+        print(person.name, ':', person.email)
+        for phone in person.phones:
+            print(phone.type, ':', phone.number)
+"""
 from .version import version as __version__
 from .capnp import *

capnp/capnp.pyx

@@ -508,7 +508,38 @@ def writePackedMessageToFd(int fd, MessageBuilder m):
 from types import ModuleType
 import os
 
-def _load(nodeSchema, module):
+def load(file_name, display_name=None, imports=[]):
+    """load a Cap'n Proto schema from a file 
+
+    You will have to load a schema before you can begin doing anything
+    meaningful with this library. Loading a schema is much like Loading
+    a Python module (and load even returns a ModuleType). Once it's been
+    loaded, you use it much like any other Module::
+
+        addressbook = capnp.load('addressbook.capnp')
+        print addressbook.qux # qux is a top level constant
+        # 123
+        message = capnp.MallocMessageBuilder()
+        person = message.initRoot(addressbook.Person)
+
+    :type file_name: str
+    :param file_name: A relative or absolute path to a Cap'n Proto schema
+
+    :type display_name: str
+    :param display_name: The name internally used by the Cap'n Proto library
+        for the loaded schema. By default, it's just os.path.basename(file_name)
+
+    :type imports: list
+    :param imports: A list of str directories to add to the import path.
+
+    :rtype: ModuleType
+    :return: A module corresponding to the loaded schema. You can access
+        parsed schemas and constants with . syntax
+
+    :Raises: :exc:`exceptions.ValueError` if `file_name` doesn't exist
+
+    """
+    def _load(nodeSchema, module):
         module._nodeSchema = nodeSchema
         nodeProto = nodeSchema.getProto()
         module._nodeProto = nodeProto
@@ -526,7 +557,6 @@ def _load(nodeSchema, module):
 
             _load(schema, local_module)
 
-def load(file_name, display_name=None, imports=[]):
     if display_name is None:
         display_name = os.path.basename(file_name)
     module = ModuleType(display_name)

capnp/fixMaybe.h

@@ -1,6 +1,8 @@
 #include "kj/common.h"
 #include <stdexcept>
 
+static_assert(CAPNP_VERSION >= 3000, "Version of Cap'n Proto C++ Library is too old. Please upgrade to a version >= 0.3 and then re-install this python library");
+
 template<typename T>
 T fixMaybe(::kj::Maybe<T> val) {
   KJ_IF_MAYBE(new_val, val) {

docs/conf.py

@@ -25,7 +25,7 @@ import sys, os, string
 
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode']
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode', 'sphinx.ext.intersphinx']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -48,19 +48,10 @@ copyright = u'2013, Author'
 # built documents.
 #
 # The short X.Y version.
-def extract_version():
+import capnp
-    """extract version from version.py, so it's not multiply defined"""
-    with open(os.path.join('..', 'capnp', 'version.py')) as f:
-        line = f.readline()
-        while not line.startswith("version"):
-            line = f.readline()
-            print line
-    exec(line)
-    return version
 
-vs = extract_version()
+vs = capnp.__version__
 # The short X.Y version.
-import string
 version = vs.rstrip(string.letters)
 # The full version, including alpha/beta/rc tags.
 release = vs
@@ -296,3 +287,5 @@ epub_copyright = u'2013, Author'
 
 # Allow duplicate toc entries.
 #epub_tocdup = True
+
+intersphinx_mapping = {'http://docs.python.org/': None}

setup.py

@@ -6,17 +6,21 @@ except ImportError:
     raise RuntimeError('No cython installed. Please run `pip install cython`')
 
 if Cython.__version__ < '0.19.1':
-    raise RuntimeError('Old cython installed. Please run `pip install -U cython`')
+    raise RuntimeError('Old cython installed (%s). Please run `pip install -U cython`' % Cython.__version__)
+
+import pkg_resources
+setuptools_version = pkg_resources.get_distribution("setuptools").version
+if setuptools_version < '0.8':
+    raise RuntimeError('Old setuptools installed (%s). Please run `pip install -U setuptools`. Running `pip install capnp` will not work alone, since setuptools needs to be upgraded before installing anything else.' % setuptools_version)
 
 from distutils.core import setup
 import os
 
 MAJOR = 0
 MINOR = 3
-MICRO = 5
+MICRO = 6
 VERSION = '%d.%d.%d' % (MAJOR, MINOR, MICRO)
 
-
 def write_version_py(filename=None):
     cnt = """\
 version = '%s'