File tree Expand file tree Collapse file tree 3 files changed +33
-38
lines changed Expand file tree Collapse file tree 3 files changed +33
-38
lines changed Original file line number Diff line number Diff line change 11Extra Features
22==============
33
4- Optionally installable features of IDOM.
4+ Optionally installable features of IDOM. To install them use the given "Name" from the table below
55
6- To install a ** stable ** set of features for IDOM simply run.
6+ .. code-block :: bash
77
8- .. code-block ::
8+ pip install idom[NAME]
99
10- pip install idom[stable]
10+ .. list-table ::
11+ :header-rows: 1
12+ :widths: 1 3
1113
12- To install **all ** extra features run
14+ * - Name
15+ - Description
1316
14- .. code-block ::
17+ * - ``stable ``
18+ - Default implementations for all IDOM's features
19+
20+ * - ``testing ``
21+ - Utilities for testing IDOM using `Selenium <https://www.selenium.dev/ >`__
1522
16- pip install idom[all]
23+ * - ``sanic ``
24+ - `Sanic <https://sanicframework.org/ >`__ as a :ref: `Layout Server `
1725
26+ * - ``tornado ``
27+ - `Tornado <https://www.tornadoweb.org/en/stable/ >`__ as a :ref: `Layout Server `
1828
19- Layout Server Implementations
20- -----------------------------
29+ * - `` flask ``
30+ - ` Flask < https://palletsprojects.com/p/flask/ >`__ as a :ref: ` Layout Server `
2131
22- There are several supported :ref: `Layout Server ` implementations available for IDOM:
32+ * - ``dialect ``
33+ - :ref: `Python Language Extension ` for writing JSX-like syntax
2334
24- - `Sanic <https://sanicframework.org/ >`__: ``pip install idom[sanic] ``
25- - `Flask <https://palletsprojects.com/p/flask/ >`__: ``pip install idom[flask] ``
26- - `Tornado <https://www.tornadoweb.org/en/stable/ >`__: ``pip install idom[tornado] ``
35+ * - ``all ``
36+ - All the features listed above (not usually needed)
2737
2838
2939Python Language Extension
3040-------------------------
3141
32- IDOM includes a transpiler for writing JSX-like syntax in a normal Python file!
42+ IDOM includes an import-time transpiler for writing JSX-like syntax in a `` .py `` file!
3343
3444.. code-block :: python
3545
Original file line number Diff line number Diff line change @@ -13,6 +13,8 @@ Libraries for defining and controlling interactive webpages with Python
1313 life-cycle-hooks
1414 core-concepts
1515 javascript-components
16+ specifications
17+ extra-features
1618 examples
1719
1820.. toctree ::
@@ -21,8 +23,6 @@ Libraries for defining and controlling interactive webpages with Python
2123
2224 GitHub Repo <https://github.com/idom-team/idom >
2325 package-api
24- specifications
25- extra-features
2626
2727
2828Early Days
Original file line number Diff line number Diff line change 11Installation
22============
33
4- .. list-table ::
5- :header-rows: 1
4+ To install IDOM and a default implementation for all features:
65
7- * - What
8- - How To Install
9-
10- * - The Core Library
11- - IDOM is on PyPI _ - use pip _ to install a **stable ** version:
12-
13- .. code-block :: bash
14-
15- pip install idom[stable]
16-
17- * - Extra Features
18-
19- - To install **specific ** features see :ref: `Extra Features `, but to install all of them:
6+ .. code-block :: bash
207
21- .. code-block :: bash
8+ pip install idom[stable]
229
23- # all extra features
24- pip install idom[all]
10+ For a minimal installation that lacks implementations for some features:
2511
26- * - Pre Release
27- - This may be unstable or subject to breaking changes
12+ .. code-block :: bash
2813
29- .. code-block :: bash
14+ pip install idom
3015
31- pip install idom --pre
16+ For more installation options see the :ref: ` Extra Features ` section.
3217
3318
3419Development Version
You can’t perform that action at this time.
0 commit comments