Apache Ignite thin (binary protocol) client, written in Python 3.
If you only want to use the
pyignite module in your project, do:
$ pip install pyignite
If you want to run tests, examples or build documentation, clone the whole repository:
$ git clone email@example.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
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
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
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.