Merge branch 'main' of https://github.com/acivitillo/idom

Author: Alessio Civitillo

MANIFEST.in

@@ -1,2 +1,3 @@
 recursive-include src/idom/client *
 recursive-include src/idom/web/templates *
+include src/idom/py.typed

VERSION

@@ -1 +1 @@
-0.34.0
+0.35.1

docs/source/creating-interfaces/rendering-data.rst

@@ -116,9 +116,9 @@ see the server log a bunch of errors that look something like:
 
 .. code-block:: text
 
-    Key not specified for dynamic child {'tagName': 'li', 'children': ['Do some coding']}
+    Key not specified for child in list {'tagName': 'li', 'children': ...}
 
-What this is telling you is that we haven't specified a unique ``key`` for each of the
+What this is telling us is that we haven't specified a unique ``key`` for each of the
 items in our todo list. In order to silence this warning we need to expand our data
 structure even further to include a unique ID for each item in our todo list:
 

docs/source/developing-idom/changelog.rst

@@ -1,6 +1,59 @@
 Changelog
 =========
 
+The IDOM team manages their short and long term plans with `GitHub Projects
+<https://github.com/orgs/idom-team/projects/1>`__. If you have questions about what the
+team are working on, or have feedback on how issues should be prioritized, feel free to
+:discussion-type:`open up a discussion <question>`.
+
+
+0.35.1
+------
+
+Re-add accidentally deleted ``py.typed`` file to distribution. See `PEP-561
+<https://www.python.org/dev/peps/pep-0561/#packaging-type-information>`__ for info on
+this marker file.
+
+
+0.35.0
+------
+
+The highlight of this release is that the default :ref:`"key" <Organizing Items With
+Keys>` of all elements will be their index amongst their neighbors. Previously this
+behavior could be engaged by setting ``IDOM_FEATURE_INDEX_AS_DEFAULT_KEY=1`` when
+running IDOM. In this release though, you will need to explicitely turn off this feature
+(i.e. ``=0``) to return to the old behavior. With this change, some may notice
+additional error logs which warn that:
+
+.. code-block:: text
+
+  Key not specified for child in list ...
+
+This is saying is that an element or component which was created in a list does not have
+a unique ``key``. For more information on how to mitigate this warning refer to the docs
+on :ref:`Organizing Items With Keys`.
+
+**Closed Issues**
+
+- Support Starlette Server - :issue:`588`
+- Fix unhandled case in module_from_template - :issue:`584`
+- Hide "Children" within IDOM_DEBUG_MODE key warnings - :issue:`562`
+- Bug in Element Key Identity - :issue:`556`
+- Add iFrame to idom.html - :issue:`542`
+- Create a use_linked_inputs widget instead of Input - :issue:`475`
+- React warning from module_from_template - :issue:`440`
+- Use Index as Default Key - :issue:`351`
+
+**Pull Requests**
+
+- add ``use_linked_inputs`` - :pull:`593`
+- add starlette server implementation - :pull:`590`
+- Log on web module replacement instead of error - :pull:`586`
+- Make Index Default Key - :pull:`579`
+- reduce log spam from missing keys in children - :pull:`564`
+- fix bug in element key identity - :pull:`563`
+- add more standard html elements - :pull:`554`
+
 
 0.34.0
 ------

docs/source/developing-idom/index.rst

@@ -6,7 +6,6 @@ Developing IDOM
 
     contributor-guide
     changelog
-    roadmap
 
 .. note::
 
@@ -42,8 +41,8 @@ you can help move this project and community forward!
         Discover the features and fixes included in each release
 
     .. grid-item-card:: :octicon:`milestone` Roadmap
-        :link: roadmap
-        :link-type: doc
+        :link: https://github.com/orgs/idom-team/projects/1
+        :link-type: url
 
         See the long term goals of the IDOM team
 

docs/source/developing-idom/roadmap.rst

@@ -4,13 +4,7 @@
 
 
 file = Path(__file__).parent / "super-simple-chart.js"
-ssc = web.module_from_file(
-    "super-simple-chart",
-    file,
-    fallback="⌛",
-    # normally this option is not required
-    replace_existing=True,
-)
+ssc = web.module_from_file("super-simple-chart", file, fallback="⌛")
 SuperSimpleChart = web.export(ssc, "SuperSimpleChart")
 
 

docs/source/escape-hatches/_examples/super_simple_chart/app.py

@@ -299,7 +299,7 @@ def tag(session: Session) -> None:
             external=True,
         )
     except Exception:
-        session.error("Cannot create a tag - tROOT are uncommited changes")
+        session.error("Cannot create a tag - there are uncommited changes")
 
     version = get_version()
     install_requirements_file(session, "make-release")
