From 1e63dc0f8d47e3f35daa34b98bee855a5e426696 Mon Sep 17 00:00:00 2001 From: grichardson36 Date: Mon, 13 Oct 2025 22:27:11 -0400 Subject: [PATCH] docs: add PROJECT_SUMMARY.md (build, tooling, quickstart) --- PROJECT_SUMMARY.md | 49 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 49 insertions(+) create mode 100644 PROJECT_SUMMARY.md diff --git a/PROJECT_SUMMARY.md b/PROJECT_SUMMARY.md new file mode 100644 index 0000000..abd369e --- /dev/null +++ b/PROJECT_SUMMARY.md @@ -0,0 +1,49 @@ +# multi-agent-postgres-data-analytics — Project Summary + +- Upstream: [disler/multi-agent-postgres-data-analytics](https://github.com/disler/multi-agent-postgres-data-analytics) +- Stars (upstream): 855 +- Description: The way we interact with our data is changing. +- Primary Languages: Python (21), TypeScript (10), JavaScript (1) +- Detected Stack: Python, Python + +## Tooling +- ESLint + +## Build +- Python: Build backend: poetry.core.masonry.api; Packaging: not configured (app-only) + +## Common Commands +- No Node scripts detected + +## Project Layout (top-level) +- api-server +- fe-clients +- imgs +- postgres_da_ai_agent +- .env.sample +- .gitignore +- LICENSE +- poetry.lock +- PROJECT_SUMMARY.md +- pyproject.toml +- README.md + +## CI/CD +- No CI workflows detected + +## Docker +- No Docker artifacts detected + +## Quickstart +``` +python -m venv .venv ; . .venv/Scripts/Activate.ps1 +pip install -U ruff black mypy pytest +pytest -q +``` + +## Suggested Next Steps +- Add .editorconfig +- Add GitHub Actions CI (lint, type, test) +- Add Ruff/Black/Mypy via pyproject.toml +- Add Dockerfile for containerized runs +