wexample-wex-addon-ai 0.1.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.
@@ -0,0 +1,165 @@
1
+ Metadata-Version: 2.1
2
+ Name: wexample-wex-addon-ai
3
+ Version: 0.1.2
4
+ Summary: AI addon for wex
5
+ Author-Email: weeger <contact@wexample.com>
6
+ License: MIT
7
+ Classifier: Programming Language :: Python :: 3
8
+ Classifier: License :: OSI Approved :: MIT License
9
+ Classifier: Operating System :: OS Independent
10
+ Requires-Python: >=3.10
11
+ Requires-Dist: wexample-wex-core>=6.0.0
12
+ Provides-Extra: dev
13
+ Requires-Dist: pytest; extra == "dev"
14
+ Requires-Dist: pytest-cov; extra == "dev"
15
+ Description-Content-Type: text/markdown
16
+
17
+ # wex_addon_ai
18
+
19
+ Version: 0.1.2
20
+
21
+ AI addon for wex
22
+
23
+ ## Table of Contents
24
+
25
+ - [Tests](#tests)
26
+ - [Suite Integration](#suite-integration)
27
+ - [Dependencies](#dependencies)
28
+ - [Versioning](#versioning)
29
+ - [License](#license)
30
+ - [Suite Integration](#suite-integration)
31
+ - [Suite Signature](#suite-signature)
32
+ - [Introduction](#introduction)
33
+ - [Roadmap](#roadmap)
34
+ - [Status Compatibility](#status-compatibility)
35
+ - [Useful Links](#useful-links)
36
+ - [Migration Notes](#migration-notes)
37
+
38
+ ## Tests
39
+
40
+ This project uses `pytest` for testing and `pytest-cov` for code coverage analysis.
41
+
42
+ ### Installation
43
+
44
+ First, install the required testing dependencies:
45
+ ```bash
46
+ .venv/bin/python -m pip install pytest pytest-cov
47
+ ```
48
+
49
+ ### Basic Usage
50
+
51
+ Run all tests with coverage:
52
+ ```bash
53
+ .venv/bin/python -m pytest --cov --cov-report=html
54
+ ```
55
+
56
+ ### Common Commands
57
+ ```bash
58
+ # Run tests with coverage for a specific module
59
+ .venv/bin/python -m pytest --cov=your_module
60
+
61
+ # Show which lines are not covered
62
+ .venv/bin/python -m pytest --cov=your_module --cov-report=term-missing
63
+
64
+ # Generate an HTML coverage report
65
+ .venv/bin/python -m pytest --cov=your_module --cov-report=html
66
+
67
+ # Combine terminal and HTML reports
68
+ .venv/bin/python -m pytest --cov=your_module --cov-report=term-missing --cov-report=html
69
+
70
+ # Run specific test file with coverage
71
+ .venv/bin/python -m pytest tests/test_file.py --cov=your_module --cov-report=term-missing
72
+ ```
73
+
74
+ ### Viewing HTML Reports
75
+
76
+ After generating an HTML report, open `htmlcov/index.html` in your browser to view detailed line-by-line coverage information.
77
+
78
+ ### Coverage Threshold
79
+
80
+ To enforce a minimum coverage percentage:
81
+ ```bash
82
+ .venv/bin/python -m pytest --cov=your_module --cov-fail-under=80
83
+ ```
84
+
85
+ This will cause the test suite to fail if coverage drops below 80%.
86
+
87
+ ## Integration in the Suite
88
+
89
+ This package is part of the Wexample Suite — a collection of high-quality, modular tools designed to work seamlessly together across multiple languages and environments.
90
+
91
+ ### Related Packages
92
+
93
+ The suite includes packages for configuration management, file handling, prompts, and more. Each package can be used independently or as part of the integrated suite.
94
+
95
+ Visit the [Wexample Suite documentation](https://docs.wexample.com) for the complete package ecosystem.
96
+
97
+ ## Dependencies
98
+
99
+ - wexample-wex-core: >=6.0.0
100
+
101
+ ## Versioning & Compatibility Policy
102
+
103
+ Wexample packages follow **Semantic Versioning** (SemVer):
104
+
105
+ - **MAJOR**: Breaking changes
106
+ - **MINOR**: New features, backward compatible
107
+ - **PATCH**: Bug fixes, backward compatible
108
+
109
+ We maintain backward compatibility within major versions and provide clear migration guides for breaking changes.
110
+
111
+ ## License
112
+
113
+ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
114
+
115
+ Free to use in both personal and commercial projects.
116
+
117
+ ## Integration in the Suite
118
+
119
+ This package is part of the Wexample Suite — a collection of high-quality, modular tools designed to work seamlessly together across multiple languages and environments.
120
+
121
+ ### Related Packages
122
+
123
+ The suite includes packages for configuration management, file handling, prompts, and more. Each package can be used independently or as part of the integrated suite.
124
+
125
+ Visit the [Wexample Suite documentation](https://docs.wexample.com) for the complete package ecosystem.
126
+
127
+ # About us
128
+
129
+ [Wexample](https://wexample.com) stands as a cornerstone of the digital ecosystem — a collective of seasoned engineers, researchers, and creators driven by a relentless pursuit of technological excellence. More than a media platform, it has grown into a vibrant community where innovation meets craftsmanship, and where every line of code reflects a commitment to clarity, durability, and shared intelligence.
130
+
131
+ This packages suite embodies this spirit. Trusted by professionals and enthusiasts alike, it delivers a consistent, high-quality foundation for modern development — open, elegant, and battle-tested. Its reputation is built on years of collaboration, refinement, and rigorous attention to detail, making it a natural choice for those who demand both robustness and beauty in their tools.
132
+
133
+ Wexample cultivates a culture of mastery. Each package, each contribution carries the mark of a community that values precision, ethics, and innovation — a community proud to shape the future of digital craftsmanship.
134
+
135
+ A Python toolkit providing wex addon capabilities for AI integrations.
136
+
137
+ ## Known Limitations & Roadmap
138
+
139
+ Current limitations and planned features are tracked in the GitHub issues.
140
+
141
+ See the [project roadmap](https://github.com/wexample/python-wex_addon_ai/issues) for upcoming features and improvements.
142
+
143
+ ## Status & Compatibility
144
+
145
+ **Maturity**: Production-ready
146
+
147
+ **Python Support**: >=3.10
148
+
149
+ **OS Support**: Linux, macOS, Windows
150
+
151
+ **Status**: Actively maintained
152
+
153
+ ## Useful Links
154
+
155
+ - **Homepage**: https://github.com/wexample/python-wex-addon-ai
156
+ - **Documentation**: [docs.wexample.com](https://docs.wexample.com)
157
+ - **Issue Tracker**: https://github.com/wexample/python-wex-addon-ai/issues
158
+ - **Discussions**: https://github.com/wexample/python-wex-addon-ai/discussions
159
+ - **PyPI**: [pypi.org/project/wex_addon_ai](https://pypi.org/project/wex_addon_ai/)
160
+
161
+ ## Migration Notes
162
+
163
+ When upgrading between major versions, refer to the migration guides in the documentation.
164
+
165
+ Breaking changes are clearly documented with upgrade paths and examples.
@@ -0,0 +1,149 @@
1
+ # wex_addon_ai
2
+
3
+ Version: 0.1.2
4
+
5
+ AI addon for wex
6
+
7
+ ## Table of Contents
8
+
9
+ - [Tests](#tests)
10
+ - [Suite Integration](#suite-integration)
11
+ - [Dependencies](#dependencies)
12
+ - [Versioning](#versioning)
13
+ - [License](#license)
14
+ - [Suite Integration](#suite-integration)
15
+ - [Suite Signature](#suite-signature)
16
+ - [Introduction](#introduction)
17
+ - [Roadmap](#roadmap)
18
+ - [Status Compatibility](#status-compatibility)
19
+ - [Useful Links](#useful-links)
20
+ - [Migration Notes](#migration-notes)
21
+
22
+ ## Tests
23
+
24
+ This project uses `pytest` for testing and `pytest-cov` for code coverage analysis.
25
+
26
+ ### Installation
27
+
28
+ First, install the required testing dependencies:
29
+ ```bash
30
+ .venv/bin/python -m pip install pytest pytest-cov
31
+ ```
32
+
33
+ ### Basic Usage
34
+
35
+ Run all tests with coverage:
36
+ ```bash
37
+ .venv/bin/python -m pytest --cov --cov-report=html
38
+ ```
39
+
40
+ ### Common Commands
41
+ ```bash
42
+ # Run tests with coverage for a specific module
43
+ .venv/bin/python -m pytest --cov=your_module
44
+
45
+ # Show which lines are not covered
46
+ .venv/bin/python -m pytest --cov=your_module --cov-report=term-missing
47
+
48
+ # Generate an HTML coverage report
49
+ .venv/bin/python -m pytest --cov=your_module --cov-report=html
50
+
51
+ # Combine terminal and HTML reports
52
+ .venv/bin/python -m pytest --cov=your_module --cov-report=term-missing --cov-report=html
53
+
54
+ # Run specific test file with coverage
55
+ .venv/bin/python -m pytest tests/test_file.py --cov=your_module --cov-report=term-missing
56
+ ```
57
+
58
+ ### Viewing HTML Reports
59
+
60
+ After generating an HTML report, open `htmlcov/index.html` in your browser to view detailed line-by-line coverage information.
61
+
62
+ ### Coverage Threshold
63
+
64
+ To enforce a minimum coverage percentage:
65
+ ```bash
66
+ .venv/bin/python -m pytest --cov=your_module --cov-fail-under=80
67
+ ```
68
+
69
+ This will cause the test suite to fail if coverage drops below 80%.
70
+
71
+ ## Integration in the Suite
72
+
73
+ This package is part of the Wexample Suite — a collection of high-quality, modular tools designed to work seamlessly together across multiple languages and environments.
74
+
75
+ ### Related Packages
76
+
77
+ The suite includes packages for configuration management, file handling, prompts, and more. Each package can be used independently or as part of the integrated suite.
78
+
79
+ Visit the [Wexample Suite documentation](https://docs.wexample.com) for the complete package ecosystem.
80
+
81
+ ## Dependencies
82
+
83
+ - wexample-wex-core: >=6.0.0
84
+
85
+ ## Versioning & Compatibility Policy
86
+
87
+ Wexample packages follow **Semantic Versioning** (SemVer):
88
+
89
+ - **MAJOR**: Breaking changes
90
+ - **MINOR**: New features, backward compatible
91
+ - **PATCH**: Bug fixes, backward compatible
92
+
93
+ We maintain backward compatibility within major versions and provide clear migration guides for breaking changes.
94
+
95
+ ## License
96
+
97
+ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
98
+
99
+ Free to use in both personal and commercial projects.
100
+
101
+ ## Integration in the Suite
102
+
103
+ This package is part of the Wexample Suite — a collection of high-quality, modular tools designed to work seamlessly together across multiple languages and environments.
104
+
105
+ ### Related Packages
106
+
107
+ The suite includes packages for configuration management, file handling, prompts, and more. Each package can be used independently or as part of the integrated suite.
108
+
109
+ Visit the [Wexample Suite documentation](https://docs.wexample.com) for the complete package ecosystem.
110
+
111
+ # About us
112
+
113
+ [Wexample](https://wexample.com) stands as a cornerstone of the digital ecosystem — a collective of seasoned engineers, researchers, and creators driven by a relentless pursuit of technological excellence. More than a media platform, it has grown into a vibrant community where innovation meets craftsmanship, and where every line of code reflects a commitment to clarity, durability, and shared intelligence.
114
+
115
+ This packages suite embodies this spirit. Trusted by professionals and enthusiasts alike, it delivers a consistent, high-quality foundation for modern development — open, elegant, and battle-tested. Its reputation is built on years of collaboration, refinement, and rigorous attention to detail, making it a natural choice for those who demand both robustness and beauty in their tools.
116
+
117
+ Wexample cultivates a culture of mastery. Each package, each contribution carries the mark of a community that values precision, ethics, and innovation — a community proud to shape the future of digital craftsmanship.
118
+
119
+ A Python toolkit providing wex addon capabilities for AI integrations.
120
+
121
+ ## Known Limitations & Roadmap
122
+
123
+ Current limitations and planned features are tracked in the GitHub issues.
124
+
125
+ See the [project roadmap](https://github.com/wexample/python-wex_addon_ai/issues) for upcoming features and improvements.
126
+
127
+ ## Status & Compatibility
128
+
129
+ **Maturity**: Production-ready
130
+
131
+ **Python Support**: >=3.10
132
+
133
+ **OS Support**: Linux, macOS, Windows
134
+
135
+ **Status**: Actively maintained
136
+
137
+ ## Useful Links
138
+
139
+ - **Homepage**: https://github.com/wexample/python-wex-addon-ai
140
+ - **Documentation**: [docs.wexample.com](https://docs.wexample.com)
141
+ - **Issue Tracker**: https://github.com/wexample/python-wex-addon-ai/issues
142
+ - **Discussions**: https://github.com/wexample/python-wex-addon-ai/discussions
143
+ - **PyPI**: [pypi.org/project/wex_addon_ai](https://pypi.org/project/wex_addon_ai/)
144
+
145
+ ## Migration Notes
146
+
147
+ When upgrading between major versions, refer to the migration guides in the documentation.
148
+
149
+ Breaking changes are clearly documented with upgrade paths and examples.
@@ -0,0 +1,81 @@
1
+ [build-system]
2
+ requires = [
3
+ "pdm-backend",
4
+ ]
5
+ build-backend = "pdm.backend"
6
+
7
+ [project]
8
+ name = "wexample-wex-addon-ai"
9
+ version = "0.1.2"
10
+ description = "AI addon for wex"
11
+ authors = [
12
+ { name = "weeger", email = "contact@wexample.com" },
13
+ ]
14
+ requires-python = ">=3.10"
15
+ classifiers = [
16
+ "Programming Language :: Python :: 3",
17
+ "License :: OSI Approved :: MIT License",
18
+ "Operating System :: OS Independent",
19
+ ]
20
+ dependencies = [
21
+ "wexample-wex-core>=6.0.0",
22
+ ]
23
+
24
+ [project.readme]
25
+ file = "README.md"
26
+ content-type = "text/markdown"
27
+
28
+ [project.license]
29
+ text = "MIT"
30
+
31
+ [project.optional-dependencies]
32
+ dev = [
33
+ "pytest",
34
+ "pytest-cov",
35
+ ]
36
+
37
+ [tool.setuptools.packages.find]
38
+ include = [
39
+ "*",
40
+ ]
41
+ exclude = [
42
+ "wexample_wex_addon_ai.testing*",
43
+ ]
44
+
45
+ [tool.pdm]
46
+ distribution = true
47
+
48
+ [tool.pdm.build]
49
+ package-dir = "src"
50
+ packages = [
51
+ { include = "wexample_wex_addon_ai", from = "src" },
52
+ ]
53
+
54
+ [tool.pytest.ini_options]
55
+ testpaths = [
56
+ "tests",
57
+ ]
58
+ pythonpath = [
59
+ "src",
60
+ ]
61
+
62
+ [tool.coverage.run]
63
+ source = [
64
+ "wexample_wex_addon_ai",
65
+ ]
66
+ omit = [
67
+ "*/tests/*",
68
+ "*/.venv/*",
69
+ "*/venv/*",
70
+ ]
71
+
72
+ [tool.coverage.report]
73
+ exclude_lines = [
74
+ "pragma: no cover",
75
+ "def __repr__",
76
+ "raise AssertionError",
77
+ "raise NotImplementedError",
78
+ "if __name__ == .__main__.:",
79
+ "if TYPE_CHECKING:",
80
+ "@abstractmethod",
81
+ ]
@@ -0,0 +1,15 @@
1
+ from __future__ import annotations
2
+
3
+ from typing import Any
4
+
5
+ from wexample_helpers.decorator.base_class import base_class
6
+ from wexample_wex_core.common.abstract_addon_manager import AbstractAddonManager
7
+
8
+
9
+ @base_class
10
+ class AiAddonManager(AbstractAddonManager):
11
+ @classmethod
12
+ def get_package_module(cls) -> Any:
13
+ import wexample_wex_addon_ai
14
+
15
+ return wexample_wex_addon_ai