Skip to main content

Plug and play NebulaGraph with pip install.

Project description

NebulaGraph-Lite-logo

NebulaGraph Lite

Open in Colab Jupyter for NebulaGraph pdm-managed

GitHub release (latest by date) pypi-version python-version

Build Checks

Try NebulaGraph with pip install, on Linux/ WSL2 or even Google Colab!

How to use

Install NebulaGraph Lite

pip3 install nebulagraph-lite

Start NebulaGraph Lite

From Jupyter Notebook: From CLI:
from nebulagraph_lite import nebulagraph_let as ng_let

n = ng_let()

n.start()
nebulagraph start  

Voilà! It'ts up and running already now!

What's next

Play with nebula3-python or ipython-ngql and walk through the Documentation!

pip3 install ipython-ngql
%load_ext ngql

And we could access it like:

%ngql --address 127.0.0.1 --port 9669 --user root --password nebula

And query like:

%ngql SHOW HOSTS;

Other non-lite or less-lite options

Intrested in other play or production options?

Production

Play and Dev

  • Docker Compose, if you are comfortable on single server
  • nebula-up, one-liner test env installer on single server, support studio, dashboard, nebulagraph algorithm, exchange etc, all-in-one.
  • Docker Extension, one-click on Docker Desktop(macOS, windows) on desktop machines, in GUI flavor.
  • Nebula-Operator-KinD, Nebula K8s Operator with K8s-in-Docker, one-liner test env with docker+k8s+nebulagrpah-operator, try NebulaGraph on K8s with ease on your single server.

Acknowledgements

Supported Platforms

Ubuntu ✔ Google Colab ✔ RockyLinux ✔ NestedContainer ✔ WSL2 ✔

FAQ

Click to see FAQ

Why not docker?

With udocker, the opinionated subset docker running in user space, we could run docker images without root privilege, docker daemon.

Thus we support running inside docker container, WSL2, Google Colab.

Can NebulaGraph-Lite run inside a container?

Yes! Say we are in a container that runs Ubuntu, we could run:

docker run -it --rm ubuntu:latest bash
# inside the container
apt update && apt install python3-pip curl -y
pip3 install nebulagraph-lite
python3

In python3:

from nebulagraph_lite import nebulagraph_let as ng_let
n = ng_let(in_container=True)
n.start()

Or in shell:

nebulagraph --container start

Does it support Windows?

Yes, it supports Windows with WSL2 or other Linux VMs with a Hypervisor.

How to clean up?

  • Step 1, from nebulagraph-lite, remove the udocker container and clean up the base path.

Python:

n.stop()
n.clean_up()

Shell:

nebulagraph stop
nebulagraph cleanup
  • Step 2, pip uninstall nebulagraph-lite and dependencies.
pip3 uninstall nebulagraph-lite udocker
  • Step 3, remove the udocker files.
rm -rf ~/.udocker

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nebulagraph_lite-0.1.2.tar.gz (14.4 kB view details)

Uploaded Source

Built Distribution

nebulagraph_lite-0.1.2-py3-none-any.whl (14.2 kB view details)

Uploaded Python 3

File details

Details for the file nebulagraph_lite-0.1.2.tar.gz.

File metadata

  • Download URL: nebulagraph_lite-0.1.2.tar.gz
  • Upload date:
  • Size: 14.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: pdm/2.11.2 CPython/3.10.12

File hashes

Hashes for nebulagraph_lite-0.1.2.tar.gz
Algorithm Hash digest
SHA256 2bd9b436c5e1093a88feb94478d40a9eae66f88d71efedb2e1b77b4fbc9ddd70
MD5 05b299f1d2157f2f2fdfb32ae0202e8a
BLAKE2b-256 451072777de9649672089bf7f7e262c037978c9c0923bc9491fa21f32a9751e7

See more details on using hashes here.

File details

Details for the file nebulagraph_lite-0.1.2-py3-none-any.whl.

File metadata

File hashes

Hashes for nebulagraph_lite-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 1461e9114a8863fccdf2d6b4a5e62db064de226967a1f7e741ae59ff1e17e540
MD5 2f3d1c2fc98cdc4fb6c7412c46a45f37
BLAKE2b-256 6369fa2ae3448772dad363928b6d99e1dd0a39760514bbcdab0ee03782f6ec03

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page