Skip to content

Commit

Permalink
Merge branch 'main' into 247-purlcli-update-validate-and-versions #247
Browse files Browse the repository at this point in the history
Reference: #247

Signed-off-by: John M. Horan <[email protected]>
  • Loading branch information
johnmhoran committed Feb 28, 2024
2 parents e8c9abb + ae6a810 commit b7edacc
Show file tree
Hide file tree
Showing 21 changed files with 9 additions and 1,635 deletions.
3 changes: 1 addition & 2 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -130,10 +130,9 @@ process_scans:

test:
@echo "-> Run the test suite"
${ACTIVATE} DJANGO_SETTINGS_MODULE=purldb_project.settings ${PYTHON_EXE} -m pytest -vvs --ignore matchcode-toolkit --ignore matchcode_pipeline --ignore matchcode_project --ignore purldb-toolkit --ignore packagedb/tests/test_throttling.py
${ACTIVATE} DJANGO_SETTINGS_MODULE=purldb_project.settings ${PYTHON_EXE} -m pytest -vvs --ignore matchcode_pipeline --ignore matchcode_project --ignore purldb-toolkit --ignore packagedb/tests/test_throttling.py
${ACTIVATE} DJANGO_SETTINGS_MODULE=purldb_project.settings ${PYTHON_EXE} -m pytest -vvs packagedb/tests/test_throttling.py
${ACTIVATE} DJANGO_SETTINGS_MODULE=matchcode_project.settings ${PYTHON_EXE} -m pytest -vvs matchcode_pipeline
${ACTIVATE} ${PYTHON_EXE} -m pytest -vvs matchcode-toolkit --ignore matchcode-toolkit/src/matchcode_toolkit/pipelines
${ACTIVATE} ${PYTHON_EXE} -m pytest -vvs purldb-toolkit/

shell:
Expand Down
6 changes: 3 additions & 3 deletions configure
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,9 @@ CLI_ARGS=$1
CUSTOM_PACKAGES=""

# Requirement arguments passed to pip and used by default or with --dev.
REQUIREMENTS="$CUSTOM_PACKAGES --editable matchcode-toolkit/ --editable purldb-toolkit/ --editable . --constraint requirements.txt"
DEV_REQUIREMENTS="$CUSTOM_PACKAGES --editable matchcode-toolkit/ --editable purldb-toolkit/[testing] --editable .[testing] --constraint requirements.txt --constraint requirements-dev.txt"
DOCS_REQUIREMENTS="$CUSTOM_PACKAGES --editable matchcode-toolkit/ --editable purldb-toolkit/ --editable .[docs] --constraint requirements.txt"
REQUIREMENTS="$CUSTOM_PACKAGES --editable purldb-toolkit/ --editable . --constraint requirements.txt"
DEV_REQUIREMENTS="$CUSTOM_PACKAGES --editable purldb-toolkit/[testing] --editable .[testing] --constraint requirements.txt --constraint requirements-dev.txt"
DOCS_REQUIREMENTS="$CUSTOM_PACKAGES --editable purldb-toolkit/ --editable .[docs] --constraint requirements.txt"

# where we create a virtualenv
VIRTUALENV_DIR=venv
Expand Down
3 changes: 0 additions & 3 deletions matchcode-toolkit/AUTHORS.rst

This file was deleted.

38 changes: 0 additions & 38 deletions matchcode-toolkit/CHANGELOG.rst

This file was deleted.

15 changes: 0 additions & 15 deletions matchcode-toolkit/MANIFEST.in

This file was deleted.

19 changes: 0 additions & 19 deletions matchcode-toolkit/NOTICE

This file was deleted.

71 changes: 1 addition & 70 deletions matchcode-toolkit/README.rst
Original file line number Diff line number Diff line change
@@ -1,72 +1,3 @@
MatchCode toolkit
=================
MatchCode toolkit is a Python library that provides the directory fingerprinting
functionality for `ScanCode toolkit <https://github.com/nexB/scancode-toolkit>`_
and `ScanCode.io <https://github.com/nexB/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 bdist_wheel # The built wheel will be in the dist/ directory
pip install matchcode_toolkit-*-py3-none-any.whl


Usage
-----

MatchCode toolkit provides the ``--fingerprint`` option for ScanCode toolkit.
This is a post-scan plugin that adds the fields
``directory_content_fingerprint`` and ``directory_structure_fingerprint`` to
Resources and computes those values for directories.
::

scancode --info --fingerprint <scan target location> --json-pp <output location>


MatchCode toolkit provides the ``scan_and_fingerprint_package`` pipeline for
ScanCode.io. This is the same as the ``scan_package`` pipeline, but has the
added step of computing fingerprints for directories.


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.
MatchCode toolkit has moved to its own repo at https://github.com/nexB/matchcode-toolkit
201 changes: 0 additions & 201 deletions matchcode-toolkit/apache-2.0.LICENSE

This file was deleted.

Loading

0 comments on commit b7edacc

Please sign in to comment.