chainlit 0.4.1__tar.gz → 0.4.3__tar.gz

{chainlit-0.4.1 → chainlit-0.4.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: chainlit
-Version: 0.4.1
+Version: 0.4.3
 Summary: A faster way to build chatbot UIs.
 Home-page: https://github.com/Chainlit/chainlit
 License: Apache-2.0 license
@@ -19,10 +19,11 @@ Requires-Dist: asyncer (>=0.0.2,<0.0.3)
 Requires-Dist: auth0-python (>=4.1.1,<5.0.0)
 Requires-Dist: click (>=8.1.3,<9.0.0)
 Requires-Dist: dataclasses_json (>=0.5.7,<0.6.0)
-Requires-Dist: fastapi (>=0.96.0,<0.97.0)
+Requires-Dist: fastapi (>=0.97.0,<0.98.0)
 Requires-Dist: fastapi-socketio (>=0.0.10,<0.0.11)
 Requires-Dist: nest-asyncio (>=1.5.6,<2.0.0)
 Requires-Dist: openai (>=0.27.7,<0.28.0)
+Requires-Dist: prisma (>=0.9.0,<0.10.0)
 Requires-Dist: pydantic (>=1.10.8,<2.0.0)
 Requires-Dist: python-dotenv (>=1.0.0,<2.0.0)
 Requires-Dist: python-graphql-client (>=0.4.3,<0.5.0)
@@ -92,7 +93,10 @@ $ chainlit run demo.py -w
 
 ### 🔗 With LangChain
 
-Checkout our plug and play [integration](https://docs.chainlit.io/langchain) with LangChain!
+Check out our plug-and-play [integration](https://docs.chainlit.io/langchain) with LangChain!
+
+### 📚 More Examples - Cookbook
+You can find various examples of Chainlit apps [here](https://github.com/Chainlit/cookbook) that leverage tools and services such as OpenAI, Anthropiс, LangChain, LlamaIndex, ChromaDB, Pinecone and more.
 
 ## 🛣 Roadmap
 - [ ] New UI elements (spreadsheet, video, carousel...)

{chainlit-0.4.1 → chainlit-0.4.3}/README.md

@@ -56,7 +56,10 @@ $ chainlit run demo.py -w
 
 ### 🔗 With LangChain
 
-Checkout our plug and play [integration](https://docs.chainlit.io/langchain) with LangChain!
+Check out our plug-and-play [integration](https://docs.chainlit.io/langchain) with LangChain!
+
+### 📚 More Examples - Cookbook
+You can find various examples of Chainlit apps [here](https://github.com/Chainlit/cookbook) that leverage tools and services such as OpenAI, Anthropiс, LangChain, LlamaIndex, ChromaDB, Pinecone and more.
 
 ## 🛣 Roadmap
 - [ ] New UI elements (spreadsheet, video, carousel...)

chainlit-0.4.3/chainlit/__init__.py

@@ -0,0 +1,165 @@
+from dotenv import load_dotenv
+from typing import Callable, Any, TYPE_CHECKING
+import os
+import asyncio
+
+if TYPE_CHECKING:
+    from chainlit.client.base import BaseClient
+
+from chainlit.lc import (
+    LANGCHAIN_INSTALLED,
+    langchain_factory,
+    langchain_postprocess,
+    langchain_run,
+    langchain_rename,
+)
+from chainlit.llama_index import LLAMA_INDEX_INSTALLED, llama_index_factory
+from chainlit.langflow import langflow_factory
+from chainlit.utils import wrap_user_function
+from chainlit.config import config
+from chainlit.telemetry import trace
+from chainlit.version import __version__
+from chainlit.logger import logger
+from chainlit.types import LLMSettings
+from chainlit.action import Action
+from chainlit.element import Image, Text, Pdf, Avatar, Pyplot
+from chainlit.message import Message, ErrorMessage, AskUserMessage, AskFileMessage
+from chainlit.user_session import user_session
+from chainlit.sync import run_sync, make_async
+from chainlit.cache import cache
+
+if LANGCHAIN_INSTALLED:
+    from chainlit.lc.callbacks import (
+        LangchainCallbackHandler,
+        AsyncLangchainCallbackHandler,
+    )
+
+if LLAMA_INDEX_INSTALLED:
+    from chainlit.llama_index.callbacks import (
+        LlamaIndexCallbackHandler,
+    )
+
+
+env_found = load_dotenv(dotenv_path=os.path.join(os.getcwd(), ".env"))
+
+if env_found:
+    logger.info("Loaded .env file")
+
+
+@trace
+def on_message(func: Callable) -> Callable:
+    """
+    Framework agnostic decorator to react to messages coming from the UI.
+    The decorated function is called every time a new message is received.
+
+    Args:
+        func (Callable[[str], Any]): The function to be called when a new message is received. Takes the input message.
+
+    Returns:
+        Callable[[str], Any]: The decorated on_message function.
+    """
+
+    config.code.on_message = wrap_user_function(func)
+    return func
+
+
+@trace
+def on_chat_start(func: Callable) -> Callable:
+    """
+    Hook to react to the user websocket connection event.
+
+    Args:
+        func (Callable[], Any]): The connection hook to execute.
+
+    Returns:
+        Callable[], Any]: The decorated hook.
+    """
+
+    config.code.on_chat_start = wrap_user_function(func, with_task=True)
+    return func
+
+
+@trace
+def on_stop(func: Callable) -> Callable:
+    """
+    Hook to react to the user stopping a conversation.
+
+    Args:
+        func (Callable[[], Any]): The stop hook to execute.
+
+    Returns:
+        Callable[[], Any]: The decorated stop hook.
+    """
+
+    config.code.on_stop = wrap_user_function(func)
+    return func
+
+
+def action_callback(name: str) -> Callable:
+    """
+    Callback to call when an action is clicked in the UI.
+
+    Args:
+        func (Callable[[Action], Any]): The action callback to execute. First parameter is the action.
+    """
+
+    def decorator(func: Callable[[Action], Any]):
+        config.code.action_callbacks[name] = wrap_user_function(func, with_task=True)
+        return func
+
+    return decorator
+
+
+@trace
+def client_factory(func: Callable[[], "BaseClient"]) -> Callable[[], "BaseClient"]:
+    """
+    Callback to call when to initialize the custom client.
+
+    Args:
+        func (Callable[[str], BaseClient]): The action callback to execute. First parameter is the session id.
+    """
+
+    config.code.client_factory = func
+    return func
+
+
+def sleep(duration: int):
+    """
+    Sleep for a given duration.
+    Args:
+        duration (int): The duration in seconds.
+    """
+    return asyncio.sleep(duration)
+
+
+__all__ = [
+    "user_session",
+    "LLMSettings",
+    "Action",
+    "Pdf",
+    "Image",
+    "Text",
+    "Avatar",
+    "Pyplot",
+    "Message",
+    "ErrorMessage",
+    "AskUserMessage",
+    "AskFileMessage",
+    "langchain_factory",
+    "langchain_postprocess",
+    "langchain_run",
+    "langchain_rename",
+    "llama_index_factory",
+    "langflow_factory",
+    "on_chat_start",
+    "on_stop",
+    "action_callback",
+    "sleep",
+    "LangchainCallbackHandler",
+    "AsyncLangchainCallbackHandler",
+    "LlamaIndexCallbackHandler",
+    "client_factory",
+    "run_sync",
+    "make_async",
+    "cache",
+]

{chainlit-0.4.1 → chainlit-0.4.3}/chainlit/action.py

@@ -1,7 +1,7 @@
 from pydantic.dataclasses import dataclass
 from dataclasses_json import dataclass_json
 
-from chainlit.emitter import get_emit_fn
+from chainlit.context import get_emitter
 from chainlit.telemetry import trace_event
 
 
@@ -21,9 +21,7 @@ class Action:
 
     def __post_init__(self) -> None:
         trace_event(f"init {self.__class__.__name__}")
-        self.emit = get_emit_fn()
-        if not self.emit:
-            raise RuntimeError("Action should be instantiated in a Chainlit context")
+        self.emit = get_emitter().emit
 
     async def send(self, for_id: str):
         trace_event(f"send {self.__class__.__name__}")

{chainlit-0.4.1 → chainlit-0.4.3}/chainlit/cli/__init__.py

@@ -21,6 +21,7 @@ from chainlit.cli.deploy import deploy
 from chainlit.cli.utils import check_file
 from chainlit.telemetry import trace_event
 from chainlit.cache import init_lc_cache
+from chainlit.db import init_local_db, migrate_local_db
 from chainlit.logger import logger
 from chainlit.server import app
 
@@ -50,6 +51,9 @@ def run_chainlit(target: str):
     # Initialize the LangChain cache if installed and enabled
     init_lc_cache()
 
+    # Initialize the local database if configured to use it
+    init_local_db()
+
     log_level = "debug" if config.run.debug else "error"
 
     # Start the server
@@ -60,26 +64,69 @@ def run_chainlit(target: str):
 
     # Run the asyncio event loop instead of uvloop to enable re entrance
     asyncio.run(start())
-    # uvicorn.run(app, host=host, port=port)
+    # uvicorn.run(app, host=host, port=port, log_level=log_level)
 
 
 # Define the "run" command for Chainlit CLI
 @cli.command("run")
 @click.argument("target", required=True, envvar="RUN_TARGET")
-@click.option("-w", "--watch", default=False, is_flag=True, envvar="WATCH")
-@click.option("-h", "--headless", default=False, is_flag=True, envvar="HEADLESS")
-@click.option("-d", "--debug", default=False, is_flag=True, envvar="DEBUG")
-@click.option("-c", "--ci", default=False, is_flag=True, envvar="CI")
-@click.option("--no-cache", default=False, is_flag=True, envvar="NO_CACHE")
-@click.option("--host")
-@click.option("--port")
-def chainlit_run(target, watch, headless, debug, ci, no_cache, host, port):
+@click.option(
+    "-w",
+    "--watch",
+    default=False,
+    is_flag=True,
+    envvar="WATCH",
+    help="Reload the app when the module changes",
+)
+@click.option(
+    "-h",
+    "--headless",
+    default=False,
+    is_flag=True,
+    envvar="HEADLESS",
+    help="Will prevent to auto open the app in the browser",
+)
+@click.option(
+    "-d",
+    "--debug",
+    default=False,
+    is_flag=True,
+    envvar="DEBUG",
+    help="Set the log level to debug",
+)
+@click.option(
+    "-c",
+    "--ci",
+    default=False,
+    is_flag=True,
+    envvar="CI",
+    help="Flag to run in CI mode",
+)
+@click.option(
+    "--no-cache",
+    default=False,
+    is_flag=True,
+    envvar="NO_CACHE",
+    help="Useful to disable third parties cache, such as langchain.",
+)
+@click.option(
+    "--db",
+    type=click.Choice(["cloud", "local"]),
+    help="Useful to control database mode when running CI.",
+)
+@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, db, host, port):
     if host:
         os.environ["CHAINLIT_HOST"] = host
     if port:
         os.environ["CHAINLIT_PORT"] = port
     if ci:
         logger.info("Running in CI mode")
+
+        if db:
+            config.project.database = db
+
         config.project.enable_telemetry = False
         no_cache = True
         from chainlit.cli.mock import mock_openai
@@ -131,6 +178,14 @@ def chainlit_logout(args=None, **kwargs):
     sys.exit(0)
 
 
+@cli.command("migrate")
+@click.argument("args", nargs=-1)
+def chainlit_migrate(args=None, **kwargs):
+    trace_event("chainlit migrate")
+    migrate_local_db()
+    sys.exit(0)
+
+
 @cli.command("init")
 @click.argument("args", nargs=-1)
 def chainlit_init(args=None, **kwargs):