pyrox-client 0.2.3__tar.gz → 0.2.5__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.
- pyrox_client-0.2.5/.gitignore +26 -0
- pyrox_client-0.2.5/LICENSE +21 -0
- pyrox_client-0.2.5/PKG-INFO +207 -0
- pyrox_client-0.2.5/README.md +183 -0
- {pyrox_client-0.2.3 → pyrox_client-0.2.5}/pyproject.toml +47 -13
- pyrox_client-0.2.5/src/pyrox/__init__.py +14 -0
- {pyrox_client-0.2.3 → pyrox_client-0.2.5}/src/pyrox/core.py +127 -7
- {pyrox_client-0.2.3 → pyrox_client-0.2.5}/src/pyrox/errors.py +23 -1
- pyrox_client-0.2.5/src/pyrox/reporting.py +1176 -0
- pyrox_client-0.2.3/.gitignore +0 -5
- pyrox_client-0.2.3/PKG-INFO +0 -237
- pyrox_client-0.2.3/README.md +0 -215
- pyrox_client-0.2.3/img.png +0 -0
- pyrox_client-0.2.3/img_1.png +0 -0
- pyrox_client-0.2.3/src/pyrox/__init__.py +0 -14
- pyrox_client-0.2.3/src/pyrox/helpers.py +0 -0
- {pyrox_client-0.2.3 → pyrox_client-0.2.5}/src/pyrox/constants.py +0 -0
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
*.pyc
|
|
2
|
+
|
|
3
|
+
/src/pyrox/__pycache__/
|
|
4
|
+
__pycache__/
|
|
5
|
+
|
|
6
|
+
site/
|
|
7
|
+
dist/
|
|
8
|
+
|
|
9
|
+
.env
|
|
10
|
+
|
|
11
|
+
.vscode/
|
|
12
|
+
|
|
13
|
+
.idea/
|
|
14
|
+
|
|
15
|
+
docs/issues/
|
|
16
|
+
docs/PROJECT_STATE.md
|
|
17
|
+
|
|
18
|
+
ui/.env.capacitor
|
|
19
|
+
ui/.env
|
|
20
|
+
ui/node_modules/
|
|
21
|
+
ui/ios/DerivedData/
|
|
22
|
+
|
|
23
|
+
.venv*/
|
|
24
|
+
node_modules/
|
|
25
|
+
pyrox_duckdb
|
|
26
|
+
test.sql
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Vlad Matei
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
|
@@ -0,0 +1,207 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: pyrox-client
|
|
3
|
+
Version: 0.2.5
|
|
4
|
+
Summary: HYROX race data client – retrieve full race results via Python
|
|
5
|
+
Author: Vlad Matei
|
|
6
|
+
License-Expression: MIT
|
|
7
|
+
License-File: LICENSE
|
|
8
|
+
Requires-Python: >=3.12
|
|
9
|
+
Requires-Dist: fsspec>=2024.2.0
|
|
10
|
+
Requires-Dist: httpx>=0.28.1
|
|
11
|
+
Requires-Dist: pandas>=2.3.3
|
|
12
|
+
Requires-Dist: pyarrow>=22.0.0
|
|
13
|
+
Provides-Extra: api
|
|
14
|
+
Requires-Dist: duckdb>=1.4.3; extra == 'api'
|
|
15
|
+
Requires-Dist: fastapi>=0.115.0; extra == 'api'
|
|
16
|
+
Requires-Dist: limits>=3.0; extra == 'api'
|
|
17
|
+
Requires-Dist: mcp>=1.2.0; extra == 'api'
|
|
18
|
+
Requires-Dist: numpy>=1.26.4; extra == 'api'
|
|
19
|
+
Requires-Dist: uvicorn[standard]>=0.30.0; extra == 'api'
|
|
20
|
+
Provides-Extra: reporting
|
|
21
|
+
Requires-Dist: duckdb>=1.4.3; extra == 'reporting'
|
|
22
|
+
Requires-Dist: numpy>=1.26.4; extra == 'reporting'
|
|
23
|
+
Description-Content-Type: text/markdown
|
|
24
|
+
|
|
25
|
+
# pyrox-client
|
|
26
|
+
|
|
27
|
+
Unofficial Python client for HYROX race results.
|
|
28
|
+
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
[](https://vmatei2.github.io/pyrox-client/)
|
|
32
|
+
[](https://pypi.org/project/pyrox-client/)
|
|
33
|
+
[](https://pypi.org/project/pyrox-client/)
|
|
34
|
+
|
|
35
|
+
## Install
|
|
36
|
+
|
|
37
|
+
```bash
|
|
38
|
+
uv pip install pyrox-client
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
or
|
|
42
|
+
|
|
43
|
+
```bash
|
|
44
|
+
pip install pyrox-client
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
DuckDB-backed reporting helpers are optional. The extra installs the DuckDB
|
|
48
|
+
Python library, but it does not bundle a database file:
|
|
49
|
+
|
|
50
|
+
```bash
|
|
51
|
+
pip install "pyrox-client[reporting]"
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
## Quickstart
|
|
55
|
+
|
|
56
|
+
```python
|
|
57
|
+
import pyrox
|
|
58
|
+
|
|
59
|
+
client = pyrox.PyroxClient()
|
|
60
|
+
|
|
61
|
+
# Discover races
|
|
62
|
+
races = client.list_races()
|
|
63
|
+
seasons = client.list_seasons()
|
|
64
|
+
locations = client.list_locations(season=8)
|
|
65
|
+
years = client.list_years(season=8, location="london")
|
|
66
|
+
|
|
67
|
+
# Fetch one race
|
|
68
|
+
london = client.get_race(season=7, location="london")
|
|
69
|
+
|
|
70
|
+
# Optional filters
|
|
71
|
+
london_male_open = client.get_race(
|
|
72
|
+
season=7,
|
|
73
|
+
location="london",
|
|
74
|
+
gender="male",
|
|
75
|
+
division="open",
|
|
76
|
+
)
|
|
77
|
+
|
|
78
|
+
# Total time filter in minutes
|
|
79
|
+
sub60 = client.get_race(season=7, location="london", total_time=60)
|
|
80
|
+
range_50_60 = client.get_race(season=7, location="london", total_time=(50, 60))
|
|
81
|
+
|
|
82
|
+
# Athlete lookup in a race
|
|
83
|
+
athlete = client.get_athlete_in_race(
|
|
84
|
+
season=7,
|
|
85
|
+
location="london",
|
|
86
|
+
athlete_name="surname, name",
|
|
87
|
+
)
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
## Core API
|
|
91
|
+
|
|
92
|
+
- `list_races(season: int | None = None, force_refresh: bool = False) -> pd.DataFrame`
|
|
93
|
+
- `list_seasons(force_refresh: bool = False) -> list[int]`
|
|
94
|
+
- `list_locations(season: int | None = None, force_refresh: bool = False) -> list[str]`
|
|
95
|
+
- `list_years(season: int | None = None, location: str | None = None, force_refresh: bool = False) -> list[int]`
|
|
96
|
+
- `get_race(season, location, year=None, gender=None, division=None, total_time=None, use_cache=True) -> pd.DataFrame`
|
|
97
|
+
- `get_season(season, locations=None, gender=None, division=None, max_workers=8, use_cache=True) -> pd.DataFrame`
|
|
98
|
+
- `get_athlete_in_race(season, location, athlete_name, year=None, gender=None, division=None, use_cache=True) -> pd.DataFrame`
|
|
99
|
+
- `clear_cache(pattern="*") -> None`
|
|
100
|
+
- `cache_info() -> dict`
|
|
101
|
+
|
|
102
|
+
## Mistake Recovery
|
|
103
|
+
|
|
104
|
+
`RaceNotFound` includes manifest-backed suggestions when a race cannot be found:
|
|
105
|
+
|
|
106
|
+
```python
|
|
107
|
+
from pyrox.errors import RaceNotFound
|
|
108
|
+
|
|
109
|
+
try:
|
|
110
|
+
client.get_race(season=8, location="londn")
|
|
111
|
+
except RaceNotFound as exc:
|
|
112
|
+
print(exc)
|
|
113
|
+
print(exc.suggestions)
|
|
114
|
+
```
|
|
115
|
+
|
|
116
|
+
## Reporting Helpers
|
|
117
|
+
|
|
118
|
+
The base install keeps the public client lightweight. `ReportingClient` requires
|
|
119
|
+
`pyrox-client[reporting]` and a local DuckDB database path; the package does not
|
|
120
|
+
ship the generated database artifact.
|
|
121
|
+
|
|
122
|
+
```python
|
|
123
|
+
from pyrox.reporting import ReportingClient
|
|
124
|
+
|
|
125
|
+
reporting = ReportingClient(database="/path/to/pyrox_duckdb")
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
## MCP Server
|
|
129
|
+
|
|
130
|
+
The hosted reporting service exposes a read-only MCP server over streamable HTTP at
|
|
131
|
+
`https://pyrox-api.fly.dev/mcp/`. It lets Claude answer natural-language questions
|
|
132
|
+
against the HYROX dataset through a small set of intent-shaped tools:
|
|
133
|
+
`list_filters`, `find_athlete`, `get_distribution`, `get_rankings`,
|
|
134
|
+
`get_race_report`, `get_deepdive`, and `get_athlete_profile`.
|
|
135
|
+
|
|
136
|
+
Add it to Claude Code with the `claude mcp add` command:
|
|
137
|
+
|
|
138
|
+
```bash
|
|
139
|
+
claude mcp add --transport http pyrox https://pyrox-api.fly.dev/mcp/
|
|
140
|
+
```
|
|
141
|
+
|
|
142
|
+
Then verify the connection:
|
|
143
|
+
|
|
144
|
+
```bash
|
|
145
|
+
claude mcp list
|
|
146
|
+
```
|
|
147
|
+
|
|
148
|
+
By default this registers the server at the local (project) scope. Use
|
|
149
|
+
`--scope user` to make it available across all your projects:
|
|
150
|
+
|
|
151
|
+
```bash
|
|
152
|
+
claude mcp add --transport http --scope user pyrox https://pyrox-api.fly.dev/mcp/
|
|
153
|
+
```
|
|
154
|
+
|
|
155
|
+
To remove it:
|
|
156
|
+
|
|
157
|
+
```bash
|
|
158
|
+
claude mcp remove pyrox
|
|
159
|
+
```
|
|
160
|
+
|
|
161
|
+
### Claude web and Desktop
|
|
162
|
+
|
|
163
|
+
Pyrox also works as a custom connector in the Claude web app and Claude Desktop
|
|
164
|
+
(paid plans). Go to **Settings -> Connectors -> Add custom connector**, set the
|
|
165
|
+
name to `Pyrox` and the URL to `https://pyrox-api.fly.dev/mcp/`, and click
|
|
166
|
+
**Add**. The server is open and read-only, so it connects without a sign-in step.
|
|
167
|
+
|
|
168
|
+
For example prompts, tool semantics, and caveats, see `docs/mcp.md`.
|
|
169
|
+
|
|
170
|
+
## Documentation
|
|
171
|
+
|
|
172
|
+
- Live docs: https://vmatei2.github.io/pyrox-client/
|
|
173
|
+
- Client API: `docs/api.md`
|
|
174
|
+
- MCP guide: `docs/mcp.md`
|
|
175
|
+
- Error model: `docs/errors.md`
|
|
176
|
+
- Filters and usage notes: `docs/filters.md`
|
|
177
|
+
|
|
178
|
+
## Repository Scope
|
|
179
|
+
|
|
180
|
+
The PyPI package is the `pyrox` client library.
|
|
181
|
+
|
|
182
|
+
This repository also contains a reporting service and UI (`pyrox_api_service/`, `ui/`) used for project workflows. Those are not part of the published `pyrox-client` wheel.
|
|
183
|
+
|
|
184
|
+
Reporting-service contract note:
|
|
185
|
+
|
|
186
|
+
- Athlete profile endpoints (`/api/athletes/profile` and `/api/athletes/{athlete_id}/profile`)
|
|
187
|
+
may include optional `personal_bests[*].percentile` values in `[0, 1]`.
|
|
188
|
+
- `average_times[*].percentile` may also be present with the same semantics.
|
|
189
|
+
- Missing percentile data is non-fatal and returned by omitting the `percentile` key
|
|
190
|
+
for that segment.
|
|
191
|
+
- Profile percentile cohorts are computed against historical results in the same
|
|
192
|
+
division and gender.
|
|
193
|
+
|
|
194
|
+
Maintainer-only operational docs:
|
|
195
|
+
|
|
196
|
+
- `docs/maintainers/README.md`
|
|
197
|
+
- `docs/maintainers/release.md`
|
|
198
|
+
- `docs/maintainers/reporting-service.md`
|
|
199
|
+
|
|
200
|
+
## License
|
|
201
|
+
|
|
202
|
+
Released under the [MIT License](LICENSE) — free to use, modify, and distribute. Copyright (c) 2026 Vlad Matei.
|
|
203
|
+
|
|
204
|
+
## Disclaimer
|
|
205
|
+
|
|
206
|
+
Pyrox is an independent project and is not affiliated with, endorsed, or sponsored by HYROX.
|
|
207
|
+
HYROX and related marks are trademarks of their respective owners and are used only for descriptive purposes.
|
|
@@ -0,0 +1,183 @@
|
|
|
1
|
+
# pyrox-client
|
|
2
|
+
|
|
3
|
+
Unofficial Python client for HYROX race results.
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
[](https://vmatei2.github.io/pyrox-client/)
|
|
8
|
+
[](https://pypi.org/project/pyrox-client/)
|
|
9
|
+
[](https://pypi.org/project/pyrox-client/)
|
|
10
|
+
|
|
11
|
+
## Install
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
uv pip install pyrox-client
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
or
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
pip install pyrox-client
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
DuckDB-backed reporting helpers are optional. The extra installs the DuckDB
|
|
24
|
+
Python library, but it does not bundle a database file:
|
|
25
|
+
|
|
26
|
+
```bash
|
|
27
|
+
pip install "pyrox-client[reporting]"
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
## Quickstart
|
|
31
|
+
|
|
32
|
+
```python
|
|
33
|
+
import pyrox
|
|
34
|
+
|
|
35
|
+
client = pyrox.PyroxClient()
|
|
36
|
+
|
|
37
|
+
# Discover races
|
|
38
|
+
races = client.list_races()
|
|
39
|
+
seasons = client.list_seasons()
|
|
40
|
+
locations = client.list_locations(season=8)
|
|
41
|
+
years = client.list_years(season=8, location="london")
|
|
42
|
+
|
|
43
|
+
# Fetch one race
|
|
44
|
+
london = client.get_race(season=7, location="london")
|
|
45
|
+
|
|
46
|
+
# Optional filters
|
|
47
|
+
london_male_open = client.get_race(
|
|
48
|
+
season=7,
|
|
49
|
+
location="london",
|
|
50
|
+
gender="male",
|
|
51
|
+
division="open",
|
|
52
|
+
)
|
|
53
|
+
|
|
54
|
+
# Total time filter in minutes
|
|
55
|
+
sub60 = client.get_race(season=7, location="london", total_time=60)
|
|
56
|
+
range_50_60 = client.get_race(season=7, location="london", total_time=(50, 60))
|
|
57
|
+
|
|
58
|
+
# Athlete lookup in a race
|
|
59
|
+
athlete = client.get_athlete_in_race(
|
|
60
|
+
season=7,
|
|
61
|
+
location="london",
|
|
62
|
+
athlete_name="surname, name",
|
|
63
|
+
)
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
## Core API
|
|
67
|
+
|
|
68
|
+
- `list_races(season: int | None = None, force_refresh: bool = False) -> pd.DataFrame`
|
|
69
|
+
- `list_seasons(force_refresh: bool = False) -> list[int]`
|
|
70
|
+
- `list_locations(season: int | None = None, force_refresh: bool = False) -> list[str]`
|
|
71
|
+
- `list_years(season: int | None = None, location: str | None = None, force_refresh: bool = False) -> list[int]`
|
|
72
|
+
- `get_race(season, location, year=None, gender=None, division=None, total_time=None, use_cache=True) -> pd.DataFrame`
|
|
73
|
+
- `get_season(season, locations=None, gender=None, division=None, max_workers=8, use_cache=True) -> pd.DataFrame`
|
|
74
|
+
- `get_athlete_in_race(season, location, athlete_name, year=None, gender=None, division=None, use_cache=True) -> pd.DataFrame`
|
|
75
|
+
- `clear_cache(pattern="*") -> None`
|
|
76
|
+
- `cache_info() -> dict`
|
|
77
|
+
|
|
78
|
+
## Mistake Recovery
|
|
79
|
+
|
|
80
|
+
`RaceNotFound` includes manifest-backed suggestions when a race cannot be found:
|
|
81
|
+
|
|
82
|
+
```python
|
|
83
|
+
from pyrox.errors import RaceNotFound
|
|
84
|
+
|
|
85
|
+
try:
|
|
86
|
+
client.get_race(season=8, location="londn")
|
|
87
|
+
except RaceNotFound as exc:
|
|
88
|
+
print(exc)
|
|
89
|
+
print(exc.suggestions)
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
## Reporting Helpers
|
|
93
|
+
|
|
94
|
+
The base install keeps the public client lightweight. `ReportingClient` requires
|
|
95
|
+
`pyrox-client[reporting]` and a local DuckDB database path; the package does not
|
|
96
|
+
ship the generated database artifact.
|
|
97
|
+
|
|
98
|
+
```python
|
|
99
|
+
from pyrox.reporting import ReportingClient
|
|
100
|
+
|
|
101
|
+
reporting = ReportingClient(database="/path/to/pyrox_duckdb")
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
## MCP Server
|
|
105
|
+
|
|
106
|
+
The hosted reporting service exposes a read-only MCP server over streamable HTTP at
|
|
107
|
+
`https://pyrox-api.fly.dev/mcp/`. It lets Claude answer natural-language questions
|
|
108
|
+
against the HYROX dataset through a small set of intent-shaped tools:
|
|
109
|
+
`list_filters`, `find_athlete`, `get_distribution`, `get_rankings`,
|
|
110
|
+
`get_race_report`, `get_deepdive`, and `get_athlete_profile`.
|
|
111
|
+
|
|
112
|
+
Add it to Claude Code with the `claude mcp add` command:
|
|
113
|
+
|
|
114
|
+
```bash
|
|
115
|
+
claude mcp add --transport http pyrox https://pyrox-api.fly.dev/mcp/
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
Then verify the connection:
|
|
119
|
+
|
|
120
|
+
```bash
|
|
121
|
+
claude mcp list
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
By default this registers the server at the local (project) scope. Use
|
|
125
|
+
`--scope user` to make it available across all your projects:
|
|
126
|
+
|
|
127
|
+
```bash
|
|
128
|
+
claude mcp add --transport http --scope user pyrox https://pyrox-api.fly.dev/mcp/
|
|
129
|
+
```
|
|
130
|
+
|
|
131
|
+
To remove it:
|
|
132
|
+
|
|
133
|
+
```bash
|
|
134
|
+
claude mcp remove pyrox
|
|
135
|
+
```
|
|
136
|
+
|
|
137
|
+
### Claude web and Desktop
|
|
138
|
+
|
|
139
|
+
Pyrox also works as a custom connector in the Claude web app and Claude Desktop
|
|
140
|
+
(paid plans). Go to **Settings -> Connectors -> Add custom connector**, set the
|
|
141
|
+
name to `Pyrox` and the URL to `https://pyrox-api.fly.dev/mcp/`, and click
|
|
142
|
+
**Add**. The server is open and read-only, so it connects without a sign-in step.
|
|
143
|
+
|
|
144
|
+
For example prompts, tool semantics, and caveats, see `docs/mcp.md`.
|
|
145
|
+
|
|
146
|
+
## Documentation
|
|
147
|
+
|
|
148
|
+
- Live docs: https://vmatei2.github.io/pyrox-client/
|
|
149
|
+
- Client API: `docs/api.md`
|
|
150
|
+
- MCP guide: `docs/mcp.md`
|
|
151
|
+
- Error model: `docs/errors.md`
|
|
152
|
+
- Filters and usage notes: `docs/filters.md`
|
|
153
|
+
|
|
154
|
+
## Repository Scope
|
|
155
|
+
|
|
156
|
+
The PyPI package is the `pyrox` client library.
|
|
157
|
+
|
|
158
|
+
This repository also contains a reporting service and UI (`pyrox_api_service/`, `ui/`) used for project workflows. Those are not part of the published `pyrox-client` wheel.
|
|
159
|
+
|
|
160
|
+
Reporting-service contract note:
|
|
161
|
+
|
|
162
|
+
- Athlete profile endpoints (`/api/athletes/profile` and `/api/athletes/{athlete_id}/profile`)
|
|
163
|
+
may include optional `personal_bests[*].percentile` values in `[0, 1]`.
|
|
164
|
+
- `average_times[*].percentile` may also be present with the same semantics.
|
|
165
|
+
- Missing percentile data is non-fatal and returned by omitting the `percentile` key
|
|
166
|
+
for that segment.
|
|
167
|
+
- Profile percentile cohorts are computed against historical results in the same
|
|
168
|
+
division and gender.
|
|
169
|
+
|
|
170
|
+
Maintainer-only operational docs:
|
|
171
|
+
|
|
172
|
+
- `docs/maintainers/README.md`
|
|
173
|
+
- `docs/maintainers/release.md`
|
|
174
|
+
- `docs/maintainers/reporting-service.md`
|
|
175
|
+
|
|
176
|
+
## License
|
|
177
|
+
|
|
178
|
+
Released under the [MIT License](LICENSE) — free to use, modify, and distribute. Copyright (c) 2026 Vlad Matei.
|
|
179
|
+
|
|
180
|
+
## Disclaimer
|
|
181
|
+
|
|
182
|
+
Pyrox is an independent project and is not affiliated with, endorsed, or sponsored by HYROX.
|
|
183
|
+
HYROX and related marks are trademarks of their respective owners and are used only for descriptive purposes.
|
|
@@ -8,37 +8,63 @@ dynamic = ["version"]
|
|
|
8
8
|
description = "HYROX race data client – retrieve full race results via Python"
|
|
9
9
|
authors = [{ name = "Vlad Matei" }]
|
|
10
10
|
readme = {file="README.md", content-type = "text/markdown" }
|
|
11
|
+
license = "MIT"
|
|
12
|
+
license-files = ["LICENSE"]
|
|
11
13
|
requires-python = ">=3.12"
|
|
12
14
|
dependencies = [
|
|
13
15
|
"pandas>=2.3.3",
|
|
14
|
-
"fastparquet>=2024.5.0",
|
|
15
16
|
"fsspec>=2024.2.0",
|
|
16
|
-
"s3fs>=2024.2.0",
|
|
17
|
-
"platformdirs>=4.2.0",
|
|
18
17
|
"httpx>=0.28.1",
|
|
19
18
|
"pyarrow>=22.0.0", # stable versions with wheels, had issues with latest
|
|
20
|
-
"statsmodels>=0.14.6",
|
|
21
|
-
"twine>=6.2.0",
|
|
22
19
|
]
|
|
23
20
|
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
21
|
+
[project.optional-dependencies]
|
|
22
|
+
reporting = [
|
|
23
|
+
"duckdb>=1.4.3",
|
|
24
|
+
"numpy>=1.26.4",
|
|
28
25
|
]
|
|
29
26
|
|
|
30
|
-
|
|
31
|
-
|
|
27
|
+
# Repository-local service dependencies (FastAPI service lives in pyrox_api_service/).
|
|
28
|
+
api = [
|
|
29
|
+
"duckdb>=1.4.3",
|
|
30
|
+
"fastapi>=0.115.0",
|
|
31
|
+
"limits>=3.0",
|
|
32
|
+
"mcp>=1.2.0",
|
|
33
|
+
"numpy>=1.26.4",
|
|
34
|
+
"uvicorn[standard]>=0.30.0",
|
|
35
|
+
]
|
|
36
|
+
|
|
37
|
+
# urls."Homepage" = "https://github.com/vmatei2/pyrox-client"
|
|
38
|
+
# urls."Issues" = "https://github.com/vmatei2/pyrox-client/issues"
|
|
32
39
|
|
|
33
40
|
[tool.hatch.build.targets.wheel]
|
|
34
41
|
packages = ["src/pyrox"]
|
|
35
42
|
|
|
43
|
+
exclude = [
|
|
44
|
+
"src/pyrox/api/**",
|
|
45
|
+
"src/pyrox/helpers.py",
|
|
46
|
+
]
|
|
47
|
+
|
|
36
48
|
[tool.hatch.build.targets.sdist]
|
|
37
49
|
include = [
|
|
38
|
-
"src/pyrox",
|
|
39
50
|
"README.md",
|
|
40
51
|
"pyproject.toml",
|
|
41
|
-
"
|
|
52
|
+
"src/pyrox/**",
|
|
53
|
+
]
|
|
54
|
+
exclude = [
|
|
55
|
+
"src/pyrox/api/**",
|
|
56
|
+
"src/pyrox/helpers.py",
|
|
57
|
+
"**/__pycache__/**",
|
|
58
|
+
"*.pyc",
|
|
59
|
+
"ui/**",
|
|
60
|
+
"pyrox_api_service/**",
|
|
61
|
+
"scripts/**",
|
|
62
|
+
"docs/**",
|
|
63
|
+
"example_notebooks/**",
|
|
64
|
+
".venv*/**",
|
|
65
|
+
"node_modules/**",
|
|
66
|
+
"dist/**",
|
|
67
|
+
"pyrox_duckdb",
|
|
42
68
|
]
|
|
43
69
|
|
|
44
70
|
[tool.hatch.version]
|
|
@@ -47,6 +73,8 @@ path = "src/pyrox/__init__.py"
|
|
|
47
73
|
[dependency-groups]
|
|
48
74
|
dev = [
|
|
49
75
|
"black>=25.11.0",
|
|
76
|
+
"duckdb>=1.4.3",
|
|
77
|
+
"fastparquet>=2024.5.0",
|
|
50
78
|
"isort>=6.1.0",
|
|
51
79
|
"pylint>=3.3.9",
|
|
52
80
|
"pytest>=8.4.2",
|
|
@@ -57,4 +85,10 @@ dev = [
|
|
|
57
85
|
"seaborn>=0.13.2",
|
|
58
86
|
"ipykernel>=7.1.0",
|
|
59
87
|
"mkdocs>=1.6.1",
|
|
88
|
+
"python-dotenv>=1.0.0",
|
|
89
|
+
"s3fs>=2024.2.0",
|
|
90
|
+
"scikit-learn>=1.8.0",
|
|
91
|
+
"statsmodels>=0.14.6",
|
|
92
|
+
"twine>=6.2.0",
|
|
93
|
+
"bs4>=0.0.2",
|
|
60
94
|
]
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
"""Public package exports for pyrox-client."""
|
|
2
|
+
|
|
3
|
+
from .core import PyroxClient
|
|
4
|
+
from .errors import AthleteNotFound, PyroxError, RaceNotFound
|
|
5
|
+
|
|
6
|
+
__version__ = "0.2.5"
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
__all__ = [
|
|
10
|
+
"PyroxClient",
|
|
11
|
+
"PyroxError",
|
|
12
|
+
"RaceNotFound",
|
|
13
|
+
"AthleteNotFound",
|
|
14
|
+
]
|