Jarvis

<p align="center" style="text-align: center"> <img src="https://yellow-cdn.veclightyear.com/0a4dffa0/fbf8030a-98f7-4ba0-b4c5-b65c20ff1f1f.png" width="371px" height="350px" alt="logo"> </p> <h2 align="center">语音激活的自然语言用户界面</h2>

[![使用Python开发][label-python]][python]

![Python][label-pyversion] ![Pypi下载量][label-pypi-downloads]

支持的平台

![平台][label-platform]

语言统计

![语言数量][label-language-ct] ![代码覆盖率][label-code-coverage]

[仓库统计][repo]

[![GitHub][label-license]][license]

![GitHub仓库星标数][label-stars] ![GitHub仓库分支数][label-forks] ![GitHub仓库关注者数][label-watchers]

代码统计

部署

[][gha_pages] [][gha_pypi] [][gha_md_valid]

[][pypi] [][pypi-files] [][pypi]

活动

开发和维护

[][webpage]

联系方式

[][webpage_contact]

快速开始

建议

• 安装 python [3.10] 或 [3.11]
• 使用专用的[虚拟环境]

安装 Jarvis

python -m pip install jarvis-ironman

安装依赖

jarvis install

初始化 - IDE

import jarvis


if __name__ == '__main__':
    jarvis.start()

初始化 - 命令行

jarvis start

使用 jarvis --help 获取使用说明。

先决条件

• MacOS <br> 已在 Mojave, Catalina, Big Sur, Monterey 和 Ventura 上测试

  • 系统偏好设置 → 安全性与隐私 → 隐私
  • 点击 + 号，在左侧窗格的以下部分添加首选的 IDE 和 终端。
    • 麦克风 - 必需，用于听取和回应。
    • 辅助功能 - 必需，用于使用亮度和音量控制的组合键。
    • 摄像头 - [可选] 仅在面部识别/检测时需要。
    • 自动化 - 必需，用于控制 系统事件 和其他应用程序，如 Outlook 和日历。
    • 文件和文件夹 或 完全磁盘访问权限 - 必需，用于所有 文件输入/输出 操作。

• Linux <br> 已在 Ubuntu 22.04 LTS 上测试

  • 将主机密码存储为环境变量：ROOT_PASSWORD
  • 与 macOS 和 Windows 不同，Ubuntu 没有特定应用程序的权限。

• Windows <br> 已在 Windows 10 上测试

  • 设置 → 隐私
    • 麦克风 - 必需，用于听取和回应。
    • 摄像头 - [可选] 仅在面部识别/检测时需要。
    • 与 macOS 不同，Windows 会弹出确认窗口以 允许 或 拒绝 对文件和文件夹的访问。
  • 安装 [Anaconda] 或 [Miniconda]，[VisualStudio C++ BuildTools][vcpp] 和 [Git][git-cli]
  • 确保 C++ 构建工具已完全安装，然后重启
  • 将 anaconda/miniconda 脚本位置添加到环境变量的 PATH 中

指南

手册 - [GitHub Wiki][wiki]

编码标准

文档字符串格式：[Google][google-docs] <br> 样式约定：[PEP 8][pep8] 和 [isort][isort]

[发布说明][release-notes]

要求

python -m pip install gitverse

用法

gitverse-release reverse -f release_notes.rst -t '发布说明'

代码检查

pre-commit 将确保代码检查、运行 pytest、生成操作手册和发布说明，并验证所有 markdown 文件（包括 Wiki 页面）中的超链接

要求

python -m pip install sphinx==5.1.1 pre-commit recommonmark

用法

pre-commit run --all-files

Pypi 包

[][pypi-repo]

[https://pypi.org/project/jarvis-ironman/][pypi]

操作手册

[][sphinx]

[https://jarvis-docs.vigneshrao.com/][runbook]

许可证和版权

© Vignesh Rao

根据 [MIT 许可证][license] 授权 [label-stars]: https://img.shields.io/github/stars/thevickypedia/Jarvis [label-forks]: https://img.shields.io/github/forks/thevickypedia/Jarvis [label-watchers]: https://img.shields.io/github/watchers/thevickypedia/Jarvis