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: pipx install . (or pip install . in a venv)
  2. Bring up services: vectorgraph up (Docker compose stack with graph/vector)
  3. Run tests: pytest -q
  4. Tinker in Python (see below) or run vectorgraph demo then python demo.py.

Install options:

  • pipx install . (recommended for CLI) or pip install . in a venv.
  • 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 (async):

import asyncio
from vectorgraph import vector_add, vector_nearest_neighbors, create_db

async def main():
    db_id = await create_db()
    await vector_add(db_id, "id1", [0.1]*768, {"tag": "demo"})
    print(await vector_nearest_neighbors(db_id, [0.1]*768, k=1))

asyncio.run(main())

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.

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.3.tar.gz (20.0 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.3-py3-none-any.whl (18.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: vectorgraph-0.1.3.tar.gz
  • Upload date:
  • Size: 20.0 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.3.tar.gz
Algorithm Hash digest
SHA256 c9d4c7ffbc34a7ef1eba0c95ac49946154cd532f75e644860a47a840e67ce42f
MD5 aa13ab739adcf964b94ab584c43374b8
BLAKE2b-256 e8a64309b2a537764c7089dc838bea953244c097efdc4c2340dd0a66807acfea

See more details on using hashes here.

File details

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

File metadata

  • Download URL: vectorgraph-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 18.4 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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 071394b2d9e1209675bdf28bfe0df997c5df1e078a08eaa5d609c84bf5c8d615
MD5 3f2e778fe036bee0b8d8fd4a4fdcc9a0
BLAKE2b-256 0dd2f4e82be0d98cb93fca5e035138612fd2a9f4c786011bdff16f4054364808

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