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.
Installation
pip install shakenfist-client
Add the vdi extra if you want graphical instance consoles to open
seamlessly through the Kerbside SPICE proxy:
pip install shakenfist-client[vdi]
Usage
sf-client instance list
sf-client instance show <ref>
sf-client instance vdiconsole <ref>
The client reads its credentials from the environment
(SHAKENFIST_NAMESPACE, SHAKENFIST_KEY, SHAKENFIST_API_URL),
from ~/.shakenfist, or from /etc/sf/shakenfist.json.
Documentation
- VDI console access -- graphical consoles, the Kerbside proxy and direct paths, and viewer selection
- Namespace capacity claims -- claiming aggregate cluster capacity for a namespace, the two claim states, and what each refusal means
- Cluster capacity -- reading what each hypervisor has committed and measured, which figure the scheduler admits against, and namespace and claim events
- Waiting out a transient capacity refusal -- how the server marks a capacity refusal it expects to pass, and the opt-in client retry which waits for it
- Pending operations on an object -- listing the cluster operations targeting an instance, network or artifact, and waiting for one to settle
- Merging and releasing -- what CI runs, merging through the merge queue, and how a release is gated on CI
- 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
Metadata
Release files for shakenfist-client 0.8.4
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 |
|---|---|---|---|---|
| shakenfist_client-0.8.4.tar.gz | 182.4 kB | With provenance | Details for shakenfist_client-0.8.4.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| shakenfist_client-0.8.4-py3-none-any.whl | Python 3 | none | any | Details for shakenfist_client-0.8.4-py3-none-any.whl |
Total release size: 252.3 kB
Release files / shakenfist_client-0.8.4.tar.gz
| Download URL | shakenfist_client-0.8.4.tar.gz |
|---|---|
| Size | 182.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
23e76943dddf52e39732cee968b18f5d03cce2ced35baeea43ed43ff1a36b8b6
|
|
BLAKE2b-256 checksum How to use checksums |
bf793028ee52a368e549247649a023c2e7c6706bab9982153958f34a13432a95
|
| 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 31, 2026.
Transparency logRelease files / shakenfist_client-0.8.4-py3-none-any.whl
| Download URL | shakenfist_client-0.8.4-py3-none-any.whl |
|---|---|
| Size | 69.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
398589422ce9981a686df24bf9ce1610cc44882741124bad84bd0e6727849b86
|
|
BLAKE2b-256 checksum How to use checksums |
7542250724dd26d84bac18afccb7cc6def8ac81140dee3c6d2486cbf2b82bca7
|
| 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 31, 2026.
Transparency logSecurity for shakenfist-client 0.8.4
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 shakenfist_client-0.8.4.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 31, 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.