B -->|diagnostics_for_mt940| C["diagnostic engine (MT940 tag patterns)"]
C -->|Diagnostic objects| B
B -->|publishDiagnostics| A
---
## When not to use bankstatementparser-lsp
- **You're not editing MT940 statements.** The server targets the SWIFT
MT940 tag-and-line format (`.mt940` / `.sta`); for CAMT XML or other
formats use a format-appropriate language server.
- **You need full parsing, not editor diagnostics.** Use the core
[`bankstatementparser`](https://pypi.org/project/bankstatementparser/)
library to parse statements into structured records.
---
## Development
`bankstatementparser-lsp` uses [Poetry](https://python-poetry.org/) and
[mise](https://mise.jdx.dev/).
```bash
git clone https://github.com/sebastienrousseau/bankstatementparser-lsp.git
cd bankstatementparser-lsp
mise install
poetry install
A Makefile orchestrates the quality gates (kept in lockstep with CI):
| Target | What it runs |
|---|---|
make check |
All gates (REQUIRED before commit) |
make test |
pytest --cov=bankstatementparser_lsp --cov-branch --cov-fail-under=100 |
make lint |
ruff check + ruff format --check |
make type-check |
mypy --strict |
make examples |
Run the example scripts |
Current state (v0.0.14): 56 tests passing, 100% line + branch
coverage against a 100% enforced floor, mypy --strict clean,
interrogate 100% docstring coverage. The suite includes documentation
and example regression tests
(tests/test_docs_accuracy.py,
tests/test_regression_docs.py,
tests/test_regression_examples.py)
that execute every documented snippet and every examples/*.py script.
Security
- No filesystem writes. The server reads from the editor's in-memory document buffer; no scratch files, no temp directories.
- MT940 parsing is a pure-
reline scanner over text from the editor — noeval, no shelling out, no XML, no network. - Lint findings are returned as
lsprotocol.Diagnosticobjects with no stack traces, so the editor never sees an internal path or exception message. - Dependencies are pinned via
poetry.lockand audited bypip-auditand Bandit in CI.
To report a vulnerability, please use GitHub private vulnerability reporting rather than a public issue.
Documentation
- Runnable examples:
examples/ - VS Code scaffold:
editors/vscode/ - Release history: CHANGELOG.md
- Core library docs: docs.bankstatementparser.com
- LSP specification: microsoft.github.io/language-server-protocol
Contributing
Contributions are welcome — see the
contributing instructions.
Thanks to all the
contributors
who have helped build bankstatementparser-lsp.
License
Licensed under the Apache License, Version 2.0.
Built on pygls and
lsprotocol by the
Open Law Library, and on the core
bankstatementparser library that
powers the validators and schemas.
Any contribution submitted for inclusion shall be licensed as above, without additional terms.
Metadata
Release files for bankstatementparser-lsp 0.0.14
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| bankstatementparser_lsp-0.0.14.tar.gz | 13.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| bankstatementparser_lsp-0.0.14-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 29.6 kB
Release files / bankstatementparser_lsp-0.0.14.tar.gz
| Download URL | bankstatementparser_lsp-0.0.14.tar.gz |
|---|---|
| Size | 13.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
1dad588732f671c7c0dc6ffa1183aab3eac0b76aa2ce5c86b5639eb4770a1079
|
|
BLAKE2b-256 checksum How to use checksums |
d9aa165de2d44f9a9fd0d0ead6fce310f4330ec17a2eb79ce25c49916633baad
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 28, 2026.
Transparency logRelease files / bankstatementparser_lsp-0.0.14-py3-none-any.whl
| Download URL | bankstatementparser_lsp-0.0.14-py3-none-any.whl |
|---|---|
| Size | 16.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
7bf874936b867ca14e86daf2a770de0639b3dde822cf526a51778400bcf16fea
|
|
BLAKE2b-256 checksum How to use checksums |
7856145cf2411a78ea7dba59292be8ec1cb0678b3f599bf0a90242606d5b49a1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 28, 2026.
Transparency log