Metadata-Version: 2.5
Name: setuav-studio-sdk
Version: 0.1.0
Summary: Public plugin contracts for Setuav Studio
License: MIT License
        
        Copyright (c) 2026 Setware
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
License-File: LICENSE
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Requires-Python: >=3.11
Requires-Dist: pyside6<7,>=6.8
Description-Content-Type: text/markdown

# Setuav Studio SDK

This package defines the Python contracts used by third-party Setuav Studio
plugins. The source and API reference are kept together for versioned releases.

## Developer documentation

From this directory:

```bash
doxygen Doxyfile
```

Open `docs/html/index.html` in a browser.

The generated reference documents only public SDK modules. Application
implementation modules are deliberately excluded.

## Example plugin

The [`packages/example-plugin`](../example-plugin) project shows the
smallest installable plugin: it declares the SDK dependency, publishes an
entry point, and cleans up its workspace and panel during deactivation.

Run the SDK and example-plugin tests from the repository root:

```bash
python scripts/sdk_contract_tests.py
```
