From 1285cf2c84ee0bdbf3c9114c4b70517f989e0c6c Mon Sep 17 00:00:00 2001 From: Archmonger <16909269+Archmonger@users.noreply.github.com> Date: Wed, 9 Mar 2022 02:24:37 -0800 Subject: [PATCH 01/26] Update readme summary --- README.md | 32 ++++++++++++-------------------- 1 file changed, 12 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index c4a3de93c..245d77270 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,14 @@ # IDOM · [![Tests](https://github.com/idom-team/idom/workflows/Test/badge.svg?event=push)](https://github.com/idom-team/idom/actions?query=workflow%3ATest) [![PyPI Version](https://img.shields.io/pypi/v/idom.svg)](https://pypi.python.org/pypi/idom) [![License](https://img.shields.io/badge/License-MIT-purple.svg)](https://github.com/idom-team/idom/blob/main/LICENSE) -IDOM is a Python web framework for building **interactive websites without needing a -single line of Javascript**. These sites are built from small elements of functionality -like buttons text and images. IDOM allows you to combine these elements into reusable -"components" that can be composed together to create complex views. - -Ecosystem independence is also a core feature of IDOM. It can be added to existing -applications built on a variety of sync and async web servers, as well as integrated -with other frameworks like Django, Jupyter, and Plotly Dash. Not only does this mean -you're free to choose what technology stack to run on, but on top of that, you can run -the exact same components wherever you need them. For example, you can take a component -originally developed in a Jupyter Notebook and embed it in your production application -without changing anything about the component itself. +IDOM is a Python framework for building **interactive websites without needing a single line of JavaScript**. By utilizing ReactJS, IDOM combines the web elements you provide (ex. `button`, `div`, `image`) into reusable "components". These components can be composed together and/or utilize [ReactJS-style hooks](https://idom-docs.herokuapp.com/docs/reference/hooks-api.html) to create complex web pages. + +When needed, you can import JavaScript components from [NPM](https://idom-docs.herokuapp.com/docs/guides/escape-hatches/javascript-components.html#dynamically-loaded-components) directly into Python. Additionally, if you decide you want to develop a component outside of Python, you can utilize the [JavaScript components API](https://idom-docs.herokuapp.com/docs/guides/escape-hatches/javascript-components.html#custom-javascript-components) where needed. + +Due to our ecosystem independent design, IDOM can be added to existing projects built on a variety of sync and async web frameworks. For example, you can take components originally developed in Jupyter and embed them into an existing Flask application. Supported web frameworks include: `FastAPI`, `Flask`, `Sanic`, `Tornado`, `Django`, `Jupyter`, and `Plotly/Dash`. # At a Glance -To get a rough idea of how to write apps in IDOM, take a look at the tiny "hello -world" application below: +To get a rough idea of how to write apps in IDOM, take a look at this tiny _Hello World_ application. ```python from idom import component, html, run @@ -30,10 +22,10 @@ run(App) # Resources -Follow the links below to find out more about this project +Follow the links below to find out more about this project. -- [Try it Now](https://mybinder.org/v2/gh/idom-team/idom-jupyter/main?urlpath=lab/tree/notebooks/introduction.ipynb) - check out IDOM in a Jupyter Notebook. -- [Documentation](https://idom-docs.herokuapp.com/) - learn how to install, run, and use IDOM. -- [Community Forum](https://github.com/idom-team/idom/discussions) - ask questions, share ideas, and show off projects. -- [Contributor Guide](https://idom-docs.herokuapp.com/docs/developing-idom/contributor-guide.html) - see how you can help develop this project. -- [Code of Conduct](https://github.com/idom-team/idom/blob/main/CODE_OF_CONDUCT.md) - standards for interacting with this community. +- [Try it Now](https://mybinder.org/v2/gh/idom-team/idom-jupyter/main?urlpath=lab/tree/notebooks/introduction.ipynb) - check out IDOM in a Jupyter Notebook. +- [Documentation](https://idom-docs.herokuapp.com/) - learn how to install, run, and use IDOM. +- [Community Forum](https://github.com/idom-team/idom/discussions) - ask questions, share ideas, and show off projects. +- [Contributor Guide](https://idom-docs.herokuapp.com/docs/developing-idom/contributor-guide.html) - see how you can help develop this project. +- [Code of Conduct](https://github.com/idom-team/idom/blob/main/CODE_OF_CONDUCT.md) - standards for interacting with this community. From aa272fb589f20884b9d5b717744fad00faba83e1 Mon Sep 17 00:00:00 2001 From: Archmonger <16909269+Archmonger@users.noreply.github.com> Date: Thu, 10 Mar 2022 03:23:25 -0800 Subject: [PATCH 02/26] minor verbiage changes --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 245d77270..f13e8a59b 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ # IDOM · [![Tests](https://github.com/idom-team/idom/workflows/Test/badge.svg?event=push)](https://github.com/idom-team/idom/actions?query=workflow%3ATest) [![PyPI Version](https://img.shields.io/pypi/v/idom.svg)](https://pypi.python.org/pypi/idom) [![License](https://img.shields.io/badge/License-MIT-purple.svg)](https://github.com/idom-team/idom/blob/main/LICENSE) -IDOM is a Python framework for building **interactive websites without needing a single line of JavaScript**. By utilizing ReactJS, IDOM combines the web elements you provide (ex. `button`, `div`, `image`) into reusable "components". These components can be composed together and/or utilize [ReactJS-style hooks](https://idom-docs.herokuapp.com/docs/reference/hooks-api.html) to create complex web pages. +IDOM is a Python framework for building **interactive websites without needing a single line of JavaScript**. By utilizing ReactJS, IDOM combines the web elements you provide (ex. `button`, `div`, `image`) into reusable "components". These components can be composed together and utilize [ReactJS-style hooks](https://idom-docs.herokuapp.com/docs/reference/hooks-api.html) to create complex web pages. When needed, you can import JavaScript components from [NPM](https://idom-docs.herokuapp.com/docs/guides/escape-hatches/javascript-components.html#dynamically-loaded-components) directly into Python. Additionally, if you decide you want to develop a component outside of Python, you can utilize the [JavaScript components API](https://idom-docs.herokuapp.com/docs/guides/escape-hatches/javascript-components.html#custom-javascript-components) where needed. -Due to our ecosystem independent design, IDOM can be added to existing projects built on a variety of sync and async web frameworks. For example, you can take components originally developed in Jupyter and embed them into an existing Flask application. Supported web frameworks include: `FastAPI`, `Flask`, `Sanic`, `Tornado`, `Django`, `Jupyter`, and `Plotly/Dash`. +Due to our ecosystem independent design, IDOM can be added to existing projects built on a variety of sync and async web frameworks. For example, you can take components originally developed in Jupyter and embed them into an existing Flask application. Current supported web frameworks include: `FastAPI`, `Flask`, `Sanic`, `Tornado`, `Django`, `Jupyter`, and `Plotly Dash`. # At a Glance From 4f82c886c41f8fff591c42c10e5df26761742a97 Mon Sep 17 00:00:00 2001 From: Archmonger <16909269+Archmonger@users.noreply.github.com> Date: Thu, 10 Mar 2022 03:26:11 -0800 Subject: [PATCH 03/26] Move supported frameworks to a new line --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f13e8a59b..ac7517ac8 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,9 @@ IDOM is a Python framework for building **interactive websites without needing a When needed, you can import JavaScript components from [NPM](https://idom-docs.herokuapp.com/docs/guides/escape-hatches/javascript-components.html#dynamically-loaded-components) directly into Python. Additionally, if you decide you want to develop a component outside of Python, you can utilize the [JavaScript components API](https://idom-docs.herokuapp.com/docs/guides/escape-hatches/javascript-components.html#custom-javascript-components) where needed. -Due to our ecosystem independent design, IDOM can be added to existing projects built on a variety of sync and async web frameworks. For example, you can take components originally developed in Jupyter and embed them into an existing Flask application. Current supported web frameworks include: `FastAPI`, `Flask`, `Sanic`, `Tornado`, `Django`, `Jupyter`, and `Plotly Dash`. +Due to our ecosystem independent design, IDOM can be added to existing projects built on a variety of sync and async web frameworks. For example, you can take components originally developed in Jupyter and embed them into an existing Flask application. + +Currently supported web frameworks include: `FastAPI`, `Flask`, `Sanic`, `Tornado`, `Django`, `Jupyter`, and `Plotly Dash`. # At a Glance From fa13def1e1874dc45db849b7f71ddd6cf6548413 Mon Sep 17 00:00:00 2001 From: Archmonger <16909269+Archmonger@users.noreply.github.com> Date: Thu, 10 Mar 2022 03:26:55 -0800 Subject: [PATCH 04/26] plotly-dash --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ac7517ac8..39b834a4a 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ When needed, you can import JavaScript components from [NPM](https://idom-docs.h Due to our ecosystem independent design, IDOM can be added to existing projects built on a variety of sync and async web frameworks. For example, you can take components originally developed in Jupyter and embed them into an existing Flask application. -Currently supported web frameworks include: `FastAPI`, `Flask`, `Sanic`, `Tornado`, `Django`, `Jupyter`, and `Plotly Dash`. +Currently supported web frameworks include: `FastAPI`, `Flask`, `Sanic`, `Tornado`, `Django`, `Jupyter`, and `Plotly-Dash`. # At a Glance From 400e93a4a3ab8e0982b35bd984ba94e09708229d Mon Sep 17 00:00:00 2001 From: Archmonger <16909269+Archmonger@users.noreply.github.com> Date: Thu, 10 Mar 2022 03:27:50 -0800 Subject: [PATCH 05/26] Reorder plotly to prevent text cutoff --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 39b834a4a..7e3af8f82 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ When needed, you can import JavaScript components from [NPM](https://idom-docs.h Due to our ecosystem independent design, IDOM can be added to existing projects built on a variety of sync and async web frameworks. For example, you can take components originally developed in Jupyter and embed them into an existing Flask application. -Currently supported web frameworks include: `FastAPI`, `Flask`, `Sanic`, `Tornado`, `Django`, `Jupyter`, and `Plotly-Dash`. +Currently supported web frameworks include: `FastAPI`, `Flask`, `Sanic`, `Tornado`, `Django`, `Plotly-Dash`, and `Jupyter`. # At a Glance From 54b3eb006b494f6a00966aa1f969928fa813ec21 Mon Sep 17 00:00:00 2001 From: Archmonger <16909269+Archmonger@users.noreply.github.com> Date: Thu, 10 Mar 2022 03:37:49 -0800 Subject: [PATCH 06/26] wordsmithing --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 7e3af8f82..4dbd86ffe 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ # IDOM · [![Tests](https://github.com/idom-team/idom/workflows/Test/badge.svg?event=push)](https://github.com/idom-team/idom/actions?query=workflow%3ATest) [![PyPI Version](https://img.shields.io/pypi/v/idom.svg)](https://pypi.python.org/pypi/idom) [![License](https://img.shields.io/badge/License-MIT-purple.svg)](https://github.com/idom-team/idom/blob/main/LICENSE) -IDOM is a Python framework for building **interactive websites without needing a single line of JavaScript**. By utilizing ReactJS, IDOM combines the web elements you provide (ex. `button`, `div`, `image`) into reusable "components". These components can be composed together and utilize [ReactJS-style hooks](https://idom-docs.herokuapp.com/docs/reference/hooks-api.html) to create complex web pages. +IDOM is a Python framework for building **interactive websites without needing a single line of JavaScript**. Web elements you provide (ex. `button`, `div`, `image`) can be combined into reusable "components". These components are composed together and can utilize [ReactJS-style hooks](https://idom-docs.herokuapp.com/docs/reference/hooks-api.html) to create complex web pages. Ultimately, all IDOM components are sent to the browser and are rendered by ReactJS. -When needed, you can import JavaScript components from [NPM](https://idom-docs.herokuapp.com/docs/guides/escape-hatches/javascript-components.html#dynamically-loaded-components) directly into Python. Additionally, if you decide you want to develop a component outside of Python, you can utilize the [JavaScript components API](https://idom-docs.herokuapp.com/docs/guides/escape-hatches/javascript-components.html#custom-javascript-components) where needed. +When needed, you can import JavaScript components from [NPM](https://idom-docs.herokuapp.com/docs/guides/escape-hatches/javascript-components.html#dynamically-loaded-components) directly into Python to be used within IDOM. Additionally, if you decide you want to develop a component outside of Python, you can utilize the [JavaScript components API](https://idom-docs.herokuapp.com/docs/guides/escape-hatches/javascript-components.html#custom-javascript-components) where needed. Due to our ecosystem independent design, IDOM can be added to existing projects built on a variety of sync and async web frameworks. For example, you can take components originally developed in Jupyter and embed them into an existing Flask application. From 7422a28c2b54e1ecbe0f12b8d8d8f1af1fc57fec Mon Sep 17 00:00:00 2001 From: Archmonger <16909269+Archmonger@users.noreply.github.com> Date: Thu, 10 Mar 2022 03:44:42 -0800 Subject: [PATCH 07/26] wordsmithing 2 --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4dbd86ffe..bc9cf1f54 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ # IDOM · [![Tests](https://github.com/idom-team/idom/workflows/Test/badge.svg?event=push)](https://github.com/idom-team/idom/actions?query=workflow%3ATest) [![PyPI Version](https://img.shields.io/pypi/v/idom.svg)](https://pypi.python.org/pypi/idom) [![License](https://img.shields.io/badge/License-MIT-purple.svg)](https://github.com/idom-team/idom/blob/main/LICENSE) -IDOM is a Python framework for building **interactive websites without needing a single line of JavaScript**. Web elements you provide (ex. `button`, `div`, `image`) can be combined into reusable "components". These components are composed together and can utilize [ReactJS-style hooks](https://idom-docs.herokuapp.com/docs/reference/hooks-api.html) to create complex web pages. Ultimately, all IDOM components are sent to the browser and are rendered by ReactJS. +IDOM is a Python framework for building **interactive websites without needing a single line of JavaScript**. Web elements you provide (ex. `button`, `div`, `image`) are combined into reusable "components". These components are composed together and can utilize [ReactJS-style hooks](https://idom-docs.herokuapp.com/docs/reference/hooks-api.html) to create complex web pages. Ultimately, all IDOM components are sent to the browser and are rendered by ReactJS. -When needed, you can import JavaScript components from [NPM](https://idom-docs.herokuapp.com/docs/guides/escape-hatches/javascript-components.html#dynamically-loaded-components) directly into Python to be used within IDOM. Additionally, if you decide you want to develop a component outside of Python, you can utilize the [JavaScript components API](https://idom-docs.herokuapp.com/docs/guides/escape-hatches/javascript-components.html#custom-javascript-components) where needed. +When needed, you can import JavaScript from [NPM](https://idom-docs.herokuapp.com/docs/guides/escape-hatches/javascript-components.html#dynamically-loaded-components) into your Python components. If you want to develop a component entirely within JavaScript, you can utilize the [JavaScript Components API](https://idom-docs.herokuapp.com/docs/guides/escape-hatches/javascript-components.html#custom-javascript-components) for additional flexibility. Due to our ecosystem independent design, IDOM can be added to existing projects built on a variety of sync and async web frameworks. For example, you can take components originally developed in Jupyter and embed them into an existing Flask application. From 3b59e142fe58eb31965635eddda91e620c8911ee Mon Sep 17 00:00:00 2001 From: Archmonger <16909269+Archmonger@users.noreply.github.com> Date: Thu, 10 Mar 2022 04:00:40 -0800 Subject: [PATCH 08/26] remove "composing" verbiage --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index bc9cf1f54..b51a655a0 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # IDOM · [![Tests](https://github.com/idom-team/idom/workflows/Test/badge.svg?event=push)](https://github.com/idom-team/idom/actions?query=workflow%3ATest) [![PyPI Version](https://img.shields.io/pypi/v/idom.svg)](https://pypi.python.org/pypi/idom) [![License](https://img.shields.io/badge/License-MIT-purple.svg)](https://github.com/idom-team/idom/blob/main/LICENSE) -IDOM is a Python framework for building **interactive websites without needing a single line of JavaScript**. Web elements you provide (ex. `button`, `div`, `image`) are combined into reusable "components". These components are composed together and can utilize [ReactJS-style hooks](https://idom-docs.herokuapp.com/docs/reference/hooks-api.html) to create complex web pages. Ultimately, all IDOM components are sent to the browser and are rendered by ReactJS. +IDOM is a Python framework for building **interactive websites without needing a single line of JavaScript**. Web elements you provide (ex. `button`, `div`, `image`) are combined into reusable "components". Components [can be nested together](https://idom-docs.herokuapp.com/docs/guides/creating-interfaces/your-first-components/index.html#conditional-rendering) and utilize [ReactJS-style hooks](https://idom-docs.herokuapp.com/docs/reference/hooks-api.html) to create complex web pages. Ultimately, all IDOM components are sent to the browser and are rendered by ReactJS. When needed, you can import JavaScript from [NPM](https://idom-docs.herokuapp.com/docs/guides/escape-hatches/javascript-components.html#dynamically-loaded-components) into your Python components. If you want to develop a component entirely within JavaScript, you can utilize the [JavaScript Components API](https://idom-docs.herokuapp.com/docs/guides/escape-hatches/javascript-components.html#custom-javascript-components) for additional flexibility. From b65fd99eed2b24e8417ccc1ea60826d1d78387ca Mon Sep 17 00:00:00 2001 From: Archmonger <16909269+Archmonger@users.noreply.github.com> Date: Thu, 10 Mar 2022 04:04:23 -0800 Subject: [PATCH 09/26] minor clarification --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b51a655a0..43ad61d5b 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # IDOM · [![Tests](https://github.com/idom-team/idom/workflows/Test/badge.svg?event=push)](https://github.com/idom-team/idom/actions?query=workflow%3ATest) [![PyPI Version](https://img.shields.io/pypi/v/idom.svg)](https://pypi.python.org/pypi/idom) [![License](https://img.shields.io/badge/License-MIT-purple.svg)](https://github.com/idom-team/idom/blob/main/LICENSE) -IDOM is a Python framework for building **interactive websites without needing a single line of JavaScript**. Web elements you provide (ex. `button`, `div`, `image`) are combined into reusable "components". Components [can be nested together](https://idom-docs.herokuapp.com/docs/guides/creating-interfaces/your-first-components/index.html#conditional-rendering) and utilize [ReactJS-style hooks](https://idom-docs.herokuapp.com/docs/reference/hooks-api.html) to create complex web pages. Ultimately, all IDOM components are sent to the browser and are rendered by ReactJS. +IDOM is a Python framework for building **interactive websites without needing a single line of JavaScript**. Web elements you provide (ex. `button`, `div`, `image`) are combined into reusable "components". Components [can be nested together](https://idom-docs.herokuapp.com/docs/guides/creating-interfaces/your-first-components/index.html#conditional-rendering) and utilize [ReactJS-style hooks](https://idom-docs.herokuapp.com/docs/reference/hooks-api.html) to create complex web pages. Ultimately, all IDOM components are communicated to the browser and then rendered by ReactJS. When needed, you can import JavaScript from [NPM](https://idom-docs.herokuapp.com/docs/guides/escape-hatches/javascript-components.html#dynamically-loaded-components) into your Python components. If you want to develop a component entirely within JavaScript, you can utilize the [JavaScript Components API](https://idom-docs.herokuapp.com/docs/guides/escape-hatches/javascript-components.html#custom-javascript-components) for additional flexibility. From 993568c1603792e601e31c35d36f2848c37e980b Mon Sep 17 00:00:00 2001 From: Mark <16909269+Archmonger@users.noreply.github.com> Date: Wed, 16 Mar 2022 00:42:03 -0700 Subject: [PATCH 10/26] Update README.md Co-authored-by: Ryan Morshead --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 43ad61d5b..4389a7b7d 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ IDOM is a Python framework for building **interactive websites without needing a When needed, you can import JavaScript from [NPM](https://idom-docs.herokuapp.com/docs/guides/escape-hatches/javascript-components.html#dynamically-loaded-components) into your Python components. If you want to develop a component entirely within JavaScript, you can utilize the [JavaScript Components API](https://idom-docs.herokuapp.com/docs/guides/escape-hatches/javascript-components.html#custom-javascript-components) for additional flexibility. -Due to our ecosystem independent design, IDOM can be added to existing projects built on a variety of sync and async web frameworks. For example, you can take components originally developed in Jupyter and embed them into an existing Flask application. +IDOM's ecosystem independent design allows it to be added to existing projects built on a variety of sync and async web frameworks. For example, you can take components originally developed in Jupyter and embed them into an existing Flask application. Currently supported web frameworks include: `FastAPI`, `Flask`, `Sanic`, `Tornado`, `Django`, `Plotly-Dash`, and `Jupyter`. From ca0b31d97f47d2e06eee6f63761b160b5fff5bb1 Mon Sep 17 00:00:00 2001 From: Archmonger <16909269+Archmonger@users.noreply.github.com> Date: Mon, 21 Mar 2022 15:58:55 -0700 Subject: [PATCH 11/26] wordsmithing --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 43ad61d5b..3c7cfc720 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,12 @@ # IDOM · [![Tests](https://github.com/idom-team/idom/workflows/Test/badge.svg?event=push)](https://github.com/idom-team/idom/actions?query=workflow%3ATest) [![PyPI Version](https://img.shields.io/pypi/v/idom.svg)](https://pypi.python.org/pypi/idom) [![License](https://img.shields.io/badge/License-MIT-purple.svg)](https://github.com/idom-team/idom/blob/main/LICENSE) -IDOM is a Python framework for building **interactive websites without needing a single line of JavaScript**. Web elements you provide (ex. `button`, `div`, `image`) are combined into reusable "components". Components [can be nested together](https://idom-docs.herokuapp.com/docs/guides/creating-interfaces/your-first-components/index.html#conditional-rendering) and utilize [ReactJS-style hooks](https://idom-docs.herokuapp.com/docs/reference/hooks-api.html) to create complex web pages. Ultimately, all IDOM components are communicated to the browser and then rendered by ReactJS. +IDOM is a Python framework for building **interactive websites without needing a single line of JavaScript**. Web elements you provide (ex. `button`, `div`, `image`) are combined into [reusable "components"](https://idom-docs.herokuapp.com/docs/guides/creating-interfaces/your-first-components/index.html#parametrizing-components). Using our ReactJS backed design, you can utilize [hooks](https://idom-docs.herokuapp.com/docs/reference/hooks-api.html) and [events](https://idom-docs.herokuapp.com/docs/guides/adding-interactivity/responding-to-events/index.html#async-event-handlers) to create infinitely complex web pages. -When needed, you can import JavaScript from [NPM](https://idom-docs.herokuapp.com/docs/guides/escape-hatches/javascript-components.html#dynamically-loaded-components) into your Python components. If you want to develop a component entirely within JavaScript, you can utilize the [JavaScript Components API](https://idom-docs.herokuapp.com/docs/guides/escape-hatches/javascript-components.html#custom-javascript-components) for additional flexibility. +When needed, you can import JavaScript from [NPM](https://idom-docs.herokuapp.com/docs/guides/escape-hatches/javascript-components.html#dynamically-loaded-components) directly into your Python components. However, if you want to develop a component entirely within JavaScript, the [JavaScript Components API](https://idom-docs.herokuapp.com/docs/guides/escape-hatches/javascript-components.html#custom-javascript-components) exists for additional flexibility. -Due to our ecosystem independent design, IDOM can be added to existing projects built on a variety of sync and async web frameworks. For example, you can take components originally developed in Jupyter and embed them into an existing Flask application. +Due to our ecosystem independent design, IDOM components can be reused across a variety of sync and async web frameworks. -Currently supported web frameworks include: `FastAPI`, `Flask`, `Sanic`, `Tornado`, `Django`, `Plotly-Dash`, and `Jupyter`. +Natively supported web frameworks include: `FastAPI`, `Flask`, `Sanic`, `Tornado`, [`Django`](https://github.com/idom-team/django-idom), [`Plotly-Dash`](https://github.com/idom-team/idom-dash), and [`Jupyter`](https://github.com/idom-team/idom-jupyter). # At a Glance From 03efc5d041570f2ca48a8c59f1ac0cc0de38ab75 Mon Sep 17 00:00:00 2001 From: Archmonger <16909269+Archmonger@users.noreply.github.com> Date: Mon, 21 Mar 2022 16:27:40 -0700 Subject: [PATCH 12/26] reduced verbosity --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 8ebb9ffba..6638a1841 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ # IDOM · [![Tests](https://github.com/idom-team/idom/workflows/Test/badge.svg?event=push)](https://github.com/idom-team/idom/actions?query=workflow%3ATest) [![PyPI Version](https://img.shields.io/pypi/v/idom.svg)](https://pypi.python.org/pypi/idom) [![License](https://img.shields.io/badge/License-MIT-purple.svg)](https://github.com/idom-team/idom/blob/main/LICENSE) -IDOM is a Python framework for building **interactive websites without needing a single line of JavaScript**. Web elements you provide (ex. `button`, `div`, `image`) are combined into [reusable "components"](https://idom-docs.herokuapp.com/docs/guides/creating-interfaces/your-first-components/index.html#parametrizing-components). Using IDOM's ReactJS backed design, you can utilize [hooks](https://idom-docs.herokuapp.com/docs/reference/hooks-api.html) and [events](https://idom-docs.herokuapp.com/docs/guides/adding-interactivity/responding-to-events/index.html#async-event-handlers) to create infinitely complex web pages. +IDOM is a Python framework for building **interactive websites without needing a single line of JavaScript**. Web elements you provide (ex. `button`, `div`, `image`) are combined into [reusable "components"](https://idom-docs.herokuapp.com/docs/guides/creating-interfaces/your-first-components/index.html#parametrizing-components). Using IDOM's [ReactJS](https://reactjs.org/) backed design, components can utilize [hooks](https://idom-docs.herokuapp.com/docs/reference/hooks-api.html) and [events](https://idom-docs.herokuapp.com/docs/guides/adding-interactivity/responding-to-events/index.html#async-event-handlers) to create infinitely complex web pages. -When needed, you can import JavaScript from [NPM](https://idom-docs.herokuapp.com/docs/guides/escape-hatches/javascript-components.html#dynamically-loaded-components) directly into your Python components. However, if you want to develop a component entirely within JavaScript, the [JavaScript Components API](https://idom-docs.herokuapp.com/docs/guides/escape-hatches/javascript-components.html#custom-javascript-components) exists for additional flexibility. +When needed, IDOM can use JavaScript components directly from [NPM](https://idom-docs.herokuapp.com/docs/guides/escape-hatches/javascript-components.html#dynamically-loaded-components). Components can also be [developed entirely within JavaScript](https://idom-docs.herokuapp.com/docs/guides/escape-hatches/javascript-components.html#custom-javascript-components) for additional flexibility. -Due to IDOM's ecosystem independent design, components can be reused across a variety of sync and async web frameworks. +IDOM's ecosystem independent design allows components to be reused across a variety of sync and async web frameworks. Natively supported web frameworks include: `FastAPI`, `Flask`, `Sanic`, `Tornado`, [`Django`](https://github.com/idom-team/django-idom), [`Plotly-Dash`](https://github.com/idom-team/idom-dash), and [`Jupyter`](https://github.com/idom-team/idom-jupyter). From 33fdda2030051dfdc65c0c53b10b1baeb3e68d3f Mon Sep 17 00:00:00 2001 From: Archmonger <16909269+Archmonger@users.noreply.github.com> Date: Mon, 21 Mar 2022 16:28:55 -0700 Subject: [PATCH 13/26] within -> in --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 6638a1841..549140d99 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ IDOM is a Python framework for building **interactive websites without needing a single line of JavaScript**. Web elements you provide (ex. `button`, `div`, `image`) are combined into [reusable "components"](https://idom-docs.herokuapp.com/docs/guides/creating-interfaces/your-first-components/index.html#parametrizing-components). Using IDOM's [ReactJS](https://reactjs.org/) backed design, components can utilize [hooks](https://idom-docs.herokuapp.com/docs/reference/hooks-api.html) and [events](https://idom-docs.herokuapp.com/docs/guides/adding-interactivity/responding-to-events/index.html#async-event-handlers) to create infinitely complex web pages. -When needed, IDOM can use JavaScript components directly from [NPM](https://idom-docs.herokuapp.com/docs/guides/escape-hatches/javascript-components.html#dynamically-loaded-components). Components can also be [developed entirely within JavaScript](https://idom-docs.herokuapp.com/docs/guides/escape-hatches/javascript-components.html#custom-javascript-components) for additional flexibility. +When needed, IDOM can use JavaScript components directly from [NPM](https://idom-docs.herokuapp.com/docs/guides/escape-hatches/javascript-components.html#dynamically-loaded-components). Components can also be [developed entirely in JavaScript](https://idom-docs.herokuapp.com/docs/guides/escape-hatches/javascript-components.html#custom-javascript-components) for additional flexibility. IDOM's ecosystem independent design allows components to be reused across a variety of sync and async web frameworks. From a83a0be59c3f82326bc72f5fd1052c7e6092b15a Mon Sep 17 00:00:00 2001 From: Archmonger <16909269+Archmonger@users.noreply.github.com> Date: Tue, 22 Mar 2022 05:10:25 -0700 Subject: [PATCH 14/26] fix hyperlink location --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 549140d99..c9617b769 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ IDOM is a Python framework for building **interactive websites without needing a single line of JavaScript**. Web elements you provide (ex. `button`, `div`, `image`) are combined into [reusable "components"](https://idom-docs.herokuapp.com/docs/guides/creating-interfaces/your-first-components/index.html#parametrizing-components). Using IDOM's [ReactJS](https://reactjs.org/) backed design, components can utilize [hooks](https://idom-docs.herokuapp.com/docs/reference/hooks-api.html) and [events](https://idom-docs.herokuapp.com/docs/guides/adding-interactivity/responding-to-events/index.html#async-event-handlers) to create infinitely complex web pages. -When needed, IDOM can use JavaScript components directly from [NPM](https://idom-docs.herokuapp.com/docs/guides/escape-hatches/javascript-components.html#dynamically-loaded-components). Components can also be [developed entirely in JavaScript](https://idom-docs.herokuapp.com/docs/guides/escape-hatches/javascript-components.html#custom-javascript-components) for additional flexibility. +When needed, IDOM can [use JavaScript components](https://idom-docs.herokuapp.com/docs/guides/escape-hatches/javascript-components.html#dynamically-loaded-components) directly from NPM. Components can also be [developed in JavaScript](https://idom-docs.herokuapp.com/docs/guides/escape-hatches/javascript-components.html#custom-javascript-components) for additional flexibility. IDOM's ecosystem independent design allows components to be reused across a variety of sync and async web frameworks. From 4f294e94f7adcffdaf0500e0ee189e9713f5d09b Mon Sep 17 00:00:00 2001 From: Ryan Morshead Date: Sun, 27 Mar 2022 22:02:11 -0700 Subject: [PATCH 15/26] Remove accidental auto-format --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index c9617b769..968d6f917 100644 --- a/README.md +++ b/README.md @@ -26,8 +26,8 @@ run(App) Follow the links below to find out more about this project. -- [Try it Now](https://mybinder.org/v2/gh/idom-team/idom-jupyter/main?urlpath=lab/tree/notebooks/introduction.ipynb) - check out IDOM in a Jupyter Notebook. -- [Documentation](https://idom-docs.herokuapp.com/) - learn how to install, run, and use IDOM. -- [Community Forum](https://github.com/idom-team/idom/discussions) - ask questions, share ideas, and show off projects. -- [Contributor Guide](https://idom-docs.herokuapp.com/docs/developing-idom/contributor-guide.html) - see how you can help develop this project. -- [Code of Conduct](https://github.com/idom-team/idom/blob/main/CODE_OF_CONDUCT.md) - standards for interacting with this community. +- [Try it Now](https://mybinder.org/v2/gh/idom-team/idom-jupyter/main?urlpath=lab/tree/notebooks/introduction.ipynb) - check out IDOM in a Jupyter Notebook. +- [Documentation](https://idom-docs.herokuapp.com/) - learn how to install, run, and use IDOM. +- [Community Forum](https://github.com/idom-team/idom/discussions) - ask questions, share ideas, and show off projects. +- [Contributor Guide](https://idom-docs.herokuapp.com/docs/developing-idom/contributor-guide.html) - see how you can help develop this project. +- [Code of Conduct](https://github.com/idom-team/idom/blob/main/CODE_OF_CONDUCT.md) - standards for interacting with this community. From df997de6b3c8436dddb4ec5e5daf55246446c276 Mon Sep 17 00:00:00 2001 From: Archmonger <16909269+Archmonger@users.noreply.github.com> Date: Tue, 5 Apr 2022 21:33:02 -0700 Subject: [PATCH 16/26] ecosystem independance shortening --- README.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/README.md b/README.md index c9617b769..59e3dd03c 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,7 @@ IDOM is a Python framework for building **interactive websites without needing a When needed, IDOM can [use JavaScript components](https://idom-docs.herokuapp.com/docs/guides/escape-hatches/javascript-components.html#dynamically-loaded-components) directly from NPM. Components can also be [developed in JavaScript](https://idom-docs.herokuapp.com/docs/guides/escape-hatches/javascript-components.html#custom-javascript-components) for additional flexibility. -IDOM's ecosystem independent design allows components to be reused across a variety of sync and async web frameworks. - -Natively supported web frameworks include: `FastAPI`, `Flask`, `Sanic`, `Tornado`, [`Django`](https://github.com/idom-team/django-idom), [`Plotly-Dash`](https://github.com/idom-team/idom-dash), and [`Jupyter`](https://github.com/idom-team/idom-jupyter). +IDOM's ecosystem independent design allows components to be reused across a variety of web frameworks, such as `FastAPI`, `Flask`, `Sanic`, `Tornado`, [`Django`](https://github.com/idom-team/django-idom), [`Plotly-Dash`](https://github.com/idom-team/idom-dash), and [`Jupyter`](https://github.com/idom-team/idom-jupyter). # At a Glance From 128520e713b13e1fb74e2450774394e5529b878e Mon Sep 17 00:00:00 2001 From: Archmonger <16909269+Archmonger@users.noreply.github.com> Date: Thu, 7 Apr 2022 12:52:01 -0700 Subject: [PATCH 17/26] backed -> based --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index fb73a719b..571debc50 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # IDOM · [![Tests](https://github.com/idom-team/idom/workflows/Test/badge.svg?event=push)](https://github.com/idom-team/idom/actions?query=workflow%3ATest) [![PyPI Version](https://img.shields.io/pypi/v/idom.svg)](https://pypi.python.org/pypi/idom) [![License](https://img.shields.io/badge/License-MIT-purple.svg)](https://github.com/idom-team/idom/blob/main/LICENSE) -IDOM is a Python framework for building **interactive websites without needing a single line of JavaScript**. Web elements you provide (ex. `button`, `div`, `image`) are combined into [reusable "components"](https://idom-docs.herokuapp.com/docs/guides/creating-interfaces/your-first-components/index.html#parametrizing-components). Using IDOM's [ReactJS](https://reactjs.org/) backed design, components can utilize [hooks](https://idom-docs.herokuapp.com/docs/reference/hooks-api.html) and [events](https://idom-docs.herokuapp.com/docs/guides/adding-interactivity/responding-to-events/index.html#async-event-handlers) to create infinitely complex web pages. +IDOM is a Python framework for building **interactive websites without needing a single line of JavaScript**. Web elements you provide (ex. `button`, `div`, `image`) are combined into [reusable "components"](https://idom-docs.herokuapp.com/docs/guides/creating-interfaces/your-first-components/index.html#parametrizing-components). Using IDOM's ReactJS based design, components can utilize [hooks](https://idom-docs.herokuapp.com/docs/reference/hooks-api.html) and [events](https://idom-docs.herokuapp.com/docs/guides/adding-interactivity/responding-to-events/index.html#async-event-handlers) to create infinitely complex web pages. When needed, IDOM can [use JavaScript components](https://idom-docs.herokuapp.com/docs/guides/escape-hatches/javascript-components.html#dynamically-loaded-components) directly from NPM. Components can also be [developed in JavaScript](https://idom-docs.herokuapp.com/docs/guides/escape-hatches/javascript-components.html#custom-javascript-components) for additional flexibility. From eb626edba3a8d2c112d53cf2ee75e6bbb2d1da26 Mon Sep 17 00:00:00 2001 From: Archmonger <16909269+Archmonger@users.noreply.github.com> Date: Thu, 7 Apr 2022 20:33:27 -0700 Subject: [PATCH 18/26] it's always wordsmithing --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 571debc50..2af2e7e29 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # IDOM · [![Tests](https://github.com/idom-team/idom/workflows/Test/badge.svg?event=push)](https://github.com/idom-team/idom/actions?query=workflow%3ATest) [![PyPI Version](https://img.shields.io/pypi/v/idom.svg)](https://pypi.python.org/pypi/idom) [![License](https://img.shields.io/badge/License-MIT-purple.svg)](https://github.com/idom-team/idom/blob/main/LICENSE) -IDOM is a Python framework for building **interactive websites without needing a single line of JavaScript**. Web elements you provide (ex. `button`, `div`, `image`) are combined into [reusable "components"](https://idom-docs.herokuapp.com/docs/guides/creating-interfaces/your-first-components/index.html#parametrizing-components). Using IDOM's ReactJS based design, components can utilize [hooks](https://idom-docs.herokuapp.com/docs/reference/hooks-api.html) and [events](https://idom-docs.herokuapp.com/docs/guides/adding-interactivity/responding-to-events/index.html#async-event-handlers) to create infinitely complex web pages. +IDOM is a micro-framework that automagically links your Python project to a ReactJS front-end, allowing you to create **interactive websites without needing a single line of JavaScript!** Web elements you provide (ex. `button`, `div`, `image`) are combined into [reusable "components"](https://idom-docs.herokuapp.com/docs/guides/creating-interfaces/your-first-components/index.html#parametrizing-components). These components can utilize [hooks](https://idom-docs.herokuapp.com/docs/reference/hooks-api.html) and [events](https://idom-docs.herokuapp.com/docs/guides/adding-interactivity/responding-to-events/index.html#async-event-handlers) to create infinitely complex web pages. When needed, IDOM can [use JavaScript components](https://idom-docs.herokuapp.com/docs/guides/escape-hatches/javascript-components.html#dynamically-loaded-components) directly from NPM. Components can also be [developed in JavaScript](https://idom-docs.herokuapp.com/docs/guides/escape-hatches/javascript-components.html#custom-javascript-components) for additional flexibility. From b8546d78a08eccba1c865b194940c7361ae9c91d Mon Sep 17 00:00:00 2001 From: Archmonger <16909269+Archmonger@users.noreply.github.com> Date: Thu, 7 Apr 2022 20:44:52 -0700 Subject: [PATCH 19/26] shortening some stuff --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 2af2e7e29..b926b19ce 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # IDOM · [![Tests](https://github.com/idom-team/idom/workflows/Test/badge.svg?event=push)](https://github.com/idom-team/idom/actions?query=workflow%3ATest) [![PyPI Version](https://img.shields.io/pypi/v/idom.svg)](https://pypi.python.org/pypi/idom) [![License](https://img.shields.io/badge/License-MIT-purple.svg)](https://github.com/idom-team/idom/blob/main/LICENSE) -IDOM is a micro-framework that automagically links your Python project to a ReactJS front-end, allowing you to create **interactive websites without needing a single line of JavaScript!** Web elements you provide (ex. `button`, `div`, `image`) are combined into [reusable "components"](https://idom-docs.herokuapp.com/docs/guides/creating-interfaces/your-first-components/index.html#parametrizing-components). These components can utilize [hooks](https://idom-docs.herokuapp.com/docs/reference/hooks-api.html) and [events](https://idom-docs.herokuapp.com/docs/guides/adding-interactivity/responding-to-events/index.html#async-event-handlers) to create infinitely complex web pages. +IDOM is a micro-framework that links your Python project to a ReactJS front-end, allowing you to create **interactive websites without needing JavaScript!** Web elements you provide are combined into [reusable "components"](https://idom-docs.herokuapp.com/docs/guides/creating-interfaces/your-first-components/index.html#parametrizing-components). These components can utilize [hooks](https://idom-docs.herokuapp.com/docs/reference/hooks-api.html) and [events](https://idom-docs.herokuapp.com/docs/guides/adding-interactivity/responding-to-events/index.html#async-event-handlers) to create infinitely complex web pages. When needed, IDOM can [use JavaScript components](https://idom-docs.herokuapp.com/docs/guides/escape-hatches/javascript-components.html#dynamically-loaded-components) directly from NPM. Components can also be [developed in JavaScript](https://idom-docs.herokuapp.com/docs/guides/escape-hatches/javascript-components.html#custom-javascript-components) for additional flexibility. From 0544ac5eaa2cff831c5ea060898a43c69013894b Mon Sep 17 00:00:00 2001 From: Archmonger <16909269+Archmonger@users.noreply.github.com> Date: Thu, 7 Apr 2022 20:50:49 -0700 Subject: [PATCH 20/26] split sections --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b926b19ce..be128f97a 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ # IDOM · [![Tests](https://github.com/idom-team/idom/workflows/Test/badge.svg?event=push)](https://github.com/idom-team/idom/actions?query=workflow%3ATest) [![PyPI Version](https://img.shields.io/pypi/v/idom.svg)](https://pypi.python.org/pypi/idom) [![License](https://img.shields.io/badge/License-MIT-purple.svg)](https://github.com/idom-team/idom/blob/main/LICENSE) -IDOM is a micro-framework that links your Python project to a ReactJS front-end, allowing you to create **interactive websites without needing JavaScript!** Web elements you provide are combined into [reusable "components"](https://idom-docs.herokuapp.com/docs/guides/creating-interfaces/your-first-components/index.html#parametrizing-components). These components can utilize [hooks](https://idom-docs.herokuapp.com/docs/reference/hooks-api.html) and [events](https://idom-docs.herokuapp.com/docs/guides/adding-interactivity/responding-to-events/index.html#async-event-handlers) to create infinitely complex web pages. +IDOM is a micro-framework that links your Python project to a ReactJS front-end, allowing you to create **interactive websites without needing JavaScript!** + +Web elements you provide are combined into [reusable "components"](https://idom-docs.herokuapp.com/docs/guides/creating-interfaces/your-first-components/index.html#parametrizing-components). These components can utilize [hooks](https://idom-docs.herokuapp.com/docs/reference/hooks-api.html) and [events](https://idom-docs.herokuapp.com/docs/guides/adding-interactivity/responding-to-events/index.html#async-event-handlers) to create infinitely complex web pages. When needed, IDOM can [use JavaScript components](https://idom-docs.herokuapp.com/docs/guides/escape-hatches/javascript-components.html#dynamically-loaded-components) directly from NPM. Components can also be [developed in JavaScript](https://idom-docs.herokuapp.com/docs/guides/escape-hatches/javascript-components.html#custom-javascript-components) for additional flexibility. From 0737db0b5d85a906ac9b1bf40f5498aacf070dd2 Mon Sep 17 00:00:00 2001 From: Archmonger <16909269+Archmonger@users.noreply.github.com> Date: Thu, 7 Apr 2022 20:52:20 -0700 Subject: [PATCH 21/26] python framework --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index be128f97a..1f799bbad 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # IDOM · [![Tests](https://github.com/idom-team/idom/workflows/Test/badge.svg?event=push)](https://github.com/idom-team/idom/actions?query=workflow%3ATest) [![PyPI Version](https://img.shields.io/pypi/v/idom.svg)](https://pypi.python.org/pypi/idom) [![License](https://img.shields.io/badge/License-MIT-purple.svg)](https://github.com/idom-team/idom/blob/main/LICENSE) -IDOM is a micro-framework that links your Python project to a ReactJS front-end, allowing you to create **interactive websites without needing JavaScript!** +IDOM is a Python micro-framework that links your web project to a ReactJS front-end, allowing you to create **interactive websites without needing JavaScript!** Web elements you provide are combined into [reusable "components"](https://idom-docs.herokuapp.com/docs/guides/creating-interfaces/your-first-components/index.html#parametrizing-components). These components can utilize [hooks](https://idom-docs.herokuapp.com/docs/reference/hooks-api.html) and [events](https://idom-docs.herokuapp.com/docs/guides/adding-interactivity/responding-to-events/index.html#async-event-handlers) to create infinitely complex web pages. From f169a74c99fe935f018e5ecd96b204991c7c5fe0 Mon Sep 17 00:00:00 2001 From: Archmonger <16909269+Archmonger@users.noreply.github.com> Date: Fri, 8 Apr 2022 18:47:41 -0700 Subject: [PATCH 22/26] wordsmitherererest --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 1f799bbad..1a313437d 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ # IDOM · [![Tests](https://github.com/idom-team/idom/workflows/Test/badge.svg?event=push)](https://github.com/idom-team/idom/actions?query=workflow%3ATest) [![PyPI Version](https://img.shields.io/pypi/v/idom.svg)](https://pypi.python.org/pypi/idom) [![License](https://img.shields.io/badge/License-MIT-purple.svg)](https://github.com/idom-team/idom/blob/main/LICENSE) -IDOM is a Python micro-framework that links your web project to a ReactJS front-end, allowing you to create **interactive websites without needing JavaScript!** +IDOM is a Python micro-framework that links your web framework of choice to a ReactJS frontend, allowing you to create **interactive websites without needing JavaScript!** -Web elements you provide are combined into [reusable "components"](https://idom-docs.herokuapp.com/docs/guides/creating-interfaces/your-first-components/index.html#parametrizing-components). These components can utilize [hooks](https://idom-docs.herokuapp.com/docs/reference/hooks-api.html) and [events](https://idom-docs.herokuapp.com/docs/guides/adding-interactivity/responding-to-events/index.html#async-event-handlers) to create infinitely complex web pages. +Following ReactJS styling, you combine web elements _(such as `div`, `img`, `h1`)_ into [reusable "components"](https://idom-docs.herokuapp.com/docs/guides/creating-interfaces/your-first-components/index.html#parametrizing-components). These components can utilize [hooks](https://idom-docs.herokuapp.com/docs/reference/hooks-api.html) and [events](https://idom-docs.herokuapp.com/docs/guides/adding-interactivity/responding-to-events/index.html#async-event-handlers) to create infinitely complex web pages. When needed, IDOM can [use JavaScript components](https://idom-docs.herokuapp.com/docs/guides/escape-hatches/javascript-components.html#dynamically-loaded-components) directly from NPM. Components can also be [developed in JavaScript](https://idom-docs.herokuapp.com/docs/guides/escape-hatches/javascript-components.html#custom-javascript-components) for additional flexibility. From f2b13fbdf6dbeff73c566a40ecee66ec68612f9b Mon Sep 17 00:00:00 2001 From: Archmonger <16909269+Archmonger@users.noreply.github.com> Date: Fri, 8 Apr 2022 21:06:43 -0700 Subject: [PATCH 23/26] more human sounding ecosystem indepedence paragraph --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 1a313437d..d7147bc09 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ Following ReactJS styling, you combine web elements _(such as `div`, `img`, `h1` When needed, IDOM can [use JavaScript components](https://idom-docs.herokuapp.com/docs/guides/escape-hatches/javascript-components.html#dynamically-loaded-components) directly from NPM. Components can also be [developed in JavaScript](https://idom-docs.herokuapp.com/docs/guides/escape-hatches/javascript-components.html#custom-javascript-components) for additional flexibility. -IDOM's ecosystem independent design allows components to be reused across a variety of web frameworks, such as `FastAPI`, `Flask`, `Sanic`, `Tornado`, [`Django`](https://github.com/idom-team/django-idom), [`Plotly-Dash`](https://github.com/idom-team/idom-dash), and [`Jupyter`](https://github.com/idom-team/idom-jupyter). +IDOM's ecosystem independent design allows components to be reused across a variety of web frameworks. Pre-existing support is included for popular frameworks such as `Flask`, `FastAPI`, `Sanic`, `Tornado`, [`Django`](https://github.com/idom-team/django-idom), [`Plotly-Dash`](https://github.com/idom-team/idom-dash), and [`Jupyter`](https://github.com/idom-team/idom-jupyter). However, any Python framework with WebSocket support can be adapted to utilize IDOM. # At a Glance From 3de8f2d5acfb73e244e9f2823bd6ad1eea689a17 Mon Sep 17 00:00:00 2001 From: Archmonger <16909269+Archmonger@users.noreply.github.com> Date: Fri, 8 Apr 2022 22:05:52 -0700 Subject: [PATCH 24/26] smithy --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d7147bc09..57f39179e 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ IDOM is a Python micro-framework that links your web framework of choice to a ReactJS frontend, allowing you to create **interactive websites without needing JavaScript!** -Following ReactJS styling, you combine web elements _(such as `div`, `img`, `h1`)_ into [reusable "components"](https://idom-docs.herokuapp.com/docs/guides/creating-interfaces/your-first-components/index.html#parametrizing-components). These components can utilize [hooks](https://idom-docs.herokuapp.com/docs/reference/hooks-api.html) and [events](https://idom-docs.herokuapp.com/docs/guides/adding-interactivity/responding-to-events/index.html#async-event-handlers) to create infinitely complex web pages. +Following ReactJS styling, web elements _(such as `div`, `img`, `h1`)_ are combined into [reusable "components"](https://idom-docs.herokuapp.com/docs/guides/creating-interfaces/your-first-components/index.html#parametrizing-components). These components can utilize [hooks](https://idom-docs.herokuapp.com/docs/reference/hooks-api.html) and [events](https://idom-docs.herokuapp.com/docs/guides/adding-interactivity/responding-to-events/index.html#async-event-handlers) to create infinitely complex web pages. When needed, IDOM can [use JavaScript components](https://idom-docs.herokuapp.com/docs/guides/escape-hatches/javascript-components.html#dynamically-loaded-components) directly from NPM. Components can also be [developed in JavaScript](https://idom-docs.herokuapp.com/docs/guides/escape-hatches/javascript-components.html#custom-javascript-components) for additional flexibility. From b9dfb5b06fef52c9163b8a269637b1015d0f89f4 Mon Sep 17 00:00:00 2001 From: Archmonger <16909269+Archmonger@users.noreply.github.com> Date: Tue, 12 Apr 2022 14:30:31 -0700 Subject: [PATCH 25/26] requested changes --- README.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 57f39179e..947ce38de 100644 --- a/README.md +++ b/README.md @@ -2,11 +2,16 @@ IDOM is a Python micro-framework that links your web framework of choice to a ReactJS frontend, allowing you to create **interactive websites without needing JavaScript!** -Following ReactJS styling, web elements _(such as `div`, `img`, `h1`)_ are combined into [reusable "components"](https://idom-docs.herokuapp.com/docs/guides/creating-interfaces/your-first-components/index.html#parametrizing-components). These components can utilize [hooks](https://idom-docs.herokuapp.com/docs/reference/hooks-api.html) and [events](https://idom-docs.herokuapp.com/docs/guides/adding-interactivity/responding-to-events/index.html#async-event-handlers) to create infinitely complex web pages. +Following ReactJS styling, web elements are combined into [reusable "components"](https://idom-docs.herokuapp.com/docs/guides/creating-interfaces/your-first-components/index.html#parametrizing-components). These components can utilize [hooks](https://idom-docs.herokuapp.com/docs/reference/hooks-api.html) and [events](https://idom-docs.herokuapp.com/docs/guides/adding-interactivity/responding-to-events/index.html#async-event-handlers) to create infinitely complex web pages. When needed, IDOM can [use JavaScript components](https://idom-docs.herokuapp.com/docs/guides/escape-hatches/javascript-components.html#dynamically-loaded-components) directly from NPM. Components can also be [developed in JavaScript](https://idom-docs.herokuapp.com/docs/guides/escape-hatches/javascript-components.html#custom-javascript-components) for additional flexibility. -IDOM's ecosystem independent design allows components to be reused across a variety of web frameworks. Pre-existing support is included for popular frameworks such as `Flask`, `FastAPI`, `Sanic`, `Tornado`, [`Django`](https://github.com/idom-team/django-idom), [`Plotly-Dash`](https://github.com/idom-team/idom-dash), and [`Jupyter`](https://github.com/idom-team/idom-jupyter). However, any Python framework with WebSocket support can be adapted to utilize IDOM. +IDOM's ecosystem independent design allows components to be reused across a variety of web frameworks. Pre-existing support is included for many popular Python frameworks, however, any framework with WebSocket support can be adapted to utilize IDOM. + +| Internal Support | External Support | +| --- | --- | +| [`Flask`, `FastAPI`, `Sanic`, `Tornado`](https://idom-docs.herokuapp.com/docs/guides/getting-started/installing-idom.html#officially-supported-servers) | [`Django`](https://github.com/idom-team/django-idom), [`Plotly-Dash`](https://github.com/idom-team/idom-dash), [`Jupyter`](https://github.com/idom-team/idom-jupyter) | + # At a Glance From e4654c19d978a53133f996fcabb7b7f763785695 Mon Sep 17 00:00:00 2001 From: Archmonger <16909269+Archmonger@users.noreply.github.com> Date: Tue, 12 Apr 2022 14:32:22 -0700 Subject: [PATCH 26/26] more words --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 947ce38de..bc57439bc 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ When needed, IDOM can [use JavaScript components](https://idom-docs.herokuapp.co IDOM's ecosystem independent design allows components to be reused across a variety of web frameworks. Pre-existing support is included for many popular Python frameworks, however, any framework with WebSocket support can be adapted to utilize IDOM. -| Internal Support | External Support | +| Supported Frameworks | Supported Frameworks (External) | | --- | --- | | [`Flask`, `FastAPI`, `Sanic`, `Tornado`](https://idom-docs.herokuapp.com/docs/guides/getting-started/installing-idom.html#officially-supported-servers) | [`Django`](https://github.com/idom-team/django-idom), [`Plotly-Dash`](https://github.com/idom-team/idom-dash), [`Jupyter`](https://github.com/idom-team/idom-jupyter) |