README
🚀 Zaturn - 强大的数据分析工具
Zaturn是一款专为数据分析师和商业用户打造的工具,它提供了强大的数据分析功能,能连接多种数据源,还能直观地展示数据,帮助用户更好地理解和处理数据。
🚀 快速开始
Zaturn的安装和配置都较为简便,以下是具体步骤:
安装步骤
- 首先安装uv工具:
npm install -g uv - 使用uv命令安装Zaturn:
uv add zaturn
配置数据源
-
方式一:编辑配置文件,将数据源信息添加到sources.txt。
- Linux/MacOS路径:
~/.config/zaturn/sources.txt - Windows路径:%APPDATA%\zaturn\sources.txt
- Linux/MacOS路径:
-
方式二:在MCP配置中直接指定数据源:
"args": [ "--noimg", "mysql+pymysql://username:password@host/database" ]
设置系统提示
建议设置以下系统提示以确保分析结果的准确性和可靠性:
You are a helpful data analysis assistant. Use only the provided data sources to process user inputs. Do not use external knowledge bases.
✨ 主要特性
- 支持多数据源:Zaturn能够连接并分析多种类型的数据源,包括PostgreSQL、SQLite、DuckDB、MySQL、ClickHouse数据库,以及CSV和Parquet文件。
- 直观的数据可视化:生成丰富的图表如散点图、折线图、柱状图等,帮助用户更直观地理解数据。如果MCP客户端不支持图片渲染,可使用--noimg参数以文件形式返回结果。
- 简便的安装配置:通过简单的命令即可完成工具安装,并提供灵活的配置方式,用户可以选择将数据源信息写入sources.txt文件或直接在MCP配置中添加。
💻 使用示例
基础用法
以下是一个示例用例,展示了如何使用Zaturn进行数据分析: 用户提问:
列出Northwind数据库中收入前五名的客户。
AI回答:
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
📚 详细文档
未来规划
-
扩展数据源支持:计划增加更多类型的数据源连接。
-
增强预测分析:实现基于历史数据的预测和 forecasting 功能,例如:
基于过去三个月的收入,预测下个月的收入情况。 -
生成报告与演示文稿:用户可以要求生成用于展示的PPT或PDF文件,使数据分析结果更易于分享和汇报。
获取帮助
如需帮助或反馈,请访问GitHub提交问题或加入Discord社区:
支持项目
如果您发现Zaturn对您有所帮助,可以通过以下方式支持该项目:
- 在GitHub上为项目加星
- 分享给更多人
- 通过Patreon每月赞助9美元:支持链接
您的支持将帮助我投入更多时间改进Zaturn,使其更加完善。
数据集引用
项目中包含了Sarah Taha和PokéAPI整理的宝可梦数据集(Kaggle ID:sarahtaha/1025-pokemon),该数据集遵循CC BY-NC-SA 4.0协议,仅用于演示目的。
Scan to join WeChat group