Liberty CLI is a user-facing command-line client for interacting with Librem One or another Liberty Deckplan Host (LDH).
Project description
Liberty CLI
Liberty CLI is a user-facing command-line client for interacting with Librem One or another Liberty Deckplan Host (LDH).
Dive into https://liberty.one for LDH design and development.
Installation
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-client # Debian-based
or
pipx install ldh-client # Python-based
Usage
For help and a list of available commands:
liberty --help
To add a tunnel connection to Network-Manager:
liberty setup tunnel
# you will be prompted for your Librem One/LDH credentials
Installation (from source)
If you'd prefer to run from source...
-
Install Python 3.x and pipenv. (See https://docs.pipenv.org/install/ for a tutorial.)
-
Install prerequisites:
apt install libcairo2-dev libgirepository1.0-dev
-
Get source:
git clone https://source.puri.sm/liberty/tool/client.git ldh_client
-
Install with pipenv:
cd ldh_client pipenv install --dev -e .
Usage (from source)
cd ldh_client
pipenv run liberty --help
or
cd ldh_client
pipenv shell
liberty --help
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/client.git ldh_client
cd ldh_client
pipenv install --dev
pipenv shell
# optionally edit defaults.py
python setup.py sdist bdist_wheel
If everything works as expected you should end up with the files:
ldh_client-<version>-py3-none-any.whl
ldh_client-<version>.tar.gz
under dist/
folder.
You can now optionally upload the created Python package to PyPI using twine:
twine upload dist/*
Sharing and contributions
Liberty CLI (LDH client)
https://source.puri.sm/liberty/tool/client
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:
- COPYING.AGPL.md, full license text
- CODE_OF_CONDUCT.md, full conduct text
- CONTRIBUTING.DCO.md, full origin text
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for ldh_client-0.0.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2ac4d72cef426c6b0eeafe0b60cad47cbeabb59b8449a985b7cb33fa8129cea3 |
|
MD5 | 662bf8b6921a0d7a3eaa7152be8a26c6 |
|
BLAKE2b-256 | d0bace3356a7e3db7e3f83dd1f15c289098c71f36b0328b97d18fbac41c23237 |