Sky Port is an universal bus between user software and compute resources. It can also be considered as a transportation layer between workload producers and compute resource providers. Sky Port makes it easy to connect user software to different cloud resources.
The current python package represents a wrapper around client REST API of the core component of Sky Port -- core daemon. The package provides classes and data structures that can be used in python programs in order to communicate with swm-core. Such communication is useful when Sky Port terminals are built (see JupyterLab terminal as an example).
- Use swm-core dev container or install manually:
sudo apt-get install python3-all-dev
sudo apt install python3-pip
pip3 install pip-tools setuptoolsNote: Python 3.12 is required.
- Install the project dependencies into a local virtualenv:
make prepare-venvmake format
make checkmake testmake act
make act ARGS='--job unit_tests'
make act ARGS='--job check --rm'Requires podman.socket (or podman system service) and act on PATH.
. .venv/bin/activate
make clean
make package
make uploadThe latest stable version of the package is uploaded to PyPi.
python3 -m pip install --user swmclientpython3 -m pip uninstall swmclientSwmApi / SwmConnection use mutual TLS against Sky Port. The SSL context
trusts only the cluster CA file you pass as ca_file. It does not load the
system public CA store.
Typical paths:
| Material | Path |
|---|---|
| Client key | ~/.swm/key.pem |
| Client cert | ~/.swm/cert.pem |
| Cluster CA | /opt/swm/spool/secure/cluster/ca-chain-cert.pem (or your spool layout) |
Prefer a passphrase-protected private key. Pass the passphrase to SwmApi(..., password=...)
or set environment variable SWM_KEY_PASSWORD. Unencrypted keys still work when
neither is set.
We appreciate all contributions. If you are planning to contribute back bug-fixes, please do so without any further discussion. If you plan to contribute new features, utility functions or extensions, please first open an issue and discuss the feature with us.
We use a shared copyright model that enables all contributors to maintain the copyright on their contributions.
This software is licensed under the BSD-3-Clause license.