chainlit 1.1.202__tar.gz → 1.1.300__tar.gz

{chainlit-1.1.202 → chainlit-1.1.300}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: chainlit
-Version: 1.1.202
+Version: 1.1.300
 Summary: Build Conversational AI.
 Home-page: https://github.com/Chainlit/chainlit
 License: Apache-2.0 license
@@ -18,17 +18,19 @@ Requires-Dist: asyncer (>=0.0.2,<0.0.3)
 Requires-Dist: click (>=8.1.3,<9.0.0)
 Requires-Dist: dataclasses_json (>=0.5.7,<0.6.0)
 Requires-Dist: fastapi (>=0.110.1,<0.111.0)
-Requires-Dist: fastapi-socketio (>=0.0.10,<0.0.11)
 Requires-Dist: filetype (>=1.2.0,<2.0.0)
 Requires-Dist: httpx (>=0.23.0)
 Requires-Dist: lazify (>=0.4.0,<0.5.0)
-Requires-Dist: literalai (==0.0.601)
+Requires-Dist: literalai (==0.0.604)
 Requires-Dist: nest-asyncio (>=1.5.6,<2.0.0)
+Requires-Dist: numpy (>=1.24.4,<2.0.0) ; python_version < "3.9"
+Requires-Dist: numpy (>=1.26,<2.0) ; python_version >= "3.9"
 Requires-Dist: packaging (>=23.1,<24.0)
 Requires-Dist: pydantic (>=1,<3)
 Requires-Dist: pyjwt (>=2.8.0,<3.0.0)
 Requires-Dist: python-dotenv (>=1.0.0,<2.0.0)
 Requires-Dist: python-multipart (>=0.0.9,<0.0.10)
+Requires-Dist: python-socketio (>=5.11.0,<6.0.0)
 Requires-Dist: starlette (>=0.37.2,<0.38.0)
 Requires-Dist: syncer (>=2.0.3,<3.0.0)
 Requires-Dist: tomli (>=2.0.1,<3.0.0)
