txapi-sdk 1.0.0__tar.gz → 1.0.1__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.
- {txapi_sdk-1.0.0 → txapi_sdk-1.0.1}/CHANGELOG.md +13 -7
- {txapi_sdk-1.0.0 → txapi_sdk-1.0.1}/PKG-INFO +4 -4
- {txapi_sdk-1.0.0 → txapi_sdk-1.0.1}/README.md +3 -3
- {txapi_sdk-1.0.0 → txapi_sdk-1.0.1}/pyproject.toml +1 -1
- {txapi_sdk-1.0.0 → txapi_sdk-1.0.1}/src/txapi/_version.py +1 -1
- {txapi_sdk-1.0.0 → txapi_sdk-1.0.1}/.gitignore +0 -0
- {txapi_sdk-1.0.0 → txapi_sdk-1.0.1}/LICENSE +0 -0
- {txapi_sdk-1.0.0 → txapi_sdk-1.0.1}/src/txapi/__init__.py +0 -0
- {txapi_sdk-1.0.0 → txapi_sdk-1.0.1}/src/txapi/_client.py +0 -0
- {txapi_sdk-1.0.0 → txapi_sdk-1.0.1}/src/txapi/_core.py +0 -0
- {txapi_sdk-1.0.0 → txapi_sdk-1.0.1}/src/txapi/_endpoints.py +0 -0
- {txapi_sdk-1.0.0 → txapi_sdk-1.0.1}/src/txapi/_errors.py +0 -0
- {txapi_sdk-1.0.0 → txapi_sdk-1.0.1}/src/txapi/_generated.py +0 -0
- {txapi_sdk-1.0.0 → txapi_sdk-1.0.1}/src/txapi/_pagination.py +0 -0
- {txapi_sdk-1.0.0 → txapi_sdk-1.0.1}/src/txapi/_protocols.py +0 -0
- {txapi_sdk-1.0.0 → txapi_sdk-1.0.1}/src/txapi/_ratelimit.py +0 -0
- {txapi_sdk-1.0.0 → txapi_sdk-1.0.1}/src/txapi/live.py +0 -0
- {txapi_sdk-1.0.0 → txapi_sdk-1.0.1}/src/txapi/py.typed +0 -0
- {txapi_sdk-1.0.0 → txapi_sdk-1.0.1}/src/txapi/types.py +0 -0
- {txapi_sdk-1.0.0 → txapi_sdk-1.0.1}/src/txapi/webhooks.py +0 -0
|
@@ -4,16 +4,13 @@ All notable changes to the txApi Python SDK (distribution `txapi-sdk`, import `t
|
|
|
4
4
|
[Keep a Changelog](https://keepachangelog.com/en/1.1.0/), versions follow
|
|
5
5
|
[Semantic Versioning](https://semver.org/).
|
|
6
6
|
|
|
7
|
-
## [
|
|
7
|
+
## [1.0.1] — 2026-10-25
|
|
8
8
|
|
|
9
9
|
### Fixed
|
|
10
10
|
|
|
11
|
-
- `
|
|
12
|
-
`
|
|
13
|
-
|
|
14
|
-
`timeout`, raises `APITimeoutError` if none comes, and `APIConnectionError` with the close
|
|
15
|
-
code and reason if the stream was refused (1008) or has ended. The README example works as
|
|
16
|
-
written.
|
|
11
|
+
- `scripts/generate.py` and its freshness test work in a Windows virtualenv: they find
|
|
12
|
+
`Scripts\ruff.exe` and pass the source to ruff as UTF-8 (the locale default there is
|
|
13
|
+
cp1252). Only affects development of the SDK; the package itself is unchanged.
|
|
17
14
|
|
|
18
15
|
## [1.0.0] — 2026-10-14
|
|
19
16
|
|
|
@@ -45,3 +42,12 @@ First release, targeting txApi **1.8.0**. Published on PyPI as **`txapi-sdk`** (
|
|
|
45
42
|
- Live console and server-log streams (`txapi[live]`, `websockets`): async iteration or
|
|
46
43
|
callbacks, `send_command` with FIFO ack correlation and timeout, automatic reconnect on
|
|
47
44
|
1001/1006/1011/1012 and network loss, no reconnect on 1008/1009 with the close reason surfaced.
|
|
45
|
+
|
|
46
|
+
### Fixed
|
|
47
|
+
|
|
48
|
+
- `ConsoleStream.send_command()` right after `async with client.console.connect()` raised
|
|
49
|
+
`APIConnectionError("live console is not connected")` against the real API — `async with`
|
|
50
|
+
only starts connecting in the background. It now waits for the (re)connect within
|
|
51
|
+
`timeout`, raises `APITimeoutError` if none comes, and `APIConnectionError` with the close
|
|
52
|
+
code and reason if the stream was refused (1008) or has ended. The README example works as
|
|
53
|
+
written. (Fixed before the first public release; part of every published 1.0.0 file.)
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.5
|
|
2
2
|
Name: txapi-sdk
|
|
3
|
-
Version: 1.0.
|
|
3
|
+
Version: 1.0.1
|
|
4
4
|
Summary: Official Python SDK for the txApi REST and WebSocket API (txAdmin / FiveM server management)
|
|
5
5
|
Project-URL: Homepage, https://txapi.cloud
|
|
6
6
|
Project-URL: Documentation, https://txapi.cloud/docs/sdks
|
|
@@ -59,7 +59,7 @@ the import stays `import txapi`. Every release is also attached to
|
|
|
59
59
|
`https://txapi.cloud/sdks/` (checksums in `SHA256SUMS`), for setups without PyPI access:
|
|
60
60
|
|
|
61
61
|
```bash
|
|
62
|
-
pip install "txapi-sdk[live] @ https://txapi.cloud/sdks/txapi_sdk-1.0.
|
|
62
|
+
pip install "txapi-sdk[live] @ https://txapi.cloud/sdks/txapi_sdk-1.0.1-py3-none-any.whl"
|
|
63
63
|
```
|
|
64
64
|
|
|
65
65
|
## Contents
|
|
@@ -123,7 +123,7 @@ asyncio.run(main())
|
|
|
123
123
|
| `server_id` | — | default server for every server-scoped call; each call can pass `server_id=` |
|
|
124
124
|
| `timeout` | `30` | seconds per attempt; each call can pass `timeout=` |
|
|
125
125
|
| `max_retries` | `2` | retries after the first attempt, `0` disables retries |
|
|
126
|
-
| `user_agent` | — | appended to `txapi-python/1.0.
|
|
126
|
+
| `user_agent` | — | appended to `txapi-python/1.0.1` |
|
|
127
127
|
| `http_client` | — | your own `httpx.Client` / `httpx.AsyncClient` (not closed by the SDK) |
|
|
128
128
|
| `on_request` / `on_response` | — | hooks for logging/metrics |
|
|
129
129
|
|
|
@@ -133,7 +133,7 @@ print(client.account.servers()) # account-level: no serverId is s
|
|
|
133
133
|
client.server.status(server_id=2) # override the default server for one call
|
|
134
134
|
```
|
|
135
135
|
|
|
136
|
-
`txapi.__version__` is the SDK version (`1.0.
|
|
136
|
+
`txapi.__version__` is the SDK version (`1.0.1`), `txapi.API_VERSION` the API version it was
|
|
137
137
|
built for (`1.8.0`).
|
|
138
138
|
|
|
139
139
|
## Calling endpoints
|
|
@@ -22,7 +22,7 @@ the import stays `import txapi`. Every release is also attached to
|
|
|
22
22
|
`https://txapi.cloud/sdks/` (checksums in `SHA256SUMS`), for setups without PyPI access:
|
|
23
23
|
|
|
24
24
|
```bash
|
|
25
|
-
pip install "txapi-sdk[live] @ https://txapi.cloud/sdks/txapi_sdk-1.0.
|
|
25
|
+
pip install "txapi-sdk[live] @ https://txapi.cloud/sdks/txapi_sdk-1.0.1-py3-none-any.whl"
|
|
26
26
|
```
|
|
27
27
|
|
|
28
28
|
## Contents
|
|
@@ -86,7 +86,7 @@ asyncio.run(main())
|
|
|
86
86
|
| `server_id` | — | default server for every server-scoped call; each call can pass `server_id=` |
|
|
87
87
|
| `timeout` | `30` | seconds per attempt; each call can pass `timeout=` |
|
|
88
88
|
| `max_retries` | `2` | retries after the first attempt, `0` disables retries |
|
|
89
|
-
| `user_agent` | — | appended to `txapi-python/1.0.
|
|
89
|
+
| `user_agent` | — | appended to `txapi-python/1.0.1` |
|
|
90
90
|
| `http_client` | — | your own `httpx.Client` / `httpx.AsyncClient` (not closed by the SDK) |
|
|
91
91
|
| `on_request` / `on_response` | — | hooks for logging/metrics |
|
|
92
92
|
|
|
@@ -96,7 +96,7 @@ print(client.account.servers()) # account-level: no serverId is s
|
|
|
96
96
|
client.server.status(server_id=2) # override the default server for one call
|
|
97
97
|
```
|
|
98
98
|
|
|
99
|
-
`txapi.__version__` is the SDK version (`1.0.
|
|
99
|
+
`txapi.__version__` is the SDK version (`1.0.1`), `txapi.API_VERSION` the API version it was
|
|
100
100
|
built for (`1.8.0`).
|
|
101
101
|
|
|
102
102
|
## Calling endpoints
|
|
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
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|