包安装

先决条件

在安装 Sherlock 之前，请确保您的系统满足以下要求

Python 3.9 或更高版本
pip (Python 包安装器)
下载依赖项所需的互联网连接

安装方法

Sherlock 可以通过多种方法安装，其中 pip 和 pipx 是推荐的方法。

使用 pip

安装 Sherlock 最简单的方法是通过 pip

pip install sherlock-project

这将从 PyPI 安装最新稳定版本，并创建 sherlock 命令。

使用 pipx

为了更隔离地安装，推荐使用 pipx

pipx install sherlock-project

pipx 的优点在于它将 Sherlock 安装在其独立的虚拟环境中，从而避免了与其他 Python 包的依赖冲突。

从源代码安装

您也可以直接从 GitHub 仓库安装

git clone https://github.com/sherlock-project/sherlock.git
cd sherlock
pip install .

来源: pyproject.toml10-12 pyproject.toml60-61

依赖项

Sherlock 正常运行依赖于多个 Python 包。当您使用 pip 或 pipx 安装 Sherlock 时，这些依赖项会自动安装。

核心依赖项

依赖项	版本	目的
certifi	>=2019.6.16	提供 Mozilla 的 CA 捆绑包用于 SSL 证书验证
colorama	^0.4.1	跨平台彩色终端文本
PySocks	^1.7.0	SOCKS 代理客户端实现
requests	^2.22.0	用于发出请求的 HTTP 库
requests-futures	^1.0.0	异步 HTTP 请求
stem	^1.8.0	用于 Tor 的 Python 控制器库
pandas	^2.2.1	数据分析和操作库
openpyxl	^3.0.10	Excel 文件格式支持

可选依赖项

Sherlock 包含对 Tor 的可选支持，可以通过以下方式安装

pip install sherlock-project[tor]

这将安装额外的依赖项

依赖项	版本	目的
torrequest	^0.1.0	简化通过 Tor 发送请求

来源: pyproject.toml42-52 pyproject.toml54-55

验证

要验证 Sherlock 是否已正确安装，请运行

sherlock --version

这将显示您系统上当前安装的 Sherlock 版本。

软件包结构

Sherlock 软件包的结构如下

该软件包暴露了 sherlock 命令行工具，提供了对 Sherlock 项目所有功能的访问。

来源: pyproject.toml24 pyproject.toml60-61

系统集成

安装后，Sherlock 与您的系统集成如下

sherlock 命令会添加到您的系统 PATH 中，允许您从任何目录运行它。执行时，它会调用 Python 解释器来运行软件包中定义的 sherlock_project.sherlock:main 函数。

来源: pyproject.toml60-61

故障排除

常见安装问题

Python 版本错误：请确保您使用的是 Python 3.9 或更高版本。通过 python --version 检查。
权限问题：如果您在安装过程中遇到权限错误，请尝试
```
pip install --user sherlock-project
```
依赖冲突：如果您遇到依赖冲突，请使用 pipx 进行隔离安装。
找不到软件包：如果 pip 找不到 sherlock-project，请确保您的 pip 是最新版本
```
pip install --upgrade pip
```

卸载

要卸载 Sherlock

pip uninstall sherlock-project

如果使用 pipx 安装

pipx uninstall sherlock-project

来源: pyproject.toml43

开发安装

希望为 Sherlock 做出贡献的开发者，请安装包含开发依赖项的软件包

git clone https://github.com/sherlock-project/sherlock.git
cd sherlock
pip install -e ".[dev]"

这会将 Sherlock 安装为“可编辑”模式，允许您在不重新安装的情况下修改源代码。

来源: pyproject.toml57-58

包安装