Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sheel-ui/graphviz-backend
https://github.com/sheel-ui/graphviz-backend
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/sheel-ui/graphviz-backend
- Owner: Sheel-ui
- Created: 2024-03-18T01:03:48.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-05-19T15:01:16.000Z (8 months ago)
- Last Synced: 2024-05-19T16:23:50.906Z (8 months ago)
- Language: Python
- Size: 2.36 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Graphviz: SQL Database Visualization Tool
Graphviz is an innovative project that empowers users to seamlessly upload SQL database files in CSV format through its intuitive frontend functionality. Once uploaded, users can effortlessly query the database using natural language. The results of these queries are then dynamically displayed in various graphical formats, including bar graphs, line graphs, or tables, providing users with clear and insightful visual representations of their data.
### Features
-
**Easy Database Upload**: Upload SQL database files in CSV format with a simple frontend interface.
- **Natural Language Queries**: Query your database using natural language for a user-friendly experience.
- **Dynamic Visualization**: Visualize query results dynamically with options for bar graphs, line graphs, or tables.
- **Powered by OpenAI API**: Utilizes the robust capabilities of OpenAI API in the backend for efficient processing and natural language understanding.
# Getting Started
To get started with Graphviz, follow these steps:
### API Setup
1. Make sure you have Python installed on your system.
2. Create a new conda environment. Install the required dependencies by running the following commands:
```bash
$ conda create -n env
$ conda activate
$ pip install -r requirements.txt
```
3. Start the API service by running the `app.py` file:
```bash
$ python app.py
```
To enable frontend functionality, a separate service needs to be initiated. GitHub repository for the frontend - [graphviz-frontend](https://github.com/Sheel-ui/graphviz-frontend)
# Changing env variables and Models
### API
1. You can find a `.env` file in the api directory. Open the file using the following command
```bash
$ vi api/.env
```
2. You can change `HOST`, `PORT` or the `ENDPOINT` of the flask service here.
3. Update your OpenAI API key in the `.env` file.
# Demo
