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

licence badge updated #133

Merged
merged 1 commit into from
Feb 12, 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
@@ -1,6 +1,6 @@
<h1 align="center">

[![License](https://img.shields.io/badge/license-CC0%201.0%20Universal-blue)](https://creativecommons.org/publicdomain/zero/1.0/)
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0)\
[![Code of Conduct](https://img.shields.io/badge/Code_of_Conduct-Contributor%20Covenant-blue)](https://www.contributor-covenant.org/version/2/0/code_of_conduct/)\
[![CI](https://github.com/sayantikabanik/DataJourney/actions/workflows/CI.yml/badge.svg)](https://github.com/sayantikabanik/DataJourney/actions/workflows/CI.yml)
[![github-repo-stats](https://github.com/sayantikabanik/DataJourney/actions/workflows/github-repo-stats.yml/badge.svg)](https://github.com/sayantikabanik/DataJourney/actions/workflows/github-repo-stats.yml)
Expand Down 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 @@ -66,8 +66,8 @@
- 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 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 @@ -80,13 +80,13 @@
| `GIT_TOKEN_CHECK` | Verifies the availability and validity of the Git authentication token. |
| `DJ_package` | Prepares and builds the Python package for the DataJourney project. |
| `DJ_pre_commit` | Runs pre-commit hooks to ensure code quality and adherence to standards. |
| `DJ_dagster` | Sets up and runs a Dagster workflow for orchestration in the project. |

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 'Dagster'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'Dagster'?", "location": {"path": "README.md", "range": {"start": {"line": 83, "column": 54}}}, "severity": "ERROR"}
| `DJ_fasthtml_app` | Executes a FastAPI-based HTML application. |
| `DJ_flask_app` | Configures and runs a Flask-based application for data services. |
| `DJ_mito_app` | Launches the Mito application for interactive data analysis in notebooks. |

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 'Mito'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'Mito'?", "location": {"path": "README.md", "range": {"start": {"line": 86, "column": 48}}}, "severity": "ERROR"}
| `DJ_panel_app` | Executes a Panel dashboard app for data visualization and analytics. |
| `DJ_llm_analysis` | Performs analysis using large language models (LLMs) on project data. |

Check failure on line 88 in README.md

View workflow job for this annotation

GitHub Actions / vale

[vale] README.md#L88

[Vale.Spelling] Did you really mean 'LLMs'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'LLMs'?", "location": {"path": "README.md", "range": {"start": {"line": 88, "column": 82}}}, "severity": "ERROR"}
| `DJ_hello_world_langchain` | Sets up a basic LangChain app as a "Hello World" example for LLMs. |

Check failure on line 89 in README.md

View workflow job for this annotation

GitHub Actions / vale

[vale] README.md#L89

[Vale.Spelling] Did you really mean 'LLMs'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'LLMs'?", "location": {"path": "README.md", "range": {"start": {"line": 89, "column": 96}}}, "severity": "ERROR"}
| `DJ_spanish_eng_translation` | Performs Spanish to English translation with Deepseek-R1 (`NOTE`: Takes about ~30 secs to execute this task) |
| `DJ_sync_dataset_trees` | Downloads and synchronizes the `trees.csv` dataset into the project structure. |

Expand All @@ -103,12 +103,12 @@
pixi run DJ_llm_analysis
```

### 🪼 Execute pre-configured Dagster pipeline

Check failure on line 106 in README.md

View workflow job for this annotation

GitHub Actions / vale

[vale] README.md#L106

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

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

Check failure on line 111 in README.md

View workflow job for this annotation

GitHub Actions / vale

[vale] README.md#L111

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

### 🐙 Panel app
```shell
Expand All @@ -116,11 +116,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 119 in README.md

View workflow job for this annotation

GitHub Actions / vale

[vale] README.md#L119

[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": 119, "column": 68}}}, "severity": "ERROR"}

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

### 🐵 Mito

Check failure on line 123 in README.md

View workflow job for this annotation

GitHub Actions / vale

[vale] README.md#L123

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

To explore further visit [trymito.io](https://docs.trymito.io/)
```shell
Expand All @@ -130,8 +130,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 133 in README.md

View workflow job for this annotation

GitHub Actions / vale

[vale] README.md#L133

[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": 133, "column": 52}}}, "severity": "ERROR"}
<img src="assets/pipeline/mito_operations.png" alt="mito_output" width="400"/>

Check failure on line 134 in README.md

View workflow job for this annotation

GitHub Actions / vale

[vale] README.md#L134

[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": 134, "column": 57}}}, "severity": "ERROR"}
</div>

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