ScanCode Toolkit 是一组代码扫描工具,用于检测代码库中代码、软件包和依赖项的来源(版权)、许可证和漏洞。ScanCode Toolkit 是一个 AboutCode 项目 <https://aboutcode.org>_。
ScanCode Toolkit 是扫描深度和准确性方面的领先工具, 被数百个软件团队使用。你可以将 ScanCode Toolkit 作为命令行工具或作为库使用。
在你的本地机器上启动并运行的说明位于 快速入门 <https://scancode-toolkit.readthedocs.io/en/stable/getting-started/index.html>_
ScanCode Toolkit 文档还提供:
我们在每次提交时在多个 CI 上运行 30,000+ 个测试,以确保与多个版本的 Windows、Linux 和 macOS 具有良好的平台 兼容性。
+------------+--------------+-------------------------+----------------------------+ | Azure | RTD Build| GitHub actions Docs | GitHub actions Release | +============+==============+=========================+============================+ | |azure| | |docs-rtd| | |docs-github-actions| | |release-github-actions| | +------------+--------------+-------------------------+----------------------------+
ScanCode 经过大量测试,拥有超过 30,000 个测试的自动化测试套件。
ScanCode 被多个项目和组织使用,例如
Eclipse Foundation <https://www.eclipse.org>、
OpenEmbedded.org <https://www.openembedded.org>、
FSFE <https://www.fsfe.org>、
FSF <https://www.fsf.org>、
OSS Review Toolkit <http://oss-review-toolkit.org>、
ClearlyDefined.io <https://clearlydefined.io/>、
RedHat Fabric8 analytics <https://github.com/fabric8-analytics>_,
以及更多。
你还可以使用配套的 ScanCode.io Web 应用 <https://github.com/aboutcode-org/scancode.io>_
在服务器端组织和运行 ScanCode,
以组织和存储多个扫描项目,包括脚本化扫描流水线。
作为独立的命令行工具,ScanCode 易于安装、运行, 并可嵌入到你的 CI/CD 处理流水线中。 它可在 Windows、macOS 和 Linux 上运行。
ScanCode 可检测源代码和二进制文件中的许可证、版权、包清单、直接依赖项 等,并被认为是该领域同类最佳和参考工具, 被多个开源工具复用为软件组成数据收集的核心工具。
ScanCode 提供最准确的许可证检测引擎,并在许可证文本数据库和你的代码之间进行 完整比较(也称为 diff 或红线比较),而不是仅依赖近似正则表达式 模式或概率搜索、编辑距离或机器学习。
ScanCode 使用 Python 编写,易于通过插件扩展,以贡献 新的和改进的扫描器、数据汇总、包清单解析器, 以及新的输出。
你可以将扫描结果保存为 JSON、YAML、HTML、CycloneDX 或 SPDX,或 甚至使用 Jinja 模板创建你自己的格式。
ScanCode 可以处理包、构建清单和锁文件格式,以收集
Package URL 并提取元数据。查看所有可用的 包解析器 <https://scancode-toolkit.readthedocs.io/en/stable/reference/index.html>_
以获取详尽列表。
ScanCode 文档托管于
scancode-toolkit.readthedocs.io <https://scancode-toolkit.readthedocs.io/en/latest/>_。
另请参阅 https://aboutcode.org 了解相关的配套项目与工具。
如需引用此仓库,请访问主页并点击“Cite this repository”按钮,获取 APA 或 BibTeX 引用格式。
如果您遇到具体问题、有建议或发现缺陷,请提交
GitHub issue <https://github.com/aboutcode-org/scancode-toolkit/issues>_。
如需快速提问或参与交流,请加入 AboutCode 社区在 Slack <https://join.slack.com/t/aboutcode-org/shared_invite/zt-3li3bfs78-mmtKG0Qhv~G2dSlNCZW2pA>_ 上的讨论。
有意获取商业支持?请联系 AboutCode 团队 <mailto:[email protected]>_。
Apache-2.0 <apache-2.0.LICENSE>_ 为整体许可证。CC-BY-4.0 <cc-by-4.0.LICENSE>_ 适用于参考数据集。有关 ScanCode 中所用第三方代码的来源和许可证的更多详细信息,请参阅 NOTICE 文件 <NOTICE>_ 和 .ABOUT 文件 <https://github.com/search?q=repo%3Aaboutcode-org%2Fscancode-toolkit+path%3A*.ABOUT&type=code>_。
.. |azure| image:: https://dev.azure.com/nexB/scancode-toolkit/_apis/build/status/nexB.scancode-toolkit?branchName=develop :target: https://dev.azure.com/nexB/scancode-toolkit/_build/latest?definitionId=1&branchName=develop :alt: Azure tests status (Linux, macOS, Windows)
.. |docs-rtd| image:: https://readthedocs.org/projects/scancode-toolkit/badge/?version=latest :target: https://scancode-toolkit.readthedocs.io/en/latest/?badge=latest :alt: Documentation Status
.. |docs-github-actions| image:: https://github.com/nexB/scancode-toolkit/actions/workflows/docs-ci.yml/badge.svg?branch=develop :target: https://github.com/nexB/scancode-toolkit/actions/workflows/docs-ci.yml :alt: Documentation Tests
.. |release-github-actions| image:: https://github.com/nexB/scancode-toolkit/actions/workflows/scancode-release.yml/badge.svg?event=push :target: https://github.com/nexB/scancode-toolkit/actions/workflows/scancode-release.yml :alt: Release tests
本项目由以下各方资助、支持和赞助:
|europa| |dgconnect|
|ngi| |nlnet|
|aboutcode| |nexb|
本项目通过 NGI0 Discovery Fund 获得资助,该基金由 NLnet 设立,并得到欧盟委员会“下一代互联网”计划(Next Generation Internet)的资助,由通信网络、内容与技术总司(DG Communications Networks, Content and Technology)主管,资助协议编号为 No 825322。
|ngidiscovery| https://nlnet.nl/project/vulnerabilitydatabase/
本项目通过 NGI0 Entrust Fund 获得资助,该基金由 NLnet 设立,并得到欧盟委员会“下一代互联网”计划(Next Generation Internet)的资助,由通信网络、内容与技术总司(DG Communications Networks, Content and Technology)主管,资助协议编号为 No 101069594。
|ngizeroentrust| https://nlnet.nl/project/Back2source/
本项目通过 NGI0 Core Fund 获得资助,该基金由 NLnet 设立,并得到欧盟委员会“下一代互联网”计划(Next Generation Internet)的资助,由通信网络、内容与技术总司(DG Communications Networks, Content and Technology)主管,资助协议编号为 No 101092990。
|ngizerocore| https://nlnet.nl/project/Back2source-next/
本项目由 NGI0 Core Fund 资助,该基金由 NLnet 设立,并得到欧盟委员会下一代互联网计划(Next Generation Internet programme)的财政支持,在通信网络、内容与技术总司(DG Communications Networks, Content and Technology)的主持下,依据第 101092990 号资助协议开展。
|ngizerocore| https://nlnet.nl/project/FastScan/
本项目由 NGI0 Commons Fund 资助,该基金由 NLnet 设立,并得到欧盟委员会下一代互联网计划(Next Generation Internet programme)的财政支持,在通信网络、内容与技术总司(DG Communications Networks, Content and Technology)的主持下,依据第 101135429 号资助协议开展。额外资金由瑞士联邦教育、研究与创新秘书处(SERI)提供。
|ngizerocommons| |swiss| https://nlnet.nl/project/MassiveFOSSscan/
本项目由 NGI0 Entrust Fund 资助,该基金由 NLnet 设立,并得到欧盟委员会下一代互联网计划(Next Generation Internet programme)的财政支持,在通信网络、内容与技术总司(DG Communications Networks, Content and Technology)的主持下,依据第 101069594 号资助协议开展。
|ngizeroentrust| https://nlnet.nl/project/purl2sym/
.. |nlnet| image:: https://nlnet.nl/logo/banner.png :target: https://nlnet.nl :height: 50 :alt: NLnet 基金会标志
.. |ngi| image:: https://ngi.eu/wp-content/uploads/thegem-logos/logo_8269bc6efcf731d34b6385775d76511d_1x.png :target: https://ngi.eu35 :height: 50 :alt: NGI 标志
.. |nexb| image:: https://nexb.com/wp-content/uploads/2022/04/nexB.svg :target: https://nexb.com :height: 30 :alt: nexB 标志
.. |europa| image:: https://ngi.eu/wp-content/uploads/sites/77/2017/10/bandiera_stelle.png :target: http://ec.europa.eu/index_en.htm :height: 40 :alt: 欧盟标志
.. |aboutcode| image:: https://aboutcode.org/img/AboutCode.svg :target: https://aboutcode.org/ :height: 30 :alt: AboutCode 标志
.. |swiss| image:: https://www.sbfi.admin.ch/sbfi/en/_jcr_content/logo/image.imagespooler.png/1493119032540/logo.png :target: https://www.sbfi.admin.ch/sbfi/en/home/seri/seri.html :height: 40 :alt: 瑞士标志
.. |dgconnect| image:: https://commission.europa.eu/themes/contrib/oe_theme/dist/ec/images/logo/positive/logo-ec--en.svg :target: https://commission.europa.eu/about-european-commission/departments-and-executive-agencies/communications-networks-content-and-technology_en :height: 40 :alt: 欧盟委员会 DG Connect 标志
.. |ngizerocore| image:: https://nlnet.nl/image/logos/NGI0_tag.svg :target: https://nlnet.nl/core :height: 40 :alt: NGI Zero Core 标志
.. |ngizerocommons| image:: https://nlnet.nl/image/logos/NGI0_tag.svg :target: https://nlnet.nl/commonsfund/ :height: 40 :alt: NGI Zero Commons 标志
.. |ngizeropet| image:: https://nlnet.nl/image/logos/NGI0PET_tag.svg :target: https://nlnet.nl/PET :height: 40 :alt: NGI Zero PET 标志
.. |ngizeroentrust| image:: https://nlnet.nl/image/logos/NGI0Entrust_tag.svg :target: https://nlnet.nl/entrust :height: 38 :alt: NGI Zero Entrust 标志