solwyn 0.1.0__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.
- solwyn-0.1.0/.github/workflows/ci.yml +40 -0
- solwyn-0.1.0/.github/workflows/publish.yml +33 -0
- solwyn-0.1.0/.gitignore +37 -0
- solwyn-0.1.0/CLAUDE.md +51 -0
- solwyn-0.1.0/LICENSE +201 -0
- solwyn-0.1.0/Makefile +44 -0
- solwyn-0.1.0/PKG-INFO +250 -0
- solwyn-0.1.0/README.md +220 -0
- solwyn-0.1.0/SECURITY.md +18 -0
- solwyn-0.1.0/pyproject.toml +74 -0
- solwyn-0.1.0/scripts/pre-commit +5 -0
- solwyn-0.1.0/src/solwyn/CLAUDE.md +34 -0
- solwyn-0.1.0/src/solwyn/__init__.py +33 -0
- solwyn-0.1.0/src/solwyn/_base.py +133 -0
- solwyn-0.1.0/src/solwyn/_privacy.py +93 -0
- solwyn-0.1.0/src/solwyn/_proxies.py +165 -0
- solwyn-0.1.0/src/solwyn/_token_details.py +45 -0
- solwyn-0.1.0/src/solwyn/_types.py +122 -0
- solwyn-0.1.0/src/solwyn/_validation.py +60 -0
- solwyn-0.1.0/src/solwyn/budget.py +516 -0
- solwyn-0.1.0/src/solwyn/circuit_breaker.py +151 -0
- solwyn-0.1.0/src/solwyn/client.py +618 -0
- solwyn-0.1.0/src/solwyn/config.py +103 -0
- solwyn-0.1.0/src/solwyn/exceptions.py +97 -0
- solwyn-0.1.0/src/solwyn/providers/__init__.py +67 -0
- solwyn-0.1.0/src/solwyn/providers/_accumulator.py +32 -0
- solwyn-0.1.0/src/solwyn/providers/_protocol.py +59 -0
- solwyn-0.1.0/src/solwyn/providers/anthropic.py +112 -0
- solwyn-0.1.0/src/solwyn/providers/google.py +108 -0
- solwyn-0.1.0/src/solwyn/providers/openai.py +121 -0
- solwyn-0.1.0/src/solwyn/py.typed +0 -0
- solwyn-0.1.0/src/solwyn/reporter.py +301 -0
- solwyn-0.1.0/src/solwyn/stream.py +204 -0
- solwyn-0.1.0/src/solwyn/tokenizer.py +183 -0
- solwyn-0.1.0/tests/CLAUDE.md +50 -0
- solwyn-0.1.0/tests/integration/conftest.py +169 -0
- solwyn-0.1.0/tests/integration/test_async_budget.py +63 -0
- solwyn-0.1.0/tests/integration/test_budget_check.py +61 -0
- solwyn-0.1.0/tests/integration/test_budget_confirm.py +41 -0
- solwyn-0.1.0/tests/integration/test_metadata_ingest.py +63 -0
- solwyn-0.1.0/tests/unit/conftest.py +57 -0
- solwyn-0.1.0/tests/unit/test_async_budget_enforcer.py +201 -0
- solwyn-0.1.0/tests/unit/test_async_metadata_reporter.py +200 -0
- solwyn-0.1.0/tests/unit/test_budget.py +411 -0
- solwyn-0.1.0/tests/unit/test_budget_confirm_failures.py +38 -0
- solwyn-0.1.0/tests/unit/test_budget_spec_compliance.py +344 -0
- solwyn-0.1.0/tests/unit/test_budget_thread_safety.py +81 -0
- solwyn-0.1.0/tests/unit/test_circuit_breaker.py +151 -0
- solwyn-0.1.0/tests/unit/test_client.py +1001 -0
- solwyn-0.1.0/tests/unit/test_client_spec_compliance.py +136 -0
- solwyn-0.1.0/tests/unit/test_exception_hierarchy.py +66 -0
- solwyn-0.1.0/tests/unit/test_no_production_asserts.py +24 -0
- solwyn-0.1.0/tests/unit/test_privacy_firewall.py +94 -0
- solwyn-0.1.0/tests/unit/test_provider_proxies.py +310 -0
- solwyn-0.1.0/tests/unit/test_providers/test_anthropic.py +208 -0
- solwyn-0.1.0/tests/unit/test_providers/test_google.py +243 -0
- solwyn-0.1.0/tests/unit/test_providers/test_openai.py +236 -0
- solwyn-0.1.0/tests/unit/test_providers/test_protocol.py +194 -0
- solwyn-0.1.0/tests/unit/test_providers/test_registry.py +161 -0
- solwyn-0.1.0/tests/unit/test_reporter.py +215 -0
- solwyn-0.1.0/tests/unit/test_stream.py +877 -0
- solwyn-0.1.0/tests/unit/test_stream_accumulators.py +308 -0
- solwyn-0.1.0/tests/unit/test_stream_nonblocking.py +74 -0
- solwyn-0.1.0/tests/unit/test_tokenizer.py +157 -0
- solwyn-0.1.0/uv.lock +756 -0
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
name: CI
|
|
2
|
+
on:
|
|
3
|
+
push:
|
|
4
|
+
branches: [main]
|
|
5
|
+
pull_request:
|
|
6
|
+
workflow_dispatch:
|
|
7
|
+
|
|
8
|
+
jobs:
|
|
9
|
+
test:
|
|
10
|
+
runs-on: ubuntu-latest
|
|
11
|
+
strategy:
|
|
12
|
+
matrix:
|
|
13
|
+
python-version: ["3.11", "3.12"]
|
|
14
|
+
steps:
|
|
15
|
+
- uses: actions/checkout@v6
|
|
16
|
+
- uses: actions/setup-python@v6
|
|
17
|
+
with:
|
|
18
|
+
python-version: ${{ matrix.python-version }}
|
|
19
|
+
- run: pip install -e ".[dev]"
|
|
20
|
+
- run: ruff check src/ tests/
|
|
21
|
+
- run: ruff format --check src/ tests/
|
|
22
|
+
- run: mypy src/solwyn/
|
|
23
|
+
- run: pytest tests/ -m unit -v --tb=short
|
|
24
|
+
|
|
25
|
+
integration:
|
|
26
|
+
if: >-
|
|
27
|
+
github.event_name == 'workflow_dispatch' ||
|
|
28
|
+
contains(github.event.pull_request.labels.*.name, 'run-integration')
|
|
29
|
+
runs-on: ubuntu-latest
|
|
30
|
+
steps:
|
|
31
|
+
- uses: actions/checkout@v6
|
|
32
|
+
- uses: actions/setup-python@v6
|
|
33
|
+
with:
|
|
34
|
+
python-version: "3.12"
|
|
35
|
+
- run: pip install -e ".[dev]"
|
|
36
|
+
- run: pytest tests/ -m integration -v --tb=short
|
|
37
|
+
env:
|
|
38
|
+
SOLWYN_TEST_API_URL: ${{ secrets.SOLWYN_TEST_API_URL }}
|
|
39
|
+
SOLWYN_TEST_API_KEY: ${{ secrets.SOLWYN_TEST_API_KEY }}
|
|
40
|
+
SOLWYN_TEST_PROJECT_ID: ${{ secrets.SOLWYN_TEST_PROJECT_ID }}
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
name: Publish
|
|
2
|
+
on:
|
|
3
|
+
push:
|
|
4
|
+
tags: ["v*"]
|
|
5
|
+
|
|
6
|
+
jobs:
|
|
7
|
+
test:
|
|
8
|
+
runs-on: ubuntu-latest
|
|
9
|
+
steps:
|
|
10
|
+
- uses: actions/checkout@v6
|
|
11
|
+
- uses: actions/setup-python@v6
|
|
12
|
+
with:
|
|
13
|
+
python-version: "3.12"
|
|
14
|
+
- run: pip install -e ".[dev]"
|
|
15
|
+
- run: ruff check src/ tests/
|
|
16
|
+
- run: pytest tests/ -m unit -v --tb=short
|
|
17
|
+
|
|
18
|
+
publish:
|
|
19
|
+
needs: test
|
|
20
|
+
runs-on: ubuntu-latest
|
|
21
|
+
environment:
|
|
22
|
+
name: pypi
|
|
23
|
+
url: https://pypi.org/p/solwyn
|
|
24
|
+
permissions:
|
|
25
|
+
id-token: write
|
|
26
|
+
steps:
|
|
27
|
+
- uses: actions/checkout@v6
|
|
28
|
+
- uses: actions/setup-python@v6
|
|
29
|
+
with:
|
|
30
|
+
python-version: "3.12"
|
|
31
|
+
- run: pip install hatch
|
|
32
|
+
- run: hatch build
|
|
33
|
+
- uses: pypa/gh-action-pypi-publish@release/v1
|
solwyn-0.1.0/.gitignore
ADDED
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
# Python
|
|
2
|
+
__pycache__/
|
|
3
|
+
*.py[cod]
|
|
4
|
+
*$py.class
|
|
5
|
+
*.egg-info/
|
|
6
|
+
*.egg
|
|
7
|
+
dist/
|
|
8
|
+
build/
|
|
9
|
+
.eggs/
|
|
10
|
+
|
|
11
|
+
# Virtual environments
|
|
12
|
+
.venv/
|
|
13
|
+
venv/
|
|
14
|
+
|
|
15
|
+
# Type checking
|
|
16
|
+
.mypy_cache/
|
|
17
|
+
|
|
18
|
+
# Linting
|
|
19
|
+
.ruff_cache/
|
|
20
|
+
|
|
21
|
+
# Testing
|
|
22
|
+
.pytest_cache/
|
|
23
|
+
htmlcov/
|
|
24
|
+
.coverage
|
|
25
|
+
|
|
26
|
+
# IDE
|
|
27
|
+
.idea/
|
|
28
|
+
.vscode/
|
|
29
|
+
*.swp
|
|
30
|
+
*.swo
|
|
31
|
+
|
|
32
|
+
# Environment
|
|
33
|
+
.env
|
|
34
|
+
.env.*
|
|
35
|
+
|
|
36
|
+
# Claude Code local state
|
|
37
|
+
.claude/
|
solwyn-0.1.0/CLAUDE.md
ADDED
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
# Solwyn Python SDK
|
|
2
|
+
|
|
3
|
+
Drop-in wrapper for `openai`, `anthropic`, and `google.generativeai` clients. Extracts token details, enforces budgets, handles failover — never computes cost (the API owns pricing).
|
|
4
|
+
|
|
5
|
+
## Commands
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
make check # full quality gate (lint + format + typecheck)
|
|
9
|
+
make test # unit tests (~1.5s)
|
|
10
|
+
make test-integration # integration tests (needs API at localhost:8080)
|
|
11
|
+
make install # install in dev mode
|
|
12
|
+
make install-hooks # install pre-commit hook
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Architecture
|
|
16
|
+
|
|
17
|
+
```
|
|
18
|
+
Solwyn SDK (this repo) Solwyn Cloud API
|
|
19
|
+
┌──────────────────────┐ ┌─────────────────┐
|
|
20
|
+
│ your code │ token counts │ PricingService │
|
|
21
|
+
│ ↓ │ (no cost) │ Budget state │
|
|
22
|
+
│ Solwyn(OpenAI()) │ ──────────────>│ Cost dashboard │
|
|
23
|
+
│ ↓ │ └─────────────────┘
|
|
24
|
+
│ LLM provider <──────│── direct call
|
|
25
|
+
└──────────────────────┘
|
|
26
|
+
|
|
27
|
+
_SolwynBase # Shared sans-I/O logic (config, token estimation, metadata)
|
|
28
|
+
├── Solwyn # Sync: httpx.Client
|
|
29
|
+
└── AsyncSolwyn # Async: httpx.AsyncClient
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
## Rules
|
|
33
|
+
|
|
34
|
+
- NEVER capture, log, or transmit prompts or responses
|
|
35
|
+
- All business logic in `_base.py` (sans-I/O); client classes are thin I/O wrappers
|
|
36
|
+
- httpx for HTTP (already a transitive dep of openai/anthropic SDKs)
|
|
37
|
+
- tiktoken is optional — always provide heuristic fallback
|
|
38
|
+
- Runtime invariants use `raise RuntimeError(...)`, not `assert` — Python's `-O` strips asserts. Enforced by `tests/unit/test_no_production_asserts.py`.
|
|
39
|
+
- Pydantic v2 only — `ConfigDict(...)`, `@model_validator`, `.model_dump()`. No v1 patterns.
|
|
40
|
+
|
|
41
|
+
## Key Conventions
|
|
42
|
+
|
|
43
|
+
- Pydantic models use `extra="forbid"` — catches typos and contract drift
|
|
44
|
+
- Response models (e.g. `BudgetCheckResponse`) use `Field(...)` for all fields the API returns — no silent defaults that mask contract changes
|
|
45
|
+
- Provider adapter registry lazy-loads concrete adapters on first call
|
|
46
|
+
- `check_budget(provider=...)` is required and keyword-only
|
|
47
|
+
- Consecutive confirm_cost failures are tracked — after 10, logs at ERROR level
|
|
48
|
+
|
|
49
|
+
## Privacy
|
|
50
|
+
|
|
51
|
+
`_privacy.py` is the ONLY module that touches customer prompt content. Never log, store, or concatenate prompt text outside this module. CI-enforced by `tests/unit/test_privacy_firewall.py`.
|
solwyn-0.1.0/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
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 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
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright [yyyy] [name of copyright owner]
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
solwyn-0.1.0/Makefile
ADDED
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
.PHONY: install install-hooks lint fmt fmt-check typecheck test test-unit test-integration check
|
|
2
|
+
|
|
3
|
+
##@ Setup
|
|
4
|
+
|
|
5
|
+
install: ## Install package in dev mode
|
|
6
|
+
uv pip install -e ".[dev]"
|
|
7
|
+
|
|
8
|
+
install-hooks: ## Install git pre-commit hook
|
|
9
|
+
@hook_dir=$$(git rev-parse --git-common-dir)/hooks && \
|
|
10
|
+
mkdir -p "$$hook_dir" && \
|
|
11
|
+
if [ -f "$$hook_dir/pre-commit" ]; then \
|
|
12
|
+
echo "Backing up existing pre-commit hook"; \
|
|
13
|
+
cp "$$hook_dir/pre-commit" "$$hook_dir/pre-commit.bak"; \
|
|
14
|
+
fi && \
|
|
15
|
+
cp scripts/pre-commit "$$hook_dir/pre-commit" && \
|
|
16
|
+
chmod +x "$$hook_dir/pre-commit" && \
|
|
17
|
+
echo "Pre-commit hook installed"
|
|
18
|
+
|
|
19
|
+
##@ Quality
|
|
20
|
+
|
|
21
|
+
lint: ## Run ruff linter
|
|
22
|
+
uv run ruff check src/ tests/
|
|
23
|
+
|
|
24
|
+
fmt: ## Auto-format code
|
|
25
|
+
uv run ruff format src/ tests/
|
|
26
|
+
uv run ruff check --fix src/ tests/
|
|
27
|
+
|
|
28
|
+
fmt-check: ## Check formatting without changes
|
|
29
|
+
uv run ruff format --check src/ tests/
|
|
30
|
+
|
|
31
|
+
typecheck: ## Run mypy strict type checking
|
|
32
|
+
uv run mypy src/solwyn/
|
|
33
|
+
|
|
34
|
+
check: lint fmt-check typecheck ## Full quality gate (pre-commit hook)
|
|
35
|
+
|
|
36
|
+
##@ Testing
|
|
37
|
+
|
|
38
|
+
test: test-unit ## Run unit tests (default)
|
|
39
|
+
|
|
40
|
+
test-unit: ## Run unit tests
|
|
41
|
+
uv run pytest tests/ -m unit -v --tb=short
|
|
42
|
+
|
|
43
|
+
test-integration: ## Run integration tests (requires API at localhost:8080)
|
|
44
|
+
uv run pytest tests/ -m integration -v --tb=short
|
solwyn-0.1.0/PKG-INFO
ADDED
|
@@ -0,0 +1,250 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: solwyn
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: AI Agent Control Plane SDK — hard spending caps, automatic failover, per-agent cost attribution
|
|
5
|
+
Project-URL: Homepage, https://solwyn.ai
|
|
6
|
+
Project-URL: Documentation, https://docs.solwyn.ai
|
|
7
|
+
Project-URL: Repository, https://github.com/solwyn-ai/solwyn-python
|
|
8
|
+
Project-URL: Bug Tracker, https://github.com/solwyn-ai/solwyn-python/issues
|
|
9
|
+
Project-URL: Model Pricing, https://mpi.sh
|
|
10
|
+
Author-email: Solwyn <hello@solwyn.ai>
|
|
11
|
+
License-Expression: Apache-2.0
|
|
12
|
+
License-File: LICENSE
|
|
13
|
+
Keywords: agent,ai,cost-management,llm,observability
|
|
14
|
+
Classifier: Development Status :: 3 - Alpha
|
|
15
|
+
Classifier: License :: OSI Approved :: Apache Software License
|
|
16
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
17
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
18
|
+
Classifier: Topic :: Software Development :: Libraries
|
|
19
|
+
Requires-Python: >=3.11
|
|
20
|
+
Requires-Dist: httpx>=0.27
|
|
21
|
+
Requires-Dist: pydantic>=2.0
|
|
22
|
+
Provides-Extra: dev
|
|
23
|
+
Requires-Dist: mypy>=1.10; extra == 'dev'
|
|
24
|
+
Requires-Dist: pytest-asyncio>=0.24; extra == 'dev'
|
|
25
|
+
Requires-Dist: pytest>=8.0; extra == 'dev'
|
|
26
|
+
Requires-Dist: ruff>=0.4; extra == 'dev'
|
|
27
|
+
Provides-Extra: openai
|
|
28
|
+
Requires-Dist: tiktoken>=0.7; extra == 'openai'
|
|
29
|
+
Description-Content-Type: text/markdown
|
|
30
|
+
|
|
31
|
+
# Solwyn Python SDK
|
|
32
|
+
|
|
33
|
+
Budget enforcement, circuit breaking, and usage tracking for OpenAI, Anthropic, and Google LLM clients.
|
|
34
|
+
|
|
35
|
+
[](https://github.com/solwyn-ai/solwyn-python/actions/workflows/ci.yml)
|
|
36
|
+
[](https://pypi.org/project/solwyn/)
|
|
37
|
+
[](https://pypi.org/project/solwyn/)
|
|
38
|
+
[](LICENSE)
|
|
39
|
+
|
|
40
|
+
Solwyn wraps your existing LLM client. Calls go directly to the provider — the SDK only reports metadata (token counts, latency, model name) to the Solwyn API. **Prompts and responses never leave your application.**
|
|
41
|
+
|
|
42
|
+
## Installation
|
|
43
|
+
|
|
44
|
+
```sh
|
|
45
|
+
pip install solwyn
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
For improved token estimation with OpenAI models:
|
|
49
|
+
|
|
50
|
+
```sh
|
|
51
|
+
pip install solwyn[openai]
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
## Quick Start
|
|
55
|
+
|
|
56
|
+
```python
|
|
57
|
+
from openai import OpenAI
|
|
58
|
+
from solwyn import Solwyn
|
|
59
|
+
|
|
60
|
+
client = Solwyn(
|
|
61
|
+
OpenAI(),
|
|
62
|
+
api_key="sk_solwyn_...",
|
|
63
|
+
project_id="proj_abc12345",
|
|
64
|
+
)
|
|
65
|
+
|
|
66
|
+
response = client.chat.completions.create(
|
|
67
|
+
model="gpt-4o",
|
|
68
|
+
messages=[{"role": "user", "content": "Hello!"}],
|
|
69
|
+
)
|
|
70
|
+
|
|
71
|
+
client.close()
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
Or use as a context manager:
|
|
75
|
+
|
|
76
|
+
```python
|
|
77
|
+
with Solwyn(OpenAI(), api_key="sk_solwyn_...", project_id="proj_abc12345") as client:
|
|
78
|
+
response = client.chat.completions.create(
|
|
79
|
+
model="gpt-4o",
|
|
80
|
+
messages=[{"role": "user", "content": "Hello!"}],
|
|
81
|
+
)
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
## Providers
|
|
85
|
+
|
|
86
|
+
### OpenAI
|
|
87
|
+
|
|
88
|
+
```python
|
|
89
|
+
from openai import OpenAI
|
|
90
|
+
from solwyn import Solwyn
|
|
91
|
+
|
|
92
|
+
client = Solwyn(OpenAI(), api_key="sk_solwyn_...", project_id="proj_abc12345")
|
|
93
|
+
response = client.chat.completions.create(model="gpt-4o", messages=[...])
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
### Anthropic
|
|
97
|
+
|
|
98
|
+
```python
|
|
99
|
+
from anthropic import Anthropic
|
|
100
|
+
from solwyn import Solwyn
|
|
101
|
+
|
|
102
|
+
client = Solwyn(Anthropic(), api_key="sk_solwyn_...", project_id="proj_abc12345")
|
|
103
|
+
response = client.messages.create(model="claude-sonnet-4-20250514", max_tokens=1024, messages=[...])
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
### Google Gemini
|
|
107
|
+
|
|
108
|
+
```python
|
|
109
|
+
from google import genai
|
|
110
|
+
from solwyn import Solwyn
|
|
111
|
+
|
|
112
|
+
client = Solwyn(genai.Client(api_key="..."), api_key="sk_solwyn_...", project_id="proj_abc12345")
|
|
113
|
+
response = client.models.generate_content(model="gemini-2.0-flash", contents="Hello!")
|
|
114
|
+
```
|
|
115
|
+
|
|
116
|
+
## Async
|
|
117
|
+
|
|
118
|
+
```python
|
|
119
|
+
from openai import AsyncOpenAI
|
|
120
|
+
from solwyn import AsyncSolwyn
|
|
121
|
+
|
|
122
|
+
async with AsyncSolwyn(
|
|
123
|
+
AsyncOpenAI(),
|
|
124
|
+
api_key="sk_solwyn_...",
|
|
125
|
+
project_id="proj_abc12345",
|
|
126
|
+
) as client:
|
|
127
|
+
response = await client.chat.completions.create(
|
|
128
|
+
model="gpt-4o",
|
|
129
|
+
messages=[{"role": "user", "content": "Hello!"}],
|
|
130
|
+
)
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
## Streaming
|
|
134
|
+
|
|
135
|
+
Pass `stream=True` as you normally would. Solwyn wraps the stream transparently and reports usage when it completes:
|
|
136
|
+
|
|
137
|
+
```python
|
|
138
|
+
stream = client.chat.completions.create(
|
|
139
|
+
model="gpt-4o",
|
|
140
|
+
messages=[{"role": "user", "content": "Hello!"}],
|
|
141
|
+
stream=True,
|
|
142
|
+
)
|
|
143
|
+
|
|
144
|
+
for chunk in stream:
|
|
145
|
+
print(chunk.choices[0].delta.content or "", end="")
|
|
146
|
+
```
|
|
147
|
+
|
|
148
|
+
## Budget Enforcement
|
|
149
|
+
|
|
150
|
+
Set `budget_mode` to control spending:
|
|
151
|
+
|
|
152
|
+
```python
|
|
153
|
+
client = Solwyn(
|
|
154
|
+
OpenAI(),
|
|
155
|
+
api_key="sk_solwyn_...",
|
|
156
|
+
project_id="proj_abc12345",
|
|
157
|
+
budget_mode="hard_deny",
|
|
158
|
+
)
|
|
159
|
+
```
|
|
160
|
+
|
|
161
|
+
| Mode | Behavior |
|
|
162
|
+
|------|----------|
|
|
163
|
+
| `alert_only` | Log a warning when budget is exceeded (default) |
|
|
164
|
+
| `hard_deny` | Raise `BudgetExceededError` and block the call |
|
|
165
|
+
|
|
166
|
+
```python
|
|
167
|
+
from solwyn import BudgetExceededError
|
|
168
|
+
|
|
169
|
+
try:
|
|
170
|
+
response = client.chat.completions.create(model="gpt-4o", messages=[...])
|
|
171
|
+
except BudgetExceededError as e:
|
|
172
|
+
print(f"Budget limit: ${e.budget_limit}, usage: ${e.current_usage}")
|
|
173
|
+
```
|
|
174
|
+
|
|
175
|
+
## Configuration
|
|
176
|
+
|
|
177
|
+
| Parameter | Env Var | Default | Description |
|
|
178
|
+
|-----------|---------|---------|-------------|
|
|
179
|
+
| `api_key` | `SOLWYN_API_KEY` | *required* | Solwyn API key |
|
|
180
|
+
| `project_id` | `SOLWYN_PROJECT_ID` | *required* | Project identifier |
|
|
181
|
+
| `api_url` | `SOLWYN_API_URL` | `https://api.solwyn.ai` | Solwyn API endpoint |
|
|
182
|
+
| `fail_open` | `SOLWYN_FAIL_OPEN` | `True` | Allow LLM calls when Solwyn API is unreachable |
|
|
183
|
+
| `budget_mode` | `SOLWYN_BUDGET_MODE` | `alert_only` | Budget enforcement mode |
|
|
184
|
+
| `fallback_provider` | `SOLWYN_FALLBACK_PROVIDER` | `None` | Failover provider when primary circuit breaks |
|
|
185
|
+
|
|
186
|
+
Use env vars to avoid passing credentials in code:
|
|
187
|
+
|
|
188
|
+
```sh
|
|
189
|
+
export SOLWYN_API_KEY="sk_solwyn_..."
|
|
190
|
+
export SOLWYN_PROJECT_ID="proj_abc12345"
|
|
191
|
+
```
|
|
192
|
+
|
|
193
|
+
```python
|
|
194
|
+
client = Solwyn(OpenAI()) # picks up from environment
|
|
195
|
+
```
|
|
196
|
+
|
|
197
|
+
## Error Handling
|
|
198
|
+
|
|
199
|
+
All SDK errors inherit from `SolwynError`:
|
|
200
|
+
|
|
201
|
+
| Exception | Raised when |
|
|
202
|
+
|-----------|-------------|
|
|
203
|
+
| `BudgetExceededError` | Budget exceeded in `hard_deny` mode |
|
|
204
|
+
| `ProviderUnavailableError` | Circuit breaker is open and no fallback exists |
|
|
205
|
+
| `ConfigurationError` | Invalid API key or project ID format |
|
|
206
|
+
|
|
207
|
+
Provider errors (e.g., `openai.RateLimitError`) pass through unmodified.
|
|
208
|
+
|
|
209
|
+
## Data Transparency
|
|
210
|
+
|
|
211
|
+
The SDK sends a `MetadataEvent` after each LLM call. This is everything it transmits:
|
|
212
|
+
|
|
213
|
+
| Field | Type | Description |
|
|
214
|
+
|-------|------|-------------|
|
|
215
|
+
| `project_id` | `str` | Project identifier |
|
|
216
|
+
| `model` | `str` | Model name (e.g., `gpt-4o`) |
|
|
217
|
+
| `provider` | `str` | `openai`, `anthropic`, or `google` |
|
|
218
|
+
| `input_tokens` | `int` | Input token count |
|
|
219
|
+
| `output_tokens` | `int` | Output token count |
|
|
220
|
+
| `token_details` | `object` | Breakdown: cached, reasoning, audio tokens |
|
|
221
|
+
| `latency_ms` | `float` | Call duration in milliseconds |
|
|
222
|
+
| `status` | `str` | `success`, `error`, or `budget_denied` |
|
|
223
|
+
| `is_failover` | `bool` | Whether a fallback provider was used |
|
|
224
|
+
| `sdk_instance_id` | `str` | Per-process UUID for deduplication |
|
|
225
|
+
| `timestamp` | `datetime` | When the call completed (UTC) |
|
|
226
|
+
|
|
227
|
+
**The SDK never captures, logs, or transmits prompts or responses.** This is enforced by [structural tests](tests/unit/test_privacy_firewall.py) and the [privacy module](src/solwyn/_privacy.py).
|
|
228
|
+
|
|
229
|
+
## Requirements
|
|
230
|
+
|
|
231
|
+
Python 3.11+
|
|
232
|
+
|
|
233
|
+
## Contributing
|
|
234
|
+
|
|
235
|
+
```sh
|
|
236
|
+
make install # install in dev mode
|
|
237
|
+
make install-hooks # install pre-commit hook
|
|
238
|
+
make check # lint + format + typecheck
|
|
239
|
+
make test # run unit tests
|
|
240
|
+
```
|
|
241
|
+
|
|
242
|
+
## Links
|
|
243
|
+
|
|
244
|
+
- [Documentation](https://docs.solwyn.ai)
|
|
245
|
+
- [Solwyn Cloud](https://solwyn.ai) — Dashboard, alerts, and analytics
|
|
246
|
+
- [MPI.sh](https://mpi.sh) — LLM API pricing comparison
|
|
247
|
+
|
|
248
|
+
## License
|
|
249
|
+
|
|
250
|
+
Apache 2.0 — see [LICENSE](LICENSE) for details.
|