.. ATTENTION::
This project is in maintenance mode. We may fix bugs, but no new features will be added in foreseeable future.
qPython
=======
qPython is a Python library providing support for interprocess communication between Python and kdb+ processes, it offers:
- Synchronous and asynchronous queries
- Convenient asynchronous callbacks mechanism
- Support for kdb+ protocol and types: v3.0, v2.6, v<=2.5
- Uncompression of the IPC data stream
- Internal representation of data via numpy arrays (lists, complex types) and numpy data types (atoms)
- Supported on Python 2.7/3.4/3.5/3.6 and numpy 1.8+
For more details please refer to the `documentation`_.
Installation
------------
To install qPython from PyPI:
``$ pip install qpython``
**Please do not use old PyPI package name: exxeleron-qpython.**
Building package
----------------
Documentation
~~~~~~~~~~~~~
qPython documentation is generated with help of `Sphinx`_ document generator.
In order to build the documentation, including the API docs, execute:
``make html`` from the doc directory.
Documentation is built into the: ``doc/build/html/`` directory.
Compile Cython extensions
~~~~~~~~~~~~~~~~~~~~~~~~~
qPython utilizes `Cython`_ to tune performance critical parts of the code.
Instructions:
- Execute: ``python setup.py build_ext --inplace``
Build binary distribution
~~~~~~~~~~~~~~~~~~~~~~~~~
Instructions:
- Execute: ``python setup.py bdist``
Testing
~~~~~~~
qPython uses py.test as a test runner for unit tests.
Instructions:
- Make sure that top directory is included in the ``PYTHONPATH``
- Execute: ``py.test``
Requirements
~~~~~~~~~~~~
qPython requires numpy 1.8 to run.
Optional requirements have to be met to provide additional features:
- tune performance of critical parts of the code:
- Cython 0.20.1
- support serialization/deserialization of ``pandas.Series`` and ``pandas.DataFrame``
- pandas 0.14.0
- run Twisted sample:
- Twisted 13.2.0
- build documentation via Sphinx:
- Sphinx 1.2.3
- mock 1.0.1
Required libraries can be installed using `pip`_.
To install all the required dependencies, execute:
``pip install -r requirements.txt``
Minimal set of required dependencies can be installed by executing:
``pip install -r requirements-minimal.txt``
.. _Cython: http://cython.org/
.. _Sphinx: http://sphinx-doc.org/
.. _pip: http://pypi.python.org/pypi/pip
.. _documentation: http://qpython.readthedocs.org/en/latest/
Raw data
{
"_id": null,
"home_page": "http://github.com/exxeleron/qPython",
"name": "qPython",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "kdb+",
"author": "exxeleron",
"author_email": "kdbtools@devnet.de",
"download_url": "https://files.pythonhosted.org/packages/99/7f/c9091cf56dfed58680d941153499a9091610d4ecb57977b54fc5a4753dc5/qPython-2.0.0.tar.gz",
"platform": "",
"description": ".. ATTENTION::\nThis project is in maintenance mode. We may fix bugs, but no new features will be added in foreseeable future. \n\nqPython\n=======\n\nqPython is a Python library providing support for interprocess communication between Python and kdb+ processes, it offers:\n\n- Synchronous and asynchronous queries\n- Convenient asynchronous callbacks mechanism\n- Support for kdb+ protocol and types: v3.0, v2.6, v<=2.5\n- Uncompression of the IPC data stream\n- Internal representation of data via numpy arrays (lists, complex types) and numpy data types (atoms)\n- Supported on Python 2.7/3.4/3.5/3.6 and numpy 1.8+\n\nFor more details please refer to the `documentation`_.\n\n\nInstallation\n------------\n\nTo install qPython from PyPI:\n\n``$ pip install qpython``\n\n**Please do not use old PyPI package name: exxeleron-qpython.**\n\n\nBuilding package\n----------------\n\nDocumentation\n~~~~~~~~~~~~~\n\nqPython documentation is generated with help of `Sphinx`_ document generator.\nIn order to build the documentation, including the API docs, execute:\n``make html`` from the doc directory.\n\nDocumentation is built into the: ``doc/build/html/`` directory.\n\n\nCompile Cython extensions\n~~~~~~~~~~~~~~~~~~~~~~~~~\n\nqPython utilizes `Cython`_ to tune performance critical parts of the code.\n\nInstructions:\n\n- Execute: ``python setup.py build_ext --inplace``\n\n\nBuild binary distribution\n~~~~~~~~~~~~~~~~~~~~~~~~~\n\nInstructions:\n\n- Execute: ``python setup.py bdist``\n\n\nTesting\n~~~~~~~\n\nqPython uses py.test as a test runner for unit tests.\n\nInstructions:\n\n- Make sure that top directory is included in the ``PYTHONPATH``\n- Execute: ``py.test``\n\n\nRequirements\n~~~~~~~~~~~~\n\nqPython requires numpy 1.8 to run.\n\nOptional requirements have to be met to provide additional features:\n\n- tune performance of critical parts of the code:\n\n - Cython 0.20.1\n\n- support serialization/deserialization of ``pandas.Series`` and ``pandas.DataFrame``\n\n - pandas 0.14.0\n\n- run Twisted sample:\n\n - Twisted 13.2.0\n\n- build documentation via Sphinx:\n\n - Sphinx 1.2.3\n - mock 1.0.1\n\nRequired libraries can be installed using `pip`_.\n\nTo install all the required dependencies, execute:\n``pip install -r requirements.txt``\n\nMinimal set of required dependencies can be installed by executing:\n``pip install -r requirements-minimal.txt``\n\n.. _Cython: http://cython.org/\n.. _Sphinx: http://sphinx-doc.org/\n.. _pip: http://pypi.python.org/pypi/pip\n.. _documentation: http://qpython.readthedocs.org/en/latest/\n",
"bugtrack_url": null,
"license": "Apache License Version 2.0",
"summary": "kdb+ interfacing library for Python",
"version": "2.0.0",
"project_urls": {
"Homepage": "http://github.com/exxeleron/qPython"
},
"split_keywords": [
"kdb+"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "997fc9091cf56dfed58680d941153499a9091610d4ecb57977b54fc5a4753dc5",
"md5": "14c6876833f6a658d1b556a14bfb3c16",
"sha256": "9d30800a6796d568bb0a8587f4c0ac84ed267a6dfd0d3358cff547558c995755"
},
"downloads": -1,
"filename": "qPython-2.0.0.tar.gz",
"has_sig": false,
"md5_digest": "14c6876833f6a658d1b556a14bfb3c16",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 28572,
"upload_time": "2019-01-02T07:19:10",
"upload_time_iso_8601": "2019-01-02T07:19:10.997261Z",
"url": "https://files.pythonhosted.org/packages/99/7f/c9091cf56dfed58680d941153499a9091610d4ecb57977b54fc5a4753dc5/qPython-2.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2019-01-02 07:19:10",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "exxeleron",
"github_project": "qPython",
"travis_ci": true,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "qpython"
}
JSON
