peng3dnet 0.1.3a0

Description:

peng3dnet 0.1.3a0

peng3dnet is a TCP-Based networking Library designed for use with peng3d.
It uses Length-Prefixing to cut the raw TCP Stream into packets, which are usually MessagePack-encoded Python objects.
peng3dnet has been tested and is developed under Python 3.5, however it should work with newer versions as well.
Python 2.x support is currently not planned, but may be possible by rewriting small parts of the code.

Documentation
The current documentation is available here on ReadTheDocs.
The Sphinx-based source for the documentation is available in the docs/ subdirectory.
Documentation for specific methods and classes is usually found in the docstring of the method/class.


Requirements
Currently, peng3dnet requires only two modules:
- bidict, as PyPI package bidict
- msgpack-python or u-msgpack-python, available under the same name on PyPI
Note that msgpack-python may be faster, since it has a C-extension.
In cases where C-extensions cannot be used, u-msgpack-python can be used, since it should work on all platforms and is written in pure Python.


Installation via pip
If possible, this method of installation is to be preferred.
Installation via pip is simple:
pip install peng3dnet
Note that on some systems it may be necessary to use sudo pip install peng3dnet if the above command fails.


Installation via setup.py
If possible, use pip instead.
Installation via setup.py
python setup.py install
Note that using this method requires manually installing the dependencies and downloading of the repository.
It may also be necessary to use sudo python setup.py install if the above command fails.