Skip to main content

Merge SPDX 3 data files

Project description

Merge SPDX 3 Document

A tool to merge SPDX 3 Documents

Installation

spdx3merge can be installed using pip:

python3 -m pip install spdx3merge

Usage

In a basic form, spdx3merge will merge multiple input documents into a single output document. To specify the input documents, use the --input or -i arguments. The output document is specified with --output or -o.

The first input document specified is considered the "root" document; that is all of its root elements will be copied to the output document root elements.

In order to generate proper output document, at least one --author- argument must be specified. The easiest is to use --author-person and specify your name. For other author options, see spdx3merge --help.

Here is a complete example:

spdx3merge \
    --input A.spdx.json \
    --input B.spdx.json \
    --input C.spdx.json \
    --output out.spdx.json \
    --author-person "Joshua Watt"

If you are going to read the document, you'll most likely also want the --pretty option to make it more readable

Development

Development on spdx3merge can be done by setting up a virtual environment and installing it in editable mode:

python3 -m venv .venv
. .venv/bin/activate
pip install -e '.[dev]'

Tests can be run using pytest:

pytest -v

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

spdx3merge-0.0.2.tar.gz (44.8 kB view details)

Uploaded Source

Built Distribution

spdx3merge-0.0.2-py3-none-any.whl (44.3 kB view details)

Uploaded Python 3

File details

Details for the file spdx3merge-0.0.2.tar.gz.

File metadata

  • Download URL: spdx3merge-0.0.2.tar.gz
  • Upload date:
  • Size: 44.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for spdx3merge-0.0.2.tar.gz
Algorithm Hash digest
SHA256 3f463cac15021486aea768b7b2620a14dcae47f6f87f53556b68aa767328f8cd
MD5 1dcbb642e4260ca408941f42aa0264d4
BLAKE2b-256 b5ef42e5144b357f2d7a56949315be24ccc2910354bf574d44617cb03437af7d

See more details on using hashes here.

File details

Details for the file spdx3merge-0.0.2-py3-none-any.whl.

File metadata

  • Download URL: spdx3merge-0.0.2-py3-none-any.whl
  • Upload date:
  • Size: 44.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for spdx3merge-0.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 d7f9805b5aeb7c02efc63ce17a7af985d89399ae41d7873d336adf0ad89fc137
MD5 6b2128a96a3f439a2e9e46e15f81c478
BLAKE2b-256 9c188f8c92561f4db4c11bb572fdbeab6b174f3926c2125bfbe839ebbed29778

See more details on using hashes here.

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