python-nanokvm
Async Python client for the Sipeed NanoKVM and NanoKVM Pro.
pip install nanokvm
Usage
import asyncio
from nanokvm.client import NanoKVMClient
from nanokvm.models import GpioType, MouseButton
async def main() -> None:
async with NanoKVMClient("https://kvm.local/api/") as client:
await client.authenticate("username", "password")
await client.push_button(GpioType.POWER, duration_ms=1000)
await client.paste_text("Hello\nworld!")
await client.mouse_click(MouseButton.LEFT, 0.5, 0.5)
async for frame in client.mjpeg_stream():
frame.save("screen.jpg")
break
asyncio.run(main())
The client detects the hardware and firmware, and raises
NanoKVMNotSupportedError instead of calling an endpoint the device lacks.
Scripts that do not use asyncio can use the same API as blocking calls through
nanokvm.sync_client.NanoKVMSyncClient.
Documentation
- Connecting and authentication: HTTPS and self-signed certificates, sessions, passwords and user accounts
- API reference: every method and the hardware and firmware it needs
- Blocking client: the API without asyncio
- Errors
- SSH
1 maintainer
Metadata
1 maintainer
Release files for nanokvm 1.5.0
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 |
|---|---|---|---|---|
| nanokvm-1.5.0.tar.gz | 100.2 kB | With provenance | Details for nanokvm-1.5.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| nanokvm-1.5.0-py3-none-any.whl | Python 3 | none | any | Details for nanokvm-1.5.0-py3-none-any.whl |
Total release size: 156.6 kB
Release files / nanokvm-1.5.0.tar.gz
| Download URL | nanokvm-1.5.0.tar.gz |
|---|---|
| Size | 100.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
7a6d45921bd1d2c21927f2da2ee32b7eae3bc14fc9212919db1096212a0de868
|
|
BLAKE2b-256 checksum How to use checksums |
c46be6e7f1a3dbf60e4e8fd5479ebc38e70a8a9e88a65e1420e66448b5e62689
|
| 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 Oct 28, 2026.
Transparency logRelease files / nanokvm-1.5.0-py3-none-any.whl
| Download URL | nanokvm-1.5.0-py3-none-any.whl |
|---|---|
| Size | 56.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
cf116b3b58c54825c790458586834fd4f09d6ee5755cf075264a9c3b80c75939
|
|
BLAKE2b-256 checksum How to use checksums |
e02a5985901a19ef29583f60321fd80bcdf2c2dc72d3f8ee08d98276e6669ff0
|
| 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 Oct 28, 2026.
Transparency logSecurity for nanokvm 1.5.0
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 nanokvm-1.5.0.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 Oct 28, 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.
