Commit b5c59d62 authored by David Seaward's avatar David Seaward
Browse files

add lockfile, update README with new names/URLs


Signed-off-by: David Seaward's avatarDavid Seaward <david.seaward@puri.sm>
parent 605e2150
.idea
Pipfile.lock
*.egg-info
{
"_meta": {
"hash": {
"sha256": "00fddae6485782e7a224441a4c4d7371030d1db501073d8192e6b18c2b880d32"
},
"pipfile-spec": 6,
"requires": {
"python_version": "3.6"
},
"sources": [
{
"name": "pypi",
"url": "https://pypi.org/simple",
"verify_ssl": true
}
]
},
"default": {
"click": {
"hashes": [
"sha256:29f99fc6125fbc931b758dc053b3114e55c77a6e4c6c3a2674a2dc986016381d",
"sha256:f15516df478d5a56180fbf80e68f206010e6d160fc39fa508b65e035fd75130b"
],
"index": "pypi",
"version": "==6.7"
},
"shipwright": {
"editable": true,
"path": "."
}
},
"develop": {}
}
# PSH Shipwright
# Shipwright
*Shipwright* is a command-line maintenance tool for operating a Purist
Services Host (PSH).
*Shipwright* is a command-line tool for operating one or more Purist
Services Host (PSH) installations from your local session.
## Prerequisites
## Installation
* Python 3.x
* pipenv (use `pip install --user pipenv`)
* See `Pipfile` for additional Python prerequisites
* Download Git repo
The preferred way to install Shipwright is with your package manager.
The recommended package name is `psh_operator`. For example:
## Installation
sudo apt install psh_operator # Debian-based (doesn't exist yet)
or
pipsi install psh_operator # Python-based (doesn't exist yet)
## Usage
```bash
cd /path/to/shipwright
pipenv install
shipwright --help
```
## Usage
## 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/purist/psh_operator.git
3. Install with pipenv:
cd /path/to/psh_operator
pipenv install
## Usage (from source)
```bash
cd /path/to/shipwright
cd /path/to/psh_operator
pipenv run shipwright --help
```
## Sharing and contributions
PSH Shipwright
<https://source.puri.sm/purist/shipwright>
Shipwright
<https://source.puri.sm/purist/psh_operator>
Copyright 2018 Purism SPC
SPDX-License-Identifier: AGPL-3.0-or-later
......
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