ScanCode Toolkitは、コードベース内のコード、パッケージ、依存関係の起源(著作権)、ライセンス、脆弱性を検出するコードスキャンツールのセットです。ScanCode ToolkitはAboutCodeプロジェクト <https://aboutcode.org>_です。
ScanCode Toolkitはスキャンの深さと精度において主要なツールであり、 数百のソフトウェアチームに利用されています。ScanCode Toolkitは コマンドラインツールとしてもライブラリとしても使用できます。
ローカルマシンで使い始めるための手順はGetting Started <https://scancode-toolkit.readthedocs.io/en/stable/getting-started/index.html>_にあります。
ScanCode Toolkitのドキュメントでは、以下も提供しています:
複数のWindows、Linux、macOSのバージョンとの優れたプラットフォーム 互換性を確保するため、複数のCIで各コミットに対して30,000以上のテストを実行しています。
+------------+--------------+-------------------------+----------------------------+ | 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ウェブアプリ <https://github.com/aboutcode-org/scancode.io>_を使用して、
スクリプト化されたスキャンパイプラインを含む複数のスキャンプロジェクトを整理・保存し、
ScanCodeをサーバー側で整理・実行することもできます。
スタンドアロンのコマンドラインツールとして、ScanCodeはインストール、実行、CI/CD処理パイプラインへの組み込みが簡単です。 Windows、macOS、Linuxで動作します。
ScanCodeはソースコードとバイナリファイルの両方でライセンス、著作権、パッケージマニフェスト、直接依存関係などを検出し、 この分野における最高クラスかつリファレンスとなるツールと見なされており、 複数のオープンソースツールでソフトウェア構成データ収集の中核ツールとして再利用されています。
ScanCodeは最も正確なライセンス検出エンジンを提供し、近似の正規表現パターンや確率的検索、編集距離、機械学習だけに頼るのではなく、 ライセンステキストのデータベースとあなたのコードとの完全な比較(diffまたはレッドライン比較とも呼ばれる)を行います。
Pythonで書かれたScanCodeは、プラグインで簡単に拡張でき、新しい改良されたスキャナー、データ要約、パッケージマニフェストパーサー、 新しい出力の提供に貢献できます。
スキャン結果を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>_ を送信してください。
簡単な質問や交流には、Slack <https://join.slack.com/t/aboutcode-org/shared_invite/zt-3li3bfs78-mmtKG0Qhv~G2dSlNCZW2pA>_ のAboutCodeコミュニティディスカッションにご参加ください。
商用サポートにご興味がありますか? 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|
このプロジェクトは、NLnetが欧州委員会のNext Generation Internetプログラムからの財政的支援を受けて設立した基金であるNGI0 Discovery Fundを通じて、DG Communications Networks, Content and Technologyの後援のもと、助成契約番号825322に基づいて資金提供を受けました。
|ngidiscovery| https://nlnet.nl/project/vulnerabilitydatabase/
このプロジェクトは、NLnetが欧州委員会のNext Generation Internetプログラムからの財政的支援を受けて設立した基金であるNGI0 Entrust Fundを通じて、DG Communications Networks, Content and Technologyの後援のもと、助成契約番号101069594に基づいて資金提供を受けました。
|ngizeroentrust| https://nlnet.nl/project/Back2source/
このプロジェクトは、NLnetが欧州委員会のNext Generation Internetプログラムからの財政的支援を受けて設立した基金であるNGI0 Core Fundを通じて、DG Communications Networks, Content and Technologyの後援のもと、助成契約番号101092990に基づいて資金提供を受けました。
|ngizerocore| https://nlnet.nl/project/Back2source-next/
本プロジェクトは、NLnet が設立した基金である NGI0 Core Fund を通じて資金提供を受けました。この基金は、欧州委員会の Next Generation Internet プログラムによる財政支援を受け、DG Communications Networks, Content and Technology の後援のもと、助成契約番号 101092990 に基づいて実施されています。
|ngizerocore| https://nlnet.nl/project/FastScan/
本プロジェクトは、NLnet が設立した基金である NGI0 Commons Fund を通じて資金提供を受けました。この基金は、欧州委員会の Next Generation Internet プログラムによる財政支援を受け、DG Communications Networks, Content and Technology の後援のもと、助成契約番号 101135429 に基づいて実施されています。追加の資金は、スイス教育研究イノベーション庁(SERI)により提供されています。
|ngizerocommons| |swiss| https://nlnet.nl/project/MassiveFOSSscan/
本プロジェクトは、NLnet が設立した基金である NGI0 Entrust Fund を通じて資金提供を受けました。この基金は、欧州委員会の Next Generation Internet プログラムによる財政支援を受け、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 foundation logo
.. |ngi| image:: https://ngi.eu/wp-content/uploads/thegem-logos/logo_8269bc6efcf731d34b6385775d76511d_1x.png :target: https://ngi.eu35 :height: 50 :alt: NGI logo
.. |nexb| image:: https://nexb.com/wp-content/uploads/2022/04/nexB.svg :target: https://nexb.com :height: 30 :alt: nexB logo
.. |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: Europa logo
.. |aboutcode| image:: https://aboutcode.org/img/AboutCode.svg :target: https://aboutcode.org/ :height: 30 :alt: AboutCode logo
.. |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: Swiss logo