Documentation improvement for PURLdb
维护者通常 1 天内回复
@chinyeungli 已经在做这个了。
开始于 2025年12月1日。
评估
这个 Issue 还没有评估数据。
描述
https://aboutcode.readthedocs.io/projects/PURLdb/en/latest/index.html
Detect software supply chain issues by mapping package binaries to their corresponding source code and determining if there are possible discrepancies between sources and sources (such as with the XZ utils attack, or sources and binaries, where package may not report the exact source code used to build binaries with the mapping analysis.
Should be "discrepancies between sources and binaries"
https://aboutcode.readthedocs.io/projects/PURLdb/en/latest/purldb/rest_api.htm
-
If
reindexflag is True then existing package will be rescanned, ifreindex_setis True then all the package in the same set will be rescanned. If reindex flag is set to true then all the non existing package will be indexed.
It's confusing about the reindex flag when it's set to True
-
unsupported_packages
A list of package urls that are not processable by the index queue.
The package indexing queue can only handle npm and maven purls.
I think we support more packages than just npm and maven?
-
If uuid is given then all purls will be added to package set if it exists else a new set would be created and all the purls will be added to that new set.
punctuation needed
-
Package Set List
Return a list of package sets and the package data of packages within
GET /api/projects/0bbdcf88-ad07-4970-9272-7d5f4c82cc7b/
I am wondering is GET /api/projects/0bbdcf88-ad07-4970-9272-7d5f4c82cc7b/ the correct command? It's the same GET as shown for "package details" https://aboutcode.readthedocs.io/projects/PURLdb/en/latest/purldb/rest_api.html#package-details
https://aboutcode.readthedocs.io/projects/PURLdb/en/latest/purldb/purl_watch.html
-
Depending on the PurlDB size PurlWatch provides two different approach.
Should be
Depending on the size of PurlDB, PurlWatch provides two different approaches.
-
The watch frequency can be customized to balance the resource uses.
Perhaps should be
The watch frequency can be customized to balance resource usage.
- 主要语言
- HTML
- 星标
- 70
- 派生
- 74
- 平均合并
- 2 天 4 小时
- 30 天内合并 PR
- 7
环境准备
- 提供 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 没有贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
aboutcode-org/purldb 的其他 Issue
-
purlcli fails未关闭
难度 2/5 1-3 小时 新手友好度 84/100
aboutcode-org/purldb#891 · 1 条评论 ·
维护者通常 1 天内回复
-
Incorrect set comparison between package names and PURLs in NPM sync logic可能已有人在做 @MuhammadBilal64 于 26 天前认领。 未关闭
难度 2/5 1-3 小时 新手友好度 75/100
aboutcode-org/purldb#890 · 1 条评论 ·
维护者通常 1 天内回复
-
PypiVersionAPI.get_latest_date() crashes when a release entry is missing upload_time_iso_8601可能已有人在做 @drawliin 于 209 天前认领。 未关闭
难度 2/5 1-3 小时 新手友好度 72/100
aboutcode-org/purldb#863 ·
维护者通常 1 天内回复
-
Add doctest and tests for clearcode coordinate helpers可能已有人在做 @drawliin 于 216 天前认领。 未关闭
难度 2/5 1-3 小时 新手友好度 78/100
aboutcode-org/purldb#861 ·
维护者通常 1 天内回复
-
Preserve version ordering in packagedb VersionResponse可能已有人在做 @drawliin 于 217 天前认领。 未关闭
难度 2/5 1-3 小时 新手友好度 85/100
aboutcode-org/purldb#857 ·
维护者通常 1 天内回复