Skip to main content

Apache Ignite binary client Python API

Project description

ignite-python-client

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

Prerequisites

  • 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).

Installation

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.

Documentation

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.

Examples

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.

Testing

Run

$ 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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
pyignite-0.3.4-py3-none-any.whl (69.8 kB) Copy SHA256 hash SHA256 Wheel py3
pyignite-0.3.4.tar.gz (43.9 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page