Skip to content

Commit fa00bf3

Browse files
committed
feat: basic abstraction
Start a high level API
1 parent c7d7171 commit fa00bf3

8 files changed

Lines changed: 626 additions & 2 deletions

Readme.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,12 @@ and allows an easy way to interact with SW360.
2020

2121
Have a look at the documentation: https://sw360.github.io/sw360python/
2222

23+
The [`SW360`](https://sw360.github.io/sw360python/index.html#sw360.SW360) class
24+
provides the main interface.
25+
26+
In [`sw360_objects.py`](./sw360/sw360_objects.py), there's also a preview of a
27+
high-level API, but note this is read-only and incomplete for now.
28+
2329
## Usage
2430

2531
### Installation

sw360/__init__.py

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,14 @@
1212
from .sw360_api import SW360
1313
from .sw360error import SW360Error
1414
from .sw360oauth2 import SW360OAuth2
15+
from .sw360_objects import Component, Release, Attachment, Project
1516

1617
__all__ = [
1718
"SW360",
1819
"SW360Error",
19-
"SW360OAuth2"
20+
"SW360OAuth2",
21+
"Component",
22+
"Release",
23+
"Attachment",
24+
"Project"
2025
]

sw360/sw360_api.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,10 @@
77
# SPDX-License-Identifier: MIT
88
# -------------------------------------------------------------------------------
99

10-
"""Python interface to the Siemens SW360 platform"""
10+
"""Main Python interface to the SW360 REST API. This provides a low-level
11+
abstraction of the REST API endpoints passing through JSON objects from/to
12+
SW360."""
13+
1114

1215
from typing import Any, Dict, Optional
1316

0 commit comments

Comments
 (0)