软件遗产-开发文档

入门

贡献

建筑

  • 软件体系结构概述了解软件遗产软件建筑学

  • 镜像了解什么是软件遗产镜像以及如何设置

  • 元数据工作流了解软件遗产存储和处理元数据

  • 钥匙斗篷学习如何使用钥匙斗篷,使用的身份验证系统软件遗产的web界面和公共API

数据模型和规范

工程类

组件

以下是软件中最相关的软件组件的简要概述遗产堆栈,按字母顺序排列。有关体系结构的详细介绍,请参见软件体系结构概述,以教学的顺序展示了他们中的每一个。

每个组件名称都链接到开发文档相应的Python模块。

swh.认证

需要keycloop身份验证的模块使用的低级库

swh.核心

中几乎所有其他模块使用的低级实用程序和助手堆栈

swh.计数器

提供有效估计SWH档案中对象数量的服务,使用Redis的Hyperloglog

swh.数据集

软件发布的档案的公共数据集和定期数据转储遗产

swh.存款

基于推送的软件构件到归档的存放

swh.docs公司

开发人员文档(用于生成您正在阅读的文档)

swh.保险丝

虚拟文件系统浏览软件遗产档案,基于保险丝

swh.图形

快速、压缩、在内存中表示存档,使用工具生成并查询。

swh.索引器

用于对存档内容进行爬网和提取的工具和工作人员从存储在其中的任何工件派生的信息

swh杂志

具有发布订阅支持的存档更改的持久日志记录程序

swh.李斯特

各种源代码托管和分发的列表器集合地点(伪造、分发、包管理器等)

swh.装载机-堆芯

所有其他加载程序使用的低级加载实用程序和辅助程序

swh.loader-git软件

装载机吉特存储库

swh.loader-mercurial公司

装载机汞的存储库

swh.装载机-svn

装载机颠覆存储库

swh.装载机-cvs

装载机并行版本系统存储库

swh.型号

实施数据模型归档源代码工件

swh.OBJ存储

内容寻址对象存储

swh.objstorage.replayer

对象存储复制工具

swh.扫描仪

源代码扫描器,用于分析代码基并将其与源代码进行比较由软件遗产归档的工件

swh.调度程序

用于异步/延迟任务的任务管理器,用于重复性任务(例如。,列出一个forge,从Git存储库加载新的东西)并一次性完成活动(例如,加载源包的特定版本)

swh.搜索

档案的搜索引擎

swh.储存

归档上的抽象层,允许访问所有存储的源代码工件及其元数据

swh.保险库

vault服务的实现,允许检索归档为自包含的捆绑包(例如,单个版本、整个存储库快照等)

swh.web网站

浏览归档文件的Web应用程序,用于交互式(HTML UI)以及机械化(restapi)的使用

swh.web.client

的Python客户端swh.web网站

依赖关系

下面描述了各个模块之间的依赖关系。

_images/py-deps-swh.svg

顶层Python模块之间的依赖关系(单击可缩放)。

档案文件