Skip to content

Commit 6de8103

Browse files
committed
Update README.md
1 parent 3d43ad3 commit 6de8103

File tree

1 file changed

+0
-13
lines changed

1 file changed

+0
-13
lines changed

README.md

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22

33
**ChatWithSQL** is a Python library that bridges the gap between natural language queries and SQL databases. Designed for reliability, security, and performance, ChatWithSQL allows developers to leverage advanced Language Learning Models (LLMs) like OpenAI, Gemini, and more to retrieve database data using simple, intuitive natural language prompts.
44

5-
---
65

76
## 🎯 Why ChatWithSQL?
87

@@ -14,7 +13,6 @@ ChatWithSQL has implemented a **schema-based validation approach** to ensure tha
1413

1514
This unique approach positions ChatWithSQL as a leader in secure and reliable, natural language-driven SQL data retrieval.
1615

17-
---
1816

1917
## 🚀 Key Features
2018

@@ -26,7 +24,6 @@ This unique approach positions ChatWithSQL as a leader in secure and reliable, n
2624
- **Database-Agnostic**: Compatible with any database supported by the URI connection format.
2725
- **Comprehensive Logging**: Provides detailed logs for easier debugging and monitoring.
2826

29-
---
3027

3128
## 📦 Installation
3229

@@ -36,7 +33,6 @@ You can install ChatWithSQL using pip:
3633
pip install chatwithsql
3734
```
3835

39-
---
4036

4137
## 🛠️ Setup and Usage
4238

@@ -79,7 +75,6 @@ response = chat_with_sql.execute_query(prompt)
7975
print(response)
8076
```
8177

82-
---
8378

8479
## 🛡️ Security by Design
8580

@@ -89,7 +84,6 @@ ChatWithSQL mitigates one of the largest risks of Text-to-SQL systems: **arbitra
8984
2. Parameters are sanitized and validated against expected types.
9085
3. Arbitrary query execution by LLMs is entirely eliminated.
9186

92-
---
9387

9488
## 🌐 Supported LLMs
9589

@@ -98,7 +92,6 @@ ChatWithSQL mitigates one of the largest risks of Text-to-SQL systems: **arbitra
9892
- **LlamaAPI**
9993
- **Ollama**
10094

101-
---
10295

10396
## 🧰 API Reference
10497

@@ -125,7 +118,6 @@ Executes a natural language query and retrieves data.
125118
- **`prompt`**: Natural language request.
126119
- **Returns**: Query results as a dictionary.
127120

128-
---
129121

130122
## 📝 Query Schema Format
131123

@@ -155,7 +147,6 @@ Example:
155147
]
156148
```
157149

158-
---
159150

160151
## 🐛 Logging and Debugging
161152

@@ -166,22 +157,18 @@ ChatWithSQL includes extensive logging for better observability:
166157

167158
Enable logging by configuring Python’s `logging` module.
168159

169-
---
170160

171161
## 🏗️ Contributing
172162

173163
Contributions are welcome! Please submit a pull request or open an issue on our [GitHub Repository](https://github.com/sathninduk/ChatWithSQL).
174164

175-
---
176165

177166
## 📜 License
178167

179168
ChatWithSQL is open-source software licensed under the MIT License.
180169

181-
---
182170

183171
## 🤝 Support
184172

185173
If you have any questions or issues, feel free to contact us at [hello@bysatha.com](mailto:hello@bysatha.com) or open a GitHub issue.
186174

187-
---

0 commit comments

Comments
 (0)