Commit 081a1f2b authored by David Seaward's avatar David Seaward
Browse files

Redefine skeleton as ldh_client. Update install-from-source docs.


Signed-off-by: David Seaward's avatarDavid Seaward <david.seaward@puri.sm>
parent a7075ed8
Pipeline #4957 failed with stages
......@@ -4,10 +4,11 @@ verify_ssl = true
name = "pypi"
[packages]
click = '>=6.0,<7.0'
[dev-packages]
whipstaff = {path = ".", editable = true}
click = ">=6.0,<7.0"
[requires]
python_version = "3.6"
python_version = "3.7"
[dev-packages.e1839a8]
path = "."
editable = true
{
"_meta": {
"hash": {
"sha256": "97259154cd5fd9090e2da105e033896c6562f26ea7a53b24cc2cac63c4a9c08e"
"sha256": "03200d794b21b245fec55de0d5f3761fea0e846c95aac1b0ef3aa010cf3375dd"
},
"pipfile-spec": 6,
"requires": {
"python_version": "3.6"
"python_version": "3.7"
},
"sources": [
{
......@@ -34,7 +34,7 @@
"index": "pypi",
"version": "==6.7"
},
"whipstaff": {
"e1839a8": {
"editable": true,
"path": "."
}
......
# Whipstaff
# Liberty CLI
[project] | [code] | [tracker]
*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.
*Liberty CLI* is a user-facing command-line client for interacting
with a Liberty Deckplan Host (LDH).
## Installation
The preferred way to install Whipstaff is with your package manager.
The recommended package name is `ldh_operator`. For example:
The preferred way to install Liberty CLI is with your package
manager. The recommended package name is `ldh_client`. For example:
sudo apt install ldh_operator # Debian-based (doesn't exist yet)
sudo apt install ldh_client # Debian-based (doesn't exist yet)
or
pipx install ldh_operator # Python-based (doesn't exist yet)
pipx install ldh_client # PyPI-based (doesn't exist yet)
## Usage
```bash
whipstaff --help
liberty --help
```
## Installation (from source)
......@@ -32,25 +31,25 @@ If you'd prefer to run from source...
2. Get source:
git clone https://source.puri.sm/liberty/ldh_operator.git
git clone https://source.puri.sm/liberty/ldh_client.git
3. Install with pipenv:
cd ldh_operator
pipenv install
cd ldh_client
pipenv install --dev -e .
## Usage (from source)
```bash
cd ldh_operator
pipenv run whipstaff --help
cd ldh_client
pipenv run liberty --help
```
## Sharing and contributions
Whipstaff (LDH operator)
<https://source.puri.sm/liberty/ldh_operator>
Copyright 2018 Purism SPC
Liberty CLI (LDH client)
<https://source.puri.sm/liberty/ldh_client>
Copyright 2018-2019 Purism SPC
SPDX-License-Identifier: AGPL-3.0-or-later
Shared under AGPL-3.0-or-later. We adhere to the Community Covenant
......@@ -65,9 +64,9 @@ For details see:
<!-- Links -->
[project]: https://source.puri.sm/liberty/ldh_operator
[code]: https://source.puri.sm/liberty/ldh_operator/tree/master
[tracker]: https://source.puri.sm/liberty/ldh_operator/issues
[project]: https://source.puri.sm/liberty/ldh_client
[code]: https://source.puri.sm/liberty/ldh_client/tree/master
[tracker]: https://source.puri.sm/liberty/ldh_client/issues
[SETUP.md]: SETUP.md
[COPYING.AGPL.md]: COPYING.AGPL.md
[CODE_OF_CONDUCT.md]: CODE_OF_CONDUCT.md
......
from setuptools import setup
setup(
name='whipstaff',
name='ldh_client',
version='0.0.1',
py_modules=['whipstaff'],
py_modules=['ldh_client'],
install_requires=[
'Click',
],
entry_points='''
[console_scripts]
whipstaff=whipstaff:cli
liberty=liberty:cli
''',
)
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment