API for textSQL

Prerequisites

• python3.10

Required configuration for development:

• OpenAI Key
• URL to the postgres DB (Read-only URL provided in .env.example)

Make a copy of .env.example, rename it to .env, and configure the above variables.

Local development

Initial setup

$ ./scripts/setup.sh

Activate virtual env

$ source ./venv/bin/activate

Run local instance

$ ./scripts/dev.sh

Test case queries to test out prompt or other API related changes:

- Three highest income zip codes in {City}
- Five zip codes in {State} with the highest income and hispanic population of at least 10,000
- Which 3 zip codes in {City} have the highest female to male ratio?
- Which zip code in {City} has the most racial diversity and what is the racial distribution?
- 10 highest crime cities in {State}
- Which 20 zip codes in {State} have median income that's closes to the national median income?
- Which zip code has a median income that is closest to the national median income?