@@ -308,6 +308,7 @@ def tag(session: Session) -> None:
     changelog_file = ROOT / "docs" / "source" / "developing-idom" / "changelog.rst"
     for line in changelog_file.read_text().splitlines():
         if line == version:
+            session.log(f"Found changelog section for version {version}")
             break
     else:
         session.error(

noxfile.py

@@ -6,6 +6,10 @@ sanic-cors
 fastapi >=0.63.0
 uvicorn[standard] >=0.13.4
 
+# extra=starlette
+fastapi >=0.16.0
+uvicorn[standard] >=0.13.4
+
 # extra=flask
 flask<2.0
 flask-cors

package-lock.json

@@ -23,12 +23,13 @@ def list2cmdline(cmd_list):
 
 
 # the name of the project
-name = "idom"
+NAME = "idom"
 
 # basic paths used to gather files
-root_dir = Path(__file__).parent
-src_dir = root_dir / "src"
-package_dir = src_dir / name
+ROOT_DIR = Path(__file__).parent
+SRC_DIR = ROOT_DIR / "src"
+PKG_DIR = SRC_DIR / NAME
+JS_DIR = SRC_DIR / "client"
 
 
 # -----------------------------------------------------------------------------
@@ -37,9 +38,9 @@ def list2cmdline(cmd_list):
 
 
 package = {
-    "name": name,
+    "name": NAME,
     "python_requires": ">=3.7",
-    "packages": find_packages(str(src_dir)),
+    "packages": find_packages(str(SRC_DIR)),
     "package_dir": {"": "src"},
     "description": "It's React, but in Python",
     "author": "Ryan Morshead",
@@ -70,7 +71,7 @@ def list2cmdline(cmd_list):
 # Library Version
 # -----------------------------------------------------------------------------
 
-pkg_root_init_file = package_dir / "__init__.py"
+pkg_root_init_file = PKG_DIR / "__init__.py"
 for line in pkg_root_init_file.read_text().split("\n"):
     if line.startswith('__version__ = "') and line.endswith('"  # DO NOT MODIFY'):
         package["version"] = (
@@ -96,15 +97,15 @@ def list2cmdline(cmd_list):
 
 
 requirements = []
-with (root_dir / "requirements" / "pkg-deps.txt").open() as f:
+with (ROOT_DIR / "requirements" / "pkg-deps.txt").open() as f:
     for line in map(str.strip, f):
         if not line.startswith("#"):
             requirements.append(line)
 package["install_requires"] = requirements
 
 _current_extras = []
 extra_requirements = {"all": []}  # type: ignore
-extra_requirements_path = root_dir / "requirements" / "pkg-extras.txt"
+extra_requirements_path = ROOT_DIR / "requirements" / "pkg-extras.txt"
 with extra_requirements_path.open() as f:
     for line in map(str.strip, f):
         if line.startswith("#") and line[1:].strip().startswith("extra="):
@@ -129,7 +130,7 @@ def list2cmdline(cmd_list):
 # -----------------------------------------------------------------------------
 
 
-with (root_dir / "README.md").open() as f:
+with (ROOT_DIR / "README.md").open() as f:
     long_description = f.read()
 
 package["long_description"] = long_description
@@ -146,14 +147,13 @@ class Command(cls):
         def run(self):
             log.info("Installing Javascript...")
             try:
-                js_dir = str(src_dir / "client")
                 npm = shutil.which("npm")  # this is required on windows
                 if npm is None:
                     raise RuntimeError("NPM is not installed.")
                 for args in (f"{npm} install", f"{npm} run build"):
                     args_list = args.split()
                     log.info(f"> {list2cmdline(args_list)}")
-                    subprocess.run(args_list, cwd=js_dir, check=True)
+                    subprocess.run(args_list, cwd=str(JS_DIR), check=True)
             except Exception:
                 log.error("Failed to install Javascript")
                 log.error(traceback.format_exc())

package.json

@@ -14,7 +14,7 @@
     "publish": "npm --workspaces publish",
     "test": "npm --workspaces test"
   },
-  "version": "0.34.0",
+  "version": "0.35.1",
   "workspaces": [
     "./packages/*"
   ]

requirements/pkg-extras.txt

@@ -21,5 +21,5 @@
     "format": "prettier --write ./src",
     "test": "echo 'no tests'"
   },
-  "version": "0.34.0"
+  "version": "0.35.1"
 }

setup.py

@@ -31,5 +31,5 @@
     "test": "uvu tests"
   },
   "type": "module",
-  "version": "0.34.0"
+  "version": "0.35.1"
 }

src/client/package-lock.json

@@ -21,7 +21,7 @@
 
 
 __author__ = "idom-team"
-__version__ = "0.34.0"  # DO NOT MODIFY
+__version__ = "0.35.1"  # DO NOT MODIFY
 
 __all__ = [
     "component",