stkai 0.2.5__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
stkai-0.2.5/LICENSE ADDED
@@ -0,0 +1,190 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to the Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ Copyright 2025 Rafael Ponte
179
+
180
+ Licensed under the Apache License, Version 2.0 (the "License");
181
+ you may not use this file except in compliance with the License.
182
+ You may obtain a copy of the License at
183
+
184
+ http://www.apache.org/licenses/LICENSE-2.0
185
+
186
+ Unless required by applicable law or agreed to in writing, software
187
+ distributed under the License is distributed on an "AS IS" BASIS,
188
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
189
+ See the License for the specific language governing permissions and
190
+ limitations under the License.
stkai-0.2.5/PKG-INFO ADDED
@@ -0,0 +1,146 @@
1
+ Metadata-Version: 2.4
2
+ Name: stkai
3
+ Version: 0.2.5
4
+ Summary: Python SDK for StackSpot AI - Remote Quick Commands and more
5
+ Author-email: Rafael Ponte <rponte@gmail.com>
6
+ License: Apache-2.0
7
+ Project-URL: Homepage, https://github.com/rafaelpontezup/stkai-sdk-python
8
+ Project-URL: Documentation, https://rafaelpontezup.github.io/stkai-sdk-python/
9
+ Project-URL: Repository, https://github.com/rafaelpontezup/stkai-sdk-python
10
+ Project-URL: Issues, https://github.com/rafaelpontezup/stkai-sdk-python/issues
11
+ Keywords: stackspot,ai,sdk,quick-commands,llm,agents,api client
12
+ Classifier: Development Status :: 3 - Alpha
13
+ Classifier: Intended Audience :: Developers
14
+ Classifier: License :: OSI Approved :: Apache Software License
15
+ Classifier: Operating System :: OS Independent
16
+ Classifier: Programming Language :: Python :: 3
17
+ Classifier: Programming Language :: Python :: 3.12
18
+ Classifier: Programming Language :: Python :: 3.13
19
+ Classifier: Topic :: Software Development :: Libraries :: Python Modules
20
+ Classifier: Typing :: Typed
21
+ Requires-Python: >=3.12
22
+ Description-Content-Type: text/markdown
23
+ License-File: LICENSE
24
+ Requires-Dist: requests>=2.28.0
25
+ Provides-Extra: dev
26
+ Requires-Dist: pytest>=7.0.0; extra == "dev"
27
+ Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
28
+ Requires-Dist: mypy>=1.0.0; extra == "dev"
29
+ Requires-Dist: ruff>=0.1.0; extra == "dev"
30
+ Requires-Dist: types-requests>=2.28.0; extra == "dev"
31
+ Provides-Extra: docs
32
+ Requires-Dist: mkdocs>=1.5.0; extra == "docs"
33
+ Requires-Dist: mkdocs-material>=9.5.0; extra == "docs"
34
+ Requires-Dist: mkdocstrings[python]>=0.24.0; extra == "docs"
35
+ Requires-Dist: mkdocs-gen-files>=0.5.0; extra == "docs"
36
+ Requires-Dist: mkdocs-literate-nav>=0.6.0; extra == "docs"
37
+ Dynamic: license-file
38
+
39
+ # stkai
40
+
41
+ [![Python](https://img.shields.io/badge/python-3.12+-blue.svg)](https://www.python.org/downloads/)
42
+ [![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](LICENSE)
43
+
44
+ Python SDK for [StackSpot AI](https://ai.stackspot.com/) - Execute Remote Quick Commands (RQCs) and interact with AI Agents.
45
+
46
+ ## Installation
47
+
48
+ ```bash
49
+ pip install stkai
50
+ ```
51
+
52
+ ## Requirements
53
+
54
+ - Python 3.12+
55
+ - [StackSpot CLI](https://docs.stackspot.com/docs/stk-cli/installation/) installed and authenticated, or client credentials for standalone auth
56
+
57
+ ## Quick Start
58
+
59
+ ### Remote Quick Commands
60
+
61
+ ```python
62
+ from stkai import RemoteQuickCommand, RqcRequest
63
+
64
+ rqc = RemoteQuickCommand(slug_name="my-quick-command")
65
+
66
+ response = rqc.execute(
67
+ request=RqcRequest(payload={"code": "def hello(): pass"})
68
+ )
69
+
70
+ if response.is_completed():
71
+ print(response.result)
72
+ else:
73
+ print(response.error_with_details())
74
+ ```
75
+
76
+ ### AI Agents
77
+
78
+ ```python
79
+ from stkai import Agent, ChatRequest
80
+
81
+ agent = Agent(agent_id="my-agent-slug")
82
+
83
+ response = agent.chat(
84
+ request=ChatRequest(user_prompt="What is SOLID?")
85
+ )
86
+
87
+ if response.is_success():
88
+ print(response.message)
89
+ ```
90
+
91
+ ### Batch Processing
92
+
93
+ ```python
94
+ responses = rqc.execute_many(
95
+ request_list=[RqcRequest(payload=data) for data in files]
96
+ )
97
+
98
+ completed = [r for r in responses if r.is_completed()]
99
+ ```
100
+
101
+ ## Features
102
+
103
+ | Feature | Description | Docs |
104
+ |---------|-------------|------|
105
+ | **Remote Quick Commands** | Execute AI commands with polling and retries | [Guide](https://rafaelpontezup.github.io/stkai-sdk-python/rqc/) |
106
+ | **AI Agents** | Chat with agents, conversations, knowledge sources | [Guide](https://rafaelpontezup.github.io/stkai-sdk-python/agents/) |
107
+ | **Batch Execution** | Process multiple requests concurrently | [Guide](https://rafaelpontezup.github.io/stkai-sdk-python/rqc/usage/#batch-execution) |
108
+ | **Result Handlers** | Customize response processing | [Guide](https://rafaelpontezup.github.io/stkai-sdk-python/rqc/handlers/) |
109
+ | **Event Listeners** | Monitor execution lifecycle | [Guide](https://rafaelpontezup.github.io/stkai-sdk-python/rqc/listeners/) |
110
+ | **Rate Limiting** | Token Bucket and adaptive AIMD algorithms | [Guide](https://rafaelpontezup.github.io/stkai-sdk-python/rqc/rate-limiting/) |
111
+ | **Configuration** | Global config via code or environment variables | [Guide](https://rafaelpontezup.github.io/stkai-sdk-python/configuration/) |
112
+
113
+ ## Documentation
114
+
115
+ Full documentation available at: **https://rafaelpontezup.github.io/stkai-sdk-python/**
116
+
117
+ - [Getting Started](https://rafaelpontezup.github.io/stkai-sdk-python/getting-started/)
118
+ - [RQC Guide](https://rafaelpontezup.github.io/stkai-sdk-python/rqc/)
119
+ - [Agents Guide](https://rafaelpontezup.github.io/stkai-sdk-python/agents/)
120
+ - [Configuration](https://rafaelpontezup.github.io/stkai-sdk-python/configuration/)
121
+ - [API Reference](https://rafaelpontezup.github.io/stkai-sdk-python/api/rqc/)
122
+
123
+ ## Development
124
+
125
+ ```bash
126
+ # Clone and setup
127
+ git clone https://github.com/rafaelpontezup/stkai-sdk.git
128
+ cd stkai-sdk
129
+ python -m venv .venv && source .venv/bin/activate
130
+ pip install -e ".[dev]"
131
+
132
+ # Run tests
133
+ pytest
134
+
135
+ # Lint and type check
136
+ ruff check src tests
137
+ mypy src
138
+
139
+ # Build docs locally
140
+ pip install -e ".[docs]"
141
+ mkdocs serve
142
+ ```
143
+
144
+ ## License
145
+
146
+ Apache License 2.0 - see [LICENSE](LICENSE) for details.
stkai-0.2.5/README.md ADDED
@@ -0,0 +1,108 @@
1
+ # stkai
2
+
3
+ [![Python](https://img.shields.io/badge/python-3.12+-blue.svg)](https://www.python.org/downloads/)
4
+ [![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](LICENSE)
5
+
6
+ Python SDK for [StackSpot AI](https://ai.stackspot.com/) - Execute Remote Quick Commands (RQCs) and interact with AI Agents.
7
+
8
+ ## Installation
9
+
10
+ ```bash
11
+ pip install stkai
12
+ ```
13
+
14
+ ## Requirements
15
+
16
+ - Python 3.12+
17
+ - [StackSpot CLI](https://docs.stackspot.com/docs/stk-cli/installation/) installed and authenticated, or client credentials for standalone auth
18
+
19
+ ## Quick Start
20
+
21
+ ### Remote Quick Commands
22
+
23
+ ```python
24
+ from stkai import RemoteQuickCommand, RqcRequest
25
+
26
+ rqc = RemoteQuickCommand(slug_name="my-quick-command")
27
+
28
+ response = rqc.execute(
29
+ request=RqcRequest(payload={"code": "def hello(): pass"})
30
+ )
31
+
32
+ if response.is_completed():
33
+ print(response.result)
34
+ else:
35
+ print(response.error_with_details())
36
+ ```
37
+
38
+ ### AI Agents
39
+
40
+ ```python
41
+ from stkai import Agent, ChatRequest
42
+
43
+ agent = Agent(agent_id="my-agent-slug")
44
+
45
+ response = agent.chat(
46
+ request=ChatRequest(user_prompt="What is SOLID?")
47
+ )
48
+
49
+ if response.is_success():
50
+ print(response.message)
51
+ ```
52
+
53
+ ### Batch Processing
54
+
55
+ ```python
56
+ responses = rqc.execute_many(
57
+ request_list=[RqcRequest(payload=data) for data in files]
58
+ )
59
+
60
+ completed = [r for r in responses if r.is_completed()]
61
+ ```
62
+
63
+ ## Features
64
+
65
+ | Feature | Description | Docs |
66
+ |---------|-------------|------|
67
+ | **Remote Quick Commands** | Execute AI commands with polling and retries | [Guide](https://rafaelpontezup.github.io/stkai-sdk-python/rqc/) |
68
+ | **AI Agents** | Chat with agents, conversations, knowledge sources | [Guide](https://rafaelpontezup.github.io/stkai-sdk-python/agents/) |
69
+ | **Batch Execution** | Process multiple requests concurrently | [Guide](https://rafaelpontezup.github.io/stkai-sdk-python/rqc/usage/#batch-execution) |
70
+ | **Result Handlers** | Customize response processing | [Guide](https://rafaelpontezup.github.io/stkai-sdk-python/rqc/handlers/) |
71
+ | **Event Listeners** | Monitor execution lifecycle | [Guide](https://rafaelpontezup.github.io/stkai-sdk-python/rqc/listeners/) |
72
+ | **Rate Limiting** | Token Bucket and adaptive AIMD algorithms | [Guide](https://rafaelpontezup.github.io/stkai-sdk-python/rqc/rate-limiting/) |
73
+ | **Configuration** | Global config via code or environment variables | [Guide](https://rafaelpontezup.github.io/stkai-sdk-python/configuration/) |
74
+
75
+ ## Documentation
76
+
77
+ Full documentation available at: **https://rafaelpontezup.github.io/stkai-sdk-python/**
78
+
79
+ - [Getting Started](https://rafaelpontezup.github.io/stkai-sdk-python/getting-started/)
80
+ - [RQC Guide](https://rafaelpontezup.github.io/stkai-sdk-python/rqc/)
81
+ - [Agents Guide](https://rafaelpontezup.github.io/stkai-sdk-python/agents/)
82
+ - [Configuration](https://rafaelpontezup.github.io/stkai-sdk-python/configuration/)
83
+ - [API Reference](https://rafaelpontezup.github.io/stkai-sdk-python/api/rqc/)
84
+
85
+ ## Development
86
+
87
+ ```bash
88
+ # Clone and setup
89
+ git clone https://github.com/rafaelpontezup/stkai-sdk.git
90
+ cd stkai-sdk
91
+ python -m venv .venv && source .venv/bin/activate
92
+ pip install -e ".[dev]"
93
+
94
+ # Run tests
95
+ pytest
96
+
97
+ # Lint and type check
98
+ ruff check src tests
99
+ mypy src
100
+
101
+ # Build docs locally
102
+ pip install -e ".[docs]"
103
+ mkdocs serve
104
+ ```
105
+
106
+ ## License
107
+
108
+ Apache License 2.0 - see [LICENSE](LICENSE) for details.
@@ -0,0 +1,95 @@
1
+ [build-system]
2
+ requires = ["setuptools>=61.0", "wheel"]
3
+ build-backend = "setuptools.build_meta"
4
+
5
+ [project]
6
+ name = "stkai"
7
+ version = "0.2.5"
8
+ description = "Python SDK for StackSpot AI - Remote Quick Commands and more"
9
+ readme = "README.md"
10
+ license = {text = "Apache-2.0"}
11
+ requires-python = ">=3.12"
12
+ authors = [
13
+ {name = "Rafael Ponte", email = "rponte@gmail.com"}
14
+ ]
15
+ keywords = ["stackspot", "ai", "sdk", "quick-commands", "llm", "agents", "api client"]
16
+ classifiers = [
17
+ "Development Status :: 3 - Alpha",
18
+ "Intended Audience :: Developers",
19
+ "License :: OSI Approved :: Apache Software License",
20
+ "Operating System :: OS Independent",
21
+ "Programming Language :: Python :: 3",
22
+ "Programming Language :: Python :: 3.12",
23
+ "Programming Language :: Python :: 3.13",
24
+ "Topic :: Software Development :: Libraries :: Python Modules",
25
+ "Typing :: Typed",
26
+ ]
27
+ dependencies = [
28
+ "requests>=2.28.0",
29
+ ]
30
+
31
+ [project.optional-dependencies]
32
+ dev = [
33
+ "pytest>=7.0.0",
34
+ "pytest-cov>=4.0.0",
35
+ "mypy>=1.0.0",
36
+ "ruff>=0.1.0",
37
+ "types-requests>=2.28.0",
38
+ ]
39
+ docs = [
40
+ "mkdocs>=1.5.0",
41
+ "mkdocs-material>=9.5.0",
42
+ "mkdocstrings[python]>=0.24.0",
43
+ "mkdocs-gen-files>=0.5.0",
44
+ "mkdocs-literate-nav>=0.6.0",
45
+ ]
46
+
47
+ [project.urls]
48
+ Homepage = "https://github.com/rafaelpontezup/stkai-sdk-python"
49
+ Documentation = "https://rafaelpontezup.github.io/stkai-sdk-python/"
50
+ Repository = "https://github.com/rafaelpontezup/stkai-sdk-python"
51
+ Issues = "https://github.com/rafaelpontezup/stkai-sdk-python/issues"
52
+
53
+ [tool.setuptools.packages.find]
54
+ where = ["src"]
55
+
56
+ [tool.pytest.ini_options]
57
+ testpaths = ["tests"]
58
+ python_files = ["test_*.py"]
59
+ python_functions = ["test_*"]
60
+ addopts = "-v --tb=short"
61
+ # Logging (disabled by default, enable with: pytest --log-cli-level=DEBUG)
62
+ log_cli = false
63
+ log_cli_level = "DEBUG"
64
+ log_cli_format = "%(asctime)s [%(levelname)s] %(name)s: %(message)s"
65
+ log_cli_date_format = "%H:%M:%S"
66
+
67
+ [tool.ruff]
68
+ target-version = "py312"
69
+ line-length = 120
70
+ src = ["src", "tests"]
71
+
72
+ [tool.ruff.lint]
73
+ select = [
74
+ "E", # pycodestyle errors
75
+ "W", # pycodestyle warnings
76
+ "F", # Pyflakes
77
+ "I", # isort
78
+ "B", # flake8-bugbear
79
+ "C4", # flake8-comprehensions
80
+ "UP", # pyupgrade
81
+ ]
82
+ ignore = [
83
+ "E501", # line too long (handled by formatter)
84
+ ]
85
+
86
+ [tool.mypy]
87
+ python_version = "3.12"
88
+ strict = true
89
+ warn_return_any = true
90
+ warn_unused_ignores = true
91
+ disallow_untyped_defs = true
92
+
93
+ [[tool.mypy.overrides]]
94
+ module = "oscli.*"
95
+ ignore_missing_imports = true
stkai-0.2.5/setup.cfg ADDED
@@ -0,0 +1,4 @@
1
+ [egg_info]
2
+ tag_build =
3
+ tag_date = 0
4
+
@@ -0,0 +1,145 @@
1
+ """
2
+ StackSpot AI SDK for Python.
3
+
4
+ A Python SDK for integrating with StackSpot AI services,
5
+ including Remote Quick Commands (RQC) and Agents.
6
+
7
+ Quick Start (RQC):
8
+ >>> from stkai import RemoteQuickCommand, RqcRequest
9
+ >>> rqc = RemoteQuickCommand(slug_name="my-quick-command")
10
+ >>> request = RqcRequest(payload={"prompt": "Hello, AI!"})
11
+ >>> response = rqc.execute(request)
12
+ >>> print(response.result)
13
+
14
+ Quick Start (Agent):
15
+ >>> from stkai import Agent, ChatRequest
16
+ >>> agent = Agent(agent_id="my-agent-slug")
17
+ >>> response = agent.chat(ChatRequest(user_prompt="What is SOLID?"))
18
+ >>> print(response.message)
19
+
20
+ Global Configuration:
21
+ >>> from stkai import STKAI
22
+ >>>
23
+ >>> # Pre-loaded with defaults + env vars
24
+ >>> timeout = STKAI.config.agent.request_timeout
25
+ >>>
26
+ >>> # Custom configuration
27
+ >>> STKAI.configure(
28
+ ... auth={"client_id": "x", "client_secret": "y"},
29
+ ... rqc={"request_timeout": 60, "max_retries": 5},
30
+ ... agent={"request_timeout": 120},
31
+ ... rate_limit={"enabled": True, "strategy": "token_bucket", "max_requests": 10},
32
+ ... )
33
+
34
+ Main Classes:
35
+ - RemoteQuickCommand: Client for executing Remote Quick Commands.
36
+ - RqcRequest: Represents a request to be sent to the RQC API.
37
+ - RqcResponse: Represents the response received from the RQC API.
38
+ - RqcExecutionStatus: Enum with execution lifecycle statuses.
39
+ - Agent: Client for interacting with StackSpot AI Agents.
40
+ - ChatRequest: Represents a chat request to be sent to an Agent.
41
+ - ChatResponse: Represents the chat response received from an Agent.
42
+ - ChatStatus: Enum with chat response statuses.
43
+
44
+ Configuration:
45
+ - STKAI: Global SDK singleton for configuration.
46
+ - STKAIConfig: Root configuration dataclass.
47
+ - AuthConfig: Authentication configuration.
48
+ - RqcConfig: RemoteQuickCommand configuration.
49
+ - AgentConfig: Agent configuration.
50
+ - RateLimitConfig: Rate limiting configuration.
51
+ - RateLimitStrategy: Type alias for valid rate limiting strategies.
52
+
53
+ Authentication (Standalone):
54
+ - AuthProvider: Abstract base class for authentication providers.
55
+ - ClientCredentialsAuthProvider: OAuth2 client credentials implementation.
56
+ - AuthenticationError: Exception raised when authentication fails.
57
+ - create_standalone_auth: Helper to create auth provider from config.
58
+
59
+ HTTP Client:
60
+ - HttpClient: Abstract base class for HTTP clients.
61
+ - EnvironmentAwareHttpClient: Auto-detects environment (CLI or standalone). Default.
62
+ - StkCLIHttpClient: HTTP client using StackSpot CLI for authentication.
63
+ - StandaloneHttpClient: HTTP client using AuthProvider for standalone auth.
64
+ - RateLimitedHttpClient: HTTP client decorator with rate limiting.
65
+ - AdaptiveRateLimitedHttpClient: HTTP client decorator with adaptive rate limiting.
66
+ - RateLimitTimeoutError: Exception raised when rate limiter exceeds max_wait_time.
67
+ """
68
+
69
+ from importlib.metadata import version as _get_version
70
+
71
+ __version__ = _get_version("stkai")
72
+
73
+ from stkai._auth import (
74
+ AuthenticationError,
75
+ AuthProvider,
76
+ ClientCredentialsAuthProvider,
77
+ create_standalone_auth,
78
+ )
79
+ from stkai._config import (
80
+ STKAI,
81
+ AgentConfig,
82
+ AuthConfig,
83
+ RateLimitConfig,
84
+ RateLimitStrategy,
85
+ RqcConfig,
86
+ STKAIConfig,
87
+ )
88
+ from stkai._http import (
89
+ AdaptiveRateLimitedHttpClient,
90
+ EnvironmentAwareHttpClient,
91
+ HttpClient,
92
+ RateLimitedHttpClient,
93
+ RateLimitTimeoutError,
94
+ StandaloneHttpClient,
95
+ StkCLIHttpClient,
96
+ )
97
+ from stkai.agents import (
98
+ Agent,
99
+ ChatRequest,
100
+ ChatResponse,
101
+ ChatStatus,
102
+ )
103
+ from stkai.rqc import (
104
+ RemoteQuickCommand,
105
+ RqcExecutionStatus,
106
+ RqcOptions,
107
+ RqcRequest,
108
+ RqcResponse,
109
+ )
110
+
111
+ __all__ = [
112
+ "__version__",
113
+ # Configuration
114
+ "STKAI",
115
+ "STKAIConfig",
116
+ "AuthConfig",
117
+ "RqcConfig",
118
+ "AgentConfig",
119
+ "RateLimitConfig",
120
+ "RateLimitStrategy",
121
+ # Authentication (Standalone)
122
+ "AuthProvider",
123
+ "ClientCredentialsAuthProvider",
124
+ "AuthenticationError",
125
+ "create_standalone_auth",
126
+ # HTTP Client
127
+ "HttpClient",
128
+ "EnvironmentAwareHttpClient",
129
+ "StkCLIHttpClient",
130
+ "StandaloneHttpClient",
131
+ "RateLimitedHttpClient",
132
+ "AdaptiveRateLimitedHttpClient",
133
+ "RateLimitTimeoutError",
134
+ # RQC
135
+ "RemoteQuickCommand",
136
+ "RqcOptions",
137
+ "RqcRequest",
138
+ "RqcResponse",
139
+ "RqcExecutionStatus",
140
+ # Agents
141
+ "Agent",
142
+ "ChatRequest",
143
+ "ChatResponse",
144
+ "ChatStatus",
145
+ ]