Skip to main content

Whipstaff is a command-line tool for operating one or more Liberty Deckplan Hosts (LDHs) from your local session. The reference implementation for an LDH operator toolkit.

Project description

Whipstaff

project | code | tracker | pypi

Whipstaff is a command-line tool for operating one or more Liberty Deckplan Hosts (LDHs) from your local session. The reference implementation for an LDH operator toolkit.

Installation

The preferred way to install Whipstaff is with your package manager. The recommended package name is ldh-operator. For example:

sudo apt install ldh-operator # Debian-based

or

pipx install ldh-operator # Python-based

Usage

For help and a list of available commands:

whipstaff --help

Installation (from source)

If you'd prefer to run from source...

  1. Install Python 3.x and pipenv. (See https://docs.pipenv.org/install/ for a tutorial.)

  2. Get source:

     git clone https://source.puri.sm/liberty/tool/operator.git ldh_operator_toolkit
    
  3. Install with pipenv:

     cd ldh_operator_toolkit
     pipenv install --dev -e .
    

Usage (from source)

cd ldh_operator_toolkit
pipenv run whipstaff --help
# using "pipenv run" avoids confusion with a regular installation

Build wheel package (and optionally upload)

Follow these instructions to build Liberty CLI as a Python package:

git clone https://source.puri.sm/liberty/tool/operator.git ldh_operator_toolkit
cd ldh_operator_toolkit
pipenv install --dev
pipenv shell
# optionally edit default.yaml
python setup.py sdist bdist_wheel

If everything works as expected you should end up with the files:

  • dist/ldh_operator-<version>-py3-none-any.whl
  • dist/ldh_operator-<version>.tar.gz

You can now optionally upload the created Python package to PyPI using twine:

twine upload dist/*

Sharing and contributions

Whipstaff (LDH operator toolkit)
https://source.puri.sm/liberty/tool/operator
Copyright 2018-2020 Purism SPC
SPDX-License-Identifier: AGPL-3.0-or-later

Shared under AGPL-3.0-or-later. We adhere to the Community Covenant 1.0 without modification, and certify origin per DCO 1.1 with a signed-off-by line. Contributions under the same terms are welcome.

For details see:

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ldh_operator-0.0.5.tar.gz (26.0 kB view details)

Uploaded Source

Built Distribution

ldh_operator-0.0.5-py3-none-any.whl (16.8 kB view details)

Uploaded Python 3

File details

Details for the file ldh_operator-0.0.5.tar.gz.

File metadata

  • Download URL: ldh_operator-0.0.5.tar.gz
  • Upload date:
  • Size: 26.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.7.6

File hashes

Hashes for ldh_operator-0.0.5.tar.gz
Algorithm Hash digest
SHA256 5a8f3de371bc7693283de4dd57e18dc460dc8cfa214e76c80d1de3639b1bfa99
MD5 ac44279256c86ce29ac7e180e829c40d
BLAKE2b-256 7e79eb935870301f92c3303a705600762bda5812bc9ef1be5cb2c391cd8fec0c

See more details on using hashes here.

File details

Details for the file ldh_operator-0.0.5-py3-none-any.whl.

File metadata

  • Download URL: ldh_operator-0.0.5-py3-none-any.whl
  • Upload date:
  • Size: 16.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.7.6

File hashes

Hashes for ldh_operator-0.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 45d8fbf5d0b25198d306ebccd4fa1b846a415dffa42a32bc3f883263c9d64d93
MD5 b06a7114c802d21b71c30dc2a334ea09
BLAKE2b-256 1e7d33dfa503c411d076934c52987fec0aec0f7b5fb33690a58cf33b70bc933d

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page