Skip to content

Nebula Python

Nebula Python is a Python client for connecting to and managing the NebulaGraph database.


You have installed Python 3.6 or later versions.

Compatibility with NebulaGraph

NebulaGraph version Nebula Python version
3.0.2 3.0.0
2.6.x 2.6.0
2.0.x 2.0.0
2.0.0-rc1 2.0.0rc1

Install Nebula Python

Install Nebula Python with pip

$ pip install nebula3-python==<version>

Install Nebula Python from the source code

  1. Clone the Nebula Python source code to the host.

    • (Recommended) To install a specific version of Nebula Python, use the Git option --branch to specify the branch. For example, to install v3.0.0, run the following command:

      $ git clone --branch v3.0.0
    • To install the daily development version, run the following command to download the source code from the master branch:

      $ git clone
  2. Change the working directory to nebula-python.

    $ cd nebula-python
  3. Run the following command to install Nebula Python.

    $ pip install .

Core of the example code

This section shows the core of the example code. For all the code, see Example.

Last update: March 13, 2023
Back to top