Analytical Pattern Management API

This is the documentation site for the Analytical Pattern Management service. The service provides a RESTful API for managing Analytical Patterns in a Neo4j graph database.

What are Analytical Patterns?

An Analytical Pattern (AP) is a graph-based representation of a sequence of data transformations. An AP is composed of Operators, which can take one or several inputs to produce an output.

Analytical Patterns are used to understand, document, and analyze complex data workflows and data provenance.

Quick Links

• API - OpenAPI specification
• Configuration - How to configure the service
• Deployment - Deployment guides for various environments
• Architecture - Technical architecture details

Getting Started

The best solution is to use the provided .devcontainer file. The neo4j database will already be configured.

To run it locally without the devcontainer:

# Requirements python >=3.13, uv, neo4j instance running
uv sync --all-groups
cp .env.example .env
# (Fill all the required variable in .env)
uv run ap_management/main.py

The API will be available at http://localhost:5000/api/v1

Interactive Documentation

• Swagger UI: http://localhost:5000/docs
• ReDoc: http://localhost:5000/redoc