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
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file shakenfist_client-0.8.3.tar.gz.
File metadata
- Download URL: shakenfist_client-0.8.3.tar.gz
- Upload date:
- Size: 72.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
42317ccbbcf6bf0531cafcb24e2fdd90eb9a4ff5fb4d6240ad3810ed9a98b988
|
|
| MD5 |
3ebee65183cbbb2b5cbb015a859dc631
|
|
| BLAKE2b-256 |
e0739049627311eaa334d8c89c45920fe2e1d6d73d35c5a8b40c765997cc6847
|
Provenance
The following attestation bundles were made for shakenfist_client-0.8.3.tar.gz:
Publisher:
release.yml on shakenfist/client-python
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
shakenfist_client-0.8.3.tar.gz -
Subject digest:
42317ccbbcf6bf0531cafcb24e2fdd90eb9a4ff5fb4d6240ad3810ed9a98b988 - Sigstore transparency entry: 2239093546
- Sigstore integration time:
-
Permalink:
shakenfist/client-python@b426e1f864c048a9f1d9de32adf9e2d8e1c3880e -
Branch / Tag:
refs/tags/v0.8.3 - Owner: https://github.com/shakenfist
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
self-hosted -
Publication workflow:
release.yml@b426e1f864c048a9f1d9de32adf9e2d8e1c3880e -
Trigger Event:
push
-
Statement type:
File details
Details for the file shakenfist_client-0.8.3-py3-none-any.whl.
File metadata
- Download URL: shakenfist_client-0.8.3-py3-none-any.whl
- Upload date:
- Size: 58.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a00ff0aa9a77c902a30b5cf45de40d75b9b1897e0e04e8a6b14242f4918db0e2
|
|
| MD5 |
c7e5ee28ff96513b7153a6489f2b29e8
|
|
| BLAKE2b-256 |
547c0859e48c30ca076bc4b824145abfa768990e6afa20f8db7fae4f0e5f90be
|
Provenance
The following attestation bundles were made for shakenfist_client-0.8.3-py3-none-any.whl:
Publisher:
release.yml on shakenfist/client-python
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
shakenfist_client-0.8.3-py3-none-any.whl -
Subject digest:
a00ff0aa9a77c902a30b5cf45de40d75b9b1897e0e04e8a6b14242f4918db0e2 - Sigstore transparency entry: 2239093694
- Sigstore integration time:
-
Permalink:
shakenfist/client-python@b426e1f864c048a9f1d9de32adf9e2d8e1c3880e -
Branch / Tag:
refs/tags/v0.8.3 - Owner: https://github.com/shakenfist
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
self-hosted -
Publication workflow:
release.yml@b426e1f864c048a9f1d9de32adf9e2d8e1c3880e -
Trigger Event:
push
-
Statement type:
