syrtis-python-client 0.0.20__tar.gz → 6.3.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.
Files changed (35) hide show
  1. syrtis_python_client-6.3.0/PKG-INFO +192 -0
  2. syrtis_python_client-6.3.0/README.md +178 -0
  3. {syrtis_python_client-0.0.20 → syrtis_python_client-6.3.0}/pyproject.toml +1 -1
  4. {syrtis_python_client-0.0.20/src/syrtis_python_client/common → syrtis_python_client-6.3.0/src/syrtis_python_client/agent}/__init__.py +0 -0
  5. syrtis_python_client-6.3.0/src/syrtis_python_client/agent/abstract_agent.py +5 -0
  6. {syrtis_python_client-0.0.20 → syrtis_python_client-6.3.0}/src/syrtis_python_client/common/syrtis_client.py +5 -1
  7. syrtis_python_client-6.3.0/src/syrtis_python_client/repository/__init__.py +0 -0
  8. syrtis_python_client-0.0.20/PKG-INFO +0 -99
  9. syrtis_python_client-0.0.20/README.md +0 -85
  10. {syrtis_python_client-0.0.20 → syrtis_python_client-6.3.0}/src/syrtis_python_client/__init__.py +0 -0
  11. {syrtis_python_client-0.0.20/src/syrtis_python_client/data → syrtis_python_client-6.3.0/src/syrtis_python_client/common}/__init__.py +0 -0
  12. {syrtis_python_client-0.0.20 → syrtis_python_client-6.3.0}/src/syrtis_python_client/common/entity_schemas.py +0 -0
  13. {syrtis_python_client-0.0.20 → syrtis_python_client-6.3.0}/src/syrtis_python_client/common/generated_entity_schemas.py +0 -0
  14. {syrtis_python_client-0.0.20 → syrtis_python_client-6.3.0}/src/syrtis_python_client/common/generated_repositories.py +0 -0
  15. {syrtis_python_client-0.0.20/src/syrtis_python_client/data/entity → syrtis_python_client-6.3.0/src/syrtis_python_client/data}/__init__.py +0 -0
  16. {syrtis_python_client-0.0.20/src/syrtis_python_client → syrtis_python_client-6.3.0/src/syrtis_python_client/data}/entity/__init__.py +0 -0
  17. {syrtis_python_client-0.0.20 → syrtis_python_client-6.3.0}/src/syrtis_python_client/data/entity/message.json +0 -0
  18. {syrtis_python_client-0.0.20 → syrtis_python_client-6.3.0}/src/syrtis_python_client/data/entity/message_stamp.json +0 -0
  19. {syrtis_python_client-0.0.20 → syrtis_python_client-6.3.0}/src/syrtis_python_client/data/entity/request.json +0 -0
  20. {syrtis_python_client-0.0.20 → syrtis_python_client-6.3.0}/src/syrtis_python_client/data/entity/session.json +0 -0
  21. {syrtis_python_client-0.0.20 → syrtis_python_client-6.3.0}/src/syrtis_python_client/data/entity/user.json +0 -0
  22. {syrtis_python_client-0.0.20/src/syrtis_python_client/repository → syrtis_python_client-6.3.0/src/syrtis_python_client/entity}/__init__.py +0 -0
  23. {syrtis_python_client-0.0.20 → syrtis_python_client-6.3.0}/src/syrtis_python_client/entity/abstract_api_entity.py +0 -0
  24. {syrtis_python_client-0.0.20 → syrtis_python_client-6.3.0}/src/syrtis_python_client/entity/message.py +0 -0
  25. {syrtis_python_client-0.0.20 → syrtis_python_client-6.3.0}/src/syrtis_python_client/entity/message_stamp.py +0 -0
  26. {syrtis_python_client-0.0.20 → syrtis_python_client-6.3.0}/src/syrtis_python_client/entity/request.py +0 -0
  27. {syrtis_python_client-0.0.20 → syrtis_python_client-6.3.0}/src/syrtis_python_client/entity/session.py +0 -0
  28. {syrtis_python_client-0.0.20 → syrtis_python_client-6.3.0}/src/syrtis_python_client/entity/user.py +0 -0
  29. {syrtis_python_client-0.0.20 → syrtis_python_client-6.3.0}/src/syrtis_python_client/py.typed +0 -0
  30. {syrtis_python_client-0.0.20 → syrtis_python_client-6.3.0}/src/syrtis_python_client/repository/abstract_api_repository.py +0 -0
  31. {syrtis_python_client-0.0.20 → syrtis_python_client-6.3.0}/src/syrtis_python_client/repository/message_repository.py +0 -0
  32. {syrtis_python_client-0.0.20 → syrtis_python_client-6.3.0}/src/syrtis_python_client/repository/message_stamp_repository.py +0 -0
  33. {syrtis_python_client-0.0.20 → syrtis_python_client-6.3.0}/src/syrtis_python_client/repository/request_repository.py +0 -0
  34. {syrtis_python_client-0.0.20 → syrtis_python_client-6.3.0}/src/syrtis_python_client/repository/session_repository.py +0 -0
  35. {syrtis_python_client-0.0.20 → syrtis_python_client-6.3.0}/src/syrtis_python_client/repository/user_repository.py +0 -0
