Skip to content
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.

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

Minor: ReadME update #116

Merged
merged 1 commit into from
Jan 17, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@

- PO (Base): Static home(s) to keep it together `(GitHub)`
- P1 (Tooling): Tooling, strings `(Powered by open source)`
- P2 (Maintenance + Monitoring): Env, automations `(Pixi + GHA)`

Check failure on line 36 in README.md

View workflow job for this annotation

GitHub Actions / vale

[vale] README.md#L36

[Vale.Spelling] Did you really mean 'Env'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'Env'?", "location": {"path": "README.md", "range": {"start": {"line": 36, "column": 34}}}, "severity": "ERROR"}

Check failure on line 36 in README.md

View workflow job for this annotation

GitHub Actions / vale

[vale] README.md#L36

[Vale.Spelling] Did you really mean 'automations'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'automations'?", "location": {"path": "README.md", "range": {"start": {"line": 36, "column": 39}}}, "severity": "ERROR"}
- P3 (Abstraction): Layer(s), CLI/task manager for users to interact with `(Pixi)`


Expand All @@ -50,11 +50,11 @@
| ✅ | `Vale.sh` configured at PR level |
| ✅ | `Pre-commit hooks` configured for code linting/formatting |
| ✨ | `Hello world` LLM design example based on [LangChain](https://python.langchain.com/) |
| ✅ | Environment management via [pixi](https://prefix.dev/) |

Check failure on line 53 in README.md

View workflow job for this annotation

GitHub Actions / vale

[vale] README.md#L53

[Vale.Spelling] Did you really mean 'pixi'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'pixi'?", "location": {"path": "README.md", "range": {"start": {"line": 53, "column": 39}}}, "severity": "ERROR"}
| ✅ | Reading data from online sources using [intake](https://github.com/intake/intake) |
| ✅ | Sample pipeline built using [Dagster](https://github.com/dagster-io/dagster) |

Check failure on line 55 in README.md

View workflow job for this annotation

GitHub Actions / vale

[vale] README.md#L55

[Vale.Spelling] Did you really mean 'Dagster'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'Dagster'?", "location": {"path": "README.md", "range": {"start": {"line": 55, "column": 40}}}, "severity": "ERROR"}
| ✅ | Building Dashboard using [holoviews](https://holoviews.org/gallery/index.html) + [panel](https://panel.holoviz.org/reference/index.html) |

Check failure on line 56 in README.md

View workflow job for this annotation

GitHub Actions / vale

[vale] README.md#L56

[Vale.Spelling] Did you really mean 'holoviews'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'holoviews'?", "location": {"path": "README.md", "range": {"start": {"line": 56, "column": 37}}}, "severity": "ERROR"}
| ✅ | Exploratory data analysis (EDA) using [mito](https://www.trymito.io/) |

Check failure on line 57 in README.md

View workflow job for this annotation

GitHub Actions / vale

[vale] README.md#L57

[Vale.Spelling] Did you really mean 'mito'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'mito'?", "location": {"path": "README.md", "range": {"start": {"line": 57, "column": 50}}}, "severity": "ERROR"}
| ✅ | Web UI build on [Flask](https://flask.palletsprojects.com/en/3.0.x/) |
| ✅ | Web UI re-done and expanded with [FastHTML](https://docs.fastht.ml/) |
| ✅ | Leverage AI models to analyse data [GitHub AI models Beta](https://docs.github.com/en/github-models/prototyping-with-ai-models) |
Expand All @@ -64,10 +64,10 @@

- Clone DJ `[email protected]:sayantikabanik/DataJourney.git`
- Generate & add `GITHUB_TOKEN`, instructions [here](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-personal-access-token-classic)
- Added requirement to run the LLM workflows
- Added requirement to run the LLM based workflows
- Switch directory `cd DataJourney`
- Download pixi : [prefix.dev](https://prefix.dev/)

Check failure on line 69 in README.md

View workflow job for this annotation

GitHub Actions / vale

[vale] README.md#L69

[Vale.Spelling] Did you really mean 'pixi'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'pixi'?", "location": {"path": "README.md", "range": {"start": {"line": 69, "column": 12}}}, "severity": "ERROR"}
- Activate env: `pixi shell`

Check failure on line 70 in README.md

View workflow job for this annotation

GitHub Actions / vale

[vale] README.md#L70

[Vale.Spelling] Did you really mean 'env'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'env'?", "location": {"path": "README.md", "range": {"start": {"line": 70, "column": 12}}}, "severity": "ERROR"}
- Install DJ framework locally `pixi run DJ_package`
- List all the tasks: `pixi task list`
- Execute a task from the list: `pixi run <TASK>`
Expand All @@ -76,15 +76,15 @@
### 🏃🏽‍♀️ Active `tasks` under DJ

- GIT_TOKEN_CHECK
- DJ_package

Check failure on line 79 in README.md

View workflow job for this annotation

GitHub Actions / vale

[vale] README.md#L79

[Vale.Spelling] Did you really mean 'DJ_package'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'DJ_package'?", "location": {"path": "README.md", "range": {"start": {"line": 79, "column": 3}}}, "severity": "ERROR"}
- DJ_pre_commit

Check failure on line 80 in README.md

View workflow job for this annotation

GitHub Actions / vale

[vale] README.md#L80

[Vale.Spelling] Did you really mean 'DJ_pre_commit'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'DJ_pre_commit'?", "location": {"path": "README.md", "range": {"start": {"line": 80, "column": 3}}}, "severity": "ERROR"}
- DJ_dagster

Check failure on line 81 in README.md

View workflow job for this annotation

GitHub Actions / vale

[vale] README.md#L81

[Vale.Spelling] Did you really mean 'DJ_dagster'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'DJ_dagster'?", "location": {"path": "README.md", "range": {"start": {"line": 81, "column": 3}}}, "severity": "ERROR"}
- DJ_fasthtml_app

Check failure on line 82 in README.md

View workflow job for this annotation

GitHub Actions / vale

[vale] README.md#L82

[Vale.Spelling] Did you really mean 'DJ_fasthtml_app'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'DJ_fasthtml_app'?", "location": {"path": "README.md", "range": {"start": {"line": 82, "column": 3}}}, "severity": "ERROR"}
- DJ_flask_app

Check failure on line 83 in README.md

View workflow job for this annotation

GitHub Actions / vale

[vale] README.md#L83

[Vale.Spelling] Did you really mean 'DJ_flask_app'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'DJ_flask_app'?", "location": {"path": "README.md", "range": {"start": {"line": 83, "column": 3}}}, "severity": "ERROR"}
- DJ_mito_app

Check failure on line 84 in README.md

View workflow job for this annotation

GitHub Actions / vale

[vale] README.md#L84

[Vale.Spelling] Did you really mean 'DJ_mito_app'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'DJ_mito_app'?", "location": {"path": "README.md", "range": {"start": {"line": 84, "column": 3}}}, "severity": "ERROR"}
- DJ_panel_app

Check failure on line 85 in README.md

View workflow job for this annotation

GitHub Actions / vale

[vale] README.md#L85

[Vale.Spelling] Did you really mean 'DJ_panel_app'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'DJ_panel_app'?", "location": {"path": "README.md", "range": {"start": {"line": 85, "column": 3}}}, "severity": "ERROR"}
- DJ_llm_analysis

Check failure on line 86 in README.md

View workflow job for this annotation

GitHub Actions / vale

[vale] README.md#L86

[Vale.Spelling] Did you really mean 'DJ_llm_analysis'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'DJ_llm_analysis'?", "location": {"path": "README.md", "range": {"start": {"line": 86, "column": 3}}}, "severity": "ERROR"}
- DJ_hello_world_langchain

Check failure on line 87 in README.md

View workflow job for this annotation

GitHub Actions / vale

[vale] README.md#L87

[Vale.Spelling] Did you really mean 'DJ_hello_world_langchain'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'DJ_hello_world_langchain'?", "location": {"path": "README.md", "range": {"start": {"line": 87, "column": 3}}}, "severity": "ERROR"}


### 🔌 About pre-commit-hooks and activating
Expand All @@ -100,12 +100,12 @@
pixi run DJ_llm_analysis
```

### 🪼 Execute pre-configured Dagster pipeline

Check failure on line 103 in README.md

View workflow job for this annotation

GitHub Actions / vale

[vale] README.md#L103

[Vale.Spelling] Did you really mean 'Dagster'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'Dagster'?", "location": {"path": "README.md", "range": {"start": {"line": 103, "column": 30}}}, "severity": "ERROR"}

```shell
pixi run DJ_dagster
```
![Dagit UI output](assets/pipeline/dagster_ui.png)

Check failure on line 108 in README.md

View workflow job for this annotation

GitHub Actions / vale

[vale] README.md#L108

[Vale.Spelling] Did you really mean 'Dagit'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'Dagit'?", "location": {"path": "README.md", "range": {"start": {"line": 108, "column": 3}}}, "severity": "ERROR"}

### 🐙 Panel app
```shell
Expand All @@ -113,11 +113,11 @@
```

*NOTE:*
The dashboard generated is exported into HTML format and saved as [stock_price_twilio_dashboard](analytics_framework%2Fdashboard%2Fstock_price_twilio_dashboard.html)

Check failure on line 116 in README.md

View workflow job for this annotation

GitHub Actions / vale

[vale] README.md#L116

[Vale.Spelling] Did you really mean 'stock_price_twilio_dashboard'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'stock_price_twilio_dashboard'?", "location": {"path": "README.md", "range": {"start": {"line": 116, "column": 68}}}, "severity": "ERROR"}

![Panel app output](assets/dashboard/panel_app_stock.png)

### 🐵 Mito

Check failure on line 120 in README.md

View workflow job for this annotation

GitHub Actions / vale

[vale] README.md#L120

[Vale.Spelling] Did you really mean 'Mito'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'Mito'?", "location": {"path": "README.md", "range": {"start": {"line": 120, "column": 7}}}, "severity": "ERROR"}

To explore further visit [trymito.io](https://docs.trymito.io/)
```shell
Expand All @@ -127,8 +127,8 @@
[//]: # (![mito output]&#40;assets/pipeline/mito_graph.png "Graph generated via mitosheet"&#41; ![mito output operation]&#40;assets/pipeline/mito_operations.png "Operations performed via mitosheet"&#41;)

<div style="display: flex; justify-content: space-between;">
<img src="assets/pipeline/mito_graph.png" alt="mito_output" width="400"/>

Check failure on line 130 in README.md

View workflow job for this annotation

GitHub Actions / vale

[vale] README.md#L130

[Vale.Spelling] Did you really mean 'mito_output'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'mito_output'?", "location": {"path": "README.md", "range": {"start": {"line": 130, "column": 52}}}, "severity": "ERROR"}
<img src="assets/pipeline/mito_operations.png" alt="mito_output" width="400"/>

Check failure on line 131 in README.md

View workflow job for this annotation

GitHub Actions / vale

[vale] README.md#L131

[Vale.Spelling] Did you really mean 'mito_output'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'mito_output'?", "location": {"path": "README.md", "range": {"start": {"line": 131, "column": 57}}}, "severity": "ERROR"}
</div>

### 🦋 Display all data sources present via web UI
Expand Down
Loading