The Unikube CLI
This is the command line interface for unikube.
Documentation
The unikube cli documentation is automatically built.
Installation
General
The unikube cli can be installed via pip. Please make sure you are using Python 3.
pip install unikube
MacOS
The unikube cli is also installable via brew:
brew tap unikubehq/tooling
brew install unikubehq/tooling/unikube
Make Local
cd docs
make html
Development
Setup
Start the local unikube development cluster:
k3d cluster start unikube
Install CLI
To install the latest (pre-)release of the Unikube CLI type
sudo pip3 install unikube==<VERSION> --upgrade --pre
Enable tab completion
unikube support tab completion scripts for bash.
unikube system completion bash > /etc/bash_completion.d/unikube.bash-completion
You probably need to restart your shell in order for the completion script to do its work.
Virtual Environment + Requirements
Create virtual environment:
python -m .venv venv
Install requirements (production + development):
pip3 install -r requirements.txt -r requirements.dev.txt
Version Build + Release
Version management is handled via bump2version.
bump2version patch|minor|major
Increase dev version (e.g.: 1.0.0-dev1 -> 1.0.0-dev2):
bump2version build
Create release (e.g.: 1.0.0-dev2 -> 1.0.0):
bump2version release
Test
Tests for the unikube cli are developed using the pytest framework in combination with the click.testing module.
Thus, it is possible to run the tests using pytest or by configuring the testing environment/options within your IDE to use pytest.
Currently, most tests are developed directly against the unikube API, using a test-account. Therefore, it is required to provide the credentials via the following environment variables:
TESTRUNNER_EMAIL=...
TESTRUNNER_SECRET=...
Otherwise, tests might fail locally, even if they are correct.
It is possible to set the environment variables using an .env file within your virtual environment or by providing them explicitly:
TESTRUNNER_EMAIL=... TESTRUNNER_SECRET=... pytest
1 maintainer
Metadata
1 maintainer
Release files for unikube 1.2.9
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 |
|---|---|---|---|---|
| unikube-1.2.9.tar.gz | 66.2 kB | Without provenance | Details for unikube-1.2.9.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| unikube-1.2.9-py3-none-any.whl | Python 3 | none | any | Details for unikube-1.2.9-py3-none-any.whl |
Total release size: 151.0 kB
Release files / unikube-1.2.9.tar.gz
| Download URL | unikube-1.2.9.tar.gz |
|---|---|
| Size | 66.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a1b9b61cee51b60b8958c8cf067abfe05f9c20d0688923b2233f480a2bbbe985
|
|
BLAKE2b-256 checksum How to use checksums |
00e11b77fb7bcda4cc46086419115084d6582a0fe22b1b99c1a5a656f73da99a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.11.1 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.10.2
|
Release files / unikube-1.2.9-py3-none-any.whl
| Download URL | unikube-1.2.9-py3-none-any.whl |
|---|---|
| Size | 84.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
d58e0be3559cffd31c60a84d0008ac900cf7488137721d50024e9d5c2afcf452
|
|
BLAKE2b-256 checksum How to use checksums |
169897888f6be48f0619c5013da91ce5d63d27ef7599d375a157e8e32ce1d1b6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.11.1 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.10.2
|
Security for unikube 1.2.9
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.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A 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.
