Skip to content

Commit bdeae83

Browse files
committed
Update README.md
1 parent 67c560e commit bdeae83

File tree

1 file changed

+27
-71
lines changed

1 file changed

+27
-71
lines changed

README.md

Lines changed: 27 additions & 71 deletions
Original file line numberDiff line numberDiff line change
@@ -43,58 +43,30 @@ Sweet is for data scientists, engineers, and developers who want to explore and
4343

4444
## Getting Started in 30 Seconds
4545

46-
```python
47-
# Launch Sweet from the command line
46+
```bash
47+
# Install and launch Sweet
48+
pip install sweet-data
4849
sweet
49-
50-
# Or load data directly
51-
sweet --file data.csv
52-
53-
# Or pipe data in
54-
echo "data.csv" | sweet
55-
cat data.csv | sweet
5650
```
5751

58-
Once in Sweet's interactive interface:
59-
60-
1. Load your data using the file browser or paste tabular data directly
61-
2. Write Polars expressions with syntax highlighting: `df = df.filter(pl.col("age") > 25)`
62-
3. See results instantly in the data preview with **approval workflow** - Sweet shows you exactly what will change before applying transformations
63-
4. **AI-assisted transformations** - Ask the AI assistant for help and review generated code before execution
64-
65-
## Why Choose Sweet?
66-
67-
- **Interactive terminal interface**: Modern TUI with syntax highlighting and real-time feedback
68-
- **Intuitive navigation**: Use keyboard shortcuts or mouse/pointer interactions for smooth control
69-
- **Experimental workflow**: Interactive environment perfect for data exploration and hypothesis testing
70-
- **Flexible data loading**: Files, stdin piping, or paste data directly from spreadsheets/web tables
71-
- **Multiple export formats**: Save your transformed data as CSV, TSV, Parquet, JSON, or JSONL
72-
- **Fast operations**: Built on Polars for high-performance data processing
73-
- **Accessible**: Perfect for both small datasets and quick exploration tasks
74-
75-
## Real-World Example
76-
77-
```bash
78-
# Start with a CSV file
79-
sweet --file sales_data.csv
80-
81-
# In Sweet's interface, build transformations step by step:
82-
# 1. Filter recent sales
83-
df = df.filter(pl.col("date") > pl.date(2024, 1, 1))
52+
Once Sweet opens:
8453

85-
# 2. Calculate revenue
86-
df = df.with_columns((pl.col("price") * pl.col("quantity")).alias("revenue"))
54+
1. **Load sample data**: use the file browser to load your CSV files or paste data directly from spreadsheets
55+
2. **Try making edits**: click on cells to edit values, add/remove columns, or change data types
56+
3. **Use the AI assistant**: ask questions like "What does this data show?" or "Filter rows where age > 30" and watch Sweet generate the code
57+
4. **See instant results**: Sweet shows you exactly what will change with an approval workflow before applying transformations
8758

88-
# 3. Group by category
89-
df = df.group_by("category").agg([
90-
pl.col("revenue").sum().alias("total_revenue"),
91-
pl.col("quantity").sum().alias("total_quantity")
92-
])
59+
The AI assistant is Sweet's premier feature: it can help you explore your data, explain patterns, and generate Polars transformations using natural language. Just type what you want to do and let Sweet handle the code!
9360

94-
# See results immediately in the data preview
95-
```
61+
## Why Choose Sweet?
9662

97-
The interactive interface lets you experiment with different approaches and see results instantly, making data exploration both efficient and enjoyable.
63+
- **Interactive terminal interface**: modern TUI with syntax highlighting and real-time feedback
64+
- **Intuitive navigation**: use keyboard shortcuts or mouse/pointer interactions for smooth control
65+
- **Experimental workflow**: interactive environment perfect for data exploration and hypothesis testing
66+
- **Flexible data loading**: files, stdin piping, or paste data directly from spreadsheets/web tables
67+
- **Multiple export formats**: save your transformed data as CSV, TSV, Parquet, JSON, or JSONL
68+
- **Fast operations**: built on Polars for high-performance data processing
69+
- **Accessible**: perfect for both small datasets and quick exploration tasks
9870

9971
## Installation
10072

@@ -104,22 +76,6 @@ You can install Sweet using pip:
10476
pip install sweet-data
10577
```
10678

107-
## Usage
108-
109-
```bash
110-
# Launch the interactive application
111-
sweet
112-
113-
# Load a specific data file
114-
sweet --file data.csv
115-
116-
# Pipe filename as a string (note the echo command)
117-
echo "data.csv" | sweet
118-
119-
# Or pipe file content directly
120-
cat data.csv | sweet
121-
```
122-
12379
## Sweet AI Assistant
12480

12581
Sweet includes an intelligent AI assistant that transforms how you work with data. This powerful feature uses advanced language models to help you explore, understand, and transform your datasets through natural language interactions.
@@ -130,22 +86,22 @@ Sweet includes an intelligent AI assistant that transforms how you work with dat
13086

13187
### AI-Powered Data Exploration
13288

133-
- **Conversational Analysis**: Ask questions like "What columns do we have?", "Describe this dataset", or "What are the data types?" and get instant, intelligent responses
134-
- **Smart Data Insights**: Get contextual analysis and explanations about your data's structure, patterns, and characteristics
135-
- **Interactive Guidance**: Receive helpful suggestions and explanations as you work through your data analysis workflow
89+
- **Conversational Analysis**: ask questions like "What columns do we have?", "Describe this dataset", or "What are the data types?" and get instant, intelligent responses
90+
- **Smart Data Insights**: get contextual analysis and explanations about your data's structure, patterns, and characteristics
91+
- **Interactive Guidance**: receive helpful suggestions and explanations as you work through your data analysis workflow
13692

13793
### Intelligent Code Generation
13894

139-
- **Natural Language to Code**: Request transformations like "Add a bonus column that's 30% of salary" or "Filter rows where age is greater than 25" and get working Polars code
140-
- **Comprehensive Polars Support**: The AI assistant has deep knowledge of the entire Polars API, including advanced operations like rolling windows, string processing, and datetime manipulations
141-
- **Context-Aware Suggestions**: Code generation takes into account your actual column names, data types, and dataset structure
95+
- **Natural Language to Code**: request transformations like "Add a bonus column that's 30% of salary" or "Filter rows where age is greater than 25" and get working Polars code
96+
- **Comprehensive Polars Support**: the AI assistant has deep knowledge of the entire Polars API, including advanced operations like rolling windows, string processing, and datetime manipulations
97+
- **Context-Aware Suggestions**: code generation takes into account your actual column names, data types, and dataset structure
14298

14399
### Key AI Features
144100

145-
- **Dual Mode Operation**: Automatically switches between conversational analysis and code generation based on your needs
146-
- **Real-time Context**: The AI assistant understands your current dataset structure and provides relevant, specific advice
147-
- **Multiple LLM Support**: Works with popular language model providers including Anthropic Claude and OpenAI GPT
148-
- **Conversational Context**: Maintains conversation context to provide better assistance throughout your data exploration session
101+
- **Dual Mode Operation**: automatically switches between conversational analysis and code generation based on your needs
102+
- **Real-time Context**: the AI assistant understands your current dataset structure and provides relevant, specific advice
103+
- **Multiple LLM Support**: works with popular language model providers including Anthropic Claude and OpenAI GPT
104+
- **Conversational Context**: maintains conversation context to provide better assistance throughout your data exploration session
149105

150106
To use the AI assistant, simply type your questions or requests in natural language, and Sweet will provide intelligent responses, explanations, or generate the appropriate Polars code for your transformations.
151107

0 commit comments

Comments
 (0)