Package: pygridgain
pygridgainGridGain Community Edition thin (binary protocol) client, written in Python 3.PrerequisitesPython 3.7 or above (3.7, 3.8, 3.9 and 3.10 are tested),Access to GridGain node, local or remote. The current thin client
version was tested on GridGain CE 8.7 and 8.8 (binary client protocol 1.7.1).InstallationFrom repositoryThis is a recommended way for users. If you only want to use thepygridgainmodule in your project, do:$ pip install pygridgainFrom sourcesThis way is more suitable for developers or if you install client from zip archive.Download and/or unzip GridGain Python client sources togridgain_client_pathGo togridgain_client_pathfolderExecutepip install -e .$cd<gridgain_client_path>
$pipinstall-e.This will install the repository version ofpygridgaininto 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$ pip install -r requirements/<your task>.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),pygridgainwill 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 and 3.10 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:pip install --upgrade pygridgainTo install the latest version of a package:pip install pygridgainTo install a specific version:pip install pygridgain==1.4.0DocumentationThe 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:$ pip install -r requirements/docs.txt
$ cd docs
$ make htmlThen open<client_root_directory>/docs/generated/html/index.htmlin your browser.ExamplesSome examples of using pygridgain 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 withpygridgainpackage
installed, and GridGain node is running on localhost:10800.TestingNB!It is recommended installingpygridgainin 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<gridgain_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.