Merge pull request #2 from ghost-in-moss/dev

initialize the project

Author: thirdgerb

.gitignore

@@ -0,0 +1,71 @@
+########################################################################
+# Python - https://github.com/github/gitignore/blob/master/Python.gitignore
+########################################################################
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+poetry.lock
+
+# Distribution / packaging
+dist/
+eggs/
+.eggs/
+*.egg-info/
+*.egg
+
+# Unit test / coverage reports
+.coverage
+.coverage\.*
+.pytest_cache/
+.mypy_cache/
+test-reports
+
+# Test fixtures
+cffi_bin
+
+# Pyenv Stuff
+.python-version
+
+########################################################################
+# OSX - https://github.com/github/gitignore/blob/master/Global/macOS.gitignore
+########################################################################
+.DS_Store
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+########################################################################
+# node - https://github.com/github/gitignore/blob/master/Node.gitignore
+########################################################################
+# Logs
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Dependency directories
+node_modules/
+
+# Coverage directory used by tools like istanbul
+coverage/
+
+# Lockfiles
+template/**/yarn.lock
+template/**/package-lock.json
+template-reactless/**/yarn.lock
+template-reactless/**/package-lock.json
+
+########################################################################
+# JetBrains
+########################################################################
+.idea
+
+########################################################################
+# VSCode
+########################################################################
+.vscode/
+buildcontext/

MANIFEST.in

@@ -0,0 +1 @@
+recursive-include streamlit_react_jsonschema/frontend/build *

README.md

