mirror of
https://github.com/NCBM/plyngent.git
synced 2026-07-23 05:55:16 +08:00
docs+ci: document ruff format --check; format app.py
This commit is contained in:
@@ -12,12 +12,15 @@ Plyngent is an LLM chat and agent toolkit (Python 3.14+, PDM-managed). Single-us
|
||||
pdm install # first-time dependency setup
|
||||
pdm sync # sync after pulling changes
|
||||
|
||||
pdm run basedpyright . # type checking (basedpyright, "recommended" strictness)
|
||||
pdm run ruff check . # linting
|
||||
pdm run ruff format . # formatting
|
||||
pdm run pytest # tests (pytest-asyncio auto mode)
|
||||
pdm run ruff check . # linting
|
||||
pdm run ruff format . # apply formatting
|
||||
pdm run ruff format --check . # CI: fail if unformatted (do not skip)
|
||||
pdm run basedpyright . # type checking (basedpyright, "recommended" strictness)
|
||||
pdm run pytest # tests (pytest-asyncio auto mode)
|
||||
```
|
||||
|
||||
GitHub Actions runs `ruff check`, `ruff format --check`, `basedpyright`, then `pytest`. Format locally with `pdm run ruff format .` so CI does not fail after publish.
|
||||
|
||||
## Architecture
|
||||
|
||||
### Data modeling: `msgspec.Struct`
|
||||
|
||||
Reference in New Issue
Block a user