IGNITE-14167 Simplify reconnecting, fix affinity topology change detection

This closes #16
15 files changed
tree: 3273889bfd758e9e1239a1195a8182d812d35cb1
  1. .asf.yaml
  2. .gitignore
  3. .travis.yml
  4. LICENSE
  5. README.md
  6. docs/
  7. examples/
  8. pyignite/
  9. requirements/
  10. setup.py
  11. tests/
  12. tox.ini
README.md

ignite-python-client

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

Prerequisites

  • Python 3.4 or above (3.6, 3.7 and 3.8 are 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-python-thin-client.git
$ 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.

Updating from older version

To upgrade an existing package, use the following command:

pip install --upgrade pyignite

To install the latest version of a package:

pip install pyignite

To install a specific version:

pip install pyignite==0.4.0

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 from the client's root directory:

$ pip install -r requirements/docs.txt
$ cd docs
$ make html

Then open docs/generated/html/index.html in your browser.

Examples

Some examples of using pyignite are provided in 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

NB! It is recommended installing pyignite in development mode. Refer to this section for instructions.

Do not forget to install test requirements:

$ pip install -r requirements/install.txt -r requirements/tests.txt

Also, you'll need to have a binary release of Ignite with lib4j2 enabled and IGNITE_HOME properly set:

$ cd <ignite_binary_release>
$ export IGNITE_HOME=$(pwd)
$ cp -r $IGNITE_HOME/libs/optional/ignite-log4j2 $IGNITE_HOME/libs/

Run basic tests

$ pytest

Run with examples

$ pytest --examples 

Run with ssl and not encrypted key

$ pytest --use-ssl=True --ssl-certfile=./tests/ssl/client_full.pem

Run with ssl and password-protected key

$ pytest --use-ssl=True --ssl-certfile=./tests/config/ssl/client_with_pass_full.pem --ssl-keyfile-password=654321

If you need to change the connection parameters, see the documentation on testing.