sbom4python 0.12.5__py3-none-any.whl

sbom4python/version.py

@@ -0,0 +1,4 @@
+# Copyright (C) 2026 Anthony Harrison
+# SPDX-License-Identifier: Apache-2.0
+
+VERSION: str = "0.12.5"

sbom4python-0.12.5.dist-info/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.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.

sbom4python-0.12.5.dist-info/METADATA

@@ -0,0 +1,192 @@
+Metadata-Version: 2.1
+Name: sbom4python
+Version: 0.12.5
+Summary: SBOM generator for Python modules
+Home-page: https://github.com/anthonyharrison/sbom4python
+Author: Anthony Harrison
+Author-email: anthony.p.harrison@gmail.com
+Maintainer: Anthony Harrison
+Maintainer-email: anthony.p.harrison@gmail.com
+License: Apache-2.0
+Keywords: security,tools,SBOM,DevSecOps,SPDX,CycloneDX
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+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 :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: lib4package (>=0.3.3)
+Requires-Dist: lib4sbom (>=0.8.0)
+Requires-Dist: sbom2dot (>=0.3.0)
+Requires-Dist: sbom4files (>=0.4.4)
+Requires-Dist: importlib-metadata (>=3.6) ; python_version < "3.10"
+Requires-Dist: toml ; python_version < "3.11"
+
+# SBOM4Python
+
+The SBOM4Python is a free, open source tool to generate a
+SBOM (Software Bill of Materials) for an installed Python module in a number of formats including
+[SPDX](https://www.spdx.org) and [CycloneDX](https://www.cyclonedx.org).
+It identifies all of the dependent components which are
+explicity defined (typically via requirements.txt file) or implicitly as a
+hidden dependency.
+
+It can also be used to create a SBOM from a requirements.txt file. In this case no transitive components will be identified.
+
+It is intended to be used as part of a continuous integration system to enable accurate records of SBOMs to be maintained
+and also to support subsequent audit needs to determine if a particular component (and version) has been used.
+
+## Installation
+
+To install use the following command:
+
+`pip install sbom4python`
+
+Alternatively, just clone the repo and install dependencies using the following command:
+
+`pip install -U -r requirements.txt`
+
+The tool requires Python 3 (3.7+). It is recommended to use a virtual python environment especially
+if you are using different versions of python. `virtualenv` is a tool for setting up virtual python environments which
+allows you to have all the dependencies for the tool set up in a single environment, or have different environments set
+up for testing using different versions of Python.
+
+### Issues with Installation
+
+If you get the following error
+
+`ImportError: failed to find libmagic.  Check your installation`
+
+This is because of a mismatch with the installation of the magic library. To resolve, please issue the following commands depending on your environment
+
+#### Windows
+
+```bash
+pip uninstall python-magic
+pip uninstall python-magic-bin
+
+pip install python-magic
+pip install python-magic-bin
+```
+
+#### Linux based system
+
+Install `libmagic` using a package manager, for example
+
+```bash
+apt install libmagic-dev
+```
+
+#### MacOS
+
+Install `libmagic` using a package manager, for example
+
+```bash
+brew install libmagic
+```
+
+## Usage
+
+```bash
+usage: sbom4python [-h] [-m MODULE] [-r REQUIREMENT] [--system] [--exclude-license] [--include-file] [--include-service] [--use-pip] [--python PYTHON] [-d] [--sbom {spdx,cyclonedx}] [--format {tag,json,yaml}] [-o OUTPUT_FILE]
+                   [-g GRAPH] [-V]
+
+SBOM4Python generates a Software Bill of Materials for the specified installed Python module identifying all of the dependent components which are explicity defined (typically via requirements.txt file) or implicitly as a hidden
+dependency.
+
+options:
+  -h, --help            show this help message and exit
+  -V, --version         show program's version number and exit
+
+Input:
+  -m MODULE, --module MODULE
+                        identity of python module
+  -r REQUIREMENT, --requirement REQUIREMENT
+                        name of requirements file
+  --system              include all installed python modules within system
+  --exclude-license     suppress detecting the license of components
+  --include-file        include reporting files associated with module
+  --include-service     include reporting of endpoints
+  --use-pip             use pip for package management
+  --python PYTHON       use specified Python interpreter for pip
+
+Output:
+  -d, --debug           add debug information
+  --sbom {spdx,cyclonedx}
+                        specify type of sbom to generate (default: spdx)
+  --format {tag,json,yaml}
+                        specify format of software bill of materials (sbom) (default: tag)
+  -o OUTPUT_FILE, --output-file OUTPUT_FILE
+                        output filename (default: output to stdout)
+  -g GRAPH, --graph GRAPH
+                        filename for dependency graph
+
+```
+						
+## Operation
+
+The `--module` option is used to identify the Python module. The `--system` option is used to indicate that the SBOM is to include all installed
+Python modules.
+
+The `--requirement` option is used to create an SBOM from a pylock.toml, requirements.txt, pyproject.toml, setup.cfg or setup.py file.
+Whilst the filenames may be different e.g. requirements_test.txt can be specified, it is the file extension which determines the identification of
+the dependencies. Using this option will normally result in no transitive dependencies being identified.
+
+One of `--module`,  `--requirement` or `--system` must be specified. If multiple options are specified, the order of priority is `--module`, `--system` and `--requirement`.
+
+The `--python` option is to speficy the path to a different python installation e.g. when using venv. This option should also be used with the `--use-pip` option.
+
+The `--sbom` option is used to specify the format of the generated SBOM (the default is SPDX). The `--format` option
+can be used to specify the formatting of the SBOM (the default is Tag Value format for a SPDX SBOM). JSON format is supported for both
+SPDX and CycloneDX SBOMs).
+
+The `--output-file` option is used to control the destination of the output generated by the tool. The
+default is to report to the console but can be stored in a file (specified using `--output-file` option).
+
+The tool attempts to determine the license of each module. This can be suppressed using the `--exclude-license` option in
+which case all licences are reported as 'NOASSERTION'.
+
+The tool can optionally include the files associated with the installed module. This can be specified using the `--include-file` option. As the filenames are
+relative to the directory in which the tool is invoked, it is recommended that the tool is launched in a directory where the source files are available.
+
+The `--graph` option is used to generate a dependency graph of the components within the SBOM. The format of the graph
+file is compatible with the [DOT language](https://graphviz.org/doc/info/lang.html) used by the
+[GraphViz](https://graphviz.org/) application.
+
+## Licence
+
+Licenced under the Apache 2.0 Licence.
+
+The tool uses a local copy of the [SPDX Licenses List](https://github.com/spdx/license-list-data) which is released under
+[Creative Commons Attribution 3.0 (CC-BY-3.0)](http://creativecommons.org/licenses/by/3.0/).
+
+## Limitations
+
+This tool is meant to support software development and security audit functions. However the usefulness of the tool is dependent on the SBOM data
+which is provided to the tool. Unfortunately, the tool is unable to determine the validity or completeness of such a SBOM file; users of the tool
+are therefore reminded that they should assert the quality of any data which is provided to the tool.
+
+The `--requirement` option will only report the package version for pinned dependencies.
+
+When processing and validating licenses, the application will use a set of synonyms to attempt to map some license identifiers to the correct [SPDX License Identifiers](https://spdx.org/licenses/). However, the
+user of the tool is reminded that they should assert the quality of any data which is provided by the tool particularly where the license identifier has been modified.
+
+Whilst [PURL](https://github.com/package-url/purl-spec) and [CPE](https://nvd.nist.gov/products/cpe) references are automatically generated for each Python module, the accuracy
+of such references cannot be guaranteed as they are dependent on the validity of the data associated with the Python module.
+
+Network access is required to populate some of the package metadata. If this is not available, a limited amount of package metadata will be included.
+
+## Feedback and Contributions
+
+Bugs and feature requests can be made via GitHub Issues.

sbom4python-0.12.5.dist-info/RECORD

@@ -0,0 +1,14 @@
+sbom4python/__init__.py,sha256=UXoScW29szuUhsP-AvPIJLEPeX_U31M1gxYUSooemy8,76
+sbom4python/cli.py,sha256=dkuA_VGfvQbiluCkkEIgK7wzAP-a4oX6P72cc26SRqc,6168
+sbom4python/license.py,sha256=5XRAwuvRNd4nt2T7shMQr3jUo9dEMstZF5Hov3IzvIw,1820
+sbom4python/scanner.py,sha256=lTY1tIyYv5FfaEld1d3gAN9pr1Hzxu98W4H9R0BuvOY,34296
+sbom4python/version.py,sha256=RlmE_Ji3D2uVSbml9hgrRrfFoWUxFHxh7SCmXrmr9ug,101
+sbom4python/license_data/spdx_licenses.json,sha256=mj836L9ndKZMZBORMqUkjzP0n23RRhleuBdXlER0pVE,222585
+test/__init__.py,sha256=Jdm3si-iktHDtKWwHpYgVfLYF-l1bE6TQDJASgkVpQU,75
+test/test_license.py,sha256=stWDum_UwVGZZsTyjrVICgBh3Azb6dUqZIMK_DUQe4s,1976
+sbom4python-0.12.5.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+sbom4python-0.12.5.dist-info/METADATA,sha256=B5td4HuOnONcOl3R0Ci-61oNmXv6U_9CP-slZkqPMbo,8984
+sbom4python-0.12.5.dist-info/WHEEL,sha256=2wepM1nk4DS4eFpYrW1TTqPcoGNfHhhO_i5m4cOimbo,92
+sbom4python-0.12.5.dist-info/entry_points.txt,sha256=_83UfxTjM06vaj0t1XlOO3YmniXkM1jsyvTdkee7tmk,53
+sbom4python-0.12.5.dist-info/top_level.txt,sha256=udvkgWvzv7RUbiqpZ-ANkgXwwk5fFhl2LiQkh8dJGQg,12
+sbom4python-0.12.5.dist-info/RECORD,,

sbom4python-0.12.5.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: bdist_wheel (0.38.4)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

sbom4python-0.12.5.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+sbom4python = sbom4python.cli:main

sbom4python-0.12.5.dist-info/top_level.txt

@@ -0,0 +1 @@
+sbom4python

test/__init__.py

@@ -0,0 +1,2 @@
+# Copyright (C) 2023 Anthony Harrison
+# SPDX-License-Identifier: Apache-2.0

test/test_license.py

@@ -0,0 +1,62 @@
+import pytest
+
+from sbom4python.scanner import SBOMScanner
+from lib4sbom.license import LicenseScanner
+
+
+class TestLicense:
+    @pytest.mark.parametrize(
+        "expression, result",
+        (
+            ("bad", "NOASSERTION"),
+            ("", "NOASSERTION"),
+            ("NONE", "NONE"),
+            ("NOASSERTION", "NOASSERTION"),
+            ("MIT and Apache-2.0", "MIT and Apache-2.0"),
+            ("MIT and Apache", "MIT and Apache-2.0"),
+            ("LicenseRef-100", "LicenseRef-100"),
+            ("ASL 2.0", "Apache-2.0"),
+            ("Apache", "Apache-2.0"),
+            ("MIT", "MIT"),
+        ),
+    )
+    def test_license(self, expression, result):
+        test_item = SBOMScanner(debug=True)
+        license = test_item.process_license_expression(expression)
+        assert license == result
+
+    # def test_find_license_id(self, license, result):
+    #    test_item = SBOMScanner(debug=True)
+    #    license_id = test_item.license_ident(license)
+    #    assert license_id == result
+
+    # @pytest.mark.parametrize(
+    #    "expression, result",
+    #    (
+    #        ("bad", "NOASSERTION"),
+    #        ("apache", "Apache-2.0"),
+    #        ("MIT and Apache-2.0", "MIT and Apache-2.0"),
+    #        ("(MIT or BSD) and Apache-2.0", "(MIT or BSD-3-Clause) and Apache-2.0"),
+    #    )
+    # )
+
+    @pytest.mark.parametrize(
+        "license, result",
+        (
+            ("bad", "UNKNOWN"),
+            ("", "UNKNOWN"),
+            ("NONE", "NONE"),
+            ("NOASSERTION", "NOASSERTION"),
+            ("Apache-2.0", "Apache-2.0"),
+            ("LicenseRef-100", "LicenseRef-100"),
+            ("ASL 2.0", "Apache-2.0"),
+            ("Apache", "Apache-2.0"),
+            ("MIT", "MIT"),
+        ),
+    )
+    def test_find_license(self, license, result):
+        test_item = LicenseScanner()
+        x = test_item.get_synonym()
+        assert (len(x) > 0)
+        licenseid = test_item.find_license(license)
+        assert licenseid == result