bitongue 0.1.0__tar.gz

bitongue-0.1.0/.github/workflows/docs.yml

@@ -0,0 +1,60 @@
+name: Docs
+
+on:
+  push:
+    branches: [main]
+    paths:
+      - 'docs/**'
+      - 'src/**'
+      - 'pyproject.toml'
+      - 'uv.lock'
+      - 'Makefile'
+      - '.github/workflows/docs.yml'
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          python-version: "3.12"
+
+      - name: Sync dependencies
+        run: uv sync --no-default-groups --group docs
+
+      - name: Build documentation
+        run: make docs-build
+        env:
+          DOCS_ROOT_URL: https://ahsen17.github.io/bitongue
+
+      - name: Upload Pages artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/_build/html
+
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

bitongue-0.1.0/.github/workflows/pypub.yml

@@ -0,0 +1,68 @@
+# This workflow will upload a Python Package to PyPI when a release is created
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: Upload PYPI
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  release-build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          python-version: "3.12"
+
+      - name: Build release distributions
+        run: uv build
+
+      - name: Upload distributions
+        uses: actions/upload-artifact@v4
+        with:
+          name: release-dists
+          path: dist/
+
+  pypi-publish:
+    runs-on: ubuntu-latest
+    needs:
+      - release-build
+    permissions:
+      # IMPORTANT: this permission is mandatory for trusted publishing
+      id-token: write
+
+    # Dedicated environments with protections for publishing are strongly recommended.
+    # For more information, see: https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment#deployment-protection-rules
+    environment:
+      name: pypi
+      # The PyPI project URL, shown in the deployment status:
+      url: https://pypi.org/p/bitongue
+      #
+      # ALTERNATIVE: if your GitHub Release name is the PyPI project version string
+      # ALTERNATIVE: exactly, uncomment the following line instead:
+      # url: https://pypi.org/project/YOURPROJECT/${{ github.event.release.name }}
+
+    steps:
+      - name: Retrieve release distributions
+        uses: actions/download-artifact@v4
+        with:
+          name: release-dists
+          path: dist/
+
+      - name: Publish release distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: dist/

bitongue-0.1.0/.github/workflows/pytest.yml

@@ -0,0 +1,70 @@
+name: Tests
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  changes:
+    runs-on: ubuntu-latest
+    outputs:
+      code: ${{ steps.filter.outputs.code }}
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Detect code changes
+        uses: dorny/paths-filter@v3
+        id: filter
+        with:
+          filters: |
+            code:
+              - 'src/**'
+              - 'tests/**'
+              - 'test_integration/**'
+              - 'pyproject.toml'
+              - 'uv.lock'
+              - 'Makefile'
+              - '.pre-commit-config.yaml'
+              - '.github/workflows/pytest.yml'
+
+  test:
+    needs: changes
+    if: needs.changes.outputs.code == 'true'
+    runs-on: ubuntu-latest
+
+    services:
+      redis:
+        image: redis:7.4-alpine
+        ports:
+          - 6379:6379
+        options: >-
+          --health-cmd "redis-cli ping"
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          python-version: "3.12"
+
+      - name: Sync dependencies
+        run: uv sync --dev --all-extras
+
+      - name: Lint
+        run: |
+          uv run ruff check src tests test_integration
+          uv run ruff format --check src tests test_integration
+
+      - name: Type check
+        run: uv run mypy
+
+      - name: Unit tests
+        run: uv run pytest tests --cov -n auto
+
+      - name: Integration tests
+        run: uv run pytest test_integration -m integration

