Skip to content

Commit fbe90f3

Browse files
authored
Use 'sdk' in schema generator names (#3)
1 parent 37bd4a0 commit fbe90f3

25 files changed

+65
-65
lines changed

.gitmodules

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
[submodule "lmsjs-schema/lmstudio.js"]
2-
path = lmsjs-schema/lmstudio.js
1+
[submodule "sdk-schema/lmstudio.js"]
2+
path = sdk-schema/lmstudio.js
33
url = https://github.com/lmstudio-ai/lmstudio.js.git

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ $ git clone https://github.com/lmstudio-ai/lmstudio-python
6363
$ cd lmstudio-python
6464
```
6565

66-
To be able to run `tox -e sync-lmsjs-schema`, it is also
66+
To be able to run `tox -e sync-sdk-schema`, it is also
6767
necessary to ensure the `lmstudio.js` submodule is updated:
6868

6969
```console
@@ -190,12 +190,12 @@ Additional notes on running and updating the tests can be found in the
190190

191191
### Expanding the API
192192

193-
- the content of `src/lmstudio/_lmsjs_models` is automatically generated by the
194-
`sync-lmsjs-schema.py` script in `lmsjs-schema` and should not be modified directly.
195-
Run `tox -e sync-lmsjs-schema` to regenerate the Python submodule from the existing
193+
- the content of `src/lmstudio/_sdk_models` is automatically generated by the
194+
`sync-sdk-schema.py` script in `sdk-schema` and should not be modified directly.
195+
Run `tox -e sync-sdk-schema` to regenerate the Python submodule from the existing
196196
export of the `lmstudio.js` schema (for example, after modifying the data model
197-
template). Run `tox -e sync-lmsjs-schema -- --regen-schema` after updating the
198-
`lmsjs-schema/lmstudio.js` submodule itself to a newer iteration of the
197+
template). Run `tox -e sync-sdk-schema -- --regen-schema` after updating the
198+
`sdk-schema/lmstudio.js` submodule itself to a newer iteration of the
199199
`lmstudio.js` JSON API.
200200
- as support for new API namespaces is added to the SDK, each should get a dedicated
201201
session type (similar to those for the already supported namespaces), even if it

lmsjs-schema/README.md

Lines changed: 0 additions & 7 deletions
This file was deleted.

pdm.lock

Lines changed: 30 additions & 30 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

pyproject.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ dependencies = [
2323
"typing-extensions>=4.12.2",
2424
]
2525

26-
# Keep this in sync with the target Python version in sync-lmsjs-schema.py
26+
# Keep this in sync with the target Python version in sync-sdk-schema.py
2727
requires-python = ">=3.11"
2828

2929
readme = "README.md"
@@ -71,7 +71,7 @@ dev = [
7171
bootstrap = [
7272
"pdm>=2.16.1",
7373
]
74-
sync-lmsjs-schema = [
74+
sync-sdk-schema = [
7575
# Needs https://github.com/koxudaxi/datamodel-code-generator/issues/2211 fix
7676
"datamodel-code-generator[http]>=0.26.4",
7777
]
File renamed without changes.

sdk-schema/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
lmstudio.js JSON Schema export
2+
==============================
3+
4+
`tox -e sync-sdk-schema` runs `sync-sdk-schema.py` in
5+
a suitably configured Python environment.
6+
7+
The generated models are written to `../src/lmstudio.js/_sdk_models/*.py`.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)