chainlit 1.0.401__tar.gz → 2.0.3__tar.gz

{chainlit-1.0.401 → chainlit-2.0.3}/PKG-INFO

@@ -1,41 +1,48 @@
 Metadata-Version: 2.1
 Name: chainlit
-Version: 1.0.401
+Version: 2.0.3
 Summary: Build Conversational AI.
-Home-page: https://github.com/Chainlit/chainlit
-License: Apache-2.0 license
+Home-page: https://chainlit.io/
+License: Apache-2.0
 Keywords: LLM,Agents,gen ai,chat ui,chatbot ui,openai,copilot,langchain,conversational ai
-Author: Chainlit
-Requires-Python: >=3.8.1,<4.0.0
-Classifier: License :: Other/Proprietary License
+Author: Willy Douhard
+Requires-Python: >=3.9,<4.0.0
+Classifier: Environment :: Web Environment
+Classifier: Framework :: FastAPI
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: JavaScript
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Communications :: Chat
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Software Development :: User Interfaces
 Requires-Dist: aiofiles (>=23.1.0,<24.0.0)
-Requires-Dist: asyncer (>=0.0.2,<0.0.3)
+Requires-Dist: asyncer (>=0.0.7,<0.0.8)
 Requires-Dist: click (>=8.1.3,<9.0.0)
-Requires-Dist: dataclasses_json (>=0.5.7,<0.6.0)
-Requires-Dist: fastapi (>=0.100)
-Requires-Dist: fastapi-socketio (>=0.0.10,<0.0.11)
+Requires-Dist: dataclasses_json (>=0.6.7,<0.7.0)
+Requires-Dist: fastapi (>=0.115.3,<0.116)
 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.300)
-Requires-Dist: nest-asyncio (>=1.5.6,<2.0.0)
+Requires-Dist: literalai (==0.1.103)
+Requires-Dist: nest-asyncio (>=1.6.0,<2.0.0)
 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-graphql-client (>=0.4.3,<0.5.0)
-Requires-Dist: python-multipart (>=0.0.9,<0.0.10)
-Requires-Dist: starlette (<0.33.0)
+Requires-Dist: python-multipart (>=0.0.18,<0.0.19)
+Requires-Dist: python-socketio (>=5.11.0,<6.0.0)
+Requires-Dist: starlette (>=0.41.2,<0.42.0)
 Requires-Dist: syncer (>=2.0.3,<3.0.0)
 Requires-Dist: tomli (>=2.0.1,<3.0.0)
 Requires-Dist: uptrace (>=1.22.0,<2.0.0)
 Requires-Dist: uvicorn (>=0.25.0,<0.26.0)
 Requires-Dist: watchfiles (>=0.20.0,<0.21.0)
+Project-URL: Documentation, https://docs.chainlit.io/
 Project-URL: Repository, https://github.com/Chainlit/chainlit
 Description-Content-Type: text/markdown
 
@@ -43,34 +50,40 @@ 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 ⚡️**
 
 Chainlit is an open-source async Python framework which allows developers to build scalable Conversational AI or agentic applications.
 
-- ✅ ChatGPT-like application
-- ✅ Embedded Chatbot & Software Copilot
-- ✅ Custom frontend (build your own agentic experience)
-- ✅ API Endpoint
+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!
 