bitongue-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,39 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - "v*"
+
+permissions:
+  contents: write
+
+jobs:
+  draft-release:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          python-version: "3.12"
+
+      - name: Sync dependencies
+        run: uv sync --dev
+
+      - name: Build distributions
+        run: uv build
+
+      - name: Generate release notes
+        run: uv run git-cliff --latest --strip header > RELEASE_NOTES.md
+
+      - name: Create draft release
+        uses: softprops/action-gh-release@v2
+        with:
+          draft: true
+          body_path: RELEASE_NOTES.md
+          files: dist/*

bitongue-0.1.0/.gitignore

@@ -0,0 +1,231 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Configuration files
+# *.ini
+*.env
+config.yaml
+config.yml
+config.toml
+config.json
+settings.*.json
+
+# Temp files
+*.log
+tmp/
+.runtime/
+
+# Ai coding
+.codex/
+.agents/
+.claude/
+.cursor/
+CLAUDE.md
+AGENTS.md
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# VS Code settings
+.vscode/
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer,
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/

bitongue-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,34 @@
+default_language_version:
+  python: "3"
+repos:
+  - repo: https://github.com/compilerla/conventional-pre-commit
+    rev: v4.2.0
+    hooks:
+      - id: conventional-pre-commit
+        stages: [commit-msg]
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: check-ast
+      - id: check-case-conflict
+      - id: check-toml
+      - id: end-of-file-fixer
+      - id: mixed-line-ending
+      - id: trailing-whitespace
+  - repo: https://github.com/provinzkraut/unasyncd
+    rev: "v0.8.1"
+    hooks:
+      - id: unasyncd
+        additional_dependencies: ["ruff"]
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: "v0.17.0"
+    hooks:
+      - id: ruff
+        args: ["--fix"]
+        types_or: [python, pyi]
+      - id: ruff-format
+        types_or: [python, pyi]
+  - repo: https://github.com/sphinx-contrib/sphinx-lint
+    rev: "v1.0.0"
+    hooks:
+      - id: sphinx-lint

bitongue-0.1.0/.python-version

@@ -0,0 +1 @@
+3.12

bitongue-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,141 @@
+# 贡献指南
+
+[中文] **·** [English](CONTRIBUTING_en.md)
+
+感谢关注 Bitongue！本文档说明如何搭建开发环境、项目约定，以及提交贡献的完整流程。
+
+## 目录
+
+[AI 协助政策](#ai-协助政策) **·** [开发环境](#开发环境) **·** [代码约定](#代码约定) **·** [贡献流程](#贡献流程) **·** [提交规范](#提交规范) **·** [测试要求](#测试要求) **·** [发布流程](#发布流程维护者) **·** [文档](#文档) **·** [行为准则](#行为准则)
+
+## AI 协助政策
+
+**本项目接受 AI 协助开发的代码。** 但请注意：
+
+- 你（提交者）必须**认真审查**提交的每一行代码，无论它由你本人还是 AI 协助编写；
+- AI 协助的代码与本人编写的代码**承担同等责任**——正确性、安全性、许可证合规
+  均由提交者负责；
+- 提交即视为你完全理解并认可该变更，"这是 AI 写的"不构成缺陷的免责理由。
+
+## 开发环境
+
+本项目使用 [uv](https://docs.astral.sh/uv/) 管理依赖，要求 Python ≥ 3.12，
+GNU Make 驱动日常命令（Makefile 已做跨平台适配）。
+
+```bash
+git clone git@github.com:Ahsen17/bitongue.git
+cd bitongue
+make install    # 创建虚拟环境并安装依赖
+make check      # lint + 类型检查 + 全部测试
+```
+
+常用命令：
+
+| 命令 | 作用 |
+|-|-|
+| `make sync` | 同步依赖 |
+| `make fix` | ruff 自动修复与格式化 |
+| `make lint` | pre-commit + mypy（strict） |
+| `make pyright` | pyright 类型检查 |
+| `make test` | 单元测试 |
+| `make test-integration` | 集成测试 |
+| `make coverage` | 覆盖率报告（`fail_under = 80`） |
+| `make docs-build` | 构建双语文档站 |
+| `make changelog` | 由 git-cliff 再生成 CHANGELOG.md |
+
+## 代码约定
+
+- 一切数据结构继承 `bitongue.base.BaseStruct`（msgspec `Struct` 封装），
+  不使用 dataclass 或 pydantic；
+- 异步只使用 anyio 原语（`create_memory_object_stream`、`fail_after` 等），
+  不直接 import asyncio；
+- 泛型使用 PEP 695 语法（`class Flowing[T: BaseMessage]`）；
+- 子包内文件分工固定：`schemas.py`（数据结构）、`protocols.py`（接口 Protocol）、
+  `exceptions.py`（异常，均继承 `BitongueError`）；`__init__.py` 显式声明
+  `__all__` 再导出；
+- 代码风格由 ruff 统一约束：行宽 90、Google 风格 docstring 约定、
+  规则组见 `pyproject.toml` 的 `[tool.ruff.lint]`；
+- 类型检查执行 mypy strict 与 pyright 双重标准，两者都必须通过。
+
+## 贡献流程
+
+本项目采用 **fork & pull** 模式，请勿直接向主仓库推送分支：
+
+1. 在 [Issues](https://github.com/Ahsen17/bitongue/issues) 中认领或提出问题；
+2. 在 GitHub 上 fork `Ahsen17/bitongue`，克隆你的 fork 并从 `main`
+   创建特性分支，如 `feat/flowing-metrics`、`fix/expiry-drift`、`docs/quickstart`；
+3. 开发并补充测试（见下方[测试要求](#测试要求)）；涉及用户可见改动时，
+   同步更新 README（中文 / English）与 `docs/`（中文）、`docs/en/`（英文）两份文档站；
+4. 确保本地 `make check` 通过；
+5. 推送分支到你的 fork，提交 Pull Request 到 `Ahsen17/bitongue` 的 `main`；
+6. PR 描述请说明：改了什么、为什么改、如何验证。CI（`pytest.yml`）必须全绿。
+
+## 提交规范
+
+提交信息遵循
+[Conventional Commits](https://www.conventionalcommits.org/zh-hans/)：
+
+```
+<类型>(<范围>?): <描述>
+
+<正文?>
+
+<脚注?>
+```
+
+常用类型：`feat`、`fix`、`refactor`、`doc`、`perf`、`style`、`test`、`build`、
+`chore`、`revert`。commit-msg 钩子会强制校验格式。
+
+CHANGELOG.md 由 [git-cliff](https://git-cliff.org) 依据提交历史自动生成
+（`make changelog`），**原则上禁止手动编辑**。
+
+## 测试要求
+
+- 测试目录镜像源码结构：`src/bitongue/flow/flowing.py` → `tests/flow/test_flowing.py`；
+- 一个测试文件只测一个模块；
+- 通用 fixture 位于 `tests/conftest.py`，子模块 fixture 位于对应子树的
+  `conftest.py`；
+- 用例统一组织为 `class TestXX`；
+- pytest 为 asyncio auto 模式，测试直接写 `async def`；
+- 外部依赖策略：单测使用 fakexx（如 fakeredis），无 fakexx 包的依赖用 async
+  mock；集成测试（`test_integration/`，标记 `integration`）使用真实服务；
+- 集成测试连接 qdrant 时，通过环境变量 `BITONGUE_TEST_QDRANT_URL`（完整 URL）
+  或 `BITONGUE_TEST_QDRANT_HOST` / `BITONGUE_TEST_QDRANT_PORT`（默认
+  `localhost:6333`）指定目标；服务不可达时用例自动 skip 而非失败；
+- 新增功能必须附带测试，覆盖率不得低于 80%。
+
+## 发布流程（维护者）
+
+版本号遵循 [SemVer 2.0.0](https://semver.org/lang/zh-Hans/)，tag 一律带 `v` 前缀：
+
+- **正式版本**：`x.y.z`，如 `v1.2.0`；
+- **非正式版本（beta）**：`x.y.z-beta.N`，如 `v1.2.0-beta.1`；`N` 从 1 开始，
+  在同一 `x.y.z` 序列内顺延。
+
+发布时序：
+
+1. 在 pyproject 中更新 `version`，提交
+   `chore(release): prepare for vX.Y.Z` 并合入 `main`
+   （git-cliff 会跳过该提交，不进 CHANGELOG）；
+2. 在 main 上打 tag 并推送：`git tag vX.Y.Z && git push origin vX.Y.Z`；
+3. `release.yml` 自动创建 **draft** release，附带该版本 notes（git-cliff 生成）
+   与 sdist/wheel 产物；
+4. 在本地运行 `make changelog` 再生成 CHANGELOG.md（须在 tag 存在之后运行，
+   新版本段落才会出现），以 `doc: update changelog for vX.Y.Z` 提交合入；
+5. 在 GitHub Releases 页面人工调整 draft（标记 pre-release 或正式）后 Publish。
+
+## 文档
+
+- 文档站构建：`make docs-build`；本地热重载预览：`make docs-serve`
+  （同时监视 `src/` 与 `docs/` 变更）；
+- 文档为 Sphinx 双语站：`docs/` 为简体中文主站，`docs/en/` 为英文镜像站，
+  两站页面文件名一一对应（主题语言切换器依赖该映射）；
+- 修改任何面向用户的行为时，请同步更新 README（中文 / English）与文档站对应页面。
+
+## 行为准则
+
+保持尊重与专业。对事不对人，欢迎新人提问。
+
+## License
+
+提交即表示你同意以 [AGPL-3.0](LICENSE) 许可授权你的贡献。