chore: Add PyPI package support for uvx/pip installation (#1764)

* Initial plan

* Add package structure and resource path utilities

- Created langbot/ package with __init__.py and __main__.py entry point
- Added paths utility to find frontend and resource files from package installation
- Updated config loading to use resource paths
- Updated frontend serving to use resource paths
- Added MANIFEST.in for package data inclusion
- Updated pyproject.toml with build system and entry points

Co-authored-by: RockChinQ <45992437+RockChinQ@users.noreply.github.com>

* Add PyPI publishing workflow and update license

- Created GitHub Actions workflow to build frontend and publish to PyPI
- Added license field to pyproject.toml to fix deprecation warning
- Updated .gitignore to exclude build artifacts
- Tested package building successfully

Co-authored-by: RockChinQ <45992437+RockChinQ@users.noreply.github.com>

* Add PyPI installation documentation

- Created PYPI_INSTALLATION.md with detailed installation and usage instructions
- Updated README.md to feature uvx/pip installation as recommended method
- Updated README_EN.md with same changes for English documentation

Co-authored-by: RockChinQ <45992437+RockChinQ@users.noreply.github.com>

* Address code review feedback

- Made package-data configuration more specific to langbot package only
- Improved path detection with caching to avoid repeated file I/O
- Removed sys.path searching which was incorrect for package data
- Removed interactive input() call for non-interactive environment compatibility
- Simplified error messages for version check

Co-authored-by: RockChinQ <45992437+RockChinQ@users.noreply.github.com>

* Fix code review issues

- Use specific exception types instead of bare except
- Fix misleading comments about directory levels
- Remove redundant existence check before makedirs with exist_ok=True
- Use context manager for file opening to ensure proper cleanup

Co-authored-by: RockChinQ <45992437+RockChinQ@users.noreply.github.com>

* Simplify package configuration and document behavioral differences

- Removed redundant package-data configuration, relying on MANIFEST.in
- Added documentation about behavioral differences between package and source installation
- Clarified that include-package-data=true uses MANIFEST.in for data files

Co-authored-by: RockChinQ <45992437+RockChinQ@users.noreply.github.com>

* chore: update pyproject.toml

* chore: try pack templates in langbot/

* chore: update

* chore: update

* chore: update

* chore: update

* chore: update

* chore: adjust dir structure

* chore: fix imports

* fix: read default-pipeline-config.json

* fix: read default-pipeline-config.json

* fix: tests

* ci: publish pypi

* chore: bump version 4.6.0-beta.1 for testing

* chore: add templates/**

* fix: send adapters and requesters icons

* chore: bump version 4.6.0b2 for testing

* chore: add platform field for docker-compose.yaml

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: RockChinQ <45992437+RockChinQ@users.noreply.github.com>
Co-authored-by: Junyan Qin <rockchinq@gmail.com>

src/langbot/pkg/pipeline/process/handler.py

@@ -0,0 +1,33 @@
+from __future__ import annotations
+
+import abc
+
+from ...core import app
+from .. import entities
+import langbot_plugin.api.entities.builtin.pipeline.query as pipeline_query
+
+
+class MessageHandler(metaclass=abc.ABCMeta):
+    ap: app.Application
+
+    def __init__(self, ap: app.Application):
+        self.ap = ap
+
+    async def initialize(self):
+        pass
+
+    @abc.abstractmethod
+    async def handle(
+        self,
+        query: pipeline_query.Query,
+    ) -> entities.StageProcessResult:
+        raise NotImplementedError
+
+    def cut_str(self, s: str) -> str:
+        """
+        Take the first line of the string, up to 20 characters, if there are multiple lines, or more than 20 characters, add an ellipsis
+        """
+        s0 = s.split('\n')[0]
+        if len(s0) > 20 or '\n' in s:
+            s0 = s0[:20] + '...'
+        return s0

src/langbot/pkg/pipeline/process/handlers/chat.py

@@ -0,0 +1,128 @@
+from __future__ import annotations
+
+import uuid
+import typing
+import traceback
+
+
+from .. import handler
+from ... import entities
+from ....provider import runner as runner_module
+
+import langbot_plugin.api.entities.events as events
+from ....utils import importutil
+from ....provider import runners
+import langbot_plugin.api.entities.builtin.provider.session as provider_session
+import langbot_plugin.api.entities.builtin.pipeline.query as pipeline_query
+
+
+importutil.import_modules_in_pkg(runners)
+
+
+class ChatMessageHandler(handler.MessageHandler):
+    async def handle(
+        self,
+        query: pipeline_query.Query,
+    ) -> typing.AsyncGenerator[entities.StageProcessResult, None]:
+        """处理"""
+        # 调API
+        #   生成器
+
+        # 触发插件事件
+        event_class = (
+            events.PersonNormalMessageReceived
+            if query.launcher_type == provider_session.LauncherTypes.PERSON
+            else events.GroupNormalMessageReceived
+        )
+
+        event = event_class(
+            launcher_type=query.launcher_type.value,
+            launcher_id=query.launcher_id,
+            sender_id=query.sender_id,
+            text_message=str(query.message_chain),
+            query=query,
+        )
+
+        # Get bound plugins for filtering
+        bound_plugins = query.variables.get('_pipeline_bound_plugins', None)
+        event_ctx = await self.ap.plugin_connector.emit_event(event, bound_plugins)
+
+        is_create_card = False  # 判断下是否需要创建流式卡片
+
+        if event_ctx.is_prevented_default():
+            if event_ctx.event.reply_message_chain is not None:
+                mc = event_ctx.event.reply_message_chain
+                query.resp_messages.append(mc)
+
+                yield entities.StageProcessResult(result_type=entities.ResultType.CONTINUE, new_query=query)
+            else:
+                yield entities.StageProcessResult(result_type=entities.ResultType.INTERRUPT, new_query=query)
+        else:
+            if event_ctx.event.user_message_alter is not None:
+                # if isinstance(event_ctx.event, str):  # 现在暂时不考虑多模态alter
+                query.user_message.content = event_ctx.event.user_message_alter
+
+            text_length = 0
+            try:
+                is_stream = await query.adapter.is_stream_output_supported()
+            except AttributeError:
+                is_stream = False
+
+            try:
+                for r in runner_module.preregistered_runners:
+                    if r.name == query.pipeline_config['ai']['runner']['runner']:
+                        runner = r(self.ap, query.pipeline_config)
+                        break
+                else:
+                    raise ValueError(f'未找到请求运行器: {query.pipeline_config["ai"]["runner"]["runner"]}')
+                if is_stream:
+                    resp_message_id = uuid.uuid4()
+
+                    async for result in runner.run(query):
+                        result.resp_message_id = str(resp_message_id)
+                        if query.resp_messages:
+                            query.resp_messages.pop()
+                        if query.resp_message_chain:
+                            query.resp_message_chain.pop()
+                        # 此时连接外部 AI 服务正常,创建卡片
+                        if not is_create_card:  # 只有不是第一次才创建卡片
+                            await query.adapter.create_message_card(str(resp_message_id), query.message_event)
+                            is_create_card = True
+                        query.resp_messages.append(result)
+                        self.ap.logger.info(f'对话({query.query_id})流式响应: {self.cut_str(result.readable_str())}')
+
+                        if result.content is not None:
+                            text_length += len(result.content)
+
+                        yield entities.StageProcessResult(result_type=entities.ResultType.CONTINUE, new_query=query)
+
+                else:
+                    async for result in runner.run(query):
+                        query.resp_messages.append(result)
+
+                        self.ap.logger.info(f'对话({query.query_id})响应: {self.cut_str(result.readable_str())}')
+
+                        if result.content is not None:
+                            text_length += len(result.content)
+
+                        yield entities.StageProcessResult(result_type=entities.ResultType.CONTINUE, new_query=query)
+
+                query.session.using_conversation.messages.append(query.user_message)
+
+                query.session.using_conversation.messages.extend(query.resp_messages)
+            except Exception as e:
+                self.ap.logger.error(f'对话({query.query_id})请求失败: {type(e).__name__} {str(e)}')
+                traceback.print_exc()
+
+                hide_exception_info = query.pipeline_config['output']['misc']['hide-exception']
+
+                yield entities.StageProcessResult(
+                    result_type=entities.ResultType.INTERRUPT,
+                    new_query=query,
+                    user_notice='请求失败' if hide_exception_info else f'{e}',
+                    error_notice=f'{e}',
+                    debug_notice=traceback.format_exc(),
+                )
+            finally:
+                # TODO statistics
+                pass

src/langbot/pkg/pipeline/process/handlers/command.py

@@ -0,0 +1,110 @@
+from __future__ import annotations
+import typing
+
+
+from .. import handler
+from ... import entities
+import langbot_plugin.api.entities.builtin.provider.message as provider_message
+import langbot_plugin.api.entities.builtin.provider.session as provider_session
+import langbot_plugin.api.entities.builtin.pipeline.query as pipeline_query
+import langbot_plugin.api.entities.events as events
+
+
+class CommandHandler(handler.MessageHandler):
+    async def handle(
+        self,
+        query: pipeline_query.Query,
+    ) -> typing.AsyncGenerator[entities.StageProcessResult, None]:
+        """Process"""
+
+        full_command_text = str(query.message_chain).strip()
+
+        command_text = full_command_text[1:]
+
+        privilege = 1
+
+        if f'{query.launcher_type.value}_{query.launcher_id}' in self.ap.instance_config.data['admins']:
+            privilege = 2
+
+        spt = command_text.split(' ')
+
+        event_class = (
+            events.PersonCommandSent
+            if query.launcher_type == provider_session.LauncherTypes.PERSON
+            else events.GroupCommandSent
+        )
+
+        event = event_class(
+            launcher_type=query.launcher_type.value,
+            launcher_id=query.launcher_id,
+            sender_id=query.sender_id,
+            command=spt[0],
+            params=spt[1:] if len(spt) > 1 else [],
+            text_message=full_command_text,
+            is_admin=(privilege == 2),
+            query=query,
+        )
+
+        # Get bound plugins for filtering
+        bound_plugins = query.variables.get('_pipeline_bound_plugins', None)
+        event_ctx = await self.ap.plugin_connector.emit_event(event, bound_plugins)
+
+        if event_ctx.is_prevented_default():
+            if event_ctx.event.reply_message_chain is not None:
+                mc = event_ctx.event.reply_message_chain
+
+                query.resp_messages.append(mc)
+
+                yield entities.StageProcessResult(result_type=entities.ResultType.CONTINUE, new_query=query)
+            else:
+                yield entities.StageProcessResult(result_type=entities.ResultType.INTERRUPT, new_query=query)
+
+        else:
+            session = await self.ap.sess_mgr.get_session(query)
+
+            async for ret in self.ap.cmd_mgr.execute(
+                command_text=command_text, full_command_text=full_command_text, query=query, session=session
+            ):
+                if ret.error is not None:
+                    query.resp_messages.append(
+                        provider_message.Message(
+                            role='command',
+                            content=str(ret.error),
+                        )
+                    )
+
+                    self.ap.logger.info(f'Command({query.query_id}) error: {self.cut_str(str(ret.error))}')
+
+                    yield entities.StageProcessResult(result_type=entities.ResultType.CONTINUE, new_query=query)
+                elif (
+                    ret.text is not None
+                    or ret.image_url is not None
+                    or ret.image_base64 is not None
+                    or ret.file_url is not None
+                ):
+                    content: list[provider_message.ContentElement] = []
+
+                    if ret.text is not None:
+                        content.append(provider_message.ContentElement.from_text(ret.text))
+
+                    if ret.image_url is not None:
+                        content.append(provider_message.ContentElement.from_image_url(ret.image_url))
+
+                    if ret.image_base64 is not None:
+                        content.append(provider_message.ContentElement.from_image_base64(ret.image_base64))
+
+                    if ret.file_url is not None:
+                        # 此时为 file 类型
+                        content.append(provider_message.ContentElement.from_file_url(ret.file_url, ret.file_name))
+                    query.resp_messages.append(
+                        provider_message.Message(
+                            role='command',
+                            content=content,
+                        )
+                    )
+
+                    self.ap.logger.info(f'Command returned: {self.cut_str(str(content[0]))}')
+
+                    yield entities.StageProcessResult(result_type=entities.ResultType.CONTINUE, new_query=query)
+                else:
+                    yield entities.StageProcessResult(result_type=entities.ResultType.INTERRUPT, new_query=query)

src/langbot/pkg/pipeline/process/process.py

@@ -0,0 +1,55 @@
+from __future__ import annotations
+
+from . import handler
+from .handlers import chat, command
+from .. import entities
+from .. import stage
+import langbot_plugin.api.entities.builtin.pipeline.query as pipeline_query
+
+
+@stage.stage_class('MessageProcessor')
+class Processor(stage.PipelineStage):
+    """请求实际处理阶段
+
+    通过命令处理器和聊天处理器处理消息。
+
+    改写：
+        - resp_messages
+    """
+
+    cmd_handler: handler.MessageHandler
+
+    chat_handler: handler.MessageHandler
+
+    async def initialize(self, pipeline_config: dict):
+        self.cmd_handler = command.CommandHandler(self.ap)
+        self.chat_handler = chat.ChatMessageHandler(self.ap)
+
+        await self.cmd_handler.initialize()
+        await self.chat_handler.initialize()
+
+    async def process(
+        self,
+        query: pipeline_query.Query,
+        stage_inst_name: str,
+    ) -> entities.StageProcessResult:
+        """Process"""
+        message_text = str(query.message_chain).strip()
+
+        self.ap.logger.info(
+            f'Processing request from {query.launcher_type.value}_{query.launcher_id} ({query.query_id}): {message_text}'
+        )
+
+        async def generator():
+            cmd_prefix = self.ap.instance_config.data['command']['prefix']
+            cmd_enable = self.ap.instance_config.data['command'].get('enable', True)
+
+            if cmd_enable and any(message_text.startswith(prefix) for prefix in cmd_prefix):
+                handler_to_use = self.cmd_handler
+            else:
+                handler_to_use = self.chat_handler
+
+            async for result in handler_to_use.handle(query):
+                yield result
+
+        return generator()