Installation¶

Prerequisites¶

Python 3.11+
A graph database (Neo4j or ArangoDB) if you plan to use database features

Installation Methods¶

Using pip¶

pip install graphcast

Using uv (recommended)¶

uv add graphcast

From Source¶

Clone the repository:

git clone https://github.com/growgraph/graphcast.git
cd graphcast

Install with development dependencies:
```
uv sync --group dev
```

Optional Dependencies¶

GraphCast has some optional dependencies that can be installed based on your needs. In order to be able to generate schema visualizations, add graphviz deps (you will need graphviz package installed on your computer, e.g. apt install graphviz-dev)

pip install graphcast[graphviz]

Verifying Installation¶

To verify your installation, you can run:

import graphcast
print(graphcast.__version__)

Spinning up databases¶

Instructions on how spin up ArangoDB and neo4j as docker images using docker compose are provided here github.com/growgraph/graphcast/docker

Configuration¶

After installation, you may need to configure your graph database connection. See the Quick Start Guide for details on setting up your environment.

For more detailed troubleshooting, refer to the API Reference or open an issue on GitHub.