软件遗产-代码扫描程序#

源代码扫描程序，用于分析代码库并将其与源代码进行比较由Software Heritage归档的工件。

入门#

要安装Software Heritage扫描仪，请运行：

pip（点阵） 安装 瑞士法郎-扫描仪

为了有效地查询Software Heritage Archive，您需要创建一个账户。这不是绝对必要的，但对匿名者的费率限制用户可能会导致操作非常缓慢。

首先，访问https://archive.softwareheritage.org/oidc/login/并创建通过单击新用户注册.

然后使用这个新创建的帐户在扫描仪中进行身份验证

瑞士法郎 扫描仪 登录

扫描仪将引导您通过设置命令：

瑞士法郎 扫描仪 设置

在中扫描本地文件项目_路径，使用：

瑞士法郎 扫描仪 扫描 项目_路径

这将查找您的本地文件，查询存档，并为您提供用于浏览结果的图形用户界面。

请注意扫描命令具有--起源检索的标志有关存档已知文件可能来自何处的信息。这个选项是实验性的，您需要联系软件遗产团队获得必要API的许可。或者，有一个按钮，该按钮将查询给定选定项的来源文件或目录。这也是实验性的，只对特权用户开放。

扫描仪将从三个位置按优先顺序添加配置选项：

您可以通过调用瑞士法郎扫描仪扫描 --帮助.

扫描仪将查找swh.scanner项目.yml目录中的文件被扫描，或在指定的路径上--项目配置文件.

全局配置位于瑞士法郎 > 扫描仪共享的部分亚马尔配置所有软件遗产工具使用的文件，默认位于~/.config/swh/global.yml.

配置文件位置受XDG基本目录规格为以及在上显式重写命令行通过-C/--配置文件标志。

以下小节和字段可用于瑞士法郎 > 扫描仪章节：

禁用全局模式（默认值：虚假的)：是否禁用全局排除模式，它引用非常常见的文件模式从扫描中排除。只有当您发现某些文件被忽视，你会想扫描，尽管可能性很小。
禁用vcs_patterns（默认值：虚假的)：是否停止使用忽略来自版本控制系统的机制（.gitignore、.hgignore、，.svnignore）。请注意，此忽略机制仅在第一时间起作用如果VCS在您的PATH（Git、Mercurial或SVN）中可用。
排除：（默认值：[])：要排除的路径的全局模式列表在所有其他排除模式之上使用。
排除模板：（默认值：[])：排除名称列表模板（如扫描仪帮助中所列）用于所有其他模板之上排除模式。如果要排除所有常见的Python，这很有用例如，缓存文件。

下面是一个示例：

扫描仪:
  禁用全局模式: 虚假的
  禁用vcs_patterns: 虚假的
  排除: [“忽略*”, “其他模式”]
  排除模板: [“Python”, “开始”, “铁锈”, “节点”]

内容：