Python REST API client for Shaken Fist
This is a python REST API client and command line client for the minimal cloud Shaken Fist.
The library is a complete interface to the Shaken Fist HTTP API.
VDI console access
sf-client instance vdiconsole <ref> opens a graphical console for an
instance. When the Shaken Fist server advertises the
vdi-console-proxy capability, the console is opened seamlessly
through the Kerbside SPICE
proxy; otherwise the client falls back to its existing
direct-to-hypervisor .vv path. Either way this "just works" without
any extra flags.
Install the optional vdi extra to get a viewer that supports the
seamless proxy path out of the box:
pip install shakenfist-client[vdi]
This pulls in ryll on Linux
(it is not published for other platforms, so the extra resolves
cleanly -- but does nothing -- elsewhere). When ryll is on PATH
and the proxy is used, the console JWT is never written to disk --
ryll performs the token exchange itself directly from the proxy
URL.
Two options tune this behaviour:
--viewer <ryll|remote-viewer|PATH>-- override viewer auto-detection, which otherwise prefersryllonPATHand falls back toremote-viewer.--direct-- force the original direct-to-hypervisor.vvpath, bypassing the Kerbside proxy even when the server advertises it.
remote-viewer (from virt-viewer) remains fully supported as a
fallback for either path -- the .vv file the client writes is a
standard virt-viewer file. sf-client instance vdiconsolefile
downloads that same .vv file without launching a viewer, and
accepts --direct too.
Documentation
- ARCHITECTURE.md -- project structure and key components
- AGENTS.md -- guide for AI agents working on this codebase
- RELEASE-SETUP.md -- one-time release infrastructure setup
2 maintainers
Release files for shakenfist-client 0.8.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| shakenfist_client-0.8.3.tar.gz | 72.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| shakenfist_client-0.8.3-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 130.4 kB
Release files / shakenfist_client-0.8.3.tar.gz
| Download URL | shakenfist_client-0.8.3.tar.gz |
|---|---|
| Size | 72.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
42317ccbbcf6bf0531cafcb24e2fdd90eb9a4ff5fb4d6240ad3810ed9a98b988
|
|
BLAKE2b-256 checksum How to use checksums |
e0739049627311eaa334d8c89c45920fe2e1d6d73d35c5a8b40c765997cc6847
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.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 Jul 24, 2026.
Transparency logRelease files / shakenfist_client-0.8.3-py3-none-any.whl
| Download URL | shakenfist_client-0.8.3-py3-none-any.whl |
|---|---|
| Size | 58.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
a00ff0aa9a77c902a30b5cf45de40d75b9b1897e0e04e8a6b14242f4918db0e2
|
|
BLAKE2b-256 checksum How to use checksums |
547c0859e48c30ca076bc4b824145abfa768990e6afa20f8db7fae4f0e5f90be
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.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 Jul 24, 2026.
Transparency log