@@ -0,0 +1,192 @@
1
+ Metadata-Version: 2.1
2
+ Name: syrtis-python-client
3
+ Version: 6.3.0
4
+ Author-Email: weeger <contact@syrtis.ai>
5
+ License: MIT
6
+ Classifier: Programming Language :: Python :: 3
7
+ Classifier: License :: OSI Approved :: MIT License
8
+ Classifier: Operating System :: OS Independent
9
+ Requires-Python: >=3.10
10
+ Provides-Extra: dev
11
+ Requires-Dist: pytest; extra == "dev"
12
+ Requires-Dist: pytest-cov; extra == "dev"
13
+ Description-Content-Type: text/markdown
14
+
15
+ # python_client
16
+
17
+ Version: 6.3.0
18
+
19
+ ## Table of Contents
20
+
21
+ - [Introduction](#introduction)
22
+ - [Tests](#tests)
23
+ - [Roadmap](#roadmap)
24
+ - [Status Compatibility](#status-compatibility)
25
+ - [Useful Links](#useful-links)
26
+ - [Suite Signature](#suite-signature)
27
+
28
+ # syrtis-python-client
29
+
30
+ Version: 0.0.22
31
+
32
+ ## Table of Contents
33
+
34
+ - [Status Compatibility](#status-compatibility)
35
+ - [Tests](#tests)
36
+ - [Roadmap](#roadmap)
37
+ - [Useful Links](#useful-links)
38
+
39
+
40
+ ## Status & Compatibility
41
+
42
+ **Maturity**: Production-ready
43
+
44
+ **Python Support**: >=3.10
45
+
46
+ **OS Support**: Linux, macOS, Windows
47
+
48
+ **Status**: Actively maintained
49
+
50
+ ## Tests
51
+
52
+ This project uses `pytest` for testing and `pytest-cov` for code coverage analysis.
53
+
54
+ ### Installation
55
+
56
+ First, install the required testing dependencies:
57
+ ```bash
58
+ .venv/bin/python -m pip install pytest pytest-cov
59
+ ```
60
+
61
+ ### Basic Usage
62
+
63
+ Run all tests with coverage:
64
+ ```bash
65
+ .venv/bin/python -m pytest --cov --cov-report=html
66
+ ```
67
+
68
+ ### Common Commands
69
+ ```bash
70
+ # Run tests with coverage for a specific module
71
+ .venv/bin/python -m pytest --cov=your_module
72
+
73
+ # Show which lines are not covered
74
+ .venv/bin/python -m pytest --cov=your_module --cov-report=term-missing
75
+
76
+ # Generate an HTML coverage report
77
+ .venv/bin/python -m pytest --cov=your_module --cov-report=html
78
+
79
+ # Combine terminal and HTML reports
80
+ .venv/bin/python -m pytest --cov=your_module --cov-report=term-missing --cov-report=html
81
+
82
+ # Run specific test file with coverage
83
+ .venv/bin/python -m pytest tests/test_file.py --cov=your_module --cov-report=term-missing
84
+ ```
85
+
86
+ ### Viewing HTML Reports
87
+
88
+ After generating an HTML report, open `htmlcov/index.html` in your browser to view detailed line-by-line coverage information.
89
+
90
+ ### Coverage Threshold
91
+
92
+ To enforce a minimum coverage percentage:
93
+ ```bash
94
+ .venv/bin/python -m pytest --cov=your_module --cov-fail-under=80
95
+ ```
96
+
97
+ This will cause the test suite to fail if coverage drops below 80%.
98
+
99
+ ## Known Limitations & Roadmap
100
+
101
+ Current limitations and planned features are tracked in the GitHub issues.
102
+
103
+ See the [project roadmap](https://github.com/wexample/python-python_client/issues) for upcoming features and improvements.
104
+
105
+ ## Useful Links
106
+
107
+ - **Homepage**: https://github.com/wexample/python-python-client
108
+ - **Documentation**: [docs.wexample.com](https://docs.wexample.com)
109
+ - **Issue Tracker**: https://github.com/wexample/python-python-client/issues
110
+ - **Discussions**: https://github.com/wexample/python-python-client/discussions
111
+ - **PyPI**: [pypi.org/project/syrtis-python-client](https://pypi.org/project/syrtis-python-client/)
112
+
113
+ ## Tests
114
+
115
+ This project uses `pytest` for testing and `pytest-cov` for code coverage analysis.
116
+
117
+ ### Installation
118
+
119
+ First, install the required testing dependencies:
120
+ ```bash
121
+ .venv/bin/python -m pip install pytest pytest-cov
122
+ ```
123
+
124
+ ### Basic Usage
125
+
126
+ Run all tests with coverage:
127
+ ```bash
128
+ .venv/bin/python -m pytest --cov --cov-report=html
129
+ ```
130
+
131
+ ### Common Commands
132
+ ```bash
133
+ # Run tests with coverage for a specific module
134
+ .venv/bin/python -m pytest --cov=your_module
135
+
136
+ # Show which lines are not covered
137
+ .venv/bin/python -m pytest --cov=your_module --cov-report=term-missing
138
+
139
+ # Generate an HTML coverage report
140
+ .venv/bin/python -m pytest --cov=your_module --cov-report=html
141
+
142
+ # Combine terminal and HTML reports
143
+ .venv/bin/python -m pytest --cov=your_module --cov-report=term-missing --cov-report=html
144
+
145
+ # Run specific test file with coverage
146
+ .venv/bin/python -m pytest tests/test_file.py --cov=your_module --cov-report=term-missing
147
+ ```
148
+
149
+ ### Viewing HTML Reports
150
+
151
+ After generating an HTML report, open `htmlcov/index.html` in your browser to view detailed line-by-line coverage information.
152
+
153
+ ### Coverage Threshold
154
+
155
+ To enforce a minimum coverage percentage:
156
+ ```bash
157
+ .venv/bin/python -m pytest --cov=your_module --cov-fail-under=80
158
+ ```
159
+
160
+ This will cause the test suite to fail if coverage drops below 80%.
161
+
162
+ ## Known Limitations & Roadmap
163
+
164
+ Current limitations and planned features are tracked in the GitHub issues.
165
+
166
+ See the [project roadmap](https://github.com/wexample/python-python_client/issues) for upcoming features and improvements.
167
+
168
+ ## Status & Compatibility
169
+
170
+ **Maturity**: Production-ready
171
+
172
+ **Python Support**: >=3.10
173
+
174
+ **OS Support**: Linux, macOS, Windows
175
+
176
+ **Status**: Actively maintained
177
+
178
+ ## Useful Links
179
+
180
+ - **Homepage**: https://github.com/wexample/python-python-client
181
+ - **Documentation**: [docs.wexample.com](https://docs.wexample.com)
182
+ - **Issue Tracker**: https://github.com/wexample/python-python-client/issues
183
+ - **Discussions**: https://github.com/wexample/python-python-client/discussions
184
+ - **PyPI**: [pypi.org/project/python_client](https://pypi.org/project/python_client/)
185
+
186
+ # About us
187
+
188
+ [Syrtis AI](https://syrtis.ai) helps organizations turn artificial intelligence from an idea into reliable, measurable systems. We are a team of engineers and practitioners focused on implementing AI services inside real businesses — from strategy and architecture to deployment, integration, and long-term operations. Our goal is simple: deliver AI that works in production, fits your constraints, and earns its keep.
189
+
190
+ We build practical solutions that connect to existing tools, data, and processes, with an emphasis on security, performance, and governance. Whether it’s automating workflows, enhancing decision-making, or creating new product capabilities, Syrtis AI designs implementations that are maintainable, scalable, and aligned with business outcomes — not demos.
191
+
192
+ Syrtis AI promotes a culture of rigor and responsibility. Every delivery reflects a commitment to clear engineering, transparent communication, and trustworthy AI practices, so teams can adopt, operate, and evolve their AI services with confidence.
@@ -0,0 +1,178 @@
1
+ # python_client
2
+
3
+ Version: 6.3.0
4
+
5
+ ## Table of Contents
6
+
7
+ - [Introduction](#introduction)
8
+ - [Tests](#tests)
9
+ - [Roadmap](#roadmap)
10
+ - [Status Compatibility](#status-compatibility)
11
+ - [Useful Links](#useful-links)
12
+ - [Suite Signature](#suite-signature)
13
+
14
+ # syrtis-python-client
15
+
16
+ Version: 0.0.22
17
+
18
+ ## Table of Contents
19
+
20
+ - [Status Compatibility](#status-compatibility)
21
+ - [Tests](#tests)
22
+ - [Roadmap](#roadmap)
23
+ - [Useful Links](#useful-links)
24
+
25
+
26
+ ## Status & Compatibility
27
+
28
+ **Maturity**: Production-ready
29
+
30
+ **Python Support**: >=3.10
31
+
32
+ **OS Support**: Linux, macOS, Windows
33
+
34
+ **Status**: Actively maintained
35
+
36
+ ## Tests
37
+
38
+ This project uses `pytest` for testing and `pytest-cov` for code coverage analysis.
39
+
40
+ ### Installation
41
+
42
+ First, install the required testing dependencies:
43
+ ```bash
44
+ .venv/bin/python -m pip install pytest pytest-cov
45
+ ```
46
+
47
+ ### Basic Usage
48
+
49
+ Run all tests with coverage:
50
+ ```bash
51
+ .venv/bin/python -m pytest --cov --cov-report=html
52
+ ```
53
+
54
+ ### Common Commands
55
+ ```bash
56
+ # Run tests with coverage for a specific module
57
+ .venv/bin/python -m pytest --cov=your_module
58
+
59
+ # Show which lines are not covered
60
+ .venv/bin/python -m pytest --cov=your_module --cov-report=term-missing
61
+
62
+ # Generate an HTML coverage report
63
+ .venv/bin/python -m pytest --cov=your_module --cov-report=html
64
+
65
+ # Combine terminal and HTML reports
66
+ .venv/bin/python -m pytest --cov=your_module --cov-report=term-missing --cov-report=html
67
+
68
+ # Run specific test file with coverage
69
+ .venv/bin/python -m pytest tests/test_file.py --cov=your_module --cov-report=term-missing
70
+ ```
71
+
72
+ ### Viewing HTML Reports
73
+
74
+ After generating an HTML report, open `htmlcov/index.html` in your browser to view detailed line-by-line coverage information.
75
+
76
+ ### Coverage Threshold
77
+
78
+ To enforce a minimum coverage percentage:
79
+ ```bash
80
+ .venv/bin/python -m pytest --cov=your_module --cov-fail-under=80
81
+ ```
82
+
83
+ This will cause the test suite to fail if coverage drops below 80%.
84
+
85
+ ## Known Limitations & Roadmap
86
+
87
+ Current limitations and planned features are tracked in the GitHub issues.
88
+
89
+ See the [project roadmap](https://github.com/wexample/python-python_client/issues) for upcoming features and improvements.
90
+
91
+ ## Useful Links
92
+
93
+ - **Homepage**: https://github.com/wexample/python-python-client
94
+ - **Documentation**: [docs.wexample.com](https://docs.wexample.com)
95
+ - **Issue Tracker**: https://github.com/wexample/python-python-client/issues
96
+ - **Discussions**: https://github.com/wexample/python-python-client/discussions
97
+ - **PyPI**: [pypi.org/project/syrtis-python-client](https://pypi.org/project/syrtis-python-client/)
98
+
99
+ ## Tests
100
+
101
+ This project uses `pytest` for testing and `pytest-cov` for code coverage analysis.
102
+
103
+ ### Installation
104
+
105
+ First, install the required testing dependencies:
106
+ ```bash
107
+ .venv/bin/python -m pip install pytest pytest-cov
108
+ ```
109
+
110
+ ### Basic Usage
111
+
112
+ Run all tests with coverage:
113
+ ```bash
114
+ .venv/bin/python -m pytest --cov --cov-report=html
115
+ ```
116
+
117
+ ### Common Commands
118
+ ```bash
119
+ # Run tests with coverage for a specific module
120
+ .venv/bin/python -m pytest --cov=your_module
121
+
122
+ # Show which lines are not covered
123
+ .venv/bin/python -m pytest --cov=your_module --cov-report=term-missing
124
+
125
+ # Generate an HTML coverage report
126
+ .venv/bin/python -m pytest --cov=your_module --cov-report=html
127
+
128
+ # Combine terminal and HTML reports
129
+ .venv/bin/python -m pytest --cov=your_module --cov-report=term-missing --cov-report=html
130
+
131
+ # Run specific test file with coverage
132
+ .venv/bin/python -m pytest tests/test_file.py --cov=your_module --cov-report=term-missing
133
+ ```
134
+
135
+ ### Viewing HTML Reports
136
+
137
+ After generating an HTML report, open `htmlcov/index.html` in your browser to view detailed line-by-line coverage information.
138
+
139
+ ### Coverage Threshold
140
+
141
+ To enforce a minimum coverage percentage:
142
+ ```bash
143
+ .venv/bin/python -m pytest --cov=your_module --cov-fail-under=80
144
+ ```
145
+
146
+ This will cause the test suite to fail if coverage drops below 80%.
147
+
148
+ ## Known Limitations & Roadmap
149
+
150
+ Current limitations and planned features are tracked in the GitHub issues.
151
+
152
+ See the [project roadmap](https://github.com/wexample/python-python_client/issues) for upcoming features and improvements.
153
+
154
+ ## Status & Compatibility
155
+
156
+ **Maturity**: Production-ready
157
+
158
+ **Python Support**: >=3.10
159
+
160
+ **OS Support**: Linux, macOS, Windows
161
+
162
+ **Status**: Actively maintained
163
+
164
+ ## Useful Links
165
+
166
+ - **Homepage**: https://github.com/wexample/python-python-client
167
+ - **Documentation**: [docs.wexample.com](https://docs.wexample.com)
168
+ - **Issue Tracker**: https://github.com/wexample/python-python-client/issues
169
+ - **Discussions**: https://github.com/wexample/python-python-client/discussions
170
+ - **PyPI**: [pypi.org/project/python_client](https://pypi.org/project/python_client/)
171
+
172
+ # About us
173
+
174
+ [Syrtis AI](https://syrtis.ai) helps organizations turn artificial intelligence from an idea into reliable, measurable systems. We are a team of engineers and practitioners focused on implementing AI services inside real businesses — from strategy and architecture to deployment, integration, and long-term operations. Our goal is simple: deliver AI that works in production, fits your constraints, and earns its keep.
175
+
176
+ We build practical solutions that connect to existing tools, data, and processes, with an emphasis on security, performance, and governance. Whether it’s automating workflows, enhancing decision-making, or creating new product capabilities, Syrtis AI designs implementations that are maintainable, scalable, and aligned with business outcomes — not demos.
177
+
178
+ Syrtis AI promotes a culture of rigor and responsibility. Every delivery reflects a commitment to clear engineering, transparent communication, and trustworthy AI practices, so teams can adopt, operate, and evolve their AI services with confidence.
@@ -6,7 +6,7 @@ build-backend = "pdm.backend"
6
6
 
7
7
  [project]
8
8
  name = "syrtis-python-client"
9
- version = "0.0.20"
9
+ version = "6.3.0"
10
10
  authors = [
11
11
  { name = "weeger", email = "contact@syrtis.ai" },
12
12
  ]
@@ -0,0 +1,5 @@
1
+ from __future__ import annotations
2
+
3
+
4
+ class AbstractAgent:
5
+ pass
@@ -9,7 +9,11 @@ from syrtis_python_client.common.generated_repositories import generated_reposit
9
9
 
10
10
 
11
11
  class SyrtisClient:
12
- DEFAULT_BASE_URL = "https://api.syrtis.ai/api/"
12
+ API_VERSION_2025_3 = "2025-3"
13
+ API_VERSION_2026_1 = "2026-1"
14
+ API_VERSION_DEFAULT = API_VERSION_2026_1
15
+ BASE_URL = "https://api.syrtis.ai/api/"
16
+ DEFAULT_BASE_URL = BASE_URL + API_VERSION_DEFAULT + "/"
13
17
 
14
18
  def __init__(self, base_url: str | None = None, api_key: str | None = None) -> None:
15
19
  self.base_url = (base_url or self.DEFAULT_BASE_URL).rstrip("/") + "/"
@@ -1,99 +0,0 @@
1
- Metadata-Version: 2.1
2
- Name: syrtis-python-client
3
- Version: 0.0.20
4
- Author-Email: weeger <contact@syrtis.ai>
5
- License: MIT
6
- Classifier: Programming Language :: Python :: 3
7
- Classifier: License :: OSI Approved :: MIT License
8
- Classifier: Operating System :: OS Independent
9
- Requires-Python: >=3.10
10
- Provides-Extra: dev
11
- Requires-Dist: pytest; extra == "dev"
12
- Requires-Dist: pytest-cov; extra == "dev"
13
- Description-Content-Type: text/markdown
14
-
15
- # syrtis-python-client
16
-
17
- Version: 0.0.20
18
-
19
- ## Table of Contents
20
-
21
- - [Status Compatibility](#status-compatibility)
22
- - [Tests](#tests)
23
- - [Roadmap](#roadmap)
24
- - [Useful Links](#useful-links)
25
-
26
-
27
- ## Status & Compatibility
28
-
29
- **Maturity**: Production-ready
30
-
31
- **Python Support**: >=3.10
32
-
33
- **OS Support**: Linux, macOS, Windows
34
-
35
- **Status**: Actively maintained
36
-
37
- ## Tests
38
-
39
- This project uses `pytest` for testing and `pytest-cov` for code coverage analysis.
40
-
41
- ### Installation
42
-
43
- First, install the required testing dependencies:
44
- ```bash
45
- .venv/bin/python -m pip install pytest pytest-cov
46
- ```
47
-
48
- ### Basic Usage
49
-
50
- Run all tests with coverage:
51
- ```bash
52
- .venv/bin/python -m pytest --cov --cov-report=html
53
- ```
54
-
55
- ### Common Commands
56
- ```bash
57
- # Run tests with coverage for a specific module
58
- .venv/bin/python -m pytest --cov=your_module
59
-
60
- # Show which lines are not covered
61
- .venv/bin/python -m pytest --cov=your_module --cov-report=term-missing
62
-
63
- # Generate an HTML coverage report
64
- .venv/bin/python -m pytest --cov=your_module --cov-report=html
65
-
66
- # Combine terminal and HTML reports
67
- .venv/bin/python -m pytest --cov=your_module --cov-report=term-missing --cov-report=html
68
-
69
- # Run specific test file with coverage
70
- .venv/bin/python -m pytest tests/test_file.py --cov=your_module --cov-report=term-missing
71
- ```
72
-
73
- ### Viewing HTML Reports
74
-
75
- After generating an HTML report, open `htmlcov/index.html` in your browser to view detailed line-by-line coverage information.
76
-
77
- ### Coverage Threshold
78
-
79
- To enforce a minimum coverage percentage:
80
- ```bash
81
- .venv/bin/python -m pytest --cov=your_module --cov-fail-under=80
82
- ```
83
-
84
- This will cause the test suite to fail if coverage drops below 80%.
85
-
86
- ## Known Limitations & Roadmap
87
-
88
- Current limitations and planned features are tracked in the GitHub issues.
89
-
90
- See the [project roadmap](https://github.com/wexample/python-python_client/issues) for upcoming features and improvements.
91
-
92
- ## Useful Links
93
-
94
- - **Homepage**: https://github.com/wexample/python-python-client
95
- - **Documentation**: [docs.wexample.com](https://docs.wexample.com)
96
- - **Issue Tracker**: https://github.com/wexample/python-python-client/issues
97
- - **Discussions**: https://github.com/wexample/python-python-client/discussions
98
- - **PyPI**: [pypi.org/project/syrtis-python-client](https://pypi.org/project/syrtis-python-client/)
99
-
@@ -1,85 +0,0 @@
1
- # syrtis-python-client
2
-
3
- Version: 0.0.20
4
-
5
- ## Table of Contents
6
-
7
- - [Status Compatibility](#status-compatibility)
8
- - [Tests](#tests)
9
- - [Roadmap](#roadmap)
10
- - [Useful Links](#useful-links)
11
-
12
-
13
- ## Status & Compatibility
14
-
15
- **Maturity**: Production-ready
16
-
17
- **Python Support**: >=3.10
18
-
19
- **OS Support**: Linux, macOS, Windows
20
-
21
- **Status**: Actively maintained
22
-
23
- ## Tests
24
-
25
- This project uses `pytest` for testing and `pytest-cov` for code coverage analysis.
26
-
27
- ### Installation
28
-
29
- First, install the required testing dependencies:
30
- ```bash
31
- .venv/bin/python -m pip install pytest pytest-cov
32
- ```
33
-
34
- ### Basic Usage
35
-
36
- Run all tests with coverage:
37
- ```bash
38
- .venv/bin/python -m pytest --cov --cov-report=html
39
- ```
40
-
41
- ### Common Commands
42
- ```bash
43
- # Run tests with coverage for a specific module
44
- .venv/bin/python -m pytest --cov=your_module
45
-
46
- # Show which lines are not covered
47
- .venv/bin/python -m pytest --cov=your_module --cov-report=term-missing
48
-
49
- # Generate an HTML coverage report
50
- .venv/bin/python -m pytest --cov=your_module --cov-report=html
51
-
52
- # Combine terminal and HTML reports
53
- .venv/bin/python -m pytest --cov=your_module --cov-report=term-missing --cov-report=html
54
-
55
- # Run specific test file with coverage
56
- .venv/bin/python -m pytest tests/test_file.py --cov=your_module --cov-report=term-missing
57
- ```
58
-
59
- ### Viewing HTML Reports
60
-
61
- After generating an HTML report, open `htmlcov/index.html` in your browser to view detailed line-by-line coverage information.
62
-
63
- ### Coverage Threshold
64
-
65
- To enforce a minimum coverage percentage:
66
- ```bash
67
- .venv/bin/python -m pytest --cov=your_module --cov-fail-under=80
68
- ```
69
-
70
- This will cause the test suite to fail if coverage drops below 80%.
71
-
72
- ## Known Limitations & Roadmap
73
-
74
- Current limitations and planned features are tracked in the GitHub issues.
75
-
76
- See the [project roadmap](https://github.com/wexample/python-python_client/issues) for upcoming features and improvements.
77
-
78
- ## Useful Links
79
-
80
- - **Homepage**: https://github.com/wexample/python-python-client
81
- - **Documentation**: [docs.wexample.com](https://docs.wexample.com)
82
- - **Issue Tracker**: https://github.com/wexample/python-python-client/issues
83
- - **Discussions**: https://github.com/wexample/python-python-client/discussions
84
- - **PyPI**: [pypi.org/project/syrtis-python-client](https://pypi.org/project/syrtis-python-client/)
85
-