MatchCode toolkit
=================
MatchCode toolkit is a Python library that provides the file and directory
fingerprinting functionality for `ScanCode toolkit
<https://github.com/aboutcode-org/scancode-toolkit>`_ and `ScanCode.io
<https://github.com/aboutcode-org/scancode.io>`_ by implementing the HaloHash algorithm
and using it in ScanCode toolkit and ScanCode.io plugins and pipelines.
Installation
------------
MatchCode toolkit must be installed in the same environment as ScanCode toolkit
or ScanCode.io.
From PyPI:
::
pip install matchcode-toolkit
A checkout of this repo can also be installed into an environment using pip's
``--editable`` option,
::
# Activate the virtual environment you want to install MatchCode-toolkit into,
# change directories to the ``matchcode-toolkit`` directory
pip install --editable .
or built into a wheel and then installed:
::
python setup.py build bdist_wheel
pip install matchcode_toolkit-*-py3-none-any.whl
Usage
-----
MatchCode toolkit provides the ``--fingerprint`` option for ScanCode toolkit.
This is a scan plugin that adds the fields
``directory_content_fingerprint``, ``directory_structure_fingerprint``, and
``halo1`` to Resources and computes those values.
::
scancode --info --fingerprint <scan target location> --json-pp <output location>
MatchCode toolkit provides the ``scan_and_fingerprint_package`` and
``fingerprint_codebase`` pipelines for ScanCode.io.
These pipelines add resource and directory fingerprints to the ``extra_data`` field.
License
-------
SPDX-License-Identifier: Apache-2.0
The ScanCode.io software is licensed under the Apache License version 2.0.
Data generated with ScanCode.io is provided as-is without warranties.
ScanCode is a trademark of nexB Inc.
You may not use this software except in compliance with the License.
You may obtain a copy of the License at: http://apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed
under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
CONDITIONS OF ANY KIND, either express or implied. See the License for the
specific language governing permissions and limitations under the License.
Data Generated with ScanCode.io is provided on an "AS IS" BASIS, WITHOUT WARRANTIES
OR CONDITIONS OF ANY KIND, either express or implied. No content created from
ScanCode.io should be considered or used as legal advice. Consult an Attorney
for any legal advice.
Raw data
{
"_id": null,
"home_page": "https://github.com/aboutcode-org/matchcode-toolkit",
"name": "matchcode-toolkit",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "matchcode, ScanCode.io, open source",
"author": "nexB. Inc. and others",
"author_email": "info@aboutcode.org",
"download_url": "https://files.pythonhosted.org/packages/27/3c/5dd3b7012acaf4e7ebfc5c2aae55292d9b8a6d6b36f66bd80011d698d1b7/matchcode_toolkit-6.0.1.tar.gz",
"platform": null,
"description": "MatchCode toolkit\n=================\nMatchCode toolkit is a Python library that provides the file and directory\nfingerprinting functionality for `ScanCode toolkit\n<https://github.com/aboutcode-org/scancode-toolkit>`_ and `ScanCode.io\n<https://github.com/aboutcode-org/scancode.io>`_ by implementing the HaloHash algorithm\nand using it in ScanCode toolkit and ScanCode.io plugins and pipelines.\n\n\nInstallation\n------------\n\nMatchCode toolkit must be installed in the same environment as ScanCode toolkit\nor ScanCode.io.\n\nFrom PyPI:\n::\n\n pip install matchcode-toolkit\n\nA checkout of this repo can also be installed into an environment using pip's\n``--editable`` option,\n::\n\n # Activate the virtual environment you want to install MatchCode-toolkit into,\n # change directories to the ``matchcode-toolkit`` directory\n pip install --editable .\n\nor built into a wheel and then installed:\n::\n\n python setup.py build bdist_wheel\n pip install matchcode_toolkit-*-py3-none-any.whl\n\n\nUsage\n-----\n\nMatchCode toolkit provides the ``--fingerprint`` option for ScanCode toolkit.\nThis is a scan plugin that adds the fields\n``directory_content_fingerprint``, ``directory_structure_fingerprint``, and\n``halo1`` to Resources and computes those values.\n::\n\n scancode --info --fingerprint <scan target location> --json-pp <output location>\n\n\nMatchCode toolkit provides the ``scan_and_fingerprint_package`` and\n``fingerprint_codebase`` pipelines for ScanCode.io.\n\nThese pipelines add resource and directory fingerprints to the ``extra_data`` field.\n\n\nLicense\n-------\n\nSPDX-License-Identifier: Apache-2.0\n\nThe ScanCode.io software is licensed under the Apache License version 2.0.\nData generated with ScanCode.io is provided as-is without warranties.\nScanCode is a trademark of nexB Inc.\n\nYou may not use this software except in compliance with the License.\nYou may obtain a copy of the License at: http://apache.org/licenses/LICENSE-2.0\nUnless required by applicable law or agreed to in writing, software distributed\nunder the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR\nCONDITIONS OF ANY KIND, either express or implied. See the License for the\nspecific language governing permissions and limitations under the License.\n\nData Generated with ScanCode.io is provided on an \"AS IS\" BASIS, WITHOUT WARRANTIES\nOR CONDITIONS OF ANY KIND, either express or implied. No content created from\nScanCode.io should be considered or used as legal advice. Consult an Attorney\nfor any legal advice.\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "matchcode-toolkit",
"version": "6.0.1",
"project_urls": {
"Homepage": "https://github.com/aboutcode-org/matchcode-toolkit"
},
"split_keywords": [
"matchcode",
" scancode.io",
" open source"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "78793bd5e2a1bf3e7c420994a3f2e6999154c72b1c1e74d0c935c785f61d25c7",
"md5": "e42b7af2284f67179ca9adbcb372b9d8",
"sha256": "180f577783c25b1051eeefadf98617d0b5f992b189c5762de38058cff5f5f741"
},
"downloads": -1,
"filename": "matchcode_toolkit-6.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e42b7af2284f67179ca9adbcb372b9d8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 21842,
"upload_time": "2024-11-08T00:04:20",
"upload_time_iso_8601": "2024-11-08T00:04:20.788683Z",
"url": "https://files.pythonhosted.org/packages/78/79/3bd5e2a1bf3e7c420994a3f2e6999154c72b1c1e74d0c935c785f61d25c7/matchcode_toolkit-6.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "273c5dd3b7012acaf4e7ebfc5c2aae55292d9b8a6d6b36f66bd80011d698d1b7",
"md5": "1ad28b63d67097c7e4b9b35071bd48d6",
"sha256": "446e8f41fa49b2932193122e0f0d47e4a842102cc2237004c7c537c0ae28fb22"
},
"downloads": -1,
"filename": "matchcode_toolkit-6.0.1.tar.gz",
"has_sig": false,
"md5_digest": "1ad28b63d67097c7e4b9b35071bd48d6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 217109,
"upload_time": "2024-11-08T00:04:22",
"upload_time_iso_8601": "2024-11-08T00:04:22.470827Z",
"url": "https://files.pythonhosted.org/packages/27/3c/5dd3b7012acaf4e7ebfc5c2aae55292d9b8a6d6b36f66bd80011d698d1b7/matchcode_toolkit-6.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-08 00:04:22",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "aboutcode-org",
"github_project": "matchcode-toolkit",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "matchcode-toolkit"
}
JSON
