Skip to main content

matchcode-toolkit

Project description

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

matchcode_toolkit-6.0.1.tar.gz (217.1 kB view details)

Uploaded Source

Built Distribution

matchcode_toolkit-6.0.1-py3-none-any.whl (21.8 kB view details)

Uploaded Python 3

File details

Details for the file matchcode_toolkit-6.0.1.tar.gz.

File metadata

  • Download URL: matchcode_toolkit-6.0.1.tar.gz
  • Upload date:
  • Size: 217.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for matchcode_toolkit-6.0.1.tar.gz
Algorithm Hash digest
SHA256 446e8f41fa49b2932193122e0f0d47e4a842102cc2237004c7c537c0ae28fb22
MD5 1ad28b63d67097c7e4b9b35071bd48d6
BLAKE2b-256 273c5dd3b7012acaf4e7ebfc5c2aae55292d9b8a6d6b36f66bd80011d698d1b7

See more details on using hashes here.

Provenance

File details

Details for the file matchcode_toolkit-6.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for matchcode_toolkit-6.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 180f577783c25b1051eeefadf98617d0b5f992b189c5762de38058cff5f5f741
MD5 e42b7af2284f67179ca9adbcb372b9d8
BLAKE2b-256 78793bd5e2a1bf3e7c420994a3f2e6999154c72b1c1e74d0c935c785f61d25c7

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page