pylekto
Async Python client for the Lekto DMS REST API.
pylekto reaches every operation of the API an API token may use: auth (who calls), health,
version (and whether a newer Lekto is out), documents (with uploads, downloads, facts, page
edits, changes of many documents), search, relations, the master data (contacts,
document_types, tags, fields), spaces, users, identifiers, the open_identifiers, the
inbox, the expected documents, lenses, rules (with templates), mailboxes, mail_rules,
webhooks, push, the pipeline, jobs, automation, the classifier and the events as they
happen. pylekto.webhooks receives what Lekto sends to a webhook.
import asyncio
from pylekto import LektoClient
async def main() -> None:
async with LektoClient("https://lekto.example.com", "lekto_…") as lekto:
me = await lekto.auth.me()
print(me.user.username, me.token_scope)
async for document in lekto.documents.list(lane=["red"]):
print(document.title)
result = await lekto.search.page("electricity bill", limit=5)
print([hit.document.title for hit in result.items])
async for event in lekto.events.listen(): # until the stream ends or raises a LektoError
print(event.type, event.document_id)
asyncio.run(main())
- Token only. A personal API token from Lekto; its rights (chosen one by one, or a preset:
read,read_write,upload) decide what the client may do, andlekto.auth.me()names them. - Your own httpx2 client if you like (
LektoClient(url, token, client=...)): pylekto sends its requests with it and leaves it open. - Errors raise. Each subclass of
LektoErrorsays what went wrong; a refusal carries Lekto's problem details with a reason code. pylekto repeats nothing: whether to try again is up to you. - New values read. A choice in the models is
Literal[...] | Unknown: a value that a newer Lekto sends and this pylekto does not know arrives aspylekto.Unknown(astr) instead of failing;case Unknown():matches it. - One version of the API. pylekto speaks the API
pylekto.API_VERSIONof Lektopylekto.LEKTO_VERSION; its models are generated from that release's OpenAPI description. Connecting to a Lekto whose API may differ warns (LektoVersionWarning): during the beta (0.x) every other MINOR, from1.0on another MAJOR or a smaller MINOR.
Receiving webhooks
Lekto signs what it sends to a webhook (Standard Webhooks). In whatever web framework receives it:
from pylekto import webhooks
from pylekto.models import TaskAnswer
async def receive(headers: dict[str, str], body: bytes) -> None:
webhooks.verify(headers, body, "whsec_…") # raises WebhookVerificationError
asked = webhooks.read_rule_ask(body) # or read_event, read_rule_send, read_propose …
task = webhooks.task(headers)
if task is not None:
await webhooks.answer(task, TaskAnswer(status="ok", answer={"paid": True}))
Requirements
Python 3.14 or newer.
Development
Open the repository in its devcontainer (.devcontainer/); it runs script/setup, which
installs the dependencies and the Git hooks. Outside the devcontainer, script/setup creates a
local .venv first.
uv sync
uv run prek run --all-files # every check: Ruff, mypy, pytest with coverage, typos, yamllint
License
MIT, see LICENSE.
Metadata
Release files for pylekto 0.2.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| pylekto-0.2.1.tar.gz | 101.8 kB | With provenance | Details for pylekto-0.2.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| pylekto-0.2.1-py3-none-any.whl | Python 3 | none | any | Details for pylekto-0.2.1-py3-none-any.whl |
Total release size: 214.3 kB
Release files / pylekto-0.2.1.tar.gz
| Download URL | pylekto-0.2.1.tar.gz |
|---|---|
| Size | 101.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
306b0cc88d569228cd6d6eecb6f3302a710614addb13122e693313a5413e1971
|
|
BLAKE2b-256 checksum How to use checksums |
456b56f182ba9a962088958d0837240df9e15d49dbbbb2b9154af9fcc90aa5d6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
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 Nov 20, 2026.
Transparency logRelease files / pylekto-0.2.1-py3-none-any.whl
| Download URL | pylekto-0.2.1-py3-none-any.whl |
|---|---|
| Size | 112.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
f8cb9418768dd7cd34848fa5462e1f908ccde870c335655b54459b8add704f24
|
|
BLAKE2b-256 checksum How to use checksums |
c46625b7b0ab944c727727bbfcf045a6c251fe16c07ca574f59d9cc53177e88d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
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 Nov 20, 2026.
Transparency logSecurity for pylekto 0.2.1
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.
Full provenance
Both files in this release have been uploaded with provenance metadata.
Attestation for pylekto-0.2.1.tar.gz
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 Nov 20, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.