Skip to content

Update README.md #2715

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README.md #2715

wants to merge 1 commit into from

Conversation

theshashank1
Copy link

TESH-Query - AI-powered CLI tool that converts natural language queries into SQL, retrieves data from databases, and allows CSV downloads.

  • Error Reduction: Minimizes human errors associated with manual SQL writing.
  • Democratized Data Access: Allows non-technical users to interact with databases effortlessly.

What is this Python project?

TESHQ is an AI-powered CLI tool designed to convert natural language queries into SQL. It retrieves data directly from your databases and allows for easy CSV exports. This tool significantly enhances productivity by enabling developers, analysts, and even users with limited SQL knowledge to interact with databases seamlessly. TESH-Query is under active development, and we warmly welcome contributions from the community!

What's the difference between this Python project and similar ones?

TESHQ distinguishes itself through a powerful combination of features tailored for efficiency and ease of use:

  • Natural Language to SQL: Simply ask your questions in plain English; no need to write complex SQL queries.
  • AI-Powered Translation: Leverages Google's Gemini AI (via Langchain) for intelligent and accurate SQL generation.
  • Broad Database Compatibility: Works seamlessly with popular databases including PostgreSQL, MySQL, and SQLite.
  • Schema-Aware Queries: Intelligently understands your database's structure to provide relevant and precise responses.
  • Versatile Formatted Output: Displays query results in a clean, readable table directly in your terminal. It also supports JSON and CSV export for further analysis and reporting.
  • Secure Configuration: Includes robust support for credential management and secure database setup.
  • Modern CLI Experience: Built with Typer and Rich to offer a visually appealing, intuitive, and responsive command-line interface.
  • Enhanced Productivity: Empowers users to retrieve data swiftly without manual SQL coding, significantly reducing query time and effort.
  • Error Minimization: By automating SQL generation from natural language, TESHQ drastically cuts down on syntax errors and logical flaws common in manual SQL writing.

The key differentiators are further highlighted in the comparison below:

Feature TESHQ Traditional SQL Query Tools Other AI SQL Tools
Natural Language Queries ✅ Yes ❌ No ✅ Yes
AI-Powered SQL Generation ✅ Yes (Gemini AI via Langchain) ❌ No ✅ Yes (varies by tool)
Database Compatibility ✅ PostgreSQL, MySQL, SQLite ✅ Varies ✅ Varies
Schema Awareness ✅ Yes ❌ No ✅ Yes
Formatted Output ✅ Table, JSON, CSV ❌ Limited ✅ Varies
Security & Credential Mgmt ✅ Yes ✅ Yes ✅ Yes
Modern CLI Interface ✅ Typer & Rich ❌ Basic CLI ✅ Varies
Error Reduction ✅ Yes ❌ No ✅ Yes
Boost Productivity ✅ Yes ❌ No ✅ Yes

In essence, TESHQ stands out due to its advanced AI-powered natural language processing, its highly intuitive and modern CLI experience (thanks to Typer and Rich), and its capability for flexible, structured data retrieval (Table, JSON, CSV), all while eliminating the complexities of manual SQL writing.

@theshashank1
Update README.md
504ca46 
- [TESH-Query](https://pypi.org/project/teshq/) - AI-powered CLI tool that converts natural language queries into SQL, retrieves data from databases, and allows CSV downloads.  
  - **Natural Language to SQL:** No need to write complex queries—just ask questions in plain English.  
  - **AI-Powered Translation:** Uses Google's Gemini AI (via Langchain) for intelligent SQL generation.  
  - **Direct Database Interaction:** Works seamlessly with PostgreSQL, MySQL, and SQLite.  
  - **Schema-Aware Queries:** Understands your database structure for relevant responses.  
  - **Formatted Results:** Displays query output in a clean, readable table in your terminal.  
  - **Secure Configuration:** Supports credential management and database setup.  
  - **CSV Export:** Retrieve query results in structured formats for further analysis.  
  - **Modern CLI Experience:** Uses Typer and Rich for a visually appealing and responsive interface.  
  - **Boost Productivity:** Enables developers and analysts to retrieve data quickly without writing SQL manually.  
  - **Error Reduction:** Minimizes human errors associated with manual SQL writing.  
  - **Democratized Data Access:** Allows non-technical users to interact with databases effortlessly.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@maxdieg211998 maxdieg211998 maxdieg211998 approved these changes

@hxx185053 hxx185053 hxx185053 approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@theshashank1 @maxdieg211998 @hxx185053