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 <>
parent 605e2150
"_meta": {
"hash": {
"sha256": "00fddae6485782e7a224441a4c4d7371030d1db501073d8192e6b18c2b880d32"
"pipfile-spec": 6,
"requires": {
"python_version": "3.6"
"sources": [
"name": "pypi",
"url": "",
"verify_ssl": true
"default": {
"click": {
"hashes": [
"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)
pipsi install psh_operator # Python-based (doesn't exist yet)
## Usage
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
<> for a tutorial.)
2. Get source:
git clone
3. Install with pipenv:
cd /path/to/psh_operator
pipenv install
## Usage (from source)
cd /path/to/shipwright
cd /path/to/psh_operator
pipenv run shipwright --help
## Sharing and contributions
PSH Shipwright
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