sqlalchemy-studio 0.1.5

FastAPI studio for inspecting SQLAlchemy databases

sqlalchemy-studio

Backend utilities for inspecting and serving database tables via a FastAPI Studio.

This package exposes a small FastAPI app that can be embedded in your application or run standalone to inspect a SQLAlchemy-accessible database.

Quick summary

• API endpoints (when using the packaged server):
  • GET /api/tables — list tables and columns
  • GET /api/tables/{name} — describe a single table
  • POST /api/{table_name}/query — run the UI's advanced query payload

Install

pip install sqlalchemy-studio

Or install from the repository for development/testing:

pip install --upgrade git+https://github.com/coderxuz/sqlalchemy-studio.git@main#subdirectory=sqlalchemy-studio-backend

Quickstart

from sqlalchemy import create_engine
from sqlalchemy.orm import DeclarativeBase
from sqlalchemy_studio import Studio

class Base(DeclarativeBase):
    pass

engine = create_engine("sqlite:///test.db")

studio = Studio(engine, Base)
# Starts uvicorn and serves API under /api
studio.run(port=9000)
# API available at http://localhost:9000/api

Serving a built frontend (optional)

If you build the Vite frontend, copy its dist output into the backend studio/static folder and the backend will serve the SPA from / while keeping the API under /api.

Example:

# from repository root
npm --prefix sqlalchemy-studio-front install
npm --prefix sqlalchemy-studio-front run build
rm -rf sqlalchemy-studio-backend/studio/static
mkdir -p sqlalchemy-studio-backend/studio/static
cp -r sqlalchemy-studio-front/dist/* sqlalchemy-studio-backend/studio/static/

Configuration notes

• By default the package mounts static files at / and prefixes API routes with /api to avoid SPA route collisions. Adjust studio/Studio.py if you need a different layout.
• CORS: Studio registers a small set of development origins. When serving the SPA from the same server you won't need CORS; keep/update Studio._set_cors for other setups.

Publishing

1. Build the distribution locally:

python -m pip install --upgrade build twine
python -m build

2. Upload to PyPI (CI should set PYPI_API_TOKEN):

python -m twine upload dist/*

License MIT — update as appropriate.