revenium-middleware 0.2.2__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.
- revenium_middleware-0.2.2/LICENSE +201 -0
- revenium_middleware-0.2.2/PKG-INFO +143 -0
- revenium_middleware-0.2.2/README.md +103 -0
- revenium_middleware-0.2.2/pyproject.toml +50 -0
- revenium_middleware-0.2.2/revenium_middleware.egg-info/PKG-INFO +143 -0
- revenium_middleware-0.2.2/revenium_middleware.egg-info/SOURCES.txt +11 -0
- revenium_middleware-0.2.2/revenium_middleware.egg-info/dependency_links.txt +1 -0
- revenium_middleware-0.2.2/revenium_middleware.egg-info/requires.txt +18 -0
- revenium_middleware-0.2.2/revenium_middleware.egg-info/top_level.txt +1 -0
- revenium_middleware-0.2.2/revenium_middleware_core/__init__.py +4 -0
- revenium_middleware-0.2.2/revenium_middleware_core/metering.py +98 -0
- revenium_middleware-0.2.2/setup.cfg +4 -0
- revenium_middleware-0.2.2/tests/test_metering.py +68 -0
|
@@ -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.
|
|
@@ -0,0 +1,143 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: revenium-middleware
|
|
3
|
+
Version: 0.2.2
|
|
4
|
+
Summary: A Python library that provides core functionality to send AI metering data to Revenium.
|
|
5
|
+
Author-email: Revenium <info@revenium.io>
|
|
6
|
+
License: Apache License 2.0
|
|
7
|
+
Project-URL: Homepage, https://github.com/revenium/revenium-middleware-core-python
|
|
8
|
+
Project-URL: Bug Tracker, https://github.com/revenium/revenium-middleware-core-python/issues
|
|
9
|
+
Project-URL: Documentation, https://github.com/revenium/revenium-middleware-core-python/blob/main/README.md
|
|
10
|
+
Keywords: middleware,logging,token-usage,metering,revenium
|
|
11
|
+
Classifier: Development Status :: 4 - Beta
|
|
12
|
+
Classifier: Programming Language :: Python :: 3
|
|
13
|
+
Classifier: Programming Language :: Python :: 3.8
|
|
14
|
+
Classifier: Programming Language :: Python :: 3.9
|
|
15
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
16
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
17
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
18
|
+
Classifier: License :: OSI Approved :: Apache Software License
|
|
19
|
+
Classifier: Operating System :: OS Independent
|
|
20
|
+
Classifier: Intended Audience :: Developers
|
|
21
|
+
Classifier: Topic :: Software Development :: Libraries :: Python Modules
|
|
22
|
+
Requires-Python: >=3.8
|
|
23
|
+
Description-Content-Type: text/markdown
|
|
24
|
+
License-File: LICENSE
|
|
25
|
+
Requires-Dist: revenium_metering
|
|
26
|
+
Provides-Extra: openai
|
|
27
|
+
Requires-Dist: revenium-middleware-openai; extra == "openai"
|
|
28
|
+
Provides-Extra: ollama
|
|
29
|
+
Requires-Dist: revenium-middleware-ollama; extra == "ollama"
|
|
30
|
+
Provides-Extra: anthropic
|
|
31
|
+
Requires-Dist: revenium-middleware-anthropic; extra == "anthropic"
|
|
32
|
+
Provides-Extra: dev
|
|
33
|
+
Requires-Dist: pytest>=7.0.0; extra == "dev"
|
|
34
|
+
Requires-Dist: pytest-cov; extra == "dev"
|
|
35
|
+
Requires-Dist: flake8; extra == "dev"
|
|
36
|
+
Requires-Dist: black; extra == "dev"
|
|
37
|
+
Requires-Dist: mypy; extra == "dev"
|
|
38
|
+
Requires-Dist: freezegun; extra == "dev"
|
|
39
|
+
Dynamic: license-file
|
|
40
|
+
|
|
41
|
+
# 🔄 Revenium Core Middleware
|
|
42
|
+
|
|
43
|
+
[](https://pypi.org/project/revenium-middleware-core/)
|
|
44
|
+
[](https://pypi.org/project/revenium-middleware-core/)
|
|
45
|
+
[](https://www.apache.org/licenses/LICENSE-2.0)
|
|
46
|
+
|
|
47
|
+
A foundational library that provides core metering functionality shared across all Revenium AI provider-specific middleware implementations (OpenAI, Anthropic, Ollama, etc). 🐍✨
|
|
48
|
+
|
|
49
|
+
## ✨ Features
|
|
50
|
+
|
|
51
|
+
- **🧠 Shared Core Functionality**: Provides the essential metering infrastructure used by all Revenium middleware implementations
|
|
52
|
+
- **🔄 Asynchronous Processing**: Background thread management for non-blocking metering operations
|
|
53
|
+
- **🛑 Graceful Shutdown**: Ensures all metering data is properly sent even during application shutdown
|
|
54
|
+
- **🔌 Provider Agnostic**: Designed to work with any AI provider through specific middleware implementations
|
|
55
|
+
|
|
56
|
+
## 📥 Installation
|
|
57
|
+
|
|
58
|
+
```bash
|
|
59
|
+
pip install revenium-middleware-core
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
## 🔧 Usage
|
|
63
|
+
|
|
64
|
+
### 🔄 Direct Usage
|
|
65
|
+
|
|
66
|
+
While this package is primarily intended as a dependency for provider-specific middleware, you can use it directly:
|
|
67
|
+
|
|
68
|
+
```python
|
|
69
|
+
from revenium_middleware_core import client, run_async_in_thread, shutdown_event
|
|
70
|
+
|
|
71
|
+
# Record usage directly
|
|
72
|
+
client.record_usage(
|
|
73
|
+
model="gpt-4",
|
|
74
|
+
prompt_tokens=500,
|
|
75
|
+
completion_tokens=200,
|
|
76
|
+
user_id="user123",
|
|
77
|
+
session_id="session456"
|
|
78
|
+
)
|
|
79
|
+
|
|
80
|
+
# Run async metering tasks in background threads
|
|
81
|
+
async def async_metering_task():
|
|
82
|
+
await client.async_record_usage(
|
|
83
|
+
model="gpt-3.5-turbo",
|
|
84
|
+
prompt_tokens=300,
|
|
85
|
+
completion_tokens=150,
|
|
86
|
+
user_id="user789"
|
|
87
|
+
)
|
|
88
|
+
|
|
89
|
+
thread = run_async_in_thread(async_metering_task())
|
|
90
|
+
|
|
91
|
+
# Application continues while metering happens in background
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
### 🏗️ Building Provider-Specific Middleware
|
|
95
|
+
|
|
96
|
+
This library is designed to be extended by provider-specific middleware implementations:
|
|
97
|
+
|
|
98
|
+
```python
|
|
99
|
+
from revenium_middleware_core import client, run_async_in_thread
|
|
100
|
+
|
|
101
|
+
# Example of how a provider-specific middleware might use the core
|
|
102
|
+
def record_provider_usage(response_data, metadata):
|
|
103
|
+
# Extract token counts from provider-specific response format
|
|
104
|
+
prompt_tokens = response_data.usage.prompt_tokens
|
|
105
|
+
completion_tokens = response_data.usage.completion_tokens
|
|
106
|
+
|
|
107
|
+
# Use the core client to record the usage
|
|
108
|
+
run_async_in_thread(
|
|
109
|
+
client.async_record_usage(
|
|
110
|
+
model=response_data.model,
|
|
111
|
+
prompt_tokens=prompt_tokens,
|
|
112
|
+
completion_tokens=completion_tokens,
|
|
113
|
+
**metadata
|
|
114
|
+
)
|
|
115
|
+
)
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
## 🔄 Compatibility
|
|
119
|
+
|
|
120
|
+
- 🐍 Python 3.8+
|
|
121
|
+
- 🤝 Compatible with all Revenium provider-specific middleware implementations
|
|
122
|
+
|
|
123
|
+
## 📚 Documentation
|
|
124
|
+
|
|
125
|
+
For more detailed documentation, please refer to the docstrings in the code or visit our GitHub repository.
|
|
126
|
+
|
|
127
|
+
## 👥 Contributing
|
|
128
|
+
|
|
129
|
+
Contributions are welcome! Please check out our contributing guidelines for details.
|
|
130
|
+
|
|
131
|
+
1. 🍴 Fork the repository
|
|
132
|
+
2. 🌿 Create your feature branch (`git checkout -b feature/amazing-feature`)
|
|
133
|
+
3. 💾 Commit your changes (`git commit -m 'Add some amazing feature'`)
|
|
134
|
+
4. 🚀 Push to the branch (`git push origin feature/amazing-feature`)
|
|
135
|
+
5. 🔍 Open a Pull Request
|
|
136
|
+
|
|
137
|
+
## 📄 License
|
|
138
|
+
|
|
139
|
+
This project is licensed under the Apache Software License - see the LICENSE file for details.
|
|
140
|
+
|
|
141
|
+
## 🙏 Acknowledgments
|
|
142
|
+
|
|
143
|
+
- 💖 Built with ❤️ by the Revenium team
|
|
@@ -0,0 +1,103 @@
|
|
|
1
|
+
# 🔄 Revenium Core Middleware
|
|
2
|
+
|
|
3
|
+
[](https://pypi.org/project/revenium-middleware-core/)
|
|
4
|
+
[](https://pypi.org/project/revenium-middleware-core/)
|
|
5
|
+
[](https://www.apache.org/licenses/LICENSE-2.0)
|
|
6
|
+
|
|
7
|
+
A foundational library that provides core metering functionality shared across all Revenium AI provider-specific middleware implementations (OpenAI, Anthropic, Ollama, etc). 🐍✨
|
|
8
|
+
|
|
9
|
+
## ✨ Features
|
|
10
|
+
|
|
11
|
+
- **🧠 Shared Core Functionality**: Provides the essential metering infrastructure used by all Revenium middleware implementations
|
|
12
|
+
- **🔄 Asynchronous Processing**: Background thread management for non-blocking metering operations
|
|
13
|
+
- **🛑 Graceful Shutdown**: Ensures all metering data is properly sent even during application shutdown
|
|
14
|
+
- **🔌 Provider Agnostic**: Designed to work with any AI provider through specific middleware implementations
|
|
15
|
+
|
|
16
|
+
## 📥 Installation
|
|
17
|
+
|
|
18
|
+
```bash
|
|
19
|
+
pip install revenium-middleware-core
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
## 🔧 Usage
|
|
23
|
+
|
|
24
|
+
### 🔄 Direct Usage
|
|
25
|
+
|
|
26
|
+
While this package is primarily intended as a dependency for provider-specific middleware, you can use it directly:
|
|
27
|
+
|
|
28
|
+
```python
|
|
29
|
+
from revenium_middleware_core import client, run_async_in_thread, shutdown_event
|
|
30
|
+
|
|
31
|
+
# Record usage directly
|
|
32
|
+
client.record_usage(
|
|
33
|
+
model="gpt-4",
|
|
34
|
+
prompt_tokens=500,
|
|
35
|
+
completion_tokens=200,
|
|
36
|
+
user_id="user123",
|
|
37
|
+
session_id="session456"
|
|
38
|
+
)
|
|
39
|
+
|
|
40
|
+
# Run async metering tasks in background threads
|
|
41
|
+
async def async_metering_task():
|
|
42
|
+
await client.async_record_usage(
|
|
43
|
+
model="gpt-3.5-turbo",
|
|
44
|
+
prompt_tokens=300,
|
|
45
|
+
completion_tokens=150,
|
|
46
|
+
user_id="user789"
|
|
47
|
+
)
|
|
48
|
+
|
|
49
|
+
thread = run_async_in_thread(async_metering_task())
|
|
50
|
+
|
|
51
|
+
# Application continues while metering happens in background
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
### 🏗️ Building Provider-Specific Middleware
|
|
55
|
+
|
|
56
|
+
This library is designed to be extended by provider-specific middleware implementations:
|
|
57
|
+
|
|
58
|
+
```python
|
|
59
|
+
from revenium_middleware_core import client, run_async_in_thread
|
|
60
|
+
|
|
61
|
+
# Example of how a provider-specific middleware might use the core
|
|
62
|
+
def record_provider_usage(response_data, metadata):
|
|
63
|
+
# Extract token counts from provider-specific response format
|
|
64
|
+
prompt_tokens = response_data.usage.prompt_tokens
|
|
65
|
+
completion_tokens = response_data.usage.completion_tokens
|
|
66
|
+
|
|
67
|
+
# Use the core client to record the usage
|
|
68
|
+
run_async_in_thread(
|
|
69
|
+
client.async_record_usage(
|
|
70
|
+
model=response_data.model,
|
|
71
|
+
prompt_tokens=prompt_tokens,
|
|
72
|
+
completion_tokens=completion_tokens,
|
|
73
|
+
**metadata
|
|
74
|
+
)
|
|
75
|
+
)
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
## 🔄 Compatibility
|
|
79
|
+
|
|
80
|
+
- 🐍 Python 3.8+
|
|
81
|
+
- 🤝 Compatible with all Revenium provider-specific middleware implementations
|
|
82
|
+
|
|
83
|
+
## 📚 Documentation
|
|
84
|
+
|
|
85
|
+
For more detailed documentation, please refer to the docstrings in the code or visit our GitHub repository.
|
|
86
|
+
|
|
87
|
+
## 👥 Contributing
|
|
88
|
+
|
|
89
|
+
Contributions are welcome! Please check out our contributing guidelines for details.
|
|
90
|
+
|
|
91
|
+
1. 🍴 Fork the repository
|
|
92
|
+
2. 🌿 Create your feature branch (`git checkout -b feature/amazing-feature`)
|
|
93
|
+
3. 💾 Commit your changes (`git commit -m 'Add some amazing feature'`)
|
|
94
|
+
4. 🚀 Push to the branch (`git push origin feature/amazing-feature`)
|
|
95
|
+
5. 🔍 Open a Pull Request
|
|
96
|
+
|
|
97
|
+
## 📄 License
|
|
98
|
+
|
|
99
|
+
This project is licensed under the Apache Software License - see the LICENSE file for details.
|
|
100
|
+
|
|
101
|
+
## 🙏 Acknowledgments
|
|
102
|
+
|
|
103
|
+
- 💖 Built with ❤️ by the Revenium team
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
[build-system]
|
|
2
|
+
requires = ["setuptools>=42", "wheel"]
|
|
3
|
+
build-backend = "setuptools.build_meta"
|
|
4
|
+
|
|
5
|
+
[project]
|
|
6
|
+
name = "revenium-middleware"
|
|
7
|
+
version = "0.2.2"
|
|
8
|
+
description = "A Python library that provides core functionality to send AI metering data to Revenium."
|
|
9
|
+
readme = "README.md"
|
|
10
|
+
requires-python = ">=3.8"
|
|
11
|
+
license = { text = "Apache License 2.0" }
|
|
12
|
+
authors = [
|
|
13
|
+
{ name = "Revenium", email = "info@revenium.io" }
|
|
14
|
+
]
|
|
15
|
+
dependencies = [
|
|
16
|
+
"revenium_metering"
|
|
17
|
+
]
|
|
18
|
+
keywords = ["middleware", "logging", "token-usage", "metering", "revenium"]
|
|
19
|
+
classifiers = [
|
|
20
|
+
"Development Status :: 4 - Beta",
|
|
21
|
+
"Programming Language :: Python :: 3",
|
|
22
|
+
"Programming Language :: Python :: 3.8",
|
|
23
|
+
"Programming Language :: Python :: 3.9",
|
|
24
|
+
"Programming Language :: Python :: 3.10",
|
|
25
|
+
"Programming Language :: Python :: 3.11",
|
|
26
|
+
"Programming Language :: Python :: 3.12",
|
|
27
|
+
"License :: OSI Approved :: Apache Software License",
|
|
28
|
+
"Operating System :: OS Independent",
|
|
29
|
+
"Intended Audience :: Developers",
|
|
30
|
+
"Topic :: Software Development :: Libraries :: Python Modules"
|
|
31
|
+
]
|
|
32
|
+
|
|
33
|
+
[project.urls]
|
|
34
|
+
"Homepage" = "https://github.com/revenium/revenium-middleware-core-python"
|
|
35
|
+
"Bug Tracker" = "https://github.com/revenium/revenium-middleware-core-python/issues"
|
|
36
|
+
"Documentation" = "https://github.com/revenium/revenium-middleware-core-python/blob/main/README.md"
|
|
37
|
+
|
|
38
|
+
[project.optional-dependencies]
|
|
39
|
+
openai = ["revenium-middleware-openai"]
|
|
40
|
+
ollama = ["revenium-middleware-ollama"]
|
|
41
|
+
anthropic = ["revenium-middleware-anthropic"]
|
|
42
|
+
|
|
43
|
+
dev = [
|
|
44
|
+
"pytest>=7.0.0",
|
|
45
|
+
"pytest-cov",
|
|
46
|
+
"flake8",
|
|
47
|
+
"black",
|
|
48
|
+
"mypy",
|
|
49
|
+
"freezegun"
|
|
50
|
+
]
|
|
@@ -0,0 +1,143 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: revenium-middleware
|
|
3
|
+
Version: 0.2.2
|
|
4
|
+
Summary: A Python library that provides core functionality to send AI metering data to Revenium.
|
|
5
|
+
Author-email: Revenium <info@revenium.io>
|
|
6
|
+
License: Apache License 2.0
|
|
7
|
+
Project-URL: Homepage, https://github.com/revenium/revenium-middleware-core-python
|
|
8
|
+
Project-URL: Bug Tracker, https://github.com/revenium/revenium-middleware-core-python/issues
|
|
9
|
+
Project-URL: Documentation, https://github.com/revenium/revenium-middleware-core-python/blob/main/README.md
|
|
10
|
+
Keywords: middleware,logging,token-usage,metering,revenium
|
|
11
|
+
Classifier: Development Status :: 4 - Beta
|
|
12
|
+
Classifier: Programming Language :: Python :: 3
|
|
13
|
+
Classifier: Programming Language :: Python :: 3.8
|
|
14
|
+
Classifier: Programming Language :: Python :: 3.9
|
|
15
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
16
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
17
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
18
|
+
Classifier: License :: OSI Approved :: Apache Software License
|
|
19
|
+
Classifier: Operating System :: OS Independent
|
|
20
|
+
Classifier: Intended Audience :: Developers
|
|
21
|
+
Classifier: Topic :: Software Development :: Libraries :: Python Modules
|
|
22
|
+
Requires-Python: >=3.8
|
|
23
|
+
Description-Content-Type: text/markdown
|
|
24
|
+
License-File: LICENSE
|
|
25
|
+
Requires-Dist: revenium_metering
|
|
26
|
+
Provides-Extra: openai
|
|
27
|
+
Requires-Dist: revenium-middleware-openai; extra == "openai"
|
|
28
|
+
Provides-Extra: ollama
|
|
29
|
+
Requires-Dist: revenium-middleware-ollama; extra == "ollama"
|
|
30
|
+
Provides-Extra: anthropic
|
|
31
|
+
Requires-Dist: revenium-middleware-anthropic; extra == "anthropic"
|
|
32
|
+
Provides-Extra: dev
|
|
33
|
+
Requires-Dist: pytest>=7.0.0; extra == "dev"
|
|
34
|
+
Requires-Dist: pytest-cov; extra == "dev"
|
|
35
|
+
Requires-Dist: flake8; extra == "dev"
|
|
36
|
+
Requires-Dist: black; extra == "dev"
|
|
37
|
+
Requires-Dist: mypy; extra == "dev"
|
|
38
|
+
Requires-Dist: freezegun; extra == "dev"
|
|
39
|
+
Dynamic: license-file
|
|
40
|
+
|
|
41
|
+
# 🔄 Revenium Core Middleware
|
|
42
|
+
|
|
43
|
+
[](https://pypi.org/project/revenium-middleware-core/)
|
|
44
|
+
[](https://pypi.org/project/revenium-middleware-core/)
|
|
45
|
+
[](https://www.apache.org/licenses/LICENSE-2.0)
|
|
46
|
+
|
|
47
|
+
A foundational library that provides core metering functionality shared across all Revenium AI provider-specific middleware implementations (OpenAI, Anthropic, Ollama, etc). 🐍✨
|
|
48
|
+
|
|
49
|
+
## ✨ Features
|
|
50
|
+
|
|
51
|
+
- **🧠 Shared Core Functionality**: Provides the essential metering infrastructure used by all Revenium middleware implementations
|
|
52
|
+
- **🔄 Asynchronous Processing**: Background thread management for non-blocking metering operations
|
|
53
|
+
- **🛑 Graceful Shutdown**: Ensures all metering data is properly sent even during application shutdown
|
|
54
|
+
- **🔌 Provider Agnostic**: Designed to work with any AI provider through specific middleware implementations
|
|
55
|
+
|
|
56
|
+
## 📥 Installation
|
|
57
|
+
|
|
58
|
+
```bash
|
|
59
|
+
pip install revenium-middleware-core
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
## 🔧 Usage
|
|
63
|
+
|
|
64
|
+
### 🔄 Direct Usage
|
|
65
|
+
|
|
66
|
+
While this package is primarily intended as a dependency for provider-specific middleware, you can use it directly:
|
|
67
|
+
|
|
68
|
+
```python
|
|
69
|
+
from revenium_middleware_core import client, run_async_in_thread, shutdown_event
|
|
70
|
+
|
|
71
|
+
# Record usage directly
|
|
72
|
+
client.record_usage(
|
|
73
|
+
model="gpt-4",
|
|
74
|
+
prompt_tokens=500,
|
|
75
|
+
completion_tokens=200,
|
|
76
|
+
user_id="user123",
|
|
77
|
+
session_id="session456"
|
|
78
|
+
)
|
|
79
|
+
|
|
80
|
+
# Run async metering tasks in background threads
|
|
81
|
+
async def async_metering_task():
|
|
82
|
+
await client.async_record_usage(
|
|
83
|
+
model="gpt-3.5-turbo",
|
|
84
|
+
prompt_tokens=300,
|
|
85
|
+
completion_tokens=150,
|
|
86
|
+
user_id="user789"
|
|
87
|
+
)
|
|
88
|
+
|
|
89
|
+
thread = run_async_in_thread(async_metering_task())
|
|
90
|
+
|
|
91
|
+
# Application continues while metering happens in background
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
### 🏗️ Building Provider-Specific Middleware
|
|
95
|
+
|
|
96
|
+
This library is designed to be extended by provider-specific middleware implementations:
|
|
97
|
+
|
|
98
|
+
```python
|
|
99
|
+
from revenium_middleware_core import client, run_async_in_thread
|
|
100
|
+
|
|
101
|
+
# Example of how a provider-specific middleware might use the core
|
|
102
|
+
def record_provider_usage(response_data, metadata):
|
|
103
|
+
# Extract token counts from provider-specific response format
|
|
104
|
+
prompt_tokens = response_data.usage.prompt_tokens
|
|
105
|
+
completion_tokens = response_data.usage.completion_tokens
|
|
106
|
+
|
|
107
|
+
# Use the core client to record the usage
|
|
108
|
+
run_async_in_thread(
|
|
109
|
+
client.async_record_usage(
|
|
110
|
+
model=response_data.model,
|
|
111
|
+
prompt_tokens=prompt_tokens,
|
|
112
|
+
completion_tokens=completion_tokens,
|
|
113
|
+
**metadata
|
|
114
|
+
)
|
|
115
|
+
)
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
## 🔄 Compatibility
|
|
119
|
+
|
|
120
|
+
- 🐍 Python 3.8+
|
|
121
|
+
- 🤝 Compatible with all Revenium provider-specific middleware implementations
|
|
122
|
+
|
|
123
|
+
## 📚 Documentation
|
|
124
|
+
|
|
125
|
+
For more detailed documentation, please refer to the docstrings in the code or visit our GitHub repository.
|
|
126
|
+
|
|
127
|
+
## 👥 Contributing
|
|
128
|
+
|
|
129
|
+
Contributions are welcome! Please check out our contributing guidelines for details.
|
|
130
|
+
|
|
131
|
+
1. 🍴 Fork the repository
|
|
132
|
+
2. 🌿 Create your feature branch (`git checkout -b feature/amazing-feature`)
|
|
133
|
+
3. 💾 Commit your changes (`git commit -m 'Add some amazing feature'`)
|
|
134
|
+
4. 🚀 Push to the branch (`git push origin feature/amazing-feature`)
|
|
135
|
+
5. 🔍 Open a Pull Request
|
|
136
|
+
|
|
137
|
+
## 📄 License
|
|
138
|
+
|
|
139
|
+
This project is licensed under the Apache Software License - see the LICENSE file for details.
|
|
140
|
+
|
|
141
|
+
## 🙏 Acknowledgments
|
|
142
|
+
|
|
143
|
+
- 💖 Built with ❤️ by the Revenium team
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
LICENSE
|
|
2
|
+
README.md
|
|
3
|
+
pyproject.toml
|
|
4
|
+
revenium_middleware.egg-info/PKG-INFO
|
|
5
|
+
revenium_middleware.egg-info/SOURCES.txt
|
|
6
|
+
revenium_middleware.egg-info/dependency_links.txt
|
|
7
|
+
revenium_middleware.egg-info/requires.txt
|
|
8
|
+
revenium_middleware.egg-info/top_level.txt
|
|
9
|
+
revenium_middleware_core/__init__.py
|
|
10
|
+
revenium_middleware_core/metering.py
|
|
11
|
+
tests/test_metering.py
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
revenium_middleware_core
|
|
@@ -0,0 +1,98 @@
|
|
|
1
|
+
import os
|
|
2
|
+
import time
|
|
3
|
+
import logging
|
|
4
|
+
import asyncio
|
|
5
|
+
import threading
|
|
6
|
+
import atexit
|
|
7
|
+
import signal
|
|
8
|
+
from typing import Literal, Awaitable, Any, Optional, Callable
|
|
9
|
+
from revenium_metering import ReveniumMetering
|
|
10
|
+
|
|
11
|
+
# Define a StopReason literal type for strict typing of stop_reason
|
|
12
|
+
StopReason = Literal["END", "END_SEQUENCE", "TIMEOUT", "TOKEN_LIMIT", "COST_LIMIT", "COMPLETION_LIMIT", "ERROR"]
|
|
13
|
+
|
|
14
|
+
api_key = os.environ.get("REVENIUM_METERING_API_KEY") or "DUMMY_API_KEY"
|
|
15
|
+
client = ReveniumMetering(api_key=api_key)
|
|
16
|
+
|
|
17
|
+
# Keep track of active metering threads
|
|
18
|
+
active_threads = []
|
|
19
|
+
shutdown_event = threading.Event()
|
|
20
|
+
|
|
21
|
+
def handle_exit(*_, **__):
|
|
22
|
+
logging.info("Shutdown initiated, waiting for metering calls to complete...")
|
|
23
|
+
shutdown_event.set()
|
|
24
|
+
|
|
25
|
+
# Give threads a chance to notice the shutdown event
|
|
26
|
+
time.sleep(0.1)
|
|
27
|
+
|
|
28
|
+
for thread in list(active_threads):
|
|
29
|
+
if thread.is_alive():
|
|
30
|
+
logging.debug(f"Waiting for metering thread to finish...")
|
|
31
|
+
thread.join(timeout=5.0)
|
|
32
|
+
if thread.is_alive():
|
|
33
|
+
logging.warning("Metering thread did not complete in time")
|
|
34
|
+
|
|
35
|
+
logging.info("Shutdown complete")
|
|
36
|
+
|
|
37
|
+
atexit.register(handle_exit)
|
|
38
|
+
signal.signal(signal.SIGINT, handle_exit)
|
|
39
|
+
signal.signal(signal.SIGTERM, handle_exit)
|
|
40
|
+
|
|
41
|
+
class MeteringThread(threading.Thread):
|
|
42
|
+
def __init__(self, coro, *args, **kwargs):
|
|
43
|
+
daemon = kwargs.pop('daemon', False) # Default to non-daemon threads
|
|
44
|
+
super().__init__(*args, **kwargs)
|
|
45
|
+
self.coro = coro
|
|
46
|
+
self.daemon = daemon
|
|
47
|
+
self.error = None
|
|
48
|
+
self.loop = None
|
|
49
|
+
|
|
50
|
+
def run(self):
|
|
51
|
+
if shutdown_event.is_set():
|
|
52
|
+
return
|
|
53
|
+
try:
|
|
54
|
+
# Create a new event loop for this thread
|
|
55
|
+
self.loop = asyncio.new_event_loop()
|
|
56
|
+
asyncio.set_event_loop(self.loop)
|
|
57
|
+
try:
|
|
58
|
+
self.loop.run_until_complete(self.coro)
|
|
59
|
+
finally:
|
|
60
|
+
self.loop.run_until_complete(self.loop.shutdown_asyncgens())
|
|
61
|
+
self.loop.close()
|
|
62
|
+
except Exception as e:
|
|
63
|
+
if not shutdown_event.is_set():
|
|
64
|
+
self.error = e
|
|
65
|
+
logging.warning(f"Error in metering thread: {str(e)}")
|
|
66
|
+
finally:
|
|
67
|
+
if self in active_threads:
|
|
68
|
+
active_threads.remove(self)
|
|
69
|
+
|
|
70
|
+
def run_async_in_thread(coroutine_or_func):
|
|
71
|
+
"""
|
|
72
|
+
Helper function to run an async coroutine or a regular function in a background thread
|
|
73
|
+
with better handling of interpreter shutdown.
|
|
74
|
+
|
|
75
|
+
Args:
|
|
76
|
+
coroutine_or_func: Either an awaitable coroutine or a regular function
|
|
77
|
+
|
|
78
|
+
Returns:
|
|
79
|
+
threading.Thread: The thread running the task
|
|
80
|
+
"""
|
|
81
|
+
if shutdown_event.is_set():
|
|
82
|
+
logging.warning("Not starting new metering thread during shutdown")
|
|
83
|
+
return None
|
|
84
|
+
|
|
85
|
+
# Check if we received a coroutine or a regular function
|
|
86
|
+
if asyncio.iscoroutine(coroutine_or_func):
|
|
87
|
+
# It's a coroutine, use it directly
|
|
88
|
+
coro = coroutine_or_func
|
|
89
|
+
else:
|
|
90
|
+
# It's a regular function or already the result, wrap it in a coroutine
|
|
91
|
+
async def wrapper():
|
|
92
|
+
return coroutine_or_func
|
|
93
|
+
coro = wrapper()
|
|
94
|
+
|
|
95
|
+
thread = MeteringThread(coro)
|
|
96
|
+
active_threads.append(thread)
|
|
97
|
+
thread.start()
|
|
98
|
+
return thread
|
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
import pytest
|
|
2
|
+
import logging
|
|
3
|
+
import asyncio
|
|
4
|
+
from unittest.mock import patch, AsyncMock
|
|
5
|
+
|
|
6
|
+
from revenium_middleware_core.metering import (
|
|
7
|
+
active_threads,
|
|
8
|
+
shutdown_event,
|
|
9
|
+
handle_exit,
|
|
10
|
+
run_async_in_thread
|
|
11
|
+
)
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
class TestMetering:
|
|
15
|
+
@pytest.fixture
|
|
16
|
+
def reset_state(self):
|
|
17
|
+
"""Fixture to reset global state before each test."""
|
|
18
|
+
# Clear any active threads
|
|
19
|
+
active_threads.clear()
|
|
20
|
+
shutdown_event.clear()
|
|
21
|
+
yield
|
|
22
|
+
# Cleanup: make sure threads get stopped
|
|
23
|
+
handle_exit()
|
|
24
|
+
|
|
25
|
+
def test_run_async_in_thread_when_shutdown(self, reset_state, caplog):
|
|
26
|
+
"""If shutdown_event is set, run_async_in_thread should log a warning and return None."""
|
|
27
|
+
shutdown_event.set()
|
|
28
|
+
with caplog.at_level(logging.WARNING):
|
|
29
|
+
thread = run_async_in_thread(asyncio.sleep(0.01))
|
|
30
|
+
assert thread is None
|
|
31
|
+
assert "Not starting new metering thread during shutdown" in caplog.text
|
|
32
|
+
|
|
33
|
+
def test_run_async_in_thread_normal(self, reset_state):
|
|
34
|
+
"""Check that run_async_in_thread starts a thread and runs the coroutine."""
|
|
35
|
+
coro_mock = AsyncMock()
|
|
36
|
+
thread = run_async_in_thread(coro_mock)
|
|
37
|
+
assert thread is not None
|
|
38
|
+
thread.join(timeout=1.0)
|
|
39
|
+
# Ensure the thread is removed from active_threads once done
|
|
40
|
+
assert thread not in active_threads
|
|
41
|
+
|
|
42
|
+
def test_metering_thread_error_handling(self, reset_state, caplog):
|
|
43
|
+
"""Ensure MeteringThread logs a warning if an exception occurs."""
|
|
44
|
+
|
|
45
|
+
async def fail_coro():
|
|
46
|
+
raise ValueError("Test error")
|
|
47
|
+
|
|
48
|
+
with caplog.at_level(logging.WARNING):
|
|
49
|
+
thread = run_async_in_thread(fail_coro())
|
|
50
|
+
thread.join(timeout=1.0)
|
|
51
|
+
assert "Error in metering thread: Test error" in caplog.text
|
|
52
|
+
|
|
53
|
+
@patch("signal.signal")
|
|
54
|
+
def test_handle_exit(self, mock_signal, reset_state, caplog):
|
|
55
|
+
"""handle_exit should set the shutdown_event and wait for threads to complete."""
|
|
56
|
+
|
|
57
|
+
# Create a long-running coroutine
|
|
58
|
+
async def long_run():
|
|
59
|
+
await asyncio.sleep(0.2)
|
|
60
|
+
|
|
61
|
+
thread = run_async_in_thread(long_run())
|
|
62
|
+
assert thread is not None
|
|
63
|
+
with caplog.at_level(logging.INFO):
|
|
64
|
+
handle_exit()
|
|
65
|
+
assert shutdown_event.is_set()
|
|
66
|
+
# Thread should have been joined
|
|
67
|
+
assert "Shutdown initiated" in caplog.text
|
|
68
|
+
assert "Shutdown complete" in caplog.text
|