Package: pyignite
ignite-python-clientApache Ignite thin (binary protocol) client, written in Python 3.PrerequisitesPython 3.7 or above (3.7, 3.8, 3.9, 3.10 and 3.11 are tested),Access to Apache Ignite node, local or remote. The current thin client
version was tested on Apache Ignite 2.14 (binary client protocol 1.7.0).Installationfor end userIf you only want to use thepyignitemodule in your project, do:$pipinstallpyignitefor developerIf you want to run tests, examples or build documentation, clone
the whole repository:$gitclonegit@github.com:apache/ignite-python-thin-client.git
$pipinstall-e.This will install the repository version ofpyigniteinto your environment
in so-called “develop” or “editable” mode. You may read more abouteditable installsin thepipmanual.Then run through the contents ofrequirementsfolder to install
the additional requirements into your working Python environment using$pipinstall-rrequirements/<yourtask>.txtYou may also want to consult thesetuptoolsmanual about usingsetup.py.optional C extensionThere is an optional C extension to speedup some computational intensive tasks. If it's compilation fails
(missing compiler or CPython headers),pyignitewill be installed without this module.On Linux or MacOS X only C compiler is required (gccorclang). It compiles during standard setup process.For building universalwheels(binary packages) for Linux, just invoke script./scripts/create_distr.sh.NB!Docker is required.On Windows MSVC 14.x required, and it should be in path, also python versions 3.7, 3.8, 3.9, 3.10 and 3.11 both for x86 and
x86-64 should be installed. You can disable some of these versions but you'd need to edit script for that.For buildingwheelsfor Windows, invoke script.\scripts\BuildWheels.ps1using PowerShell. Just make sure that
your execution policy allows execution of scripts in your environment.Ready wheels forx86andx86-64for different python versions (3.7, 3.8, 3.9 and 3.10) will be
located indistrdirectory.Updating from older versionTo upgrade an existing package, use the following command:pipinstall--upgradepyigniteTo install the latest version of a package:pipinstallpyigniteTo install a specific version:pipinstallpyignite==0.6.1DocumentationThe package documentationis available atRTDfor 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:$pipinstall-rrequirements/docs.txt
$cddocs
$makehtmlThen opendocs/generated/html/index.htmlin your browser.ExamplesSome examples of using pyignite are provided inexamplesfolder. They are
extensively commented in the
“Examples of usage”
section of the documentation.This code implies that it is run in the environment withpyignitepackage
installed, and Apache Ignite node is running on localhost:10800.TestingNB!It is recommended installingpyignitein development mode.
Refer tothis sectionfor instructions.Do not forget to install test requirements:$pipinstall-rrequirements/install.txt-rrequirements/tests.txtAlso, you'll need to have a binary release of Ignite withlog4j2enabled and to setIGNITE_HOMEenvironment variable:$cd<ignite_binary_release>
$exportIGNITE_HOME=$(pwd)$cp-r$IGNITE_HOME/libs/optional/ignite-log4j2$IGNITE_HOME/libs/Run basic tests$pytestRun with examples$pytest--examplesIf you need to change the connection parameters, see the documentation ontesting.