Metadata-Version: 2.4
Name: shakenfist_client
Version: 0.8.4
Summary: The command line client for Shaken Fist
Project-URL: Homepage, https://shakenfist.com
Project-URL: Bug Tracker, https://github.com/shakenfist/shakenfist/issues
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: AUTHORS
Requires-Dist: click>=8.0.0
Requires-Dist: prettytable
Requires-Dist: requests>=2.31.0
Requires-Dist: requests_toolbelt>=1.0.0
Requires-Dist: chardet>=5.0.0
Requires-Dist: urllib3>=1.26.14
Requires-Dist: tqdm
Requires-Dist: shakenfist-utilities
Requires-Dist: pyyaml
Requires-Dist: importlib-metadata; python_version < "3.9"
Provides-Extra: test
Requires-Dist: coverage; extra == "test"
Requires-Dist: testtools; extra == "test"
Requires-Dist: mock; extra == "test"
Requires-Dist: stestr; extra == "test"
Requires-Dist: tox; extra == "test"
Requires-Dist: flake8; extra == "test"
Provides-Extra: vdi
Requires-Dist: ryll; sys_platform == "linux" and extra == "vdi"
Dynamic: license-file

Python REST API client for Shaken Fist
======================================

This is a python REST API client and command line client for the minimal
cloud [Shaken Fist](https://github.com/shakenfist/shakenfist).

The library is a complete interface to the Shaken Fist HTTP API.

## Installation

```bash
pip install shakenfist-client
```

Add the `vdi` extra if you want graphical instance consoles to open
seamlessly through the Kerbside SPICE proxy:

```bash
pip install shakenfist-client[vdi]
```

## Usage

```bash
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

<!-- These links are absolute, and stay absolute. README.md is the
     package's long description on PyPI, where a relative link resolves
     against pypi.org and 404s. They point at develop because that is
     where the documentation this release's README describes is
     maintained. -->

- [VDI console access](https://github.com/shakenfist/client-python/blob/develop/docs/vdi-console.md)
  -- graphical consoles, the Kerbside proxy and direct paths, and viewer
  selection
- [Namespace capacity claims](https://github.com/shakenfist/client-python/blob/develop/docs/namespace-claims.md)
  -- claiming aggregate cluster capacity for a namespace, the two claim
  states, and what each refusal means
- [Cluster capacity](https://github.com/shakenfist/client-python/blob/develop/docs/cluster-capacity.md)
  -- 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](https://github.com/shakenfist/client-python/blob/develop/docs/transient-capacity-retry.md)
  -- 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](https://github.com/shakenfist/client-python/blob/develop/docs/object-operations.md)
  -- listing the cluster operations targeting an instance, network or
  artifact, and waiting for one to settle
- [Merging and releasing](https://github.com/shakenfist/client-python/blob/develop/docs/development.md)
  -- what CI runs, merging through the merge queue, and how a release is
  gated on CI
- [ARCHITECTURE.md](https://github.com/shakenfist/client-python/blob/develop/ARCHITECTURE.md) -- project structure and key components
- [AGENTS.md](https://github.com/shakenfist/client-python/blob/develop/AGENTS.md) -- guide for AI agents working on this codebase
- [RELEASE-SETUP.md](https://github.com/shakenfist/client-python/blob/develop/RELEASE-SETUP.md) -- one-time release infrastructure setup
