High level api

Readme.md

@@ -20,6 +20,12 @@ and allows an easy way to interact with SW360.
 
 Have a look at the documentation: https://sw360.github.io/sw360python/
 
+The [`SW360`](https://sw360.github.io/sw360python/index.html#sw360.SW360) class
+provides the main interface.
+
+In [`sw360_objects.py`](./sw360/sw360_objects.py), there's also a preview of a
+high-level API, but note this is read-only and incomplete for now.
+
 ## Usage
 
 ### Installation

pyproject.toml

@@ -24,6 +24,7 @@ classifiers = [
 [tool.poetry.dependencies]
 python = "^3.9" # 3.9 is needed for urllib 2.5 to fix CVE-2025-50181
 requests = "^2.32.4" # fix CVE-2024-47081
+packageurl-python = ">=0.11, <1.0"
 
 [tool.poetry.group.dev.dependencies]
 colorama = "^0.4.6"

sw360/__init__.py

@@ -12,9 +12,14 @@
 from .sw360_api import SW360
 from .sw360error import SW360Error
 from .sw360oauth2 import SW360OAuth2
+from .sw360_objects import Component, Release, Attachment, Project
 
 __all__ = [
     "SW360",
     "SW360Error",
-    "SW360OAuth2"
+    "SW360OAuth2",
+    "Component",
+    "Release",
+    "Attachment",
+    "Project"
 ]

sw360/sw360_api.py

@@ -7,7 +7,10 @@
 # SPDX-License-Identifier: MIT
 # -------------------------------------------------------------------------------
 
-"""Python interface to the Siemens SW360 platform"""
+"""Main Python interface to the SW360 REST API. This provides a low-level
+abstraction of the REST API endpoints passing through JSON objects from/to
+SW360."""
+
 
 from typing import Any, Dict, Optional