Zaturn (SQL Data Analysis)

🚀 Zaturn

Zaturn is a powerful data analysis tool designed for data analysts and business users, offering a wide range of features to streamline data analysis.

🚀 Quick Start

Zaturn is a versatile tool that empowers data analysts and business users with robust data analysis capabilities. It simplifies the process of working with data, making it accessible and efficient.

✨ Features

• Multi - Data Source Support: Zaturn can connect to and analyze various types of data sources, including PostgreSQL, SQLite, DuckDB, MySQL, ClickHouse databases, as well as CSV and Parquet files.
• Intuitive Data Visualization: Generate a variety of charts such as scatter plots, line graphs, bar charts, etc., to help users understand data more intuitively. If the MCP client does not support image rendering, use the --noimg parameter to return results as a file.
• Simple Installation and Configuration: Install the tool with simple commands and enjoy flexible configuration options. Users can choose to write data source information to the sources.txt file or directly add it in the MCP configuration.

📦 Installation

1. First, install the uv tool:

   npm install -g uv
   

2. Use the uv command to install Zaturn:

   uv add zaturn
   

📚 Documentation

Configure Data Sources

• Method 1: Edit the configuration file and add data source information to sources.txt.

  • Linux/MacOS path: ~/.config/zaturn/sources.txt
  • Windows path: %APPDATA%\zaturn\sources.txt

• Method 2: Specify data sources directly in the MCP configuration:

  "args": [
    "--noimg",
    "mysql+pymysql://username:password@host/database"
  ]
  

Set System Prompts

It is recommended to set the following system prompt to ensure the accuracy and reliability of analysis results:

You are a helpful data analysis assistant. Use only the provided data sources to process user inputs. Do not use external knowledge bases.

Usage Examples

User Question:

List the top 5 customers by revenue in the Northwind database.

AI Answer:

The top 5 customers by revenue for Northwind are:

1. B's Beverages with a revenue of $6,154,115.34
2. Hungry Coyote Import Store** with a revenue of $5,698,023.67
3. Rancho grande with a revenue of $5,559,110.08
4. Gourmet Lanchonetes with a revenue of $5,552,597.90
5. Ana Trujillo Emparedados y helados with a revenue of $5,534,356.6

🔮 Future Plans

• Expand Data Source Support: Plan to add connections to more types of data sources.
• Enhance Predictive Analysis: Implement prediction and forecasting functions based on historical data, for example:

  Forecast next month's revenue based on the revenue of the past three months.
  

• Generate Reports and Presentations: Users can request the generation of PPT or PDF files for presentation, making data analysis results easier to share and report.

🆘 Get Help

If you need help or want to provide feedback, please visit GitHub to submit an issue or join the Discord community:

• GitHub
• Discord

🌟 Support the Project

If you find Zaturn helpful, you can support the project in the following ways:

• Star the project on GitHub.
• Share it with more people.
• Sponsor $9 per month via Patreon: Support Link

Your support will help me invest more time in improving Zaturn and making it even better.

📚 Dataset Citation

The project includes a Pokémon dataset compiled by Sarah Taha and PokéAPI (Kaggle ID: sarahtaha/1025 - pokemon). This dataset follows the [CC BY - NC - SA 4.0](https://creativecommons.org/licenses/by - nc - sa/4.0/) license and is used for demonstration purposes only.

⭐ Star History

[](https://star - history.com#github/kdqed/zaturn)