Apache Ignite Python Thin Client

Clone this repo:
  1. 4b60f30 IGNITE-12809 Python thin client - Fix wrong order of the SQL query result (#8203) by Nikolay · 3 months ago ignite-13735 master
  2. 0a9d71f IGNITE-12718 pyignite: added SSL keyfile password argument. (#7480) by Andrey Kuznetsov · 3 months ago
  3. 2db9114 IGNITE-10691: Python thin client: UUID marshalling fix by Dmitry Melnichuk · 1 year, 9 months ago
  4. b84185f IGNITE-10645: SQL: Avoid key/val ownership resolution of a field in runtime. This closes #5657. by Pavel Kuznetsov · 1 year, 10 months ago
  5. 4ebd0d0 IGNITE-10358: Added collections data type specification for python thin client by Dmitry Melnichuk · 2 years ago


Apache Ignite thin (binary protocol) client, written in Python 3.


  • Python 3.4 or above (3.6 is tested),
  • Access to Apache Ignite node, local or remote. The current thin client version was tested on Apache Ignite 2.7.0 (binary client protocol 1.2.0).


for end user

If you only want to use the pyignite module in your project, do:

$ pip install pyignite

for developer

If you want to run tests, examples or build documentation, clone the whole repository:

$ git clone git@github.com:apache/ignite.git
$ cd ignite/modules/platforms/python
$ pip install -e .

This will install the repository version of pyignite into your environment in so-called “develop” or “editable” mode. You may read more about editable installs in the pip manual.

Then run through the contents of requirements folder to install the additional requirements into your working Python environment using

$ pip install -r requirements/<your task>.txt

You may also want to consult the setuptools manual about using setup.py.


The package documentation is available at RTD for your convenience.

If you want to build the documentation from source, do the developer installation as described above, then run the following commands:

$ cd ignite/modules/platforms/python
$ pip install -r requirements/docs.txt
$ cd docs
$ make html

Then open ignite/modules/platforms/python/docs/generated/html/index.html in your browser.


Some examples of using pyignite are provided in ignite/modules/platforms/python/examples folder. They are extensively commented in the “Examples of usage” section of the documentation.

This code implies that it is run in the environment with pyignite package installed, and Apache Ignite node is running on localhost:10800.



$ cd ignite/modules/platforms/python
$ python setup.py pytest

NB! All tests require Apache Ignite node running on localhost:10800. If you need to change the connection parameters, see the documentation on testing.