shinychat 0.0.1a0__tar.gz → 0.0.1a1__tar.gz

{shinychat-0.0.1a0 → shinychat-0.0.1a1}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: shinychat
-Version: 0.0.1a0
-Summary: Add your description here
+Version: 0.0.1a1
+Summary: An AI Chat interface for Shiny apps.
 Project-URL: Homepage, https://posit-dev.github.io/shinychat/
 Project-URL: Documentation, https://posit-dev.github.io/shinychat/pkg/py/
 Project-URL: Repository, https://github.com/posit-dev/shinychat
@@ -34,3 +34,61 @@ Requires-Dist: pytest>=6.2.4; extra == 'test'
 Requires-Dist: shinylive; extra == 'test'
 Requires-Dist: shinywidgets; extra == 'test'
 Requires-Dist: tox-uv>=1; extra == 'test'
+Description-Content-Type: text/markdown
+
+# shinychat
+
+<a href="https://posit-dev.github.io/shinychat/py"><img src="https://posit-dev.github.io/shinychat/logo.svg" align="right" height="138" alt="shinychat for Python website" /></a>
+
+Chat UI component for [Shiny for Python](https://shiny.posit.co/py/).
+
+## Installation
+
+You can install shinychat from PyPI with:
+
+```bash
+uv pip install shinychat
+```
+
+Or, install the development version of shinychat from [GitHub](https://github.com/posit-dev/shinychat) with:
+
+```bash
+uv pip install git+https://github.com/posit-dev/shinychat.git
+```
+
+## Example
+
+To run this example, you'll first need to create an OpenAI API key, and set it in your environment as `OPENAI_API_KEY`.
+
+```r
+from shiny.express import render, ui
+from shinychat.express import Chat
+
+# Set some Shiny page options
+ui.page_opts(title="Hello Chat")
+
+# Create a chat instance, with an initial message
+chat = Chat(
+    id="chat",
+    messages=[
+        {"content": "Hello! How can I help you today?", "role": "assistant"},
+    ],
+)
+
+# Display the chat
+chat.ui()
+
+
+# Define a callback to run when the user submits a message
+@chat.on_user_submit
+async def handle_user_input(user_input: str):
+    await chat.append_message(f"You said: {user_input}")
+
+
+"Message state:"
+
+
+@render.code
+def message_state():
+    return str(chat.messages())
+```

shinychat-0.0.1a1/pkg-py/README.md

@@ -0,0 +1,56 @@
+# shinychat
+
+<a href="https://posit-dev.github.io/shinychat/py"><img src="https://posit-dev.github.io/shinychat/logo.svg" align="right" height="138" alt="shinychat for Python website" /></a>
+
+Chat UI component for [Shiny for Python](https://shiny.posit.co/py/).
+
+## Installation
+
+You can install shinychat from PyPI with:
+
+```bash
+uv pip install shinychat
+```
+
+Or, install the development version of shinychat from [GitHub](https://github.com/posit-dev/shinychat) with:
+
+```bash
+uv pip install git+https://github.com/posit-dev/shinychat.git
+```
+
+## Example
+
+To run this example, you'll first need to create an OpenAI API key, and set it in your environment as `OPENAI_API_KEY`.
+
+```r
+from shiny.express import render, ui
+from shinychat.express import Chat
+
+# Set some Shiny page options
+ui.page_opts(title="Hello Chat")
+
+# Create a chat instance, with an initial message
+chat = Chat(
+    id="chat",
+    messages=[
+        {"content": "Hello! How can I help you today?", "role": "assistant"},
+    ],
+)
+
+# Display the chat
+chat.ui()
+
+
+# Define a callback to run when the user submits a message
+@chat.on_user_submit
+async def handle_user_input(user_input: str):
+    await chat.append_message(f"You said: {user_input}")
+
+
+"Message state:"
+
+
+@render.code
+def message_state():
+    return str(chat.messages())
+```

{shinychat-0.0.1a0 → shinychat-0.0.1a1}/pkg-py/src/shinychat/__version.py

@@ -17,5 +17,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.0.1a0'
-__version_tuple__ = version_tuple = (0, 0, 1, 'a0')
+__version__ = version = '0.0.1a1'
+__version_tuple__ = version_tuple = (0, 0, 1, 'a1')

{shinychat-0.0.1a0 → shinychat-0.0.1a1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "shinychat"
-description = "Add your description here"
+description = "An AI Chat interface for Shiny apps."
 readme = "pkg-py/README.md"
 requires-python = ">=3.9"
 license = { text = "MIT" }