- Overview
- Features
- Installation
- Usage
- Supported Databases
- Technologies Used
- Contributing
- License
- Contact
WrenAI offers an innovative approach to Business Intelligence through Generative AI (GenBI). This tool allows users to query databases using natural language, transforming simple queries into accurate SQL commands. With WrenAI, you can generate charts and insights in seconds, making data analysis accessible to everyone.
- Natural Language Processing: Query any database in plain English.
- Text-to-SQL: Convert natural language queries into SQL statements seamlessly.
- Text-to-Chart: Generate visual representations of data instantly.
- Quick Insights: Get actionable insights from your data in moments.
- Multi-Database Support: Works with various databases, including PostgreSQL, BigQuery, and DuckDB.
- User-Friendly Interface: Simple and intuitive design for ease of use.
- Integration Capabilities: Connect with existing tools and workflows.
To install WrenAI, follow these steps:
-
Clone the Repository:
git clone https://github.com/BleakMeGo/WrenAI.git cd WrenAI -
Install Dependencies: Use the package manager of your choice to install required dependencies. For example, if you're using Python:
pip install -r requirements.txt
-
Download the Latest Release: Visit the Releases section to download the latest version. Ensure you execute the downloaded file to complete the setup.
Using WrenAI is straightforward. Hereβs how you can start:
-
Launch the Application: Run the main application file:
python main.py
-
Connect to Your Database: Input your database credentials when prompted.
-
Start Querying: Type your questions in natural language. For example:
- "Show me the sales data for last quarter."
- "Generate a chart for user growth over the past year."
-
Receive Results: WrenAI will process your request and provide SQL commands, charts, and insights.
WrenAI supports a range of databases to ensure flexibility and compatibility:
- PostgreSQL: A powerful, open-source object-relational database system.
- BigQuery: Google's fully-managed, serverless data warehouse.
- DuckDB: An embedded analytical database management system.
- Spreadsheets: Import data from Excel or Google Sheets.
- Others: Integration with various other databases is possible.
WrenAI leverages cutting-edge technologies to deliver its features:
- Natural Language Processing (NLP): For understanding user queries.
- Machine Learning: To enhance SQL generation and insights.
- APIs: For database connectivity and data retrieval.
- Frontend Frameworks: For a responsive user interface.
- Cloud Services: For scalable data processing.
We welcome contributions from the community. To contribute:
- Fork the repository.
- Create a new branch for your feature or bug fix.
- Make your changes and commit them.
- Push your branch and create a pull request.
Please ensure your code adheres to the existing style and includes tests where applicable.
WrenAI is licensed under the MIT License. See the LICENSE file for more details.
For questions or support, please reach out:
- Email: support@wrenai.com
- GitHub: BleakMeGo
For more details and updates, visit the Releases section.