You can now connect your own database & datasets to textSQL and self-host the service. Our vision is to continue to modularize and improve this process.
- Public-facing interactive interfaces for data. Democratizing public data
- Empowering researchers. Enabling journalists and other researchers to more easily explore data
- Business intelligence. Reducing the burden on technical employees to build & run queries for non-technical
These instructions will walk you through running your own API and client. You can run this all on localhost and then deploy it wherever you would like.
python3.10
- OpenAI Key
- URL to the postgres DB
Configure the above in .env in the following path /byod/api/app/
Here's an example of .env file that points to the CensusGPT Postgres database
OPENAI_KEY="YOUR_OPENAI_KEY"
DB_URL="postgresql://census_data_user:3PjePE3hVzm2m2UFPywLTLfIiC6w28HB@dpg-cg73gvhmbg5ab7mrk8qg-b.replica-cyan.oregon-postgres.render.com/census_data_w0ix"
Initial setup
$ ./scripts/setup.shActivate virtual env
$ source ./venv/bin/activateRun local instance
$ ./scripts/dev.shA front-end streamlit application for Text-to-SQL (alternatively you can use your own frontend)
python3.10
- base URL for TextSQL API
Configure the above in .env
Example of .env file that should go in the following path /byod/client
API_BASE="http://localhost:9000"
When everything on localhost, this will point to the BYOD API on port 9000.
Initial setup
$ ./scripts/setup.sh
Activate virtual env
$ source ./venv/bin/activate
Run local instance
$ ./scripts/dev.sh
Reach out in the discord for support: https://discord.com/invite/JZtxhZQQus