@@ -0,0 +1,70 @@
+# Streamlit-react-jsonschema
+
+Streamlit component, 
+building form by [react-jsonschema-form](https://react-jsonschema-form.readthedocs.io/).
+
+This library is experimental for [GhostOS](https://github.com/ghost-in-moss/GhostOS) yet.
+
+## Installation
+
+install `streamlit-react-jsonschema` with pip
+
+```bash
+pip install streamlit_react_jsonschema
+```
+
+## Example
+
+see [baseline example](examples/baseline.py)
+
+```python
+from typing import Union, List, Dict
+import streamlit as st
+import streamlit_react_jsonschema as srj
+import inspect
+from pydantic import BaseModel, Field
+
+
+class Student(BaseModel):
+    name: str = Field(description="name of the student")
+    level: int = Field(description="level of the student")
+
+
+class SomeClass(BaseModel):
+    """
+    test class of pydantic model Foo
+    """
+    name: Union[str, None] = Field(None, description="filed with optional[str]")
+    age: int = Field(0, description="bar value")
+    some_float: float = Field(description="test about float value")
+
+    students: List[Student] = Field(default_factory=list, description="list of students")
+    students_dict: Dict[str, Student] = Field(default_factory=dict, description="dict of students")
+
+
+st.title("Streamlit-react-jsonschema Example")
+with st.expander("source code of the example pydantic class", expanded=True):
+    codes = inspect.getsource(SomeClass)
+    st.code(codes)
+
+value, submitted = srj.pydantic_form(model=SomeClass)
+
+st.subheader("result:")
+st.write(f"submitted: {submitted}")
+st.write(f"type of the result: {type(value)}")
+st.write(value)
+if isinstance(value, BaseModel):
+    st.write("model dump value")
+    st.write(value.model_dump(exclude_defaults=False))
+```
+
+How to run this example? Check [streamlit](https://docs.streamlit.io/) first~
+
+## Dependencies
+
+- [Streamlit](https://streamlit.io/)
+- [React-jsonschema-form](https://react-jsonschema-form.readthedocs.io/): render the form from json schema
+- [Material UI](https://mui.com/) : use `@rjsf/mui` theme from the `react-jsonschema-form`
+- [pydantic](https://docs.pydantic.dev/latest/) : generate json schema
+
+

examples/baseline.py

@@ -0,0 +1,38 @@
+from typing import Union, List, Dict
+import streamlit as st
+import streamlit_react_jsonschema as srj
+import inspect
+from pydantic import BaseModel, Field
+
+
+class Student(BaseModel):
+    name: str = Field(description="name of the student")
+    level: int = Field(description="level of the student")
+
+
+class SomeClass(BaseModel):
+    """
+    test class of pydantic model Foo
+    """
+    name: Union[str, None] = Field(None, description="filed with optional[str]")
+    age: int = Field(0, description="bar value")
+    some_float: float = Field(description="test about float value")
+
+    students: List[Student] = Field(default_factory=list, description="list of students")
+    students_dict: Dict[str, Student] = Field(default_factory=dict, description="dict of students")
+
+
+st.title("Streamlit-react-jsonschema Example")
+with st.expander("source code of the example pydantic class", expanded=True):
+    codes = inspect.getsource(SomeClass)
+    st.code(codes)
+
+value, submitted = srj.pydantic_form(model=SomeClass)
+
+st.subheader("result:")
+st.write(f"submitted: {submitted}")
+st.write(f"type of the result: {type(value)}")
+st.write(value)
+if isinstance(value, BaseModel):
+    st.write("model dump value")
+    st.write(value.model_dump(exclude_defaults=False))

pyproject.toml

@@ -0,0 +1,18 @@
+[tool.poetry]
+name = "streamlit_react_jsonschema"
+version = "0.1.3"
+description = "streamlit component for GhostOS, render form from JSONSchema by react-jsonschema-component"
+authors = ["ZhuMing <[email protected]>"]
+license = "MIT"
+readme = "README.md"
+
+[tool.poetry.dependencies]
+python = "!=3.9.7,>=3.8"
+pydantic = "^2"
+streamlit = "^1.39.0"
+
+
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"

streamlit_react_jsonschema/__init__.py

@@ -0,0 +1,107 @@
+import os
+import streamlit as st
+import streamlit.components.v1 as components
+from typing import Type, Dict, Optional, Tuple
+from pydantic import BaseModel
+
+__all__ = [
+    'jsonschema_form',
+    'pydantic_form',
+    'pydantic_instance_form',
+]
+
+_RELEASE = True
+
+COMPONENT_NAME = "streamlit_react_jsonschema"
+
+if not _RELEASE:
+    _component_func = components.declare_component(
+        COMPONENT_NAME,
+        url="http://localhost:3001",
+    )
+else:
+    parent_dir = os.path.dirname(os.path.abspath(__file__))
+    build_dir = os.path.join(parent_dir, "frontend/build")
+    _component_func = components.declare_component(COMPONENT_NAME, path=build_dir)
+
+
+def pydantic_form(
+        model: Type[BaseModel],
+        *,
+        key: str = None,
+        default: Dict = None,
+) -> Tuple[Optional[BaseModel], bool]:
+    """
+    render a react-json-schema form by json schema from pydantic model
+    default ui is material ui v5
+    see details in frontend/
+    :param model: the pydantic model type
+    :param key: the elementId of the Form
+    :param default: default value of the model.
+    :return: (model instance: BaseModel, submitted: bool)
+    model instance is None unless the form is submitted, get the pydantic model instance.
+    this function use pydantic model to validate the result that form returns.
+    """
+    if key is None:
+        key = _pydantic_model_key(model)
+    schema = model.model_json_schema()
+    result, submitted = jsonschema_form(key, schema, default=default)
+    if result is not None:
+        return model(**result), submitted is True
+    return result, submitted is True
+
+
+def _pydantic_model_key(model: Type[BaseModel]) -> str:
+    return f"{model.__module__}:{model.__qualname__}"
+
+
+def pydantic_instance_form(
+        instance: BaseModel,
+        *,
+        key: str = None,
+        deep: bool = True,
+) -> Tuple[Optional[BaseModel], bool]:
+    """
+    render a react-json-schema form by json schema from pydantic instance
+    default ui is material ui v5
+    :param instance: pydantic model instance
+    :param key: the elementId of the Form
+    :param deep: if deep is True, return instance's deep copy by updated values
+    :return: (instance, submitted)
+    instance is None unless the form is submitted, get the pydantic model instance.
+    """
+    data = instance.model_dump(exclude_defaults=False)
+    schema = instance.model_json_schema()
+    model = type(instance)
+    if key is None:
+        key = _pydantic_model_key(model)
+    result, submitted = jsonschema_form(key, schema, default=data)
+    if result is None:
+        return None, submitted is True
+    return instance.model_copy(update=result, deep=deep), submitted is True
+
+
+def jsonschema_form(
+        key: str,
+        schema: Dict,
+        *,
+        default: Dict = None,
+) -> Tuple[Optional[Dict], bool]:
+    """
+    render a react-json-schema form by raw json schema
+    :param key: the elementId of the Form
+    :param schema: the json schema
+    :param default: default value of the schema
+    :return: None unless the form is submitted, get the dict value of the formData
+    """
+    if default is None:
+        default = {}
+    with st.container(border=True):
+        component_value = _component_func(
+            key=key,
+            schema=schema,
+            formData=default,
+        )
+    if isinstance(component_value, dict):
+        return component_value.get("formData", {}), component_value.get("submitted", False)
+    return None, False

streamlit_react_jsonschema/frontend/.env

@@ -0,0 +1,6 @@
+# Run the component's dev server on :3001
+# (The Streamlit dev server already runs on :3000)
+PORT=3001
+
+# Don't automatically open the web browser on `npm run start`.
+BROWSER=none

streamlit_react_jsonschema/frontend/.prettierrc

@@ -0,0 +1,5 @@
+{
+  "endOfLine": "lf",
+  "semi": false,
+  "trailingComma": "es5"
+}

streamlit_react_jsonschema/frontend/build/asset-manifest.json

@@ -0,0 +1,10 @@
+{
+  "files": {
+    "main.js": "./static/js/main.1978918c.js",
+    "index.html": "./index.html",
+    "main.1978918c.js.map": "./static/js/main.1978918c.js.map"
+  },
+  "entrypoints": [
+    "static/js/main.1978918c.js"
+  ]
+}