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 1
1
Extra Features
2
2
==============
3
3
4
- Optionally installable features of IDOM.
4
+ Optionally installable features of IDOM. To install them use the given "Name" from the table below
5
5
6
- To install a ** stable ** set of features for IDOM simply run.
6
+ .. code-block :: bash
7
7
8
- .. code-block ::
8
+ pip install idom[NAME]
9
9
10
- pip install idom[stable]
10
+ .. list-table ::
11
+ :header-rows: 1
12
+ :widths: 1 3
11
13
12
- To install **all ** extra features run
14
+ * - Name
15
+ - Description
13
16
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/ >`__
15
22
16
- pip install idom[all]
23
+ * - ``sanic ``
24
+ - `Sanic <https://sanicframework.org/ >`__ as a :ref: `Layout Server `
17
25
26
+ * - ``tornado ``
27
+ - `Tornado <https://www.tornadoweb.org/en/stable/ >`__ as a :ref: `Layout Server `
18
28
19
- Layout Server Implementations
20
- -----------------------------
29
+ * - `` flask ``
30
+ - ` Flask < https://palletsprojects.com/p/flask/ >`__ as a :ref: ` Layout Server `
21
31
22
- There are several supported :ref: `Layout Server ` implementations available for IDOM:
32
+ * - ``dialect ``
33
+ - :ref: `Python Language Extension ` for writing JSX-like syntax
23
34
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)
27
37
28
38
29
39
Python Language Extension
30
40
-------------------------
31
41
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!
33
43
34
44
.. code-block :: python
35
45
Original file line number Diff line number Diff line change @@ -13,6 +13,8 @@ Libraries for defining and controlling interactive webpages with Python
13
13
life-cycle-hooks
14
14
core-concepts
15
15
javascript-components
16
+ specifications
17
+ extra-features
16
18
examples
17
19
18
20
.. toctree ::
@@ -21,8 +23,6 @@ Libraries for defining and controlling interactive webpages with Python
21
23
22
24
GitHub Repo <https://github.com/idom-team/idom >
23
25
package-api
24
- specifications
25
- extra-features
26
26
27
27
28
28
Early Days
Original file line number Diff line number Diff line change 1
1
Installation
2
2
============
3
3
4
- .. list-table ::
5
- :header-rows: 1
4
+ To install IDOM and a default implementation for all features:
6
5
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
20
7
21
- .. code-block :: bash
8
+ pip install idom[stable]
22
9
23
- # all extra features
24
- pip install idom[all]
10
+ For a minimal installation that lacks implementations for some features:
25
11
26
- * - Pre Release
27
- - This may be unstable or subject to breaking changes
12
+ .. code-block :: bash
28
13
29
- .. code-block :: bash
14
+ pip install idom
30
15
31
- pip install idom --pre
16
+ For more installation options see the :ref: ` Extra Features ` section.
32
17
33
18
34
19
Development Version
You can’t perform that action at this time.
0 commit comments