canary-framework 0.1.0__tar.gz

canary_framework-0.1.0/.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,43 @@
+name: 🐛 Bug 报告
+description: 报告框架的 bug 或异常行为
+labels: [bug]
+body:
+  - type: textarea
+    attributes:
+      label: 描述问题
+      description: 请清晰描述你遇到的问题
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: 复现步骤
+      description: 提供最小复现代码
+      render: python
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: 期望行为
+      description: 你期望发生什么？
+    validations:
+      required: true
+  - type: input
+    attributes:
+      label: CF 版本
+      placeholder: "0.1.0"
+    validations:
+      required: true
+  - type: input
+    attributes:
+      label: Python 版本
+      placeholder: "3.12"
+    validations:
+      required: true
+  - type: input
+    attributes:
+      label: 操作系统
+      placeholder: "Ubuntu 22.04 / macOS 14 / Windows 11"
+  - type: textarea
+    attributes:
+      label: 其他上下文
+      description: 日志输出、截图等

canary_framework-0.1.0/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,8 @@
+blank_issues_enabled: false
+contact_links:
+  - name: 💬 讨论 / Discussions
+    url: https://github.com/HotcocoaCanary/Canary-Framework/discussions
+    about: 使用问题、想法建议请到 Discussions 交流
+  - name: 📖 文档 / Wiki
+    url: https://github.com/HotcocoaCanary/Canary-Framework/wiki
+    about: 查看 Wiki 文档

canary_framework-0.1.0/.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,24 @@
+name: ✨ 功能请求
+description: 建议新功能或改进
+labels: [enhancement]
+body:
+  - type: textarea
+    attributes:
+      label: 使用场景
+      description: 描述你的使用场景，你想解决什么问题？
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: 期望方案
+      description: 你期望的 API 或行为是什么样的？
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: 备选方案
+      description: 你考虑过哪些替代方案？
+  - type: textarea
+    attributes:
+      label: 补充信息
+      description: 其他相关内容

canary_framework-0.1.0/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,20 @@
+## 变更说明
+
+<!-- 请描述这个 PR 做了什么 -->
+
+## 变更类型
+
+- [ ] 🐛 Bug 修复
+- [ ] ✨ 新功能
+- [ ] 📝 文档
+- [ ] ♻️ 重构
+- [ ] 🧪 测试
+- [ ] 🔧 配置/工具
+
+## 检查清单
+
+- [ ] 代码已通过 `ruff check` 和 `ruff format`
+- [ ] 类型检查已通过 `mypy`
+- [ ] 已添加/更新测试
+- [ ] 所有测试通过 `pytest`
+- [ ] 文档已更新（如需要）

canary_framework-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,46 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+env:
+  FORCE_JAVASCRIPT_ACTIONS_TO_NODE24: true
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.12", "3.13"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+
+      - name: Set up Python ${{ matrix.python-version }}
+        run: uv python install ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: uv sync --extra dev --extra web
+
+      - name: Lint (ruff)
+        run: uv run ruff check src/ tests/ example/
+
+      - name: Format check (ruff)
+        run: uv run ruff format --check src/ tests/ example/
+
+      - name: Type check (mypy)
+        run: uv run mypy src/
+
+      - name: Test
+        run: uv run pytest --cov=src/canary_framework --cov-report=term --cov-report=xml
+
+      - name: Upload coverage
+        uses: codecov/codecov-action@v5
+        with:
+          files: ./coverage.xml

canary_framework-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,45 @@
+name: Publish
+
+on:
+  push:
+    tags:
+      - "v*"
+
+env:
+  FORCE_JAVASCRIPT_ACTIONS_TO_NODE24: true
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+
+      - name: Build
+        run: uv build
+
+      - name: Check package
+        run: uv run --with twine twine check dist/*
+
+      - name: Upload artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+    environment: publish
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

canary_framework-0.1.0/.github/workflows/sync-wiki.yml

@@ -0,0 +1,79 @@
+name: Sync Wiki
+
+on:
+  push:
+    branches: [main]
+    paths:
+      - "docs/zh/**"
+
+env:
+  FORCE_JAVASCRIPT_ACTIONS_TO_NODE24: true
+
+permissions:
+  contents: write
+
+jobs:
+  sync-wiki:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Sync docs to wiki
+        env:
+          GH_TOKEN: ${{ secrets.GH_PAT }}
+        run: |
+          git clone "https://x-access-token:${GH_TOKEN}@github.com/${{ github.repository }}.wiki.git" /tmp/wiki
+
+          declare -A TITLES=(
+              ["index"]="Home"
+              ["quickstart"]="快速开始"
+              ["core-concepts"]="核心概念"
+              ["services"]="服务"
+              ["modules"]="模块"
+              ["configuration"]="配置"
+              ["lifecycle"]="生命周期"
+              ["dependency-injection"]="依赖注入"
+              ["web-integration"]="Web-集成"
+              ["api-reference"]="API-参考"
+          )
+
+          ORDER=(index quickstart core-concepts services modules configuration lifecycle dependency-injection web-integration api-reference)
+
+          cd /tmp/wiki
+          for key in "${ORDER[@]}"; do
+              src="$GITHUB_WORKSPACE/docs/zh/${key}.md"
+              title="${TITLES[$key]}"
+              dst="${title// /-}.md"
+              if [ -f "$src" ]; then
+                  cp "$src" "$dst"
+              fi
+          done
+
+          cat > _Sidebar.md << 'SIDEBAR'
+          # 文档
+
+          - [快速开始](快速开始)
+          - [核心概念](核心概念)
+          - [服务](服务)
+          - [模块](模块)
+          - [配置](配置)
+          - [生命周期](生命周期)
+          - [依赖注入](依赖注入)
+          - [Web 集成](Web-集成)
+          - [API 参考](API-参考)
+
+          ---
+
+          [回到仓库](https://github.com/HotcocoaCanary/Canary-Framework)
+          SIDEBAR
+
+          git add -A
+          if git diff --cached --quiet; then
+              echo "No wiki changes."
+          else
+              git -c user.name="github-actions[bot]" \
+                  -c user.email="github-actions[bot]@users.noreply.github.com" \
+                  commit -m "Sync docs from main repo"
+              git push origin master
+              echo "Wiki updated!"
+          fi

canary_framework-0.1.0/.gitignore

@@ -0,0 +1,218 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+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
+
+# 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
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# 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/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml

canary_framework-0.1.0/.python-version

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

canary_framework-0.1.0/CHANGELOG.md

@@ -0,0 +1,16 @@
+# 变更日志
+
+## [0.1.0] - 2026-05-25
+
+### 新增
+- 核心引擎 `Canary`：服务生命周期编排（init → start → stop）
+- 装饰器 `@service` / `@module`：声明服务和模块
+- 装饰器 `@config`：基于 pydantic-settings 的自动配置加载
+- 装饰器 `@on_init` / `@on_start` / `@on_end`：生命周期钩子
+- 依赖注入：按 snake_case 自动注入依赖实例
+- 拓扑排序启动：基于 Kahn 算法保证依赖顺序
+- Context 上下文系统：parent 链向上委托配置和依赖解析
+- Web 集成 `WebCanary`：自动接入 FastAPI + Uvicorn
+- 装饰器 `@web` / `@router` / `@get` / `@post` / `@put` / `@delete` / `@patch`
+- 配置前缀分发：`uvicorn_*` → uvicorn，`fastapi_*` → FastAPI
+- 框架日志系统：`CF_LOG_LEVEL` 环境变量控制，与 uvicorn 隔离

canary_framework-0.1.0/CODE_OF_CONDUCT.md

@@ -0,0 +1,34 @@
+# 行为准则
+
+## 我们的承诺
+
+为了营造一个开放和友好的环境，我们承诺让每个人都能无差别地参与此项目。
+
+## 我们的标准
+
+鼓励的行为：
+- 使用友好和包容的语言
+- 尊重不同的观点和经验
+- 建设性地接受批评
+- 关注对社区最有利的事情
+
+禁止的行为：
+- 使用与性别、性取向、种族、宗教等相关的冒犯性言论
+- 公开或私下骚扰
+- 未经许可发布他人私人信息
+
+## 我们的责任
+
+项目维护者有责任明确可接受行为的标准，并对任何不可接受的行为采取适当和公平的纠正措施。
+
+## 范围
+
+本行为准则适用于所有项目空间和公共场合。
+
+## 执行
+
+如有不可接受的行为，可通过 GitHub Issues 向维护者报告。
+
+## 来源
+
+改编自 [Contributor Covenant](https://www.contributor-covenant.org)，版本 2.1。

canary_framework-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,45 @@
+# 贡献指南
+
+感谢你对 CF (Canary Framework) 的关注！欢迎贡献代码、文档或提出问题。
+
+## 环境搭建
+
+```bash
+git clone https://github.com/HotcocoaCanary/Canary-Framework.git
+cd Canary-Framework
+uv sync --extra dev --extra web
+```
+
+## 开发流程
+
+1. Fork 仓库，从 `main` 创建功能分支
+2. 编写代码和测试
+3. 运行检查和测试：
+
+```bash
+uv run ruff check src/ tests/       # 代码检查
+uv run ruff format src/ tests/      # 代码格式化
+uv run mypy src/                     # 类型检查
+uv run pytest --cov=src/canary_framework              # 运行测试
+```
+
+4. 提交 PR，描述变更内容
+
+## 代码风格
+
+- Python 3.12+ 语法
+- 使用 ruff 进行格式化和 lint
+- 类型注解尽量完整
+- 注释使用中文（docstring 中英文均可）
+
+## 提交信息规范
+
+```
+类型: 简短描述
+
+类型: feat / fix / docs / refactor / test / chore
+```
+
+## 许可证
+
+贡献的代码将采用 Apache 2.0 许可证。