Change all references to old project name
This commit is contained in:
2
LICENSE
2
LICENSE
@@ -1,4 +1,4 @@
|
||||
Copyright (c) 2013, Jason Paryani <capnpc-python-cpp@jparyani.com>
|
||||
Copyright (c) 2013, Jason Paryani <pycapnp@jparyani.com>
|
||||
All rights reserved.
|
||||
|
||||
Redistribution and use in source and binary forms, with or without
|
||||
|
||||
14
README.md
14
README.md
@@ -1,6 +1,6 @@
|
||||
#capnpc-python-cpp
|
||||
#pycapnp
|
||||
|
||||
More thorough docs are available at [http://jparyani.github.io/capnpc-python-cpp/](http://jparyani.github.io/capnpc-python-cpp/).
|
||||
More thorough docs are available at [http://jparyani.github.io/pycapnp/](http://jparyani.github.io/pycapnp/).
|
||||
|
||||
## Requirements
|
||||
|
||||
@@ -24,20 +24,20 @@ pip install -U setuptools
|
||||
|
||||
## Building and installation
|
||||
|
||||
Install with `pip install capnp`. You can set the CC environment variable to control the compiler version, ie `CC=gcc-4.8 pip install capnp`.
|
||||
Install with `pip install pycapnp`. You can set the CC environment variable to control the compiler version, ie `CC=gcc-4.8 pip install capnp`.
|
||||
|
||||
Or you can clone the repo like so:
|
||||
|
||||
git clone https://github.com/jparyani/capnpc-python-cpp.git
|
||||
git clone https://github.com/jparyani/pycapnp.git
|
||||
|
||||
`cd` into the repo directory and run `pip install .`
|
||||
|
||||
## Development
|
||||
|
||||
This project uses [git-flow](http://jeffkreeftmeijer.com/2010/why-arent-you-using-git-flow/). Essentially, just make sure you do your changes in the `develop` branch.
|
||||
This project uses [git-flow](http://jeffkreeftmeijer.com/2010/why-arent-you-using-git-flow/). Essentially, just make sure you do your changes in the `develop` branch. You can run the tests by installing pytest with `pip install pytest`, and then run `py.test`
|
||||
|
||||
## Documentation/Example
|
||||
There is some basic documentation [here](http://jparyani.github.io/capnpc-python-cpp/).
|
||||
There is some basic documentation [here](http://jparyani.github.io/pycapnp/).
|
||||
|
||||
The examples directory has one example that shows off the capabilities quite nicely. Here it is, reproduced:
|
||||
|
||||
@@ -112,5 +112,5 @@ If you get an error on installation like:
|
||||
|
||||
Then you have too old a version of setuptools. Run `pip install -U setuptools` then try again.
|
||||
|
||||
[](https://travis-ci.org/jparyani/capnpc-python-cpp)
|
||||
[](https://travis-ci.org/jparyani/pycapnp)
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ This is a python wrapping of the C++ implementation of the `Cap'n Proto <http://
|
||||
|
||||
Cap’n Proto is an insanely fast data interchange format and capability-based RPC system. Think JSON, except binary. Or think Protocol Buffers, except faster. In fact, in benchmarks, Cap’n Proto is INFINITY TIMES faster than Protocol Buffers.
|
||||
|
||||
The INFINITY TIMES faster part isn't so true for python, but in some simplistic benchmarks (available in the `benchmark directory of the repo <https://github.com/jparyani/capnpc-python-cpp/tree/master/benchmark>`_), capnp has proven to be decently faster than Protocol Buffers. Also, the python capnp library can load Cap'n Proto schema files directly, without the need for a seperate compile step like with Protocol Buffers or Thrift.
|
||||
The INFINITY TIMES faster part isn't so true for python, but in some simplistic benchmarks (available in the `benchmark directory of the repo <https://github.com/jparyani/pycapnp/tree/master/benchmark>`_), capnp has proven to be decently faster than Protocol Buffers. Also, the python capnp library can load Cap'n Proto schema files directly, without the need for a seperate compile step like with Protocol Buffers or Thrift.
|
||||
|
||||
Contents:
|
||||
|
||||
|
||||
@@ -22,7 +22,7 @@ Using pip is by far the easiest way to install the library. After you've install
|
||||
|
||||
pip install -U cython
|
||||
pip install -U setuptools
|
||||
pip install capnp
|
||||
pip install pycapnp
|
||||
|
||||
You can control the compiler version with the environment variable CC, ie. `CC=gcc-4.8 pip install capnp`. You only need to run the setuptools line if you have a setuptools older than v0.8.0, and the cython line if you have a version older than v0.19.1.
|
||||
|
||||
@@ -31,12 +31,13 @@ From Source
|
||||
|
||||
If you want the latest development version, you can clone the github repo and install like so::
|
||||
|
||||
git clone https://github.com/jparyani/capnpc-python-cpp.git
|
||||
pip install capnpc-python-cpp
|
||||
git clone https://github.com/jparyani/pycapnp.git
|
||||
cd pycapnp
|
||||
pip install .
|
||||
|
||||
or::
|
||||
|
||||
cd capnpc-python-cpp
|
||||
cd pycapnp
|
||||
python setup.py install
|
||||
|
||||
If you don't use pip, you will need to manually install Cython, and a setuptools with a version >= .8.
|
||||
@@ -44,10 +45,14 @@ If you don't use pip, you will need to manually install Cython, and a setuptools
|
||||
Development
|
||||
-------------------
|
||||
|
||||
Clone the repo from https://github.com/jparyani/capnpc-python-cpp.git and use the `develop` branch. I'll probably ask you to redo pull requests that target `master` and aren't easily mergable to `develop`::
|
||||
Clone the repo from https://github.com/jparyani/pycapnp.git and use the `develop` branch. I'll probably ask you to redo pull requests that target `master` and aren't easily mergable to `develop`::
|
||||
|
||||
git clone https://github.com/jparyani/capnpc-python-cpp.git
|
||||
git clone https://github.com/jparyani/pycapnp.git
|
||||
git checkout develop
|
||||
|
||||
Testing is done through pytest, like so::
|
||||
|
||||
pip install pytest
|
||||
py.test
|
||||
|
||||
Once you're done installing, take a look at the :ref:`quickstart`
|
||||
|
||||
@@ -215,7 +215,7 @@ The only tricky one is unions, where you need to call `.which()` to determine th
|
||||
Full Example
|
||||
------------------
|
||||
|
||||
Here is a full example reproduced from `examples/example.py <https://github.com/jparyani/capnpc-python-cpp/blob/master/examples/example.py>`_::
|
||||
Here is a full example reproduced from `examples/example.py <https://github.com/jparyani/pycapnp/blob/master/examples/example.py>`_::
|
||||
|
||||
from __future__ import print_function
|
||||
import os
|
||||
|
||||
4
setup.py
4
setup.py
@@ -59,8 +59,8 @@ setup(
|
||||
license='BSD',
|
||||
author="Jason Paryani",
|
||||
author_email="pypi-contact@jparyani.com",
|
||||
url = 'https://github.com/jparyani/capnpc-python-cpp',
|
||||
download_url = 'https://github.com/jparyani/capnpc-python-cpp/archive/v%s.zip' % VERSION,
|
||||
url = 'https://github.com/jparyani/pycapnp',
|
||||
download_url = 'https://github.com/jparyani/pycapnp/archive/v%s.zip' % VERSION,
|
||||
keywords = ['capnp', 'capnproto'],
|
||||
classifiers = [
|
||||
'Development Status :: 3 - Alpha',
|
||||
|
||||
Reference in New Issue
Block a user