nebula3-python

What it is and what it does

nebula3-python is the official Python client for NebulaGraph v3, a distributed graph database. It provides connection pooling, session management, and query execution against NebulaGraph servers, with support for both graph queries and storage-layer scanning. The library handles result parsing and offers utilities to extract and format query results for downstream processing or visualization.

Typical workflows involve creating a connection pool to a NebulaGraph cluster, obtaining a session, executing nGQL queries (NebulaGraph's query language), and processing results. The package supports parameterized queries, session context managers for automatic cleanup, and result transformation methods like dict_for_vis() for graph visualization. It's designed for both interactive analysis and production web services accessing a single graph space.

Use it for:

• Connect to a NebulaGraph cluster and execute graph traversal queries from Python applications
• Build a web service that maintains a session pool for efficient multi-user access to a single graph space
• Extract and transform query results into Pandas DataFrames or visualization-ready JSON structures
• Scan vertices and edges directly from NebulaGraph storage for bulk graph analysis
• Execute parameterized queries with server-side evaluation for dynamic graph exploration

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

A Python client library for connecting to and querying NebulaGraph v3 databases, supporting session pooling, parameterized queries, and result extraction for visualization.

Yes, if you are working with NebulaGraph v3. The package is actively maintained, has no known vulnerabilities, installs with low friction, and is licensed permissively. It is the canonical client for Python-to-NebulaGraph integration. Verify version compatibility with your NebulaGraph server before installing.

Install

nebula3-python on PyPI

pip install nebula3-python

uv add nebula3-python

poetry add nebula3-python

Installing nebula3-python

Before you install

Low install friction with a pure-wheel distribution. Actively maintained with recent commits and no known vulnerabilities. Depends on five common utilities (future, httplib2, pytz, six, httpx) with no exotic system dependencies.

License in practice

Licensed under Apache 2.0 (permissive), allowing commercial and private use with minimal restrictions—suitable for most projects.

Quickstart

pip install nebula3-python

from nebula3.gclient.net import ConnectionPool
from nebula3.Config import Config

config = Config()
connection_pool = ConnectionPool()
connection_pool.init([('127.0.0.1', 9669)], config)
session = connection_pool.get_session('root', 'nebula')
result = session.execute('SHOW TAGS')
print(result)
session.release()
connection_pool.close()

Requires a running NebulaGraph v3 server accessible at the specified host and port; Python >= 3.6.2.

Verify before relying

• Exact compatibility matrix between nebula3-python versions and NebulaGraph server versions
• Performance characteristics under high concurrency or large result sets
• Whether Pandas integration is built-in or requires separate installation

Package facts

Evidence: nebula3_python-3.8.3-py3-none-any.whl

Tags

More Database packages