wexample-remote 1.1.5__tar.gz → 1.2.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.
- wexample_remote-1.2.0/PKG-INFO +112 -0
- wexample_remote-1.2.0/README.md +96 -0
- {wexample_remote-1.1.5 → wexample_remote-1.2.0}/pyproject.toml +2 -2
- wexample_remote-1.1.5/PKG-INFO +0 -213
- wexample_remote-1.1.5/README.md +0 -197
- {wexample_remote-1.1.5 → wexample_remote-1.2.0}/src/wexample_remote/__init__.py +0 -0
- {wexample_remote-1.1.5 → wexample_remote-1.2.0}/src/wexample_remote/common/__init__.py +0 -0
- {wexample_remote-1.1.5 → wexample_remote-1.2.0}/src/wexample_remote/common/abstract_remote.py +0 -0
- {wexample_remote-1.1.5 → wexample_remote-1.2.0}/src/wexample_remote/common/gateway_remote.py +0 -0
- {wexample_remote-1.1.5 → wexample_remote-1.2.0}/src/wexample_remote/common/remote_registry.py +0 -0
- {wexample_remote-1.1.5 → wexample_remote-1.2.0}/src/wexample_remote/common/remote_status.py +0 -0
- {wexample_remote-1.1.5 → wexample_remote-1.2.0}/src/wexample_remote/enum/__init__.py +0 -0
- {wexample_remote-1.1.5 → wexample_remote-1.2.0}/src/wexample_remote/enum/remote_state.py +0 -0
- {wexample_remote-1.1.5 → wexample_remote-1.2.0}/src/wexample_remote/exception/__init__.py +0 -0
- {wexample_remote-1.1.5 → wexample_remote-1.2.0}/src/wexample_remote/exception/duplicate_remote_key_exception.py +0 -0
- {wexample_remote-1.1.5 → wexample_remote-1.2.0}/src/wexample_remote/exception/remote_not_found_exception.py +0 -0
- {wexample_remote-1.1.5 → wexample_remote-1.2.0}/src/wexample_remote/py.typed +0 -0
- {wexample_remote-1.1.5 → wexample_remote-1.2.0}/tests/.gitkeep +0 -0
- {wexample_remote-1.1.5 → wexample_remote-1.2.0}/tests/test_remote_registry.py +0 -0
|
@@ -0,0 +1,112 @@
|
|
|
1
|
+
Metadata-Version: 2.1
|
|
2
|
+
Name: wexample-remote
|
|
3
|
+
Version: 1.2.0
|
|
4
|
+
Author-Email: weeger <contact@wexample.com>
|
|
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
|
+
Requires-Dist: wexample-api
|
|
11
|
+
Requires-Dist: wexample-helpers>=20.7.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
|
+
# remote
|
|
18
|
+
|
|
19
|
+
Version: 1.2.0
|
|
20
|
+
|
|
21
|
+
## Table of Contents
|
|
22
|
+
|
|
23
|
+
- [Introduction](#introduction)
|
|
24
|
+
- [Install](#install)
|
|
25
|
+
- [Tests](#tests)
|
|
26
|
+
- [Roadmap](#roadmap)
|
|
27
|
+
- [Status Compatibility](#status-compatibility)
|
|
28
|
+
- [Useful Links](#useful-links)
|
|
29
|
+
|
|
30
|
+
`wexample-remote` keeps track of everything a Python application talks to outside itself — an HTTP API, a model provider, a database — whatever the library it goes through. It holds what those have in common: a registry of the app's remotes and a status per remote (up, down, or unconfigured when its address or credentials are missing), with the time the check took.
|
|
31
|
+
|
|
32
|
+
It mirrors `php-remote`. For HTTP APIs built on `wexample-api`, `GatewayRemote` checks a gateway by requesting its ping path.
|
|
33
|
+
|
|
34
|
+
## Installation
|
|
35
|
+
|
|
36
|
+
```bash
|
|
37
|
+
pip install wexample-remote
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
Requires Python >=3.10.
|
|
41
|
+
|
|
42
|
+
## Tests
|
|
43
|
+
|
|
44
|
+
This project uses `pytest` for testing and `pytest-cov` for code coverage analysis.
|
|
45
|
+
|
|
46
|
+
### Installation
|
|
47
|
+
|
|
48
|
+
First, install the required testing dependencies:
|
|
49
|
+
```bash
|
|
50
|
+
.venv/bin/python -m pip install pytest pytest-cov
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
### Basic Usage
|
|
54
|
+
|
|
55
|
+
Run all tests with coverage:
|
|
56
|
+
```bash
|
|
57
|
+
.venv/bin/python -m pytest --cov --cov-report=html
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
### Common Commands
|
|
61
|
+
```bash
|
|
62
|
+
# Run tests with coverage for a specific module
|
|
63
|
+
.venv/bin/python -m pytest --cov=your_module
|
|
64
|
+
|
|
65
|
+
# Show which lines are not covered
|
|
66
|
+
.venv/bin/python -m pytest --cov=your_module --cov-report=term-missing
|
|
67
|
+
|
|
68
|
+
# Generate an HTML coverage report
|
|
69
|
+
.venv/bin/python -m pytest --cov=your_module --cov-report=html
|
|
70
|
+
|
|
71
|
+
# Combine terminal and HTML reports
|
|
72
|
+
.venv/bin/python -m pytest --cov=your_module --cov-report=term-missing --cov-report=html
|
|
73
|
+
|
|
74
|
+
# Run specific test file with coverage
|
|
75
|
+
.venv/bin/python -m pytest tests/test_file.py --cov=your_module --cov-report=term-missing
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
### Viewing HTML Reports
|
|
79
|
+
|
|
80
|
+
After generating an HTML report, open `htmlcov/index.html` in your browser to view detailed line-by-line coverage information.
|
|
81
|
+
|
|
82
|
+
### Coverage Threshold
|
|
83
|
+
|
|
84
|
+
To enforce a minimum coverage percentage:
|
|
85
|
+
```bash
|
|
86
|
+
.venv/bin/python -m pytest --cov=your_module --cov-fail-under=80
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
This will cause the test suite to fail if coverage drops below 80%.
|
|
90
|
+
|
|
91
|
+
## Known Limitations & Roadmap
|
|
92
|
+
|
|
93
|
+
Current limitations and planned features are tracked in the GitHub issues.
|
|
94
|
+
|
|
95
|
+
See the [project roadmap](https://github.com/wexample/python-remote/issues) for upcoming features and improvements.
|
|
96
|
+
|
|
97
|
+
## Status & Compatibility
|
|
98
|
+
|
|
99
|
+
**Maturity**: Production-ready
|
|
100
|
+
|
|
101
|
+
**Python Support**: >=3.10
|
|
102
|
+
|
|
103
|
+
**OS Support**: Linux, macOS, Windows
|
|
104
|
+
|
|
105
|
+
**Status**: Actively maintained
|
|
106
|
+
|
|
107
|
+
## Useful Links
|
|
108
|
+
|
|
109
|
+
- **Homepage**: https://github.com/wexample/python-remote
|
|
110
|
+
- **Issue Tracker**: https://github.com/wexample/python-remote/issues
|
|
111
|
+
- **Discussions**: https://github.com/wexample/python-remote/discussions
|
|
112
|
+
- **PyPI**: [pypi.org/project/wexample-remote](https://pypi.org/project/wexample-remote/)
|
|
@@ -0,0 +1,96 @@
|
|
|
1
|
+
# remote
|
|
2
|
+
|
|
3
|
+
Version: 1.2.0
|
|
4
|
+
|
|
5
|
+
## Table of Contents
|
|
6
|
+
|
|
7
|
+
- [Introduction](#introduction)
|
|
8
|
+
- [Install](#install)
|
|
9
|
+
- [Tests](#tests)
|
|
10
|
+
- [Roadmap](#roadmap)
|
|
11
|
+
- [Status Compatibility](#status-compatibility)
|
|
12
|
+
- [Useful Links](#useful-links)
|
|
13
|
+
|
|
14
|
+
`wexample-remote` keeps track of everything a Python application talks to outside itself — an HTTP API, a model provider, a database — whatever the library it goes through. It holds what those have in common: a registry of the app's remotes and a status per remote (up, down, or unconfigured when its address or credentials are missing), with the time the check took.
|
|
15
|
+
|
|
16
|
+
It mirrors `php-remote`. For HTTP APIs built on `wexample-api`, `GatewayRemote` checks a gateway by requesting its ping path.
|
|
17
|
+
|
|
18
|
+
## Installation
|
|
19
|
+
|
|
20
|
+
```bash
|
|
21
|
+
pip install wexample-remote
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
Requires Python >=3.10.
|
|
25
|
+
|
|
26
|
+
## Tests
|
|
27
|
+
|
|
28
|
+
This project uses `pytest` for testing and `pytest-cov` for code coverage analysis.
|
|
29
|
+
|
|
30
|
+
### Installation
|
|
31
|
+
|
|
32
|
+
First, install the required testing dependencies:
|
|
33
|
+
```bash
|
|
34
|
+
.venv/bin/python -m pip install pytest pytest-cov
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
### Basic Usage
|
|
38
|
+
|
|
39
|
+
Run all tests with coverage:
|
|
40
|
+
```bash
|
|
41
|
+
.venv/bin/python -m pytest --cov --cov-report=html
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
### Common Commands
|
|
45
|
+
```bash
|
|
46
|
+
# Run tests with coverage for a specific module
|
|
47
|
+
.venv/bin/python -m pytest --cov=your_module
|
|
48
|
+
|
|
49
|
+
# Show which lines are not covered
|
|
50
|
+
.venv/bin/python -m pytest --cov=your_module --cov-report=term-missing
|
|
51
|
+
|
|
52
|
+
# Generate an HTML coverage report
|
|
53
|
+
.venv/bin/python -m pytest --cov=your_module --cov-report=html
|
|
54
|
+
|
|
55
|
+
# Combine terminal and HTML reports
|
|
56
|
+
.venv/bin/python -m pytest --cov=your_module --cov-report=term-missing --cov-report=html
|
|
57
|
+
|
|
58
|
+
# Run specific test file with coverage
|
|
59
|
+
.venv/bin/python -m pytest tests/test_file.py --cov=your_module --cov-report=term-missing
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
### Viewing HTML Reports
|
|
63
|
+
|
|
64
|
+
After generating an HTML report, open `htmlcov/index.html` in your browser to view detailed line-by-line coverage information.
|
|
65
|
+
|
|
66
|
+
### Coverage Threshold
|
|
67
|
+
|
|
68
|
+
To enforce a minimum coverage percentage:
|
|
69
|
+
```bash
|
|
70
|
+
.venv/bin/python -m pytest --cov=your_module --cov-fail-under=80
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
This will cause the test suite to fail if coverage drops below 80%.
|
|
74
|
+
|
|
75
|
+
## Known Limitations & Roadmap
|
|
76
|
+
|
|
77
|
+
Current limitations and planned features are tracked in the GitHub issues.
|
|
78
|
+
|
|
79
|
+
See the [project roadmap](https://github.com/wexample/python-remote/issues) for upcoming features and improvements.
|
|
80
|
+
|
|
81
|
+
## Status & Compatibility
|
|
82
|
+
|
|
83
|
+
**Maturity**: Production-ready
|
|
84
|
+
|
|
85
|
+
**Python Support**: >=3.10
|
|
86
|
+
|
|
87
|
+
**OS Support**: Linux, macOS, Windows
|
|
88
|
+
|
|
89
|
+
**Status**: Actively maintained
|
|
90
|
+
|
|
91
|
+
## Useful Links
|
|
92
|
+
|
|
93
|
+
- **Homepage**: https://github.com/wexample/python-remote
|
|
94
|
+
- **Issue Tracker**: https://github.com/wexample/python-remote/issues
|
|
95
|
+
- **Discussions**: https://github.com/wexample/python-remote/discussions
|
|
96
|
+
- **PyPI**: [pypi.org/project/wexample-remote](https://pypi.org/project/wexample-remote/)
|
|
@@ -6,7 +6,7 @@ build-backend = "pdm.backend"
|
|
|
6
6
|
|
|
7
7
|
[project]
|
|
8
8
|
name = "wexample-remote"
|
|
9
|
-
version = "1.
|
|
9
|
+
version = "1.2.0"
|
|
10
10
|
authors = [
|
|
11
11
|
{ name = "weeger", email = "contact@wexample.com" },
|
|
12
12
|
]
|
|
@@ -18,7 +18,7 @@ classifiers = [
|
|
|
18
18
|
]
|
|
19
19
|
dependencies = [
|
|
20
20
|
"wexample-api",
|
|
21
|
-
"wexample-helpers>=20.
|
|
21
|
+
"wexample-helpers>=20.7.0",
|
|
22
22
|
]
|
|
23
23
|
|
|
24
24
|
[project.readme]
|
wexample_remote-1.1.5/PKG-INFO
DELETED
|
@@ -1,213 +0,0 @@
|
|
|
1
|
-
Metadata-Version: 2.1
|
|
2
|
-
Name: wexample-remote
|
|
3
|
-
Version: 1.1.5
|
|
4
|
-
Author-Email: weeger <contact@wexample.com>
|
|
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
|
-
Requires-Dist: wexample-api
|
|
11
|
-
Requires-Dist: wexample-helpers>=20.5.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
|
-
# remote
|
|
18
|
-
|
|
19
|
-
Version: 1.1.5
|
|
20
|
-
|
|
21
|
-
## A remote
|
|
22
|
-
|
|
23
|
-
```python
|
|
24
|
-
from wexample_remote import AbstractRemote, RemoteStatus
|
|
25
|
-
|
|
26
|
-
class RenderServerRemote(AbstractRemote):
|
|
27
|
-
def get_key(self) -> str:
|
|
28
|
-
return "render_server"
|
|
29
|
-
|
|
30
|
-
def check_status(self) -> RemoteStatus:
|
|
31
|
-
return RemoteStatus.up() if renderer.ping() else RemoteStatus.down("No answer.")
|
|
32
|
-
```
|
|
33
|
-
|
|
34
|
-
`AbstractRemote` carries no field, so a class already built on another base — a gateway, a connector — takes it as a mixin. `get_label()` defaults to the key. A check may raise instead of returning `down()`: the registry reports the exception message.
|
|
35
|
-
|
|
36
|
-
## The registry
|
|
37
|
-
|
|
38
|
-
```python
|
|
39
|
-
from wexample_remote import RemoteRegistry
|
|
40
|
-
|
|
41
|
-
registry = RemoteRegistry([render_server, billing])
|
|
42
|
-
|
|
43
|
-
registry.check("billing") # RemoteStatus, with its latency in milliseconds
|
|
44
|
-
registry.check_all() # dict of RemoteStatus, by key
|
|
45
|
-
registry.check("billing").to_dict()
|
|
46
|
-
```
|
|
47
|
-
|
|
48
|
-
Two remotes sharing a key are refused; an unknown key raises `RemoteNotFoundException`.
|
|
49
|
-
|
|
50
|
-
## A wexample-api gateway
|
|
51
|
-
|
|
52
|
-
```python
|
|
53
|
-
from wexample_remote import GatewayRemote
|
|
54
|
-
|
|
55
|
-
remote = GatewayRemote(gateway=billing_gateway, key="billing", label="Billing API", ping_path="health")
|
|
56
|
-
```
|
|
57
|
-
|
|
58
|
-
It reads unconfigured while the gateway has no base URL, and otherwise requests the ping path: any status below 400 is up. A subclass adds its own missing settings by overriding `get_missing_settings()`.
|
|
59
|
-
|
|
60
|
-
## Table of Contents
|
|
61
|
-
|
|
62
|
-
- [A remote](#a-remote)
|
|
63
|
-
- [The registry](#the-registry)
|
|
64
|
-
- [A wexample-api gateway](#a-wexample-api-gateway)
|
|
65
|
-
- [Installation](#installation)
|
|
66
|
-
- [Tests](#tests)
|
|
67
|
-
- [Architecture](#architecture)
|
|
68
|
-
- [Integration in the Suite](#integration-in-the-suite)
|
|
69
|
-
- [Dependencies](#dependencies)
|
|
70
|
-
- [Versioning & Compatibility Policy](#versioning--compatibility-policy)
|
|
71
|
-
- [License](#license)
|
|
72
|
-
- [About us](#about-us)
|
|
73
|
-
- [Known Limitations & Roadmap](#known-limitations--roadmap)
|
|
74
|
-
- [Status & Compatibility](#status--compatibility)
|
|
75
|
-
- [Useful Links](#useful-links)
|
|
76
|
-
- [Migration Notes](#migration-notes)
|
|
77
|
-
|
|
78
|
-
## Installation
|
|
79
|
-
|
|
80
|
-
```bash
|
|
81
|
-
pip install wexample-remote
|
|
82
|
-
```
|
|
83
|
-
|
|
84
|
-
Requires Python >=3.10.
|
|
85
|
-
|
|
86
|
-
## Tests
|
|
87
|
-
|
|
88
|
-
This project uses `pytest` for testing and `pytest-cov` for code coverage analysis.
|
|
89
|
-
|
|
90
|
-
### Installation
|
|
91
|
-
|
|
92
|
-
First, install the required testing dependencies:
|
|
93
|
-
```bash
|
|
94
|
-
.venv/bin/python -m pip install pytest pytest-cov
|
|
95
|
-
```
|
|
96
|
-
|
|
97
|
-
### Basic Usage
|
|
98
|
-
|
|
99
|
-
Run all tests with coverage:
|
|
100
|
-
```bash
|
|
101
|
-
.venv/bin/python -m pytest --cov --cov-report=html
|
|
102
|
-
```
|
|
103
|
-
|
|
104
|
-
### Common Commands
|
|
105
|
-
```bash
|
|
106
|
-
# Run tests with coverage for a specific module
|
|
107
|
-
.venv/bin/python -m pytest --cov=your_module
|
|
108
|
-
|
|
109
|
-
# Show which lines are not covered
|
|
110
|
-
.venv/bin/python -m pytest --cov=your_module --cov-report=term-missing
|
|
111
|
-
|
|
112
|
-
# Generate an HTML coverage report
|
|
113
|
-
.venv/bin/python -m pytest --cov=your_module --cov-report=html
|
|
114
|
-
|
|
115
|
-
# Combine terminal and HTML reports
|
|
116
|
-
.venv/bin/python -m pytest --cov=your_module --cov-report=term-missing --cov-report=html
|
|
117
|
-
|
|
118
|
-
# Run specific test file with coverage
|
|
119
|
-
.venv/bin/python -m pytest tests/test_file.py --cov=your_module --cov-report=term-missing
|
|
120
|
-
```
|
|
121
|
-
|
|
122
|
-
### Viewing HTML Reports
|
|
123
|
-
|
|
124
|
-
After generating an HTML report, open `htmlcov/index.html` in your browser to view detailed line-by-line coverage information.
|
|
125
|
-
|
|
126
|
-
### Coverage Threshold
|
|
127
|
-
|
|
128
|
-
To enforce a minimum coverage percentage:
|
|
129
|
-
```bash
|
|
130
|
-
.venv/bin/python -m pytest --cov=your_module --cov-fail-under=80
|
|
131
|
-
```
|
|
132
|
-
|
|
133
|
-
This will cause the test suite to fail if coverage drops below 80%.
|
|
134
|
-
|
|
135
|
-
## Architecture
|
|
136
|
-
|
|
137
|
-
The package mirrors `php-remote`, class for class where Python needs it.
|
|
138
|
-
|
|
139
|
-
src/wexample_remote/common/abstract_remote.py is the contract: `get_key()`, `get_label()`, `check_status()`. It is a plain class without fields rather than a `BaseClass`, so that connectors and gateways, already attrs classes, can mix it in.
|
|
140
|
-
|
|
141
|
-
src/wexample_remote/common/remote_status.py is a src/wexample_remote/enum/remote_state.py, a message, a latency and a check date; `to_dict()` is the shape reported to consoles and screens.
|
|
142
|
-
|
|
143
|
-
src/wexample_remote/common/remote_registry.py indexes remotes by key and checks them. `check()` measures the latency and turns any exception into a down status: one broken remote must not hide the others. It is the only place the package catches everything.
|
|
144
|
-
|
|
145
|
-
src/wexample_remote/common/gateway_remote.py is the counterpart of `ApiClientRemote`. `php-remote`'s `ClientDefinition`, `ApiClientFactory` and rate limiter have none: a `wexample-api` gateway is built from its own fields, and spaces its requests itself with `rate_limit_delay`.
|
|
146
|
-
|
|
147
|
-
## Integration in the Suite
|
|
148
|
-
|
|
149
|
-
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.
|
|
150
|
-
|
|
151
|
-
### Related Packages
|
|
152
|
-
|
|
153
|
-
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.
|
|
154
|
-
|
|
155
|
-
## Dependencies
|
|
156
|
-
|
|
157
|
-
- wexample-api:
|
|
158
|
-
- wexample-helpers: >=20.5.0
|
|
159
|
-
|
|
160
|
-
## Versioning & Compatibility Policy
|
|
161
|
-
|
|
162
|
-
Wexample packages follow **Semantic Versioning** (SemVer):
|
|
163
|
-
|
|
164
|
-
- **MAJOR**: Breaking changes
|
|
165
|
-
- **MINOR**: New features, backward compatible
|
|
166
|
-
- **PATCH**: Bug fixes, backward compatible
|
|
167
|
-
|
|
168
|
-
We maintain backward compatibility within major versions and provide clear migration guides for breaking changes.
|
|
169
|
-
|
|
170
|
-
## License
|
|
171
|
-
|
|
172
|
-
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
|
|
173
|
-
|
|
174
|
-
Free to use in both personal and commercial projects.
|
|
175
|
-
|
|
176
|
-
## About us
|
|
177
|
-
|
|
178
|
-
[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.
|
|
179
|
-
|
|
180
|
-
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.
|
|
181
|
-
|
|
182
|
-
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.
|
|
183
|
-
|
|
184
|
-
Built and maintained by [Romain Weeger](https://weeger.io).
|
|
185
|
-
|
|
186
|
-
## Known Limitations & Roadmap
|
|
187
|
-
|
|
188
|
-
Current limitations and planned features are tracked in the GitHub issues.
|
|
189
|
-
|
|
190
|
-
See the [project roadmap](https://github.com/wexample/python-remote/issues) for upcoming features and improvements.
|
|
191
|
-
|
|
192
|
-
## Status & Compatibility
|
|
193
|
-
|
|
194
|
-
**Maturity**: Production-ready
|
|
195
|
-
|
|
196
|
-
**Python Support**: >=3.10
|
|
197
|
-
|
|
198
|
-
**OS Support**: Linux, macOS, Windows
|
|
199
|
-
|
|
200
|
-
**Status**: Actively maintained
|
|
201
|
-
|
|
202
|
-
## Useful Links
|
|
203
|
-
|
|
204
|
-
- **Homepage**: https://github.com/wexample/python-remote
|
|
205
|
-
- **Issue Tracker**: https://github.com/wexample/python-remote/issues
|
|
206
|
-
- **Discussions**: https://github.com/wexample/python-remote/discussions
|
|
207
|
-
- **PyPI**: [pypi.org/project/wexample-remote](https://pypi.org/project/wexample-remote/)
|
|
208
|
-
|
|
209
|
-
## Migration Notes
|
|
210
|
-
|
|
211
|
-
When upgrading between major versions, refer to the migration guides in the documentation.
|
|
212
|
-
|
|
213
|
-
Breaking changes are clearly documented with upgrade paths and examples.
|
wexample_remote-1.1.5/README.md
DELETED
|
@@ -1,197 +0,0 @@
|
|
|
1
|
-
# remote
|
|
2
|
-
|
|
3
|
-
Version: 1.1.5
|
|
4
|
-
|
|
5
|
-
## A remote
|
|
6
|
-
|
|
7
|
-
```python
|
|
8
|
-
from wexample_remote import AbstractRemote, RemoteStatus
|
|
9
|
-
|
|
10
|
-
class RenderServerRemote(AbstractRemote):
|
|
11
|
-
def get_key(self) -> str:
|
|
12
|
-
return "render_server"
|
|
13
|
-
|
|
14
|
-
def check_status(self) -> RemoteStatus:
|
|
15
|
-
return RemoteStatus.up() if renderer.ping() else RemoteStatus.down("No answer.")
|
|
16
|
-
```
|
|
17
|
-
|
|
18
|
-
`AbstractRemote` carries no field, so a class already built on another base — a gateway, a connector — takes it as a mixin. `get_label()` defaults to the key. A check may raise instead of returning `down()`: the registry reports the exception message.
|
|
19
|
-
|
|
20
|
-
## The registry
|
|
21
|
-
|
|
22
|
-
```python
|
|
23
|
-
from wexample_remote import RemoteRegistry
|
|
24
|
-
|
|
25
|
-
registry = RemoteRegistry([render_server, billing])
|
|
26
|
-
|
|
27
|
-
registry.check("billing") # RemoteStatus, with its latency in milliseconds
|
|
28
|
-
registry.check_all() # dict of RemoteStatus, by key
|
|
29
|
-
registry.check("billing").to_dict()
|
|
30
|
-
```
|
|
31
|
-
|
|
32
|
-
Two remotes sharing a key are refused; an unknown key raises `RemoteNotFoundException`.
|
|
33
|
-
|
|
34
|
-
## A wexample-api gateway
|
|
35
|
-
|
|
36
|
-
```python
|
|
37
|
-
from wexample_remote import GatewayRemote
|
|
38
|
-
|
|
39
|
-
remote = GatewayRemote(gateway=billing_gateway, key="billing", label="Billing API", ping_path="health")
|
|
40
|
-
```
|
|
41
|
-
|
|
42
|
-
It reads unconfigured while the gateway has no base URL, and otherwise requests the ping path: any status below 400 is up. A subclass adds its own missing settings by overriding `get_missing_settings()`.
|
|
43
|
-
|
|
44
|
-
## Table of Contents
|
|
45
|
-
|
|
46
|
-
- [A remote](#a-remote)
|
|
47
|
-
- [The registry](#the-registry)
|
|
48
|
-
- [A wexample-api gateway](#a-wexample-api-gateway)
|
|
49
|
-
- [Installation](#installation)
|
|
50
|
-
- [Tests](#tests)
|
|
51
|
-
- [Architecture](#architecture)
|
|
52
|
-
- [Integration in the Suite](#integration-in-the-suite)
|
|
53
|
-
- [Dependencies](#dependencies)
|
|
54
|
-
- [Versioning & Compatibility Policy](#versioning--compatibility-policy)
|
|
55
|
-
- [License](#license)
|
|
56
|
-
- [About us](#about-us)
|
|
57
|
-
- [Known Limitations & Roadmap](#known-limitations--roadmap)
|
|
58
|
-
- [Status & Compatibility](#status--compatibility)
|
|
59
|
-
- [Useful Links](#useful-links)
|
|
60
|
-
- [Migration Notes](#migration-notes)
|
|
61
|
-
|
|
62
|
-
## Installation
|
|
63
|
-
|
|
64
|
-
```bash
|
|
65
|
-
pip install wexample-remote
|
|
66
|
-
```
|
|
67
|
-
|
|
68
|
-
Requires Python >=3.10.
|
|
69
|
-
|
|
70
|
-
## Tests
|
|
71
|
-
|
|
72
|
-
This project uses `pytest` for testing and `pytest-cov` for code coverage analysis.
|
|
73
|
-
|
|
74
|
-
### Installation
|
|
75
|
-
|
|
76
|
-
First, install the required testing dependencies:
|
|
77
|
-
```bash
|
|
78
|
-
.venv/bin/python -m pip install pytest pytest-cov
|
|
79
|
-
```
|
|
80
|
-
|
|
81
|
-
### Basic Usage
|
|
82
|
-
|
|
83
|
-
Run all tests with coverage:
|
|
84
|
-
```bash
|
|
85
|
-
.venv/bin/python -m pytest --cov --cov-report=html
|
|
86
|
-
```
|
|
87
|
-
|
|
88
|
-
### Common Commands
|
|
89
|
-
```bash
|
|
90
|
-
# Run tests with coverage for a specific module
|
|
91
|
-
.venv/bin/python -m pytest --cov=your_module
|
|
92
|
-
|
|
93
|
-
# Show which lines are not covered
|
|
94
|
-
.venv/bin/python -m pytest --cov=your_module --cov-report=term-missing
|
|
95
|
-
|
|
96
|
-
# Generate an HTML coverage report
|
|
97
|
-
.venv/bin/python -m pytest --cov=your_module --cov-report=html
|
|
98
|
-
|
|
99
|
-
# Combine terminal and HTML reports
|
|
100
|
-
.venv/bin/python -m pytest --cov=your_module --cov-report=term-missing --cov-report=html
|
|
101
|
-
|
|
102
|
-
# Run specific test file with coverage
|
|
103
|
-
.venv/bin/python -m pytest tests/test_file.py --cov=your_module --cov-report=term-missing
|
|
104
|
-
```
|
|
105
|
-
|
|
106
|
-
### Viewing HTML Reports
|
|
107
|
-
|
|
108
|
-
After generating an HTML report, open `htmlcov/index.html` in your browser to view detailed line-by-line coverage information.
|
|
109
|
-
|
|
110
|
-
### Coverage Threshold
|
|
111
|
-
|
|
112
|
-
To enforce a minimum coverage percentage:
|
|
113
|
-
```bash
|
|
114
|
-
.venv/bin/python -m pytest --cov=your_module --cov-fail-under=80
|
|
115
|
-
```
|
|
116
|
-
|
|
117
|
-
This will cause the test suite to fail if coverage drops below 80%.
|
|
118
|
-
|
|
119
|
-
## Architecture
|
|
120
|
-
|
|
121
|
-
The package mirrors `php-remote`, class for class where Python needs it.
|
|
122
|
-
|
|
123
|
-
src/wexample_remote/common/abstract_remote.py is the contract: `get_key()`, `get_label()`, `check_status()`. It is a plain class without fields rather than a `BaseClass`, so that connectors and gateways, already attrs classes, can mix it in.
|
|
124
|
-
|
|
125
|
-
src/wexample_remote/common/remote_status.py is a src/wexample_remote/enum/remote_state.py, a message, a latency and a check date; `to_dict()` is the shape reported to consoles and screens.
|
|
126
|
-
|
|
127
|
-
src/wexample_remote/common/remote_registry.py indexes remotes by key and checks them. `check()` measures the latency and turns any exception into a down status: one broken remote must not hide the others. It is the only place the package catches everything.
|
|
128
|
-
|
|
129
|
-
src/wexample_remote/common/gateway_remote.py is the counterpart of `ApiClientRemote`. `php-remote`'s `ClientDefinition`, `ApiClientFactory` and rate limiter have none: a `wexample-api` gateway is built from its own fields, and spaces its requests itself with `rate_limit_delay`.
|
|
130
|
-
|
|
131
|
-
## Integration in the Suite
|
|
132
|
-
|
|
133
|
-
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.
|
|
134
|
-
|
|
135
|
-
### Related Packages
|
|
136
|
-
|
|
137
|
-
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.
|
|
138
|
-
|
|
139
|
-
## Dependencies
|
|
140
|
-
|
|
141
|
-
- wexample-api:
|
|
142
|
-
- wexample-helpers: >=20.5.0
|
|
143
|
-
|
|
144
|
-
## Versioning & Compatibility Policy
|
|
145
|
-
|
|
146
|
-
Wexample packages follow **Semantic Versioning** (SemVer):
|
|
147
|
-
|
|
148
|
-
- **MAJOR**: Breaking changes
|
|
149
|
-
- **MINOR**: New features, backward compatible
|
|
150
|
-
- **PATCH**: Bug fixes, backward compatible
|
|
151
|
-
|
|
152
|
-
We maintain backward compatibility within major versions and provide clear migration guides for breaking changes.
|
|
153
|
-
|
|
154
|
-
## License
|
|
155
|
-
|
|
156
|
-
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
|
|
157
|
-
|
|
158
|
-
Free to use in both personal and commercial projects.
|
|
159
|
-
|
|
160
|
-
## About us
|
|
161
|
-
|
|
162
|
-
[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.
|
|
163
|
-
|
|
164
|
-
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.
|
|
165
|
-
|
|
166
|
-
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.
|
|
167
|
-
|
|
168
|
-
Built and maintained by [Romain Weeger](https://weeger.io).
|
|
169
|
-
|
|
170
|
-
## Known Limitations & Roadmap
|
|
171
|
-
|
|
172
|
-
Current limitations and planned features are tracked in the GitHub issues.
|
|
173
|
-
|
|
174
|
-
See the [project roadmap](https://github.com/wexample/python-remote/issues) for upcoming features and improvements.
|
|
175
|
-
|
|
176
|
-
## Status & Compatibility
|
|
177
|
-
|
|
178
|
-
**Maturity**: Production-ready
|
|
179
|
-
|
|
180
|
-
**Python Support**: >=3.10
|
|
181
|
-
|
|
182
|
-
**OS Support**: Linux, macOS, Windows
|
|
183
|
-
|
|
184
|
-
**Status**: Actively maintained
|
|
185
|
-
|
|
186
|
-
## Useful Links
|
|
187
|
-
|
|
188
|
-
- **Homepage**: https://github.com/wexample/python-remote
|
|
189
|
-
- **Issue Tracker**: https://github.com/wexample/python-remote/issues
|
|
190
|
-
- **Discussions**: https://github.com/wexample/python-remote/discussions
|
|
191
|
-
- **PyPI**: [pypi.org/project/wexample-remote](https://pypi.org/project/wexample-remote/)
|
|
192
|
-
|
|
193
|
-
## Migration Notes
|
|
194
|
-
|
|
195
|
-
When upgrading between major versions, refer to the migration guides in the documentation.
|
|
196
|
-
|
|
197
|
-
Breaking changes are clearly documented with upgrade paths and examples.
|
|
File without changes
|
|
File without changes
|
{wexample_remote-1.1.5 → wexample_remote-1.2.0}/src/wexample_remote/common/abstract_remote.py
RENAMED
|
File without changes
|
{wexample_remote-1.1.5 → wexample_remote-1.2.0}/src/wexample_remote/common/gateway_remote.py
RENAMED
|
File without changes
|
{wexample_remote-1.1.5 → wexample_remote-1.2.0}/src/wexample_remote/common/remote_registry.py
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|