@@ -42,13 +44,12 @@ Description-Content-Type: text/markdown
 
 [![](https://dcbadge.vercel.app/api/server/ZThrUxbAYw?style=flat)](https://discord.gg/k73SQ3FyUh)
 [![Twitter](https://img.shields.io/twitter/url/https/twitter.com/chainlit_io.svg?style=social&label=Follow%20%40chainlit_io)](https://twitter.com/chainlit_io)
+![PyPI - Downloads](https://img.shields.io/pypi/dm/chainlit)
+[![GitHub Contributors](https://img.shields.io/github/contributors/chainlit/chainlit)](https://github.com/chainlit/chainlit/graphs/contributors)
 [![CI](https://github.com/Chainlit/chainlit/actions/workflows/ci.yaml/badge.svg)](https://github.com/Chainlit/chainlit/actions/workflows/ci.yaml)
 
 **Build production-ready Conversational AI applications in minutes, not weeks ⚡️**
 
-> [!NOTE]  
-> You can ask Chainlit related questions to [Chainlit Help](https://help.chainlit.io/)! Also available on the Discord `@Chainlit Help`. Proudly built with Chainlit!
-
 Chainlit is an open-source async Python framework which allows developers to build scalable Conversational AI or agentic applications.
 
 - ✅ ChatGPT-like application
@@ -57,11 +58,15 @@ Chainlit is an open-source async Python framework which allows developers to bui
 - ✅ Custom frontend (build your own agentic experience)
 - ✅ API Endpoint
 
-Full documentation is available [here](https://docs.chainlit.io).
+Full documentation is available [here](https://docs.chainlit.io). You can ask Chainlit related questions to [Chainlit Help](https://help.chainlit.io/), an app built using Chainlit!
 
-Contact us [here](https://forms.gle/BX3UNBLmTF75KgZVA) for **Enterprise Support** and to get early access to Literal AI, our product to evaluate and monitor LLM applications.
+> [!NOTE]  
+> Contact us [here](https://forms.gle/BX3UNBLmTF75KgZVA) for **Enterprise Support**.
+> Check out [Literal AI](https://literalai.com), our product to monitor and evaluate LLM applications! It works with any Python or TypeScript applications and [seamlessly](https://docs.chainlit.io/data-persistence/overview) with Chainlit by adding a `LITERAL_API_KEY` in your project.
 
-https://github.com/Chainlit/chainlit/assets/13104895/8882af90-fdfa-4b24-8200-1ee96c6c7490
+<p align="center">
+    <img src="https://github.com/Chainlit/chainlit/assets/13104895/0c2cc7a9-766c-41d3-aae2-117a2d0eb8ed" width="80%" />
+</p>
 
 ## Installation
 
@@ -84,8 +89,10 @@ Create a new file `demo.py` with the following code:
 import chainlit as cl
 
 
-@cl.step
-def tool():
+@cl.step(type="tool")
+async def tool():
+    # Fake tool
+    await cl.sleep(2)
     return "Response from the tool!"
 
 
@@ -102,11 +109,12 @@ async def main(message: cl.Message):
         None.
     """
 
+    final_answer = await cl.Message(content="").send()
+
     # Call the tool
-    tool()
+    final_answer.content = await tool()
 
-    # Send the final answer.
-    await cl.Message(content="This is the final answer").send()
+    await final_answer.update()
 ```
 
 Now run it!

{chainlit-1.1.202 → chainlit-1.1.300}/README.md

@@ -2,13 +2,12 @@
 
 [![](https://dcbadge.vercel.app/api/server/ZThrUxbAYw?style=flat)](https://discord.gg/k73SQ3FyUh)
 [![Twitter](https://img.shields.io/twitter/url/https/twitter.com/chainlit_io.svg?style=social&label=Follow%20%40chainlit_io)](https://twitter.com/chainlit_io)
+![PyPI - Downloads](https://img.shields.io/pypi/dm/chainlit)
+[![GitHub Contributors](https://img.shields.io/github/contributors/chainlit/chainlit)](https://github.com/chainlit/chainlit/graphs/contributors)
 [![CI](https://github.com/Chainlit/chainlit/actions/workflows/ci.yaml/badge.svg)](https://github.com/Chainlit/chainlit/actions/workflows/ci.yaml)
 
 **Build production-ready Conversational AI applications in minutes, not weeks ⚡️**
 
-> [!NOTE]  
-> You can ask Chainlit related questions to [Chainlit Help](https://help.chainlit.io/)! Also available on the Discord `@Chainlit Help`. Proudly built with Chainlit!
-
 Chainlit is an open-source async Python framework which allows developers to build scalable Conversational AI or agentic applications.
 
 - ✅ ChatGPT-like application
@@ -17,11 +16,15 @@ Chainlit is an open-source async Python framework which allows developers to bui
 - ✅ Custom frontend (build your own agentic experience)
 - ✅ API Endpoint
 
-Full documentation is available [here](https://docs.chainlit.io).
+Full documentation is available [here](https://docs.chainlit.io). You can ask Chainlit related questions to [Chainlit Help](https://help.chainlit.io/), an app built using Chainlit!
 
-Contact us [here](https://forms.gle/BX3UNBLmTF75KgZVA) for **Enterprise Support** and to get early access to Literal AI, our product to evaluate and monitor LLM applications.
+> [!NOTE]  
+> Contact us [here](https://forms.gle/BX3UNBLmTF75KgZVA) for **Enterprise Support**.
+> Check out [Literal AI](https://literalai.com), our product to monitor and evaluate LLM applications! It works with any Python or TypeScript applications and [seamlessly](https://docs.chainlit.io/data-persistence/overview) with Chainlit by adding a `LITERAL_API_KEY` in your project.
 
-https://github.com/Chainlit/chainlit/assets/13104895/8882af90-fdfa-4b24-8200-1ee96c6c7490
+<p align="center">
+    <img src="https://github.com/Chainlit/chainlit/assets/13104895/0c2cc7a9-766c-41d3-aae2-117a2d0eb8ed" width="80%" />
+</p>
 
 ## Installation
 
@@ -44,8 +47,10 @@ Create a new file `demo.py` with the following code:
 import chainlit as cl
 
 
-@cl.step
-def tool():
+@cl.step(type="tool")
+async def tool():
+    # Fake tool
+    await cl.sleep(2)
     return "Response from the tool!"
 
 
@@ -62,11 +67,12 @@ async def main(message: cl.Message):
         None.
     """
 
+    final_answer = await cl.Message(content="").send()
+
     # Call the tool
-    tool()
+    final_answer.content = await tool()
 
-    # Send the final answer.
-    await cl.Message(content="This is the final answer").send()
+    await final_answer.update()
 ```
 
 Now run it!

{chainlit-1.1.202 → chainlit-1.1.300}/chainlit/__init__.py

@@ -28,7 +28,7 @@ from chainlit.config import config
 from chainlit.context import context
 from chainlit.element import (
     Audio,
-    Avatar,
+    Component,
     File,
     Image,
     Pdf,
@@ -52,7 +52,7 @@ from chainlit.oauth_providers import get_configured_oauth_providers
 from chainlit.step import Step, step
 from chainlit.sync import make_async, run_sync
 from chainlit.telemetry import trace
-from chainlit.types import AudioChunk, ChatProfile, ThreadDict
+from chainlit.types import AudioChunk, ChatProfile, Starter, ThreadDict
 from chainlit.user import PersistedUser, User
 from chainlit.user_session import user_session
 from chainlit.utils import make_module_getattr, wrap_user_function
@@ -115,7 +115,7 @@ def oauth_callback(
 
     Example:
         @cl.oauth_callback
-        async def oauth_callback(provider_id: str, token: str, raw_user_data: Dict[str, str], default_app_user: User) -> Optional[User]:
+        async def oauth_callback(provider_id: str, token: str, raw_user_data: Dict[str, str], default_app_user: User, id_token: Optional[str]) -> Optional[User]:
 
     Returns:
         Callable[[str, str, Dict[str, str], User], Optional[User]]: The decorated authentication callback.
@@ -208,6 +208,22 @@ def set_chat_profiles(
     return func
 
 
+@trace
+def set_starters(func: Callable[[Optional["User"]], List["Starter"]]) -> Callable:
+    """
+    Programmatic declaration of the available starter (can depend on the User from the session if authentication is setup).
+
+    Args:
+        func (Callable[[Optional["User"]], List["Starter"]]): The function declaring the starters.
+
+    Returns:
+        Callable[[Optional["User"]], List["Starter"]]: The decorated function.
+    """
+
+    config.code.set_starters = wrap_user_function(func)
+    return func
+
+
 @trace
 def on_chat_end(func: Callable) -> Callable:
     """
@@ -348,6 +364,8 @@ __getattr__ = make_module_getattr(
 )
 
 __all__ = [
+    "ChatProfile",
+    "Starter",
     "user_session",
     "CopilotFunction",
     "AudioChunk",
@@ -359,7 +377,7 @@ __all__ = [
     "Plotly",
     "Image",
     "Text",
-    "Avatar",
+    "Component",
     "Pyplot",
     "File",
     "Task",

{chainlit-1.1.202 → chainlit-1.1.300}/chainlit/cli/__init__.py

@@ -7,13 +7,12 @@ import uvicorn
 
 nest_asyncio.apply()
 
-from chainlit.auth import ensure_jwt_secret
 from chainlit.cache import init_lc_cache
-from chainlit.cli.utils import check_file
 from chainlit.config import (
     BACKEND_ROOT,
     DEFAULT_HOST,
     DEFAULT_PORT,
+    DEFAULT_ROOT_PATH,
     config,
     init_config,
     lint_translations,
@@ -22,8 +21,8 @@ from chainlit.config import (
 from chainlit.logger import logger
 from chainlit.markdown import init_markdown
 from chainlit.secret import random_secret
-from chainlit.server import app, register_wildcard_route_handler
 from chainlit.telemetry import trace_event
+from chainlit.utils import check_file, ensure_jwt_secret
 
 
 # Create the main command group for Chainlit CLI
@@ -35,8 +34,14 @@ def cli():
 
 # Define the function to run Chainlit with provided options
 def run_chainlit(target: str):
+    from chainlit.server import combined_asgi_app as app
+
     host = os.environ.get("CHAINLIT_HOST", DEFAULT_HOST)
     port = int(os.environ.get("CHAINLIT_PORT", DEFAULT_PORT))
+    root_path = os.environ.get("CHAINLIT_ROOT_PATH", DEFAULT_ROOT_PATH)
+
+    ssl_certfile = os.environ.get("CHAINLIT_SSL_CERT", None)
+    ssl_keyfile = os.environ.get("CHAINLIT_SSL_KEY", None)
 
     ws_per_message_deflate_env = os.environ.get(
         "UVICORN_WS_PER_MESSAGE_DEFLATE", "true"
@@ -47,8 +52,13 @@ def run_chainlit(target: str):
         "yes",
     ]  # Convert to boolean
 
+    ws_protocol = os.environ.get(
+        "UVICORN_WS_PROTOCOL", "auto"
+    )
+
     config.run.host = host
     config.run.port = port
+    config.run.root_path = root_path
 
     check_file(target)
     # Load the module provided by the user
@@ -57,8 +67,6 @@ def run_chainlit(target: str):
 
     ensure_jwt_secret()
 
-    register_wildcard_route_handler()
-
     # Create the chainlit.md file if it doesn't exist
     init_markdown(config.root)
 
@@ -73,8 +81,11 @@ def run_chainlit(target: str):
             app,
             host=host,
             port=port,
+            ws=ws_protocol,
             log_level=log_level,
             ws_per_message_deflate=ws_per_message_deflate,
+            ssl_keyfile=ssl_keyfile,
+            ssl_certfile=ssl_certfile,
         )
         server = uvicorn.Server(config)
         await server.serve()
@@ -126,13 +137,47 @@ def run_chainlit(target: str):
     envvar="NO_CACHE",
     help="Useful to disable third parties cache, such as langchain.",
 )
+@click.option(
+    "--ssl-cert",
+    default=None,
+    envvar="CHAINLIT_SSL_CERT",
+    help="Specify the file path for the SSL certificate.",
+)
+@click.option(
+    "--ssl-key",
+    default=None,
+    envvar="CHAINLIT_SSL_KEY",
+    help="Specify the file path for the SSL key",
+)
 @click.option("--host", help="Specify a different host to run the server on")
 @click.option("--port", help="Specify a different port to run the server on")
-def chainlit_run(target, watch, headless, debug, ci, no_cache, host, port):
+@click.option("--root-path", help="Specify a different root path to run the server on")
+def chainlit_run(
+    target,
+    watch,
+    headless,
+    debug,
+    ci,
+    no_cache,
+    ssl_cert,
+    ssl_key,
+    host,
+    port,
+    root_path,
+):
     if host:
         os.environ["CHAINLIT_HOST"] = host
     if port:
         os.environ["CHAINLIT_PORT"] = port
+    if bool(ssl_cert) != bool(ssl_key):
+        raise click.UsageError(
+            "Both --ssl-cert and --ssl-key must be provided together."
+        )
+    if ssl_cert:
+        os.environ["CHAINLIT_SSL_CERT"] = ssl_cert
+        os.environ["CHAINLIT_SSL_KEY"] = ssl_key
+    if root_path:
+        os.environ["CHAINLIT_ROOT_PATH"] = root_path
     if ci:
         logger.info("Running in CI mode")
 
@@ -150,6 +195,8 @@ def chainlit_run(target, watch, headless, debug, ci, no_cache, host, port):
     config.run.no_cache = no_cache
     config.run.ci = ci
     config.run.watch = watch
+    config.run.ssl_cert = ssl_cert
+    config.run.ssl_key = ssl_key
 
     run_chainlit(target)
 

{chainlit-1.1.202 → chainlit-1.1.300}/chainlit/config.py

@@ -4,7 +4,7 @@ import site
 import sys
 from importlib import util
 from pathlib import Path
-from typing import TYPE_CHECKING, Any, Callable, Dict, List, Optional, Union, Literal
+from typing import TYPE_CHECKING, Any, Callable, Dict, List, Literal, Optional, Union
 
 import tomli
 from chainlit.logger import logger
@@ -18,7 +18,7 @@ if TYPE_CHECKING:
     from chainlit.action import Action
     from chainlit.element import ElementBased
     from chainlit.message import Message
-    from chainlit.types import AudioChunk, ChatProfile, ThreadDict
+    from chainlit.types import AudioChunk, ChatProfile, Starter, ThreadDict
     from chainlit.user import User
     from fastapi import Request, Response
 
@@ -61,9 +61,6 @@ allow_origins = ["*"]
 # follow_symlink = false
 
 [features]
-# Show the prompt playground
-prompt_playground = true
-
 # Process and display HTML in messages. This can be a security risk (see https://stackoverflow.com/questions/19603097/why-is-it-dangerous-to-render-user-generated-html-or-javascript)
 unsafe_allow_html = false
 
@@ -95,21 +92,15 @@ auto_tag_thread = true
     sample_rate = 44100
 
 [UI]
-# Name of the app and chatbot.
-name = "Chatbot"
-
-# Show the readme while the thread is empty.
-show_readme_as_default = true
+# Name of the assistant.
+name = "Assistant"
 
-# Description of the app and chatbot. This is used for HTML tags.
+# Description of the assistant. This is used for HTML tags.
 # description = ""
 
 # Large size content are by default collapsed for a cleaner ui
 default_collapse_content = true
 
-# The default value for the expand messages settings.
-default_expand_messages = false
-
 # Hide the chain of thought details from the user in the UI.
 hide_cot = false
 
@@ -136,6 +127,7 @@ hide_cot = false
 # custom_build = "./public/build"
 
 [UI.theme]
+    default = "dark"
     #layout = "wide"
     #font_family = "Inter, sans-serif"
 # Override default MUI light theme. (Check theme.ts)
@@ -147,6 +139,9 @@ hide_cot = false
         #main = "#F80061"
         #dark = "#980039"
         #light = "#FFE7EB"
+    [UI.theme.light.text]
+        #primary = "#212121"
+        #secondary = "#616161"
 
 # Override default MUI dark theme. (Check theme.ts)
 [UI.theme.dark]
@@ -157,7 +152,9 @@ hide_cot = false
         #main = "#F80061"
         #dark = "#980039"
         #light = "#FFE7EB"
-
+    [UI.theme.dark.text]
+        #primary = "#EEEEEE"
+        #secondary = "#BDBDBD"
 
 [meta]
 generated_by = "{__version__}"
@@ -166,6 +163,7 @@ generated_by = "{__version__}"
 
 DEFAULT_HOST = "0.0.0.0"
 DEFAULT_PORT = 8000
+DEFAULT_ROOT_PATH = ""
 
 
 @dataclass()
@@ -174,6 +172,9 @@ class RunSettings:
     module_name: Optional[str] = None
     host: str = DEFAULT_HOST
     port: int = DEFAULT_PORT
+    ssl_cert: Optional[str] = None
+    ssl_key: Optional[str] = None
+    root_path: str = DEFAULT_ROOT_PATH
     headless: bool = False
     watch: bool = False
     no_cache: bool = False
@@ -188,16 +189,24 @@ class PaletteOptions(DataClassJsonMixin):
     dark: Optional[str] = ""
 
 
+@dataclass()
+class TextOptions(DataClassJsonMixin):
+    primary: Optional[str] = ""
+    secondary: Optional[str] = ""
+
+
 @dataclass()
 class Palette(DataClassJsonMixin):
     primary: Optional[PaletteOptions] = None
     background: Optional[str] = ""
     paper: Optional[str] = ""
+    text: Optional[TextOptions] = None
 
 
 @dataclass()
 class Theme(DataClassJsonMixin):
     font_family: Optional[str] = None
+    default: Optional[Literal["light", "dark"]] = "dark"
     layout: Optional[Literal["default", "wide"]] = "default"
     light: Optional[Palette] = None
     dark: Optional[Palette] = None
@@ -224,7 +233,6 @@ class AudioFeature(DataClassJsonMixin):
 
 @dataclass()
 class FeaturesSettings(DataClassJsonMixin):
-    prompt_playground: bool = True
     spontaneous_file_upload: Optional[SpontaneousFileUploadFeature] = None
     audio: Optional[AudioFeature] = Field(default_factory=AudioFeature)
     latex: bool = False
@@ -235,12 +243,10 @@ class FeaturesSettings(DataClassJsonMixin):
 @dataclass()
 class UISettings(DataClassJsonMixin):
     name: str
-    show_readme_as_default: bool = True
     description: str = ""
     hide_cot: bool = False
     # Large size content are by default collapsed for a cleaner ui
     default_collapse_content: bool = True
-    default_expand_messages: bool = False
     github: Optional[str] = None
     theme: Optional[Theme] = None
     # Optional custom CSS file that allows you to customize the UI
@@ -279,6 +285,7 @@ class CodeSettings:
     set_chat_profiles: Optional[Callable[[Optional["User"]], List["ChatProfile"]]] = (
         None
     )
+    set_starters: Optional[Callable[[Optional["User"]], List["Starter"]]] = None
 
 
 @dataclass()

{chainlit-1.1.202 → chainlit-1.1.300}/chainlit/context.py

@@ -69,6 +69,8 @@ def init_http_context(
     user_env: Optional[Dict[str, str]] = None,
     client_type: ClientType = "webapp",
 ) -> ChainlitContext:
+    from chainlit.data import get_data_layer
+
     session_id = str(uuid.uuid4())
     thread_id = thread_id or str(uuid.uuid4())
     session = HTTPSession(
@@ -81,6 +83,13 @@ def init_http_context(
     )
     context = ChainlitContext(session)
     context_var.set(context)
+
+    if data_layer := get_data_layer():
+        if user_id := getattr(user, "id", None):
+            asyncio.create_task(
+                data_layer.update_thread(thread_id=thread_id, user_id=user_id)
+            )
+
     return context