zhou
32ca8c1208
CI / Lint, Typecheck & Test (push) Successful in 1m57s
1. 新建 docs/ Sphinx 文档结构 (conf.py + 8 个 rst 章节), napoleon 支持 Google/NumPy docstring, rtd 主题, 自动生成 API 参考与错误家族文档 2. 新建 .readthedocs.yaml 配置, pyproject.toml 加 docs 依赖 3. 删除 runner.py 的 _apply_verbose_to_graph 死代码及对应测试 (功能已移入 executors.run 统一处理) 4. 更新 README: CLI 示例改为 pf 统一入口, 模块结构表补全 cli/pf.py/cli/configs/cli/_ops 等模块 5. 修复版本不一致 (pyproject.toml 0.3.5 → 0.4.5) 6. 加文档徽章链接到 ReadTheDocs
52 lines
762 B
ReStructuredText
52 lines
762 B
ReStructuredText
安装
|
||
====
|
||
|
||
PyFlowX 支持 Python 3.8+，仅依赖标准库与 PyYAML（3.8 额外需要 ``graphlib_backport`` 和 ``typing-extensions``）。
|
||
|
||
pip 安装
|
||
--------
|
||
|
||
.. code-block:: bash
|
||
|
||
pip install pyflowx
|
||
|
||
uv 安装
|
||
-------
|
||
|
||
推荐使用 `uv <https://docs.astral.sh/uv/>`_：
|
||
|
||
.. code-block:: bash
|
||
|
||
uv add pyflowx
|
||
|
||
可选依赖
|
||
--------
|
||
|
||
``office`` —— PDF/图片处理（pdftool、screenshot 等工具需要）：
|
||
|
||
.. code-block:: bash
|
||
|
||
pip install pyflowx[office]
|
||
|
||
``dev`` —— 开发工具链（ruff、pyrefly、pytest、tox 等）：
|
||
|
||
.. code-block:: bash
|
||
|
||
pip install pyflowx[dev]
|
||
|
||
验证安装
|
||
--------
|
||
|
||
.. code-block:: bash
|
||
|
||
pf --version
|
||
|
||
输出示例::
|
||
|
||
PyFlowX 0.4.5
|
||
|
||
下一步
|
||
------
|
||
|
||
前往 :doc:`quickstart` 开始使用。
|