-Full documentation is available [here](https://docs.chainlit.io).
+https://github.com/user-attachments/assets/b3738aba-55c0-42fa-ac00-6efd1ee0d148
 
-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.
-
-https://github.com/Chainlit/chainlit/assets/13104895/8882af90-fdfa-4b24-8200-1ee96c6c7490
 
 ## Installation
 
 Open a terminal and run:
 
-```bash
-$ pip install chainlit
-$ chainlit hello
+```sh
+pip install chainlit
+chainlit hello
 ```
 
 If this opens the `hello app` in your browser, you're all set!
 
+### Development version
+
+The latest in-development version can be installed straight from GitHub with:
+
+```sh
+pip install git+https://github.com/Chainlit/chainlit.git#subdirectory=backend/
+```
+
+(Requires Node and pnpm installed on the system.)
+
 ## 🚀 Quickstart
 
 ### 🐍 Pure Python
@@ -81,8 +94,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!"
 
 
@@ -99,37 +114,20 @@ async def main(message: cl.Message):
         None.
     """
 
+
     # Call the tool
-    tool()
+    tool_res = await tool()
 
-    # Send the final answer.
-    await cl.Message(content="This is the final answer").send()
+    await cl.Message(content=tool_res).send()
 ```
 
 Now run it!
 
-```
-$ chainlit run demo.py -w
+```sh
+chainlit run demo.py -w
 ```
 
 <img src="/images/quick-start.png" alt="Quick Start"></img>
-## 🎉 Key Features and Integrations
-
-Full documentation is available [here](https://docs.chainlit.io). Key features:
-
-- [💬 Multi Modal chats](https://docs.chainlit.io/advanced-features/multi-modal)
-- [💭 Chain of Thought visualisation](https://docs.chainlit.io/concepts/step)
-- [💾 Data persistence + human feedback](https://docs.chainlit.io/data-persistence/overview)
-- [🛝 In context Prompt Playground](https://docs.chainlit.io/advanced-features/prompt-playground/overview)
-- [👤 Authentication](https://docs.chainlit.io/authentication/overview)
-
-Chainlit is compatible with all Python programs and libraries. That being said, it comes with integrations for:
-
-- [LangChain](https://docs.chainlit.io/integrations/langchain)
-- [Llama Index](https://docs.chainlit.io/integrations/llama-index)
-- [Autogen](https://github.com/Chainlit/cookbook/tree/main/pyautogen)
-- [OpenAI Assistant](https://github.com/Chainlit/cookbook/tree/main/openai-assistant)
-- [Haystack](https://docs.chainlit.io/integrations/haystack)
 
 ## 📚 More Examples - Cookbook
 

{chainlit-1.0.401 → chainlit-2.0.3}/README.md

@@ -2,34 +2,40 @@
 
 [![](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 ⚡️**
 
 Chainlit is an open-source async Python framework which allows developers to build scalable Conversational AI or agentic applications.
 
-- ✅ ChatGPT-like application
-- ✅ Embedded Chatbot & Software Copilot
-- ✅ Custom frontend (build your own agentic experience)
-- ✅ API Endpoint
+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!
 
-Full documentation is available [here](https://docs.chainlit.io).
+https://github.com/user-attachments/assets/b3738aba-55c0-42fa-ac00-6efd1ee0d148
 
-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.
-
-https://github.com/Chainlit/chainlit/assets/13104895/8882af90-fdfa-4b24-8200-1ee96c6c7490
 
 ## Installation
 
 Open a terminal and run:
 
-```bash
-$ pip install chainlit
-$ chainlit hello
+```sh
+pip install chainlit
+chainlit hello
 ```
 
 If this opens the `hello app` in your browser, you're all set!
 
+### Development version
+
+The latest in-development version can be installed straight from GitHub with:
+
+```sh
+pip install git+https://github.com/Chainlit/chainlit.git#subdirectory=backend/
+```
+
+(Requires Node and pnpm installed on the system.)
+
 ## 🚀 Quickstart
 
 ### 🐍 Pure Python
@@ -40,8 +46,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!"
 
 
@@ -58,37 +66,20 @@ async def main(message: cl.Message):
         None.
     """
 
+
     # Call the tool
-    tool()
+    tool_res = await tool()
 
-    # Send the final answer.
-    await cl.Message(content="This is the final answer").send()
+    await cl.Message(content=tool_res).send()
 ```
 
 Now run it!
 
-```
-$ chainlit run demo.py -w
+```sh
+chainlit run demo.py -w
 ```
 
 <img src="/images/quick-start.png" alt="Quick Start"></img>
-## 🎉 Key Features and Integrations
-
-Full documentation is available [here](https://docs.chainlit.io). Key features:
-
-- [💬 Multi Modal chats](https://docs.chainlit.io/advanced-features/multi-modal)
-- [💭 Chain of Thought visualisation](https://docs.chainlit.io/concepts/step)
-- [💾 Data persistence + human feedback](https://docs.chainlit.io/data-persistence/overview)
-- [🛝 In context Prompt Playground](https://docs.chainlit.io/advanced-features/prompt-playground/overview)
-- [👤 Authentication](https://docs.chainlit.io/authentication/overview)
-
-Chainlit is compatible with all Python programs and libraries. That being said, it comes with integrations for:
-
-- [LangChain](https://docs.chainlit.io/integrations/langchain)
-- [Llama Index](https://docs.chainlit.io/integrations/llama-index)
-- [Autogen](https://github.com/Chainlit/cookbook/tree/main/pyautogen)
-- [OpenAI Assistant](https://github.com/Chainlit/cookbook/tree/main/openai-assistant)
-- [Haystack](https://docs.chainlit.io/integrations/haystack)
 
 ## 📚 More Examples - Cookbook
 

chainlit-2.0.3/chainlit/__init__.py

@@ -0,0 +1,191 @@
+import os
+
+from dotenv import load_dotenv
+
+# ruff: noqa: E402
+# Keep this here to ensure imports have environment available.
+env_found = load_dotenv(dotenv_path=os.path.join(os.getcwd(), ".env"))
+
+from chainlit.logger import logger
+
+if env_found:
+    logger.info("Loaded .env file")
+
+import asyncio
+from typing import TYPE_CHECKING, Any, Dict
+
+from literalai import ChatGeneration, CompletionGeneration, GenerationMessage
+from pydantic.dataclasses import dataclass
+
+import chainlit.input_widget as input_widget
+from chainlit.action import Action
+from chainlit.cache import cache
+from chainlit.chat_context import chat_context
+from chainlit.chat_settings import ChatSettings
+from chainlit.context import context
+from chainlit.element import (
+    Audio,
+    CustomElement,
+    Dataframe,
+    File,
+    Image,
+    Pdf,
+    Plotly,
+    Pyplot,
+    Task,
+    TaskList,
+    TaskStatus,
+    Text,
+    Video,
+)
+from chainlit.message import (
+    AskActionMessage,
+    AskFileMessage,
+    AskUserMessage,
+    ErrorMessage,
+    Message,
+)
+from chainlit.step import Step, step
+from chainlit.sync import make_async, run_sync
+from chainlit.types import ChatProfile, InputAudioChunk, OutputAudioChunk, Starter
+from chainlit.user import PersistedUser, User
+from chainlit.user_session import user_session
+from chainlit.utils import make_module_getattr
+from chainlit.version import __version__
+
+from .callbacks import (
+    action_callback,
+    author_rename,
+    data_layer,
+    header_auth_callback,
+    oauth_callback,
+    on_audio_chunk,
+    on_audio_end,
+    on_audio_start,
+    on_chat_end,
+    on_chat_resume,
+    on_chat_start,
+    on_logout,
+    on_message,
+    on_settings_update,
+    on_stop,
+    on_window_message,
+    password_auth_callback,
+    send_window_message,
+    set_chat_profiles,
+    set_starters,
+)
+
+if TYPE_CHECKING:
+    from chainlit.haystack.callbacks import HaystackAgentCallbackHandler
+    from chainlit.langchain.callbacks import (
+        AsyncLangchainCallbackHandler,
+        LangchainCallbackHandler,
+    )
+    from chainlit.llama_index.callbacks import LlamaIndexCallbackHandler
+    from chainlit.mistralai import instrument_mistralai
+    from chainlit.openai import instrument_openai
+
+
+def sleep(duration: int):
+    """
+    Sleep for a given duration.
+    Args:
+        duration (int): The duration in seconds.
+    """
+    return asyncio.sleep(duration)
+
+
+@dataclass()
+class CopilotFunction:
+    name: str
+    args: Dict[str, Any]
+
+    def acall(self):
+        return context.emitter.send_call_fn(self.name, self.args)
+
+
+__getattr__ = make_module_getattr(
+    {
+        "LangchainCallbackHandler": "chainlit.langchain.callbacks",
+        "AsyncLangchainCallbackHandler": "chainlit.langchain.callbacks",
+        "LlamaIndexCallbackHandler": "chainlit.llama_index.callbacks",
+        "HaystackAgentCallbackHandler": "chainlit.haystack.callbacks",
+        "instrument_openai": "chainlit.openai",
+        "instrument_mistralai": "chainlit.mistralai",
+    }
+)
+
+__all__ = [
+    "Action",
+    "AskActionMessage",
+    "AskFileMessage",
+    "AskUserMessage",
+    "AsyncLangchainCallbackHandler",
+    "Audio",
+    "ChatGeneration",
+    "ChatProfile",
+    "ChatSettings",
+    "CompletionGeneration",
+    "CopilotFunction",
+    "CustomElement",
+    "Dataframe",
+    "ErrorMessage",
+    "File",
+    "GenerationMessage",
+    "HaystackAgentCallbackHandler",
+    "Image",
+    "InputAudioChunk",
+    "LangchainCallbackHandler",
+    "LlamaIndexCallbackHandler",
+    "Message",
+    "OutputAudioChunk",
+    "Pdf",
+    "PersistedUser",
+    "Plotly",
+    "Pyplot",
+    "Starter",
+    "Step",
+    "Task",
+    "TaskList",
+    "TaskStatus",
+    "Text",
+    "User",
+    "Video",
+    "__version__",
+    "action_callback",
+    "author_rename",
+    "cache",
+    "chat_context",
+    "context",
+    "data_layer",
+    "header_auth_callback",
+    "input_widget",
+    "instrument_mistralai",
+    "instrument_openai",
+    "make_async",
+    "oauth_callback",
+    "on_audio_chunk",
+    "on_audio_end",
+    "on_audio_start",
+    "on_chat_end",
+    "on_chat_resume",
+    "on_chat_start",
+    "on_logout",
+    "on_message",
+    "on_settings_update",
+    "on_stop",
+    "on_window_message",
+    "password_auth_callback",
+    "run_sync",
+    "send_window_message",
+    "set_chat_profiles",
+    "set_starters",
+    "sleep",
+    "step",
+    "user_session",
+]
+
+
+def __dir__():
+    return __all__

chainlit-2.0.3/chainlit/_utils.py

@@ -0,0 +1,8 @@
+"""Util functions which are explicitly not part of the public API."""
+
+from pathlib import Path
+
+
+def is_path_inside(child_path: Path, parent_path: Path) -> bool:
+    """Check if the child path is inside the parent path."""
+    return parent_path.resolve() in child_path.resolve().parents

{chainlit-1.0.401 → chainlit-2.0.3}/chainlit/action.py

@@ -1,28 +1,30 @@
 import uuid
-from typing import Optional
+from typing import Dict, Optional
+
+from dataclasses_json import DataClassJsonMixin
+from pydantic import Field
+from pydantic.dataclasses import dataclass
 
 from chainlit.context import context
 from chainlit.telemetry import trace_event
-from dataclasses_json import DataClassJsonMixin
-from pydantic.dataclasses import Field, dataclass
 
 
 @dataclass
 class Action(DataClassJsonMixin):
     # Name of the action, this should be used in the action_callback
     name: str
-    # The value associated with the action. This is useful to differentiate between multiple actions with the same name.
-    value: str
-    # The label of the action. This is what the user will see. If not provided the name will be used.
+    # The parameters to call this action with.
+    payload: Dict
+    # The label of the action. This is what the user will see.
     label: str = ""
-    # The description of the action. This is what the user will see when they hover the action.
-    description: str = ""
+    # The tooltip of the action button. This is what the user will see when they hover the action.
+    tooltip: str = ""
+    # The lucid icon name for this action.
+    icon: Optional[str] = None
     # This should not be set manually, only used internally.
     forId: Optional[str] = None
     # The ID of the action
     id: str = Field(default_factory=lambda: str(uuid.uuid4()))
-    # Show the action in a drawer menu
-    collapsed: bool = False
 
     def __post_init__(self) -> None:
         trace_event(f"init {self.__class__.__name__}")

chainlit-1.0.401/chainlit/auth.py → chainlit-2.0.3/chainlit/auth/__init__.py

@@ -1,20 +1,16 @@
 import os
-from datetime import datetime, timedelta
-from typing import Any, Dict
 
-import jwt
+from fastapi import Depends, HTTPException
+
 from chainlit.config import config
 from chainlit.data import get_data_layer
+from chainlit.logger import logger
 from chainlit.oauth_providers import get_configured_oauth_providers
-from chainlit.user import User
-from fastapi import Depends, HTTPException
-from fastapi.security import OAuth2PasswordBearer
-
-reuseable_oauth = OAuth2PasswordBearer(tokenUrl="/login", auto_error=False)
 
+from .cookie import OAuth2PasswordBearerWithCookie
+from .jwt import create_jwt, decode_jwt, get_jwt_secret
 
-def get_jwt_secret():
-    return os.environ.get("CHAINLIT_AUTH_SECRET")
+reuseable_oauth = OAuth2PasswordBearerWithCookie(tokenUrl="/login", auto_error=False)
 
 
 def ensure_jwt_secret():
@@ -42,46 +38,39 @@ def get_configuration():
         "requireLogin": require_login(),
         "passwordAuth": config.code.password_auth_callback is not None,
         "headerAuth": config.code.header_auth_callback is not None,
-        "oauthProviders": get_configured_oauth_providers()
-        if is_oauth_enabled()
-        else [],
+        "oauthProviders": (
+            get_configured_oauth_providers() if is_oauth_enabled() else []
+        ),
+        "default_theme": config.ui.default_theme,
     }
 
 
-def create_jwt(data: User) -> str:
-    to_encode = data.to_dict()  # type: Dict[str, Any]
-    to_encode.update(
-        {
-            "exp": datetime.utcnow() + timedelta(minutes=60 * 24 * 15),  # 15 days
-        }
-    )
-    encoded_jwt = jwt.encode(to_encode, get_jwt_secret(), algorithm="HS256")
-    return encoded_jwt
-
-
 async def authenticate_user(token: str = Depends(reuseable_oauth)):
     try:
-        dict = jwt.decode(
-            token,
-            get_jwt_secret(),
-            algorithms=["HS256"],
-            options={"verify_signature": True},
-        )
-        del dict["exp"]
-        user = User(**dict)
+        user = decode_jwt(token)
     except Exception as e:
-        raise HTTPException(status_code=401, detail="Invalid authentication token")
+        raise HTTPException(
+            status_code=401, detail="Invalid authentication token"
+        ) from e
+
     if data_layer := get_data_layer():
+        # Get or create persistent user if we've a data layer available.
         try:
             persisted_user = await data_layer.get_user(user.identifier)
-            if persisted_user == None:
+            if persisted_user is None:
                 persisted_user = await data_layer.create_user(user)
+                assert persisted_user
         except Exception as e:
+            logger.exception("Unable to get persisted_user from data layer: %s", e)
             return user
 
+        if user and user.display_name:
+            # Copy ephemeral display_name from authenticated user to persistent user.
+            persisted_user.display_name = user.display_name
+
         return persisted_user
-    else:
-        return user
+
+    return user
 
 
 async def get_current_user(token: str = Depends(reuseable_oauth)):
@@ -89,3 +78,6 @@ async def get_current_user(token: str = Depends(reuseable_oauth)):
         return None
 
     return await authenticate_user(token)
+
+
+__all__ = ["create_jwt", "get_configuration", "get_current_user"]