Ignite Quick Start Guide for Python | Ignite Documentation

Ignite Summit 2023 — Watch on demand — Register now!


Ignite Quick Start Guide for Python

This chapter explains system requirements for running Ignite and how to install Ignite, start a cluster, and run a simple Hello World example using a thin client for Python.

Thin Client is a lightweight Ignite connection mode. It does not participate in the cluster, never holds any data, or performs computations. All it does is establish a socket connection to one or multiple Ignite nodes and perform all operations through those nodes.


Ignite was tested on:


Oracle JDK 8, 11 or 17 Open JDK 8, 11 or 17, IBM JDK 8, 11 or 17


Linux (any flavor), Mac OSX (10.6 and up), Windows (XP and up), Windows Server (2008 and up), Oracle Solaris


x86, x64, SPARC, PowerPC


No restrictions (10G recommended)



Version 3.4 or above

Installing Ignite

To get started with the Apache Ignite binary distribution:

  1. Download the Ignite binary as a zip archive.

  2. Unzip the zip archive into the installation folder in your system.

  3. (Optional) Enable required modules.

  4. (Optional) Set the IGNITE_HOME environment variable or Windows PATH to point to the installation folder and make sure there is no trailing / (or \ for Windows) in the path.

Once that’s done, execute the following command to install the Python Thin Client package. This thin client is abbreviated as pyignite:

pip3 install pyignite
pip install pyignite

Starting a Node

Before connecting to Ignite via the Python thin client, you must start at least one Ignite cluster node.

You can start a node from the command line using the default configuration or by passing a custom configuration file. You can start as many nodes as you like and they will all automatically discover each other.

Navigate into the bin folder of the Ignite installation directory from the command shell. Your command might look like this:

cd {IGNITE_HOME}/bin/
cd {IGNITE_HOME}\bin\

Start a node with a custom configuration file that is passed as a parameter to ignite.sh|bat like this:

./ignite.sh ../examples/config/example-ignite.xml
ignite.bat ..\examples\config\example-ignite.xml

You will see output similar to this:

[08:53:45] Ignite node started OK (id=7b30bc8e)
[08:53:45] Topology snapshot [ver=1, locNode=7b30bc8e, servers=1, clients=0, state=ACTIVE, CPUs=4, offheap=1.6GB, heap=2.0GB]

Open another tab from your command shell and run the same command again:

./ignite.sh ../examples/config/example-ignite.xml
ignite.bat ..\examples\config\example-ignite.xml

Check the Topology snapshot line in the output. Now you have a cluster of two server nodes with more CPUs and RAM available cluster-wide:

[08:54:34] Ignite node started OK (id=3a30b7a4)
[08:54:34] Topology snapshot [ver=2, locNode=3a30b7a4, servers=2, clients=0, state=ACTIVE, CPUs=4, offheap=3.2GB, heap=4.0GB]
By default, ignite.sh|bat starts a node with the default configuration file: config/default-config.xml.

Running Your First Application

Once the cluster is started, you can use the Ignite Python thin client to perform cache operations.

Assuming that the server node is running locally, here is a HelloWorld example that puts and gets values from the cache:

from pyignite import Client

client = Client()
client.connect('', 10800)

#Create cache
my_cache = client.create_cache('my cache')

#Put value in cache
my_cache.put(1, 'Hello World')

#Get value from cache
result = my_cache.get(1)

To run this, you can save the example as a text file (hello.py for example) and run it from the command line:

python3 hello.py

Or you can enter the example into your Python interpreter/shell (IDLE on Windows, for example) and modify/execute it there.

Further Examples

Explore more Ignite Python examples here.