Developer Guide

GraphScope has been developed by an active team of software engineers and researchers. Any contributions from the open-source community to improve this project are greatly appreciated!

GraphScope is licensed under Apache License 2.0.

Building and Testing

GraphScope has many dependencies.

To make life easier, we provide two docker images with all required dependencies installed.

  • graphscope-vineyard as the builder, and

  • graphscope-runtime as the base image for runtime.

For developers, they just need to git clone the latest version of code from our repo, make their changes to the code and build with command in the root:

make graphscope

This command triggers the building process. It will build the current source code in a container with image graphscope-vineyard, and copy built binaries into a new image based from graphscope-runtime. The generated releasing image is tagged as graphscope/graphscope:SHORTSHA

GraphScope python client is separate with the engines image. If you are developing python client and not modifying the proto files, the engines image doesn’t need to rebuild. You may want to re-install the python client on local.

cd python
python3 install

To test the newly built binaries, manually open a session and assigned your image:

import graphscope

sess = graphscope.session(k8s_gs_image='graphscope/graphscope:SHORTSHA')

# ...

Or use the test script to pass all test cases.

./scripts/ --all --image graphscope/graphscope:SHORTSHA

Building and Testing GraphScope Locally with Docker

We provide a docker images based on ubuntu:20.04 with all required dependencies installed.


For developers, they just need to start a container with docker run and git clone the latest version of code from our repo, make their changes to the code and build with command:

docker pull
# set docker container shared memory: 10G
docker run --shm-size 10240m -it /bin/bash
# inner container
git clone
git clone
# building
export GRAPHSCOPE_HOME=/opt/graphscope
cd GraphScope && make INSTALL_PREFIX=/opt/graphscope install
# testing:
#   export GS_TEST_DIR=<path_to_your_gstest_dir>
cd GraphScope/python && python3 -m pytest -s -v ./tests/unittest

Build Python Wheels

GraphScope’s python client can run on Linux and MacOS, which can be installed from wheel packages we distributed on pypi. For developers, the wheel packages could be built via the following procedure:


The wheel packages for Linux is built inside the manylinux2010 environment. The pre-built docker image is available via

docker pull

Or, you can build the image from scratch. Assuming you are in the root directory of GraphScope repository, You could build the docker image (note that you only need to rebuild the docker image when you update dependencies in manylinux2010.Dockerfile) by

cd k8s
make graphscope-manylinux2010

The wheel packages for python{36,37,38,39} could be build by the following command:

cd k8s
make graphscope-manylinux2010-py{36,37,38,39}


The wheel packages for MacOS could be built directly on Mac. Assuming you are in the root directory of GraphScope repository:

python3 bdist_wheel

To make sure the maximum compatibility you may need:

python3 bdist_wheel --plat-name macosx-10.9-x86_64

Note that if you want to build wheel packages for different Python versions, you may need to install multiple version of Python using conda or pyenv.

The GraphScope analytical engine and interactive engine could be built locally on mac with script.

If GraphScope’s dependencies are not satisfied,you could use the to install dependencies of GraphScope.

Deploy the GraphScope with the script

Code Format

GraphScope follows the Google Style Guide for C++ and black for python.

Please reformat your code with clang-format and black if your Pull Request violates the CI.