mermaid-trace 0.3.1__tar.gz

mermaid_trace-0.3.1/.github/workflows/ci.yml

@@ -0,0 +1,55 @@
+name: CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: true
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Cache pip dependencies
+      uses: actions/cache@v4
+      with:
+        path: ~/.cache/pip
+        key: ${{ runner.os }}-pip-${{ matrix.python-version }}-${{ hashFiles('pyproject.toml') }}
+        restore-keys: |
+          ${{ runner.os }}-pip-${{ matrix.python-version }}-
+          ${{ runner.os }}-pip-
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -e .[dev]
+
+    - name: Lint with Ruff
+      run: |
+        ruff check src tests
+
+    - name: Type check with Mypy
+      run: |
+        mypy --no-incremental src
+
+    - name: Test with pytest
+      run: |
+        pytest --cov-report=xml
+
+    - name: Upload coverage to Codecov
+      uses: codecov/codecov-action@v4
+      with:
+        token: ${{ secrets.CODECOV_TOKEN }}
+        fail_ci_if_error: true

mermaid_trace-0.3.1/.github/workflows/release.yml

@@ -0,0 +1,51 @@
+name: Release
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  test-and-build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.10"
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install build twine
+        pip install -e .[dev]
+    - name: Run tests
+      run: |
+        pytest
+    - name: Build package
+      run: |
+        python -m build
+    - name: Check distribution
+      run: |
+        python -m twine check --strict dist/*
+    - name: Upload Artifacts
+      uses: actions/upload-artifact@v4
+      with:
+        name: dist
+        path: dist/
+
+  pypi-publish:
+    name: Upload release to PyPI
+    needs: test-and-build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/mermaid-trace
+    permissions:
+      id-token: write
+    steps:
+    - uses: actions/download-artifact@v4
+      with:
+        name: dist
+        path: dist/
+    - name: Publish package distributions to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1

mermaid_trace-0.3.1/.gitignore

@@ -0,0 +1,162 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$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/
+docs/build/
+docs/source/generated/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.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
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary dependencies to ensure reproducible builds.
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and others
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.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/
+
+# IDEs
+.vscode/
+.idea/
+.trae/
+*.swp
+*.swo
+.DS_Store
+
+# Ruff
+.ruff_cache/

mermaid_trace-0.3.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 xt765
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

mermaid_trace-0.3.1/PKG-INFO

@@ -0,0 +1,163 @@
+Metadata-Version: 2.4
+Name: mermaid-trace
+Version: 0.3.1
+Summary: Visualize your Python code execution flow as Mermaid Sequence Diagrams.
+Project-URL: Documentation, https://github.com/xt765/mermaid-trace#readme
+Project-URL: Changelog, https://github.com/xt765/mermaid-trace/blob/main/docs/en/CHANGELOG.md
+Project-URL: Issues, https://github.com/xt765/mermaid-trace/issues
+Project-URL: Source, https://github.com/xt765/mermaid-trace
+Author-email: xt765 <xt765@foxmail.com>
+License: MIT License
+        
+        Copyright (c) 2026 xt765
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+License-File: LICENSE
+Keywords: asyncio,logging,mermaid,mermaid-trace,sequence-diagram,trace,visualization
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Classifier: Topic :: Software Development :: Debuggers
+Classifier: Topic :: System :: Logging
+Requires-Python: >=3.10
+Requires-Dist: typing-extensions>=4.0.0
+Requires-Dist: watchdog>=2.0.0
+Provides-Extra: all
+Requires-Dist: fastapi>=0.100.0; extra == 'all'
+Provides-Extra: dev
+Requires-Dist: fastapi>=0.100.0; extra == 'dev'
+Requires-Dist: httpx; extra == 'dev'
+Requires-Dist: mypy; extra == 'dev'
+Requires-Dist: pytest; extra == 'dev'
+Requires-Dist: pytest-asyncio; extra == 'dev'
+Requires-Dist: pytest-cov; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Provides-Extra: fastapi
+Requires-Dist: fastapi>=0.100.0; extra == 'fastapi'
+Description-Content-Type: text/markdown
+
+# MermaidTrace: The Python Logger That Draws Diagrams
+
+[![PyPI version](https://img.shields.io/pypi/v/mermaid-trace.svg?style=flat-square)](https://pypi.org/project/mermaid-trace/)
+[![Python Versions](https://img.shields.io/pypi/pyversions/mermaid-trace.svg?style=flat-square)](https://pypi.org/project/mermaid-trace/)
+[![License](https://img.shields.io/github/license/xt765/mermaid-trace?style=flat-square)](LICENSE)
+[![CI Status](https://img.shields.io/github/actions/workflow/status/xt765/mermaid-trace/ci.yml?style=flat-square&label=CI)](https://github.com/xt765/mermaid-trace/actions/workflows/ci.yml)
+[![Codecov](https://img.shields.io/codecov/c/github/xt765/mermaid-trace?style=flat-square&logo=codecov)](https://codecov.io/gh/xt765/mermaid-trace)
+
+**Stop reading logs. Start watching them.**
+
+MermaidTrace is a specialized logging tool that automatically generates [Mermaid JS](https://mermaid.js.org/) sequence diagrams from your code execution. It's perfect for visualizing complex business logic, microservice interactions, or asynchronous flows.
+
+## ✨ Features
+
+- **Decorator-Driven**: Just add `@trace` or `@trace_interaction` to your functions.
+- **Auto-Diagramming**: Generates `.mmd` files that can be viewed in VS Code, GitHub, or Mermaid Live Editor.
+- **Async Support**: Works seamlessly with `asyncio` coroutines.
+- **Context Inference**: Automatically tracks nested calls and infers `source` participants using `contextvars`.
+- **FastAPI Integration**: Includes middleware for zero-config HTTP request tracing.
+- **CLI Tool**: Built-in viewer to preview diagrams in your browser.
+
+## 🚀 Quick Start
+
+### Installation
+
+```bash
+pip install mermaid-trace
+```
+
+### Basic Usage
+
+```python
+from mermaid_trace import trace, configure_flow
+import time
+
+# 1. Configure output
+configure_flow("my_flow.mmd")
+
+# 2. Add decorators
+@trace(source="Client", target="PaymentService", action="Process Payment")
+def process_payment(amount):
+    if check_balance(amount):
+        return "Success"
+    return "Failed"
+
+@trace(source="PaymentService", target="Database", action="Check Balance")
+def check_balance(amount):
+    return True
+
+# 3. Run your code
+process_payment(100)
+```
+
+### Nested Calls (Context Inference)
+
+You don't need to specify `source` every time. MermaidTrace infers it from the current context.
+
+```python
+@trace(source="Client", target="API")
+def main():
+    # Inside here, current participant is "API"
+    service_call()
+
+@trace(target="Service") # source inferred as "API"
+def service_call():
+    pass
+```
+
+### FastAPI Integration
+
+```python
+from fastapi import FastAPI
+from mermaid_trace.integrations.fastapi import MermaidTraceMiddleware
+
+app = FastAPI()
+app.add_middleware(MermaidTraceMiddleware, app_name="MyAPI")
+
+@app.get("/")
+async def root():
+    return {"message": "Hello World"}
+```
+
+### CLI Viewer
+
+Visualize your generated `.mmd` files instantly:
+
+```bash
+mermaid-trace serve my_flow.mmd
+```
+
+## 📂 Documentation
+
+- [English Documentation](docs/en/README.md)
+- [中文文档](README_CN.md)
+
+## 🤝 Contributing
+
+We welcome contributions! Please see [CONTRIBUTING.md](docs/en/CONTRIBUTING.md) for details.
+
+## 📄 License
+
+MIT

mermaid_trace-0.3.1/README.md

@@ -0,0 +1,102 @@
+# MermaidTrace: The Python Logger That Draws Diagrams
+
+[![PyPI version](https://img.shields.io/pypi/v/mermaid-trace.svg?style=flat-square)](https://pypi.org/project/mermaid-trace/)
+[![Python Versions](https://img.shields.io/pypi/pyversions/mermaid-trace.svg?style=flat-square)](https://pypi.org/project/mermaid-trace/)
+[![License](https://img.shields.io/github/license/xt765/mermaid-trace?style=flat-square)](LICENSE)
+[![CI Status](https://img.shields.io/github/actions/workflow/status/xt765/mermaid-trace/ci.yml?style=flat-square&label=CI)](https://github.com/xt765/mermaid-trace/actions/workflows/ci.yml)
+[![Codecov](https://img.shields.io/codecov/c/github/xt765/mermaid-trace?style=flat-square&logo=codecov)](https://codecov.io/gh/xt765/mermaid-trace)
+
+**Stop reading logs. Start watching them.**
+
+MermaidTrace is a specialized logging tool that automatically generates [Mermaid JS](https://mermaid.js.org/) sequence diagrams from your code execution. It's perfect for visualizing complex business logic, microservice interactions, or asynchronous flows.
+
+## ✨ Features
+
+- **Decorator-Driven**: Just add `@trace` or `@trace_interaction` to your functions.
+- **Auto-Diagramming**: Generates `.mmd` files that can be viewed in VS Code, GitHub, or Mermaid Live Editor.
+- **Async Support**: Works seamlessly with `asyncio` coroutines.
+- **Context Inference**: Automatically tracks nested calls and infers `source` participants using `contextvars`.
+- **FastAPI Integration**: Includes middleware for zero-config HTTP request tracing.
+- **CLI Tool**: Built-in viewer to preview diagrams in your browser.
+
+## 🚀 Quick Start
+
+### Installation
+
+```bash
+pip install mermaid-trace
+```
+
+### Basic Usage
+
+```python
+from mermaid_trace import trace, configure_flow
+import time
+
+# 1. Configure output
+configure_flow("my_flow.mmd")
+
+# 2. Add decorators
+@trace(source="Client", target="PaymentService", action="Process Payment")
+def process_payment(amount):
+    if check_balance(amount):
+        return "Success"
+    return "Failed"
+
+@trace(source="PaymentService", target="Database", action="Check Balance")
+def check_balance(amount):
+    return True
+
+# 3. Run your code
+process_payment(100)
+```
+
+### Nested Calls (Context Inference)
+
+You don't need to specify `source` every time. MermaidTrace infers it from the current context.
+
+```python
+@trace(source="Client", target="API")
+def main():
+    # Inside here, current participant is "API"
+    service_call()
+
+@trace(target="Service") # source inferred as "API"
+def service_call():
+    pass
+```
+
+### FastAPI Integration
+
+```python
+from fastapi import FastAPI
+from mermaid_trace.integrations.fastapi import MermaidTraceMiddleware
+
+app = FastAPI()
+app.add_middleware(MermaidTraceMiddleware, app_name="MyAPI")
+
+@app.get("/")
+async def root():
+    return {"message": "Hello World"}
+```
+
+### CLI Viewer
+
+Visualize your generated `.mmd` files instantly:
+
+```bash
+mermaid-trace serve my_flow.mmd
+```
+
+## 📂 Documentation
+
+- [English Documentation](docs/en/README.md)
+- [中文文档](README_CN.md)
+
+## 🤝 Contributing
+
+We welcome contributions! Please see [CONTRIBUTING.md](docs/en/CONTRIBUTING.md) for details.
+
+## 📄 License
+
+MIT

mermaid_trace-0.3.1/README_CN.md

@@ -0,0 +1,102 @@
+# MermaidTrace: 能画图的 Python 日志工具
+
+[![PyPI version](https://img.shields.io/pypi/v/mermaid-trace.svg?style=flat-square)](https://pypi.org/project/mermaid-trace/)
+[![Python Versions](https://img.shields.io/pypi/pyversions/mermaid-trace.svg?style=flat-square)](https://pypi.org/project/mermaid-trace/)
+[![License](https://img.shields.io/github/license/xt765/mermaid-trace?style=flat-square)](LICENSE)
+[![CI Status](https://img.shields.io/github/actions/workflow/status/xt765/mermaid-trace/ci.yml?style=flat-square&label=CI)](https://github.com/xt765/mermaid-trace/actions/workflows/ci.yml)
+[![Codecov](https://img.shields.io/codecov/c/github/xt765/mermaid-trace?style=flat-square&logo=codecov)](https://codecov.io/gh/xt765/mermaid-trace)
+
+**别再干读日志了。开始“看”懂它们吧。**
+
+MermaidTrace 是一个专业的日志工具，能从你的代码执行中自动生成 [Mermaid JS](https://mermaid.js.org/) 时序图。它非常适合可视化复杂的业务逻辑、微服务交互或异步流程。
+
+## ✨ 特性
+
+- **装饰器驱动**：只需在函数上添加 `@trace` 或 `@trace_interaction` 即可。
+- **自动绘图**：生成 `.mmd` 文件，可在 VS Code、GitHub 或 Mermaid Live Editor 中查看。
+- **异步支持**：无缝支持 `asyncio` 协程。
+- **上下文推断**：利用 `contextvars` 自动追踪嵌套调用并推断 `source`（调用方）参与者。
+- **FastAPI 集成**：内置中间件，实现零配置的 HTTP 请求追踪。
+- **CLI 工具**：内置查看器，可在浏览器中即时预览图表。
+
+## 🚀 快速开始
+
+### 安装
+
+```bash
+pip install mermaid-trace
+```
+
+### 基础用法
+
+```python
+from mermaid_trace import trace, configure_flow
+import time
+
+# 1. 配置输出文件
+configure_flow("my_flow.mmd")
+
+# 2. 添加装饰器
+@trace(source="Client", target="PaymentService", action="Process Payment")
+def process_payment(amount):
+    if check_balance(amount):
+        return "Success"
+    return "Failed"
+
+@trace(source="PaymentService", target="Database", action="Check Balance")
+def check_balance(amount):
+    return True
+
+# 3. 运行代码
+process_payment(100)
+```
+
+### 嵌套调用（上下文推断）
+
+你不需要每次都指定 `source`（调用方）。MermaidTrace 会根据当前上下文自动推断。
+
+```python
+@trace(source="Client", target="API")
+def main():
+    # 在这里，当前的参与者是 "API"
+    service_call()
+
+@trace(target="Service") # source 被自动推断为 "API"
+def service_call():
+    pass
+```
+
+### FastAPI 集成
+
+```python
+from fastapi import FastAPI
+from mermaid_trace.integrations.fastapi import MermaidTraceMiddleware
+
+app = FastAPI()
+app.add_middleware(MermaidTraceMiddleware, app_name="MyAPI")
+
+@app.get("/")
+async def root():
+    return {"message": "Hello World"}
+```
+
+### CLI 查看器
+
+即时可视化生成的 `.mmd` 文件：
+
+```bash
+mermaid-trace serve my_flow.mmd
+```
+
+## 📂 文档
+
+- [英文文档](docs/en/README.md)
+- [中文文档](README_CN.md)
+
+## 🤝 贡献
+
+欢迎贡献！详情请参阅 [CONTRIBUTING.md](docs/zh/CONTRIBUTING.md)。
+
+## 📄 许可证
+
+MIT

mermaid_trace-0.3.1/SECURITY.md

@@ -0,0 +1,21 @@
+# Security Policy
+
+## Supported Versions
+
+Use this section to tell people about which versions of your project are
+currently being supported with security updates.
+
+| Version | Supported |
+| ------- | --------- |
+| 0.1.x   | ✅        |
+| < 0.1   | ❌        |
+
+## Reporting a Vulnerability
+
+Use this section to tell people how to report a vulnerability.
+
+Tell them where to go, how often they can expect to get an update on a
+reported vulnerability, what to expect if the vulnerability is accepted or
+rejected, etc.
+
+Please report vulnerabilities to xt765@foxmail.com. We will respond within 48 hours.