{"id":28700753,"url":"https://github.com/nebula-contrib/nebulagraph-lite","last_synced_at":"2025-06-14T11:40:45.891Z","repository":{"id":216487177,"uuid":"741369856","full_name":"nebula-contrib/nebulagraph-lite","owner":"nebula-contrib","description":"The minimal, ad-hoc way of plug and play NebulaGraph with pip install, even inside Colab Notebook!","archived":false,"fork":false,"pushed_at":"2024-05-24T05:49:09.000Z","size":1319,"stargazers_count":17,"open_issues_count":4,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-06-12T18:16:28.397Z","etag":null,"topics":["colab","graphdatabase","nebulagraph"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nebula-contrib.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2024-01-10T08:56:17.000Z","updated_at":"2025-03-15T02:00:21.000Z","dependencies_parsed_at":"2024-01-29T10:47:18.334Z","dependency_job_id":null,"html_url":"https://github.com/nebula-contrib/nebulagraph-lite","commit_stats":null,"previous_names":["wey-gu/nebulagraph-lite","nebula-contrib/nebulagraph-lite"],"tags_count":14,"template":false,"template_full_name":null,"purl":"pkg:github/nebula-contrib/nebulagraph-lite","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nebula-contrib%2Fnebulagraph-lite","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nebula-contrib%2Fnebulagraph-lite/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nebula-contrib%2Fnebulagraph-lite/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nebula-contrib%2Fnebulagraph-lite/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nebula-contrib","download_url":"https://codeload.github.com/nebula-contrib/nebulagraph-lite/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nebula-contrib%2Fnebulagraph-lite/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259810961,"owners_count":22915134,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["colab","graphdatabase","nebulagraph"],"created_at":"2025-06-14T11:40:44.554Z","updated_at":"2025-06-14T11:40:45.885Z","avatar_url":"https://github.com/nebula-contrib.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv\u003e\n  \u003cimg src=\"https://github.com/nebula-contrib/nebulagraph-lite/assets/1651790/97b5dccb-bca1-4141-b426-03bcb3761a10\" alt=\"NebulaGraph-Lite-logo\" height=\"100\" style=\"float:left;\"\u003e\n  \u003ch1 style=\"margin-left:110px;\"\u003eNebulaGraph Lite\u003c/h1\u003e\n\u003c/div\u003e\n\nTry NebulaGraph with `pip install`, on Linux/ WSL2 or even [Google Colab](https://colab.research.google.com/github/nebula-contrib/nebulagraph-lite/blob/main/examples/NebulaGraph_Lite.ipynb) or [ModelScope Notebook](https://modelscope.cn/my/mynotebook/preset), in container, rootless.\n\n[![Open in Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/nebula-contrib/nebulagraph-lite/blob/main/examples/NebulaGraph_Lite.ipynb)\n[![ModelScope](https://img.shields.io/badge/ModelScope-Notebook-blue?logo=jupyter)](https://github.com/nebula-contrib/nebulagraph-lite/blob/main/examples/NebulaGraph_Lite.ipynb)\n[![Jupyter](https://img.shields.io/badge/Jupyter-Supported-brightgreen?logo=jupyter)](https://github.com/nebula-contrib/nebulagraph-lite/blob/main/examples/NebulaGraph_Lite.ipynb)\n[![for NebulaGraph](https://img.shields.io/badge/Toolchain-NebulaGraph-blue)](https://github.com/vesoft-inc/nebula)\n[![pdm-managed](https://img.shields.io/badge/pdm-managed-blueviolet)](https://pdm.fming.dev)\n\n\n[![GitHub release (latest by date)](https://img.shields.io/github/v/release/nebula-contrib/nebulagraph-lite?label=release)](https://github.com/nebula-contrib/nebulagraph-lite/releases)\n[![pypi-version](https://img.shields.io/pypi/v/nebulagraph-lite)](https://pypi.org/project/nebulagraph-lite/)\n[![python-version](https://img.shields.io/badge/python-3.8%20|%203.9%20|%203.10%20|%203.11%20|%203.12-blue)](https://www.python.org/)\n\n[![Build Checks](https://github.com/nebula-contrib/nebulagraph-lite/actions/workflows/release.yaml/badge.svg)](https://github.com/nebula-contrib/nebulagraph-lite/actions/workflows/release.yaml)\n\n## How to use\n\n\u003e Install NebulaGraph Lite\n\n```bash\npip3 install nebulagraph-lite\n```\n\n\u003e Start NebulaGraph Lite\n\n\u003ctable\u003e\n\u003ctr\u003e\n\u003ctd\u003e From Jupyter Notebook: \u003c/td\u003e \u003ctd\u003e From CLI: \u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\n\n```python\nfrom nebulagraph_lite import nebulagraph_let as ng_let\n\nn = ng_let()\n\nn.start()\n```\n\n\u003c/td\u003e\n\u003ctd\u003e\n\n\n```bash\n\nnebulagraph start  \n\n```\n\n\n\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/table\u003e\n\nVoilà! It'ts up and running already now!\n\n\n## Free NebulaGraph Playground in 5 minutes\n\n\u003e Thanks to [Google Colab](https://colab.research.google.com/) and [ModelScope Notebook](https://modelscope.cn/my/mynotebook/preset), we could have a free NebulaGraph playground in 5 minutes.\n\nGo with 👉 [![Open in Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/nebula-contrib/nebulagraph-lite/blob/main/examples/NebulaGraph_Lite.ipynb).\n\n\u003cdetails\u003e\n  \u003csummary\u003eIn China?\u003c/summary\u003e\n\nGo with 👉 [![Open in ModelScope](https://img.shields.io/badge/ModelScope-Notebook-blue?logo=jupyter)](https://github.com/nebula-contrib/nebulagraph-lite/blob/main/examples/NebulaGraph_Lite.ipynb)\n\n\u003c/details\u003e\n\n## What's next\n\nPlay with `nebula3-python` or [jupyter-nebulagraph](https://jupyter-nebulagraph.readthedocs.io) and walk through the [Documentation](https://docs.nebula-graph.io/)!\n\n```bash\npip3 install jupyter-nebulagraph\n%load_ext ngql\n```\n\nAnd we could access it like:\n\n```python\n%ngql --address 127.0.0.1 --port 9669 --user root --password nebula\n```\n\nAnd query like:\n\n```python\n%ngql SHOW HOSTS;\n```\n\n## Other non-lite or less-lite options\n\nIntrested in other play or production options?\n\n### Production\n\n- [Binary Packages](https://www.nebula-graph.io/download), if running on bare OS.\n- [K8s Operator](https://github.com/vesoft-inc/nebula-operator), on K8s.\n- [NebulaGrpah Cloud](https://www.nebula-graph.io/cloud), the managed NebulaGraph service.\n\n### Play and Dev\n\n- [Docker Compose](https://github.com/vesoft-inc/nebula-docker-compose), if you are comfortable to play with Docker on single server.\n- [nebula-up](https://github.com/nebula-contrib/nebula-up), one-liner test env installer on single server, support studio, dashboard, nebulagraph algorithm, exchange etc, all-in-one.\n- [Docker Extension](https://github.com/nebula-contrib/nebulagraph-docker-ext), one-click on Docker Desktop(macOS, windows) on desktop machines, in GUI flavor.\n- [Nebula-Operator-KinD](https://github.com/nebula-contrib/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.\n\n## Acknowledgements\n\n- udocker, https://github.com/indigo-dc/udocker, the foundation of this project\n- Fakechroot, https://github.com/dex4er/fakechroot, the engine runs MetaD and StorageD\n- PRoot, https://proot-me.github.io, the engine runs GraphD and Console\n- docker-in-colab, https://github.com/drengskapur/docker-in-colab, inspired our Colab capablity\n- NebulaGraph Docker, https://github.com/vesoft-inc/nebula-docker-compose, the container images we leveraged\n\n## Supported Platforms\n\n[![Ubuntu ✔](https://img.shields.io/badge/Ubuntu-✔-green?logo=ubuntu)](https://github.com/nebula-contrib/nebulagraph-lite)\n[![Google Colab ✔](https://img.shields.io/badge/Google%20Colab-✔-green?logo=googlecolab)](https://colab.research.google.com/github/nebula-contrib/nebulagraph-lite/blob/main/examples/NebulaGraph_Lite.ipynb)\n[![ModelScope Notebook ✔](https://img.shields.io/badge/ModelScope%20Notebook-✔-green?logo=jupyter)](https://github.com/nebula-contrib/nebulagraph-lite/blob/main/examples/NebulaGraph_Lite.ipynb)\n[![RockyLinux ✔](https://img.shields.io/badge/RockyLinux-✔-green?logo=rockylinux)](https://github.com/nebula-contrib/nebulagraph-lite)\n[![Nested**Container** ✔](https://img.shields.io/badge/NestedContainer-✔-green?logo=docker)](https://github.com/nebula-contrib/nebulagraph-lite)\n[![WSL2 ✔](https://img.shields.io/badge/WSL2-✔-green?logo=windows)](https://github.com/nebula-contrib/nebulagraph-lite)\n\n## FAQ\n\n\u003cdetails\u003e\n  \u003csummary\u003eClick to see FAQ\u003c/summary\u003e\n\n### Why not docker?\n\nWith udocker, the opinionated subset docker running in user space, we could run docker images without root privilege, docker daemon.\n\nThus we support running inside docker container, WSL2, Google Colab.\n\n### Can NebulaGraph-Lite run inside a container?\n\nYes! Say we are in a container that runs Ubuntu, we could run:\n\n```bash\ndocker run -it --rm ubuntu:latest bash\n# inside the container\napt update \u0026\u0026 apt install python3-pip curl -y\npip3 install nebulagraph-lite\npython3\n```\n\nIn python3:\n\n```python\nfrom nebulagraph_lite import nebulagraph_let as ng_let\nn = ng_let(in_container=True)\nn.start()\n```\n\nOr in shell:\n\n```bash\nnebulagraph --container start\n```\n\n### Does it support Windows?\n\nYes, it supports Windows with WSL2 or other Linux VMs with a Hypervisor.\n\n### How to clean up?\n\n- Step 1, from nebulagraph-lite, remove the udocker container and clean up the base path.\n\nPython:\n\n```python\nn.stop()\nn.clean_up()\n```\n\nShell:\n\n```bash\nnebulagraph stop\nnebulagraph cleanup\n```\n\n- Step 2, pip uninstall nebulagraph-lite and dependencies.\n\n```bash\npip3 uninstall nebulagraph-lite udocker\n```\n\n- Step 3, remove the udocker files.\n\n```bash\nrm -rf ~/.udocker\n```\n\n\u003c/details\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnebula-contrib%2Fnebulagraph-lite","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnebula-contrib%2Fnebulagraph-lite","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnebula-contrib%2Fnebulagraph-lite/lists"}