Metadata-Version: 2.4
Name: orrin-sdk
Version: 0.2.0.6
Summary: SDK for creating and registering custom Orrin apps, tools, agents, and plugins
Author-email: Aidan White <ceo@stellr-company.com>
License: Copyright (c) 2026 Stellr, LLC. All rights reserved.
        
        This software and associated documentation files (the "Software") are proprietary to Stellr, LLC.
        
        Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
        
        1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
        2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
        3. Commercial use requires a separate license agreement from Stellr, LLC. Contact ceo@stellr-company.com for licensing information.
        4. Neither the name of Stellr, LLC nor the names of its contributors may be used to endorse or promote products derived from this Software without specific prior written permission.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL STELLR, LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Project-URL: Homepage, https://stellr-company.com
Classifier: Programming Language :: Python :: 3
Classifier: License :: Other/Proprietary License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: orrin-cli>=0.2.0.2
Requires-Dist: rich>=14.3.3
Dynamic: license-file

# Orrin SDK

The Orrin SDK is the heart of the Orrin Apps infrastructure. This SDK enables developers to create the backends to the apps they host on Orrin Apps, as well as create tools to be used throughout the Stellr product ecosystem, and in their own applications.

## Usages
---

The Orrin SDK can be used for two things:

1. Backends for Orrin Apps
2. Backends for custom tools

### Backends for Orrin Apps
The Orrin SDK provides developers with the `OrrinAppsSDK` class, which is used to "register" functions as "actions" for the frontend. These actions can be used in the frontend to manipulate the UI via data.

This infrastructure is enforced to ensure stability and seggregation between the frontend that is hosted on OrrinApps and the backend. This effectively enables the backend to be completely separate from the frontend, which enables Stellr to manage apps more effeciently.

### Backends for custom tools
The Orrin SDK provides developers with the `OrrinToolsSDK` class, which is used to "register" functions as "actions" for the tools. These actions can then be utilized by AI models to perform tasks for users based on some sort of input. This entire infrastructure depends on our new protocol Exegesis, specifically the Exegesis Centralized Execution.

`OrrinToolsSDK` effectively enables users to create custom tools that can do virtually anything they'd like based on abstract inputs.

Please refer to [Stellr API Docs](https://api.stellr-company.com/ce/docs) for more information on getting started with creating a custom tool for the Stellr product ecosystem, as well as your own applications.

Please refer to the [Guide on Orrin SDK](https://stellr-company.com/orrin/sdk) for more information on the overarching SDK.

Both of these aforementioned sources provide elaborate explanations and detailed dives into how to get started with the Stellr API and Orrin SDK, as well as how to create custom app backends and custom tool backends.

#### What's New?

v0.2.0.6 brings forth bug fixes with processing of source code due to name changes of core classes introduced in v0.2.0.2.
