Skip to main content

MatchCode toolkit is a Python library that provides the file and directory fingerprinting functionality for ScanCode toolkit and 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.

Metadata

Release files for matchcode-toolkit 7.2.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for matchcode-toolkit 7.2.2
File Size Uploaded
matchcode_toolkit-7.2.2.tar.gz 234.3 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for matchcode-toolkit 7.2.2
File Interpreter ABI Platform
matchcode_toolkit-7.2.2-py3-none-any.whl Python 3 none any Details

Total release size: 254.3 kB

Release files / matchcode_toolkit-7.2.2.tar.gz

Download URL matchcode_toolkit-7.2.2.tar.gz
Size 234.3 kB
Tags Source
SHA-256 checksum
How to use checksums
bad0a5f3ba414d78b36cbdcbb8dd64127ab65838ea7be053053b3fa4dfea0dc4
BLAKE2b-256 checksum
How to use checksums
d2cfc1186e1c010b40d7029ba1931b242d5d005e1f74635510223559e33f6458
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.0.1 CPython/3.12.7

Release files / matchcode_toolkit-7.2.2-py3-none-any.whl

Download URL matchcode_toolkit-7.2.2-py3-none-any.whl
Size 19.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
bfd1d8bdf3e01a513fe58b91cd3ffe61ea0bcad80fc27cdf13786a2ebc3d508c
BLAKE2b-256 checksum
How to use checksums
5e112407a96ca3925a473130e1127999511a7b05d5cef9dc8fdc0efa424b3768
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.0.1 CPython/3.12.7

Release history Release notifications | RSS feed

This release

7.2.2 This release

2 release files

7.2.1

2 release files

7.2.0

2 release files

7.1.0

2 release files

7.0.0

2 release files

6.0.1

2 release files

5.1.0

2 release files

5.0.0

2 release files

4.1.0

2 release files

4.0.0

2 release files

3.1.0

2 release files

3.0.0

2 release files

2.0.1

2 release files

2.0.0

2 release files

1.1.3

2 release files

1.1.1

2 release files

1.1.0

2 release files

1.0.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page