-
-
Notifications
You must be signed in to change notification settings - Fork 324
rename idom to reactpy #892
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
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
blank_issues_enabled: false | ||
contact_links: | ||
- name: Start a Discussion | ||
url: https://github.com/idom-team/idom/discussions | ||
url: https://github.com/reactive-python/reactpy/discussions | ||
about: Report issues, request features, ask questions, and share ideas |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
# --- Build Artifacts --- | ||
src/idom/_client | ||
src/reactpy/_client | ||
|
||
# --- Jupyter --- | ||
*.ipynb_checkpoints | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,3 @@ | ||
recursive-include src/idom/_client * | ||
recursive-include src/idom/web/templates * | ||
include src/idom/py.typed | ||
recursive-include src/reactpy/_client * | ||
recursive-include src/reactpy/web/templates * | ||
include src/reactpy/py.typed |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,24 +1,40 @@ | ||
# IDOM · [](https://github.com/idom-team/idom/actions?query=workflow%3ATest) [](https://pypi.python.org/pypi/idom) [](https://github.com/idom-team/idom/blob/main/LICENSE) | ||
|
||
IDOM connects your Python web framework of choice to a ReactJS frontend, allowing you to create **interactive websites without needing JavaScript!** | ||
|
||
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 components directly from NPM](https://idom-docs.herokuapp.com/docs/guides/escape-hatches/javascript-components.html#dynamically-loaded-components). For additional flexibility, components can also be [fully developed in JavaScript](https://idom-docs.herokuapp.com/docs/guides/escape-hatches/javascript-components.html#custom-javascript-components). | ||
|
||
Any Python web framework with Websockets can support IDOM. See below for what frameworks are supported out of the box. | ||
|
||
| 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) | | ||
|
||
# ReactPy · [](https://github.com/reactive-python/reactpy/actions?query=workflow%3ATest) [](https://pypi.python.org/pypi/reactpy) [](https://github.com/reactive-python/reactpy/blob/main/LICENSE) | ||
|
||
ReactPy is a library for building user interfaces in Python without Javascript. ReactPy | ||
interfaces are made from components which look and behave similarly to this found in | ||
[ReactJS](https://reactjs.org/). Designed with simplicity in mind, ReactPy can be used | ||
by those without web development experience while also being powerful enough to grow | ||
with your ambitions. | ||
|
||
<table> | ||
<thead> | ||
<tr> | ||
<th>Supported Servers</th> | ||
<th>Supported Integrations</th> | ||
Comment on lines
+12
to
+13
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We should be consistent about our usage of verbiage. ASGI Python Frameworks are not servers. The word server only applies to things like
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. How about “built-in backends” and “supported frameworks”? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Neither option gives a good indication of why we separate these two categories. Maybe we say something like
|
||
</tr> | ||
</thead> | ||
<tbody> | ||
<tr> | ||
<td> | ||
<a href="https://reactpy-docs.herokuapp.com/docs/guides/getting-started/installing-reactpy.html#officially-supported-servers"> | ||
Flask, FastAPI, Sanic, Tornado | ||
</a> | ||
</td> | ||
<td> | ||
<a href="https://github.com/reactive-python/reactpy-django">Django</a>, | ||
<a href="https://github.com/reactive-python/reactpy-jupyter">Jupyter</a>, | ||
<a href="https://github.com/reactive-python/reactpy-dash">Plotly-Dash</a> | ||
</td> | ||
</tr> | ||
</tbody> | ||
</table> | ||
|
||
# At a Glance | ||
|
||
To get a rough idea of how to write apps in IDOM, take a look at this tiny _Hello World_ application. | ||
To get a rough idea of how to write apps in ReactPy, take a look at this tiny _Hello World_ application. | ||
|
||
```python | ||
from idom import component, html, run | ||
from reactpy import component, html, run | ||
|
||
@component | ||
def HelloWorld(): | ||
|
@@ -31,8 +47,8 @@ run(HelloWorld) | |
|
||
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/reactive-python/reactpy-jupyter/main?urlpath=lab/tree/notebooks/introduction.ipynb) - check out ReactPy in a Jupyter Notebook. | ||
- [Documentation](https://reactpy-docs.herokuapp.com/) - learn how to install, run, and use ReactPy. | ||
- [Community Forum](https://github.com/reactive-python/reactpy/discussions) - ask questions, share ideas, and show off projects. | ||
- [Contributor Guide](https://reactpy-docs.herokuapp.com/docs/developing-reactpy/contributor-guide.html) - see how you can help develop this project. | ||
- [Code of Conduct](https://github.com/reactive-python/reactpy/blob/main/CODE_OF_CONDUCT.md) - standards for interacting with this community. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Something I'm now realizing, why are we using HTML tables instead of markdown tables? They should accomplish the same thing?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
IMO, the md table was quite hard to read in raw text with all the links.