Skip to content

Commit fdaa492

Browse files
rmorshearmorshea
committed
improve description
1 parent 800e2fc commit fdaa492

File tree

2 files changed

+44
-22
lines changed

2 files changed

+44
-22
lines changed

‎README.md

+33-11
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,38 @@
11
# ReactPy · [![Tests](https://github.com/reactive-python/reactpy/workflows/test/badge.svg)](https://github.com/reactive-python/reactpy/actions?query=workflow%3ATest) [![PyPI Version](https://img.shields.io/pypi/v/reactpy.svg)](https://pypi.python.org/pypi/reactpy) [![License](https://img.shields.io/badge/License-MIT-purple.svg)](https://github.com/reactive-python/reactpy/blob/main/LICENSE)
22

3-
ReactPy connects your Python web framework of choice to a ReactJS frontend, allowing you to create **interactive websites without needing JavaScript!**
4-
5-
Following ReactJS styling, web elements are combined into [reusable "components"](https://reactpy-docs.herokuapp.com/docs/guides/creating-interfaces/your-first-components/index.html#parametrizing-components). These components can utilize [hooks](https://reactpy-docs.herokuapp.com/docs/reference/hooks-api.html) and [events](https://reactpy-docs.herokuapp.com/docs/guides/adding-interactivity/responding-to-events/index.html#async-event-handlers) to create infinitely complex web pages.
6-
7-
When needed, ReactPy can [use components directly from NPM](https://reactpy-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://reactpy-docs.herokuapp.com/docs/guides/escape-hatches/javascript-components.html#custom-javascript-components).
8-
9-
Any Python web framework with Websockets can support ReactPy. See below for what frameworks are supported out of the box.
10-
11-
| Supported Frameworks | Supported Frameworks (External) |
12-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
13-
| [`Flask`, `FastAPI`, `Sanic`, `Tornado`](https://reactpy-docs.herokuapp.com/docs/guides/getting-started/installing-reactpy.html#officially-supported-servers) | [`Django`](https://github.com/reactive-python/django-reactpy), [`Plotly-Dash`](https://github.com/reactive-python/reactpy-dash), [`Jupyter`](https://github.com/reactive-python/reactpy-jupyter) |
3+
ReactPy is a library for building user interfaces in Python without any Javascript.
4+
Interfaces made using ReactPy are composed of encapsulated components which look and
5+
behave similarly to those found in [ReactJS](https://reactjs.org/). These components are
6+
easy to create and reason about when you're getting started, as well as simple to extend
7+
and maintain when you need to make changes later.
8+
9+
Whether you need to run a full blown application with a standalone server, or just want
10+
try things out in a Jupyter Notebook. ReactPy has you covered - it's both approachable
11+
for those without web development experience while also being powerful enough to grow
12+
with your ambitions.
13+
14+
<table>
15+
<thead>
16+
<tr>
17+
<th>Supported Servers</th>
18+
<th>Supported Integrations</th>
19+
</tr>
20+
</thead>
21+
<tbody>
22+
<tr>
23+
<td>
24+
<a href="https://reactpy-docs.herokuapp.com/docs/guides/getting-started/installing-reactpy.html#officially-supported-servers">
25+
Flask, FastAPI, Sanic, Tornado
26+
</a>
27+
</td>
28+
<td>
29+
<a href="https://github.com/reactive-python/reactpy-django">Django</a>,
30+
<a href="https://github.com/reactive-python/reactpy-jupyter">Jupyter</a>,
31+
<a href="https://github.com/reactive-python/reactpy-dash">Plotly-Dash</a>
32+
</td>
33+
</tr>
34+
</tbody>
35+
</table>
1436

1537
# At a Glance
1638

‎docs/source/index.rst

+11-11
Original file line numberDiff line numberDiff line change
@@ -39,17 +39,17 @@ ReactPy
3939
Community <https://github.com/reactive-python/reactpy/discussions>
4040

4141

42-
ReactPy is a Python web framework for building **interactive websites without a single
43-
line of Javascript**. This is accomplished by breaking down complex applications into
44-
nestable and reusable chunks of code called :ref:`"components" <Your First Components>`
45-
that allow you to focus on what your application does rather than how it does it.
46-
47-
ReactPy can be added to existing applications built on a variety of sync and async web
48-
servers, as well as integrated with other frameworks like Django, Jupyter, and Plotly
49-
Dash. Not only does this mean you're free to choose what technology stack to run on, but
50-
on top of that, you can run the exact same components wherever you need them. For
51-
example, you can take a component originally developed in a Jupyter Notebook and embed
52-
it in your production application without changing anything about the component itself.
42+
ReactPy is a library for building user interfaces in Python without any Javascript.
43+
These interfaces are composed of encapsulated :ref:`"components" <Your First
44+
Components>` which look and behave similarly to those found in `ReactJS
45+
<https://reactjs.org/>`__. Components made using ReactPy are easy to create and reason
46+
about when you're getting started, as well as simple to extend and maintain when you
47+
have to make changes later.
48+
49+
Whether you need to run a full blown application with a standalone server, or just want
50+
try things out in a Jupyter Notebook. ReactPy has you covered - it's both approachable
51+
for those without web development experience while also being powerful enough to grow
52+
with your ambitions.
5353

5454

5555
At a Glance

0 commit comments

Comments
 (0)