Skip to main content

Minimal Postgres stack combining Apache AGE graph + pgvector with simple async helpers.

Project description

QuixiAI VectorGraph

A minimal, batteries-included PostgreSQL stack that pairs Apache AGE (graph) with pgvector. Spin it up with Docker, hit a couple of Python helpers, and you have graph + vector storage in one place.

60-second start

  1. Install: pip install vectorgraph (or pipx install vectorgraph)
  2. Bring up services: vectorgraph up (Docker compose stack with graph/vector)
  3. Run tests: pytest -q (optional if you cloned)
  4. Tinker in Python (see below) or run vectorgraph demo then python demo.py.

Install options:

  • pip install vectorgraph (or pipx install vectorgraph for a global CLI).
  • CLI commands: vectorgraph up, vectorgraph down, vectorgraph logs -f, vectorgraph ps, vectorgraph demo.
    • Prefer async API for apps; sync helpers are available at vectorgraph.sync (see async/sync combined demo).

Python quickstart

import asyncio
from vectorgraph import create_db, delete_db, graph_create_entity, vector_add, vector_nearest_neighbors

async def main():
    db_id = await create_db()
    try:
        await graph_create_entity(db_id, "n1", "Hello", "Graph+Vector")
        await vector_add(db_id, "n1", [0.1]*768, {"label": "hello"})
        neighbors = await vector_nearest_neighbors(db_id, [0.1]*768, k=3)
        print(neighbors)
    finally:
        await delete_db(db_id)

asyncio.run(main())

Combined example: python examples/demo.py (async flow) and python examples/demo.py --sync (sync via vectorgraph.sync).

Use as a library

Install into your app (no CLI needed if you already run Postgres/AGE/pgvector):

pip install vectorgraph

Minimal usage (sync helpers):

from vectorgraph import sync as vg

db_id = vg.create_db()
vg.vector_add(db_id, "id1", [0.1]*768, {"tag": "demo"})
print(vg.vector_nearest_neighbors(db_id, [0.1]*768, k=1))
vg.delete_db(db_id)

Env vars respected by the helpers: POSTGRES_USER, POSTGRES_PASSWORD, POSTGRES_DB, POSTGRES_HOST, POSTGRES_PORT. If you’re pointing at an existing stack, set these to your running Postgres/AGE instance. Defaults match the bundled compose stack: POSTGRES_USER=vg_user, POSTGRES_PASSWORD=vg_password, POSTGRES_DB=vg_db, POSTGRES_HOST=127.0.0.1, POSTGRES_PORT=5432.

Clone the repo (optional)

If you want the source and tests locally:

  • Clone: git clone https://github.com/QuixiAI/vectorgraph.git && cd vectorgraph
  • Install editable: pip install -e .
  • Run tests: pytest -q

Files

  • db.py — public async API for graph + vector helpers (AGE + pgvector).
  • graph.py / vector.py — thin wrappers if you prefer to import per-domain.
  • schema.sql — enables extensions and embeds the TEI-friendly get_embedding function.
  • Dockerfile — Postgres 16 image with AGE, pgvector, pgsql-http.
  • docker-compose.yml — Postgres + HuggingFace TEI (embedding service).
  • tests/ — async end-to-end tests for graph and vector paths.
  • pyproject.toml — package metadata (dependencies via pip/uv/pdm) and CLI entrypoint.
  • vectorgraph/stack/ — packaged docker-compose.yml, Dockerfile, schema.sql used by the CLI.

Environment

Defaults are baked into the stack; you normally don’t need to touch .env. If a .env exists in your project root, vectorgraph up will copy it into its cache and use it; otherwise it uses the packaged defaults. The embedding container sits on a private Docker network (no host port) and is reachable from Postgres at http://embeddings:80.

Typical flow

  • vectorgraph up
  • run Python code using the helpers (or vectorgraph demo then python demo.py)
  • pytest -q to sanity check
  • vectorgraph down when done

Notes

  • Vectors are fixed at 768-dim; the TEI model (unsloth/embeddinggemma-300m) matches that.
  • Each call to create_db() makes a dedicated AGE graph + vector table keyed by UUID to keep tests isolated.

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

vectorgraph-0.1.6.tar.gz (20.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

vectorgraph-0.1.6-py3-none-any.whl (18.6 kB view details)

Uploaded Python 3

File details

Details for the file vectorgraph-0.1.6.tar.gz.

File metadata

  • Download URL: vectorgraph-0.1.6.tar.gz
  • Upload date:
  • Size: 20.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.9

File hashes

Hashes for vectorgraph-0.1.6.tar.gz
Algorithm Hash digest
SHA256 3c6ffcd223816c13ff5b0135068d5ab3b3675bada645f5cf514520b0b66327a4
MD5 55008c2d86e8001863d6d18275a7692d
BLAKE2b-256 8bf7f67c3d0f6c8f811e8023afa933b9ea4fb93d223381054f9e8b4f5721bc4c

See more details on using hashes here.

File details

Details for the file vectorgraph-0.1.6-py3-none-any.whl.

File metadata

  • Download URL: vectorgraph-0.1.6-py3-none-any.whl
  • Upload date:
  • Size: 18.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.9

File hashes

Hashes for vectorgraph-0.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 ce752d548213467b9f8cabdf5807df1b7a3af73b12b7f4f46e25e13420903b6b
MD5 6797fa5de5995421e075b80617304e6d
BLAKE2b-256 dbaa8371e7b4a08470aaed99d8826ad1c7f685132c985a5122d8354e5ac82868

See more details on using hashes here.

Supported by

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