streamlit-lexical 0.0.1__tar.gz

streamlit_lexical-0.0.1/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2018-2021 Streamlit Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

streamlit_lexical-0.0.1/MANIFEST.in

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

streamlit_lexical-0.0.1/PKG-INFO

@@ -0,0 +1,44 @@
+Metadata-Version: 2.1
+Name: streamlit_lexical
+Version: 0.0.1
+Summary: Streamlit component that allows you to do use Lexical's rich text editor
+Home-page: 
+Author: Ben Fox
+Author-email: ben@musubilabs.ai
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: streamlit==1.36.0
+Provides-Extra: devel
+Requires-Dist: wheel; extra == "devel"
+Requires-Dist: pytest==7.4.0; extra == "devel"
+Requires-Dist: playwright==1.39.0; extra == "devel"
+Requires-Dist: requests==2.31.0; extra == "devel"
+Requires-Dist: pytest-playwright-snapshot==1.0; extra == "devel"
+Requires-Dist: pytest-rerunfailures==12.0; extra == "devel"
+
+# streamlit_lexical
+
+Streamlit component that allows you to use Lexical's rich text plugin. 
+
+## Installation instructions
+
+```sh
+cd streamlit_lexical/frontend
+npm install (or yarn install)
+npm run build
+cd ../..
+pip install -e ./
+```
+
+## Usage instructions
+
+```python
+import streamlit as st
+
+from streamlit_lexical import streamlit_lexical
+
+rich_text_dict = streamlit_lexical("name")
+
+st.markdown(rich_text_dict)
+```

streamlit_lexical-0.0.1/README.md

@@ -0,0 +1,25 @@
+# streamlit_lexical
+
+Streamlit component that allows you to use Lexical's rich text plugin. 
+
+## Installation instructions
+
+```sh
+cd streamlit_lexical/frontend
+npm install (or yarn install)
+npm run build
+cd ../..
+pip install -e ./
+```
+
+## Usage instructions
+
+```python
+import streamlit as st
+
+from streamlit_lexical import streamlit_lexical
+
+rich_text_dict = streamlit_lexical("name")
+
+st.markdown(rich_text_dict)
+```

streamlit_lexical-0.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

streamlit_lexical-0.0.1/setup.py

@@ -0,0 +1,37 @@
+from pathlib import Path
+
+import setuptools
+
+this_directory = Path(__file__).parent
+long_description = (this_directory / "README.md").read_text()
+
+setuptools.setup(
+    name="streamlit_lexical",
+    version="0.0.1",
+    author="Ben Fox",
+    author_email="ben@musubilabs.ai",
+    description="Streamlit component that allows you to do use Lexical's rich text editor",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    url="",
+    packages=setuptools.find_packages(),
+    include_package_data=True,
+    classifiers=[],
+    python_requires=">=3.7",
+    install_requires=[
+        # By definition, a Custom Component depends on Streamlit.
+        # If your component has other Python dependencies, list
+        # them here.
+        "streamlit == 1.36.0",
+    ],
+    extras_require={
+        "devel": [
+            "wheel",
+            "pytest==7.4.0",
+            "playwright==1.39.0",
+            "requests==2.31.0",
+            "pytest-playwright-snapshot==1.0",
+            "pytest-rerunfailures==12.0",
+        ]
+    }
+)

streamlit_lexical-0.0.1/streamlit_lexical/__init__.py

@@ -0,0 +1,72 @@
+import os
+import streamlit.components.v1 as components
+
+# Create a _RELEASE constant. We'll set this to False while we're developing
+# the component, and True when we're ready to package and distribute it.
+# (This is, of course, optional - there are innumerable ways to manage your
+# release process.)
+_RELEASE = True
+# Declare a Streamlit component. `declare_component` returns a function
+# that is used to create instances of the component. We're naming this
+# function "_component_func", with an underscore prefix, because we don't want
+# to expose it directly to users. Instead, we will create a custom wrapper
+# function, below, that will serve as our component's public API.
+
+# It's worth noting that this call to `declare_component` is the
+# *only thing* you need to do to create the binding between Streamlit and
+# your component frontend. Everything else we do in this file is simply a
+# best practice.
+
+if not _RELEASE:
+    _component_func = components.declare_component(
+        # We give the component a simple, descriptive name ("my_component"
+        # does not fit this bill, so please choose something better for your
+        # own component :)
+        "streamlit_lexical",
+        # Pass `url` here to tell Streamlit that the component will be served
+        # by the local dev server that you run via `npm run start`.
+        # (This is useful while your component is in development.)
+        url="http://localhost:3001",
+    )
+else:
+    # When we're distributing a production version of the component, we'll
+    # replace the `url` param with `path`, and point it to the component's
+    # build directory:
+    parent_dir = os.path.dirname(os.path.abspath(__file__))
+    build_dir = os.path.join(parent_dir, "frontend/build")
+    _component_func = components.declare_component("streamlit_lexical", path=build_dir)
+
+
+# Create a wrapper function for the component. This is an optional
+# best practice - we could simply expose the component function returned by
+# `declare_component` and call it done. The wrapper allows us to customize
+# our component's API: we can pre-process its input args, post-process its
+# output value, and add a docstring for users.
+def streamlit_lexical(height=960, value="", placeholder="", debounce=500, key=None, on_change=None):
+    """Create a new instance of "streamlit_lexical".
+
+    Parameters
+    ----------
+    height: int
+        Optional specification for height, in pixels of lexical text box.
+    value: str
+        Optional initial value to pass to editor
+    placeholder: str
+        Optional initial placeholder text to display in editor
+    debounce:
+        Time delay to save editor contents. Default is 500 ms/
+    key: str or None
+        An optional key that uniquely identifies this component. If this is
+        None, and the component's arguments are changed, the component will
+        be re-mounted in the Streamlit frontend and lose its current state.
+
+    Returns
+    -------
+    str
+        Markdown string of content in editor
+
+    """
+    assert debounce > 0, "Debounce must be greater than 0."
+    assert height > 0, "The min_height must be greater than 0." 
+    component_value = _component_func(min_height=height, key=key, value=value, placeholder=placeholder, debounce=debounce, on_change=on_change)
+    return component_value

streamlit_lexical-0.0.1/streamlit_lexical/example.py

@@ -0,0 +1,29 @@
+import streamlit as st
+from __init__ import streamlit_lexical
+# Add some test code to play with the component while it's in development.
+# During development, we can run this just as we would any other Streamlit
+# app: `$ streamlit run my_component/example.py`
+def update_val():
+    new_content = "# New Heading\n\nThis is updated content in **Markdown**."
+    st.session_state['key'] = new_content
+
+st.write("#") # if this isnt here, for some reason, if you change the heading prior to entering any text, the page jumps to the bottom
+st.header("Lexical Rich Text Editor")
+
+if st.session_state.get('key') is None:
+    st.session_state['key'] = 'initial value'
+
+# Create an instance of our component with a constant `name` arg, and
+markdown = streamlit_lexical(value=st.session_state.get('key'), placeholder="Enter some rich text", key='1234', height=800)
+
+
+# Button to update content
+st.button("Update Editor Content", on_click=update_val)
+
+    #markdown = streamlit_lexical(value=new_content, placeholder="Enter some rich text", height=800)
+
+#st.markdown(markdown)
+#markdown = streamlit_lexical(value="", placeholder="Enter some rich text", height=800, on_change=None)
+
+st.markdown(markdown)
+st.markdown("---")

streamlit_lexical-0.0.1/streamlit_lexical/frontend/build/asset-manifest.json

@@ -0,0 +1,18 @@
+{
+  "files": {
+    "main.css": "./static/css/main.b0581e46.css",
+    "main.js": "./static/js/main.1d3f0525.js",
+    "index.html": "./index.html",
+    "static/media/type-bold.svg": "./static/media/type-bold.b3bec3f33045771f9484.svg",
+    "static/media/arrow-counterclockwise.svg": "./static/media/arrow-counterclockwise.48745dc8e6d9b1a2f8ec.svg",
+    "static/media/arrow-clockwise.svg": "./static/media/arrow-clockwise.2ba775456dd603357519.svg",
+    "static/media/type-italic.svg": "./static/media/type-italic.d3971b39b0fe39a09b1b.svg",
+    "static/media/type-underline.svg": "./static/media/type-underline.b41f84ace38d530f30b9.svg",
+    "main.b0581e46.css.map": "./static/css/main.b0581e46.css.map",
+    "main.1d3f0525.js.map": "./static/js/main.1d3f0525.js.map"
+  },
+  "entrypoints": [
+    "static/css/main.b0581e46.css",
+    "static/js/main.1d3f0525.js"
+  ]
+}