Metadata-Version: 2.4
Name: csspin-tooling
Version: 1.0.0rc1
Summary: Plugin-package for csspin providing common tooling for csspin-based projects
Author-email: CONTACT Software GmbH <info@contact-software.com>
Maintainer-email: Benjamin Thomas Schwertfeger <benjaminthomas.schwertfeger@contact-software.com>, Fabian Hafer <fabian.hafer@contact-software.com>, Waleri Enns <waleri.enns@contact-software.com>
License-Expression: Apache-2.0
Project-URL: CONTACT Software GmbH, https://contact-software.com
Project-URL: Documentation, https://csspin-tooling.readthedocs.io/en/stable/
Project-URL: Issue Tracker, https://github.com/cslab/csspin-tooling/issues
Project-URL: Release Notes, https://csspin-tooling.readthedocs.io/en/stable/relnotes.html
Project-URL: Repository, https://github.com/cslab/csspin-tooling
Classifier: Environment :: Console
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Software Development
Requires-Python: >=3.10
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: csspin-python
Dynamic: license-file

``csspin-tooling`` is maintained by `CONTACT Software GmbH`_ and provides
utility plugins and tasks to be used with the `csspin`_ task runner.

The following plugins are available:

- ``csspin_tooling.sbomasm``: Assembles multiple CycloneDX SBOM files into a
  single enriched top-level SBOM using the `sbomasm`_ tool.

Prerequisites
-------------

`csspin`_ must be installed before using this package:

.. code-block:: console

   python -m pip install csspin

Using csspin-tooling
--------------------

Add the package and the desired plugins to your project's ``spinfile.yaml``:

.. code-block:: yaml

    spin:
      project_name: my_project

    plugin_packages:
      - csspin-python
      - csspin-tooling

    plugins:
      - csspin_tooling.sbomasm

    python:
      version: "3.11.9"

Provision the project to download sbomasm and install all dependencies:

.. code-block:: console

   spin provision

Assemble a top-level SBOM from all ``*.cdx.json`` files in the project root:

.. code-block:: console

   spin sbom --help

.. _`CONTACT Software GmbH`: https://contact-software.com
.. _`csspin`: https://pypi.org/project/csspin
.. _`sbomasm`: https://github.com/interlynk-io/sbomasm
