commit | 99ed735a3ac34542c633e8bb0c94c7707f32a7da | [log] [tgz] |
---|---|---|
author | Igor Sapego <igorsapg@gmail.com> | Mon Jan 25 17:14:11 2021 +0300 |
committer | Igor Sapego <igorsapg@gmail.com> | Mon Jan 25 17:14:11 2021 +0300 |
tree | 35a2df5e696bcb0ac0387029cde55dacd9868000 | |
parent | 51e9c829725c7f24724446656149c621a39389af [diff] |
IGNITE-11303: Partition Awareness for Python Thin
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 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
.
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.
NB! All tests require Apache Ignite node running on localhost:10800. For the convenience, docker-compose.yml
is present. So installing docker
and docker-compose
is recommended. Also, it is recommended installing pyignite
in development mode. You can do that using following command:
$ pip install -e .
$ docker-compose down && docker-compose up -d ignite $ pytest
$ docker-compose down && docker-compose up -d ignite $ pytest --examples
$ docker-compose down && docker-compose up -d ignite $ pytest --use-ssl=True --ssl-certfile=./tests/config/ssl/client_full.pem
$ docker-compose down && docker-compose up -d ignite $ 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.