Replaces missing occurrences of pisa_cli for wt_cli

This commit is contained in:
Sergi Delgado Segura
2020-02-12 10:40:16 +01:00
parent c3246a3652
commit e6187fc657
5 changed files with 17 additions and 17 deletions

View File

@@ -1,10 +1,10 @@
# Dependencies
`pisa-cli` has both system-wide and Python dependencies. This document walks you trough how to satisfy them.
`wt_cli` has both system-wide and Python dependencies. This document walks you trough how to satisfy them.
## System-wide dependencies
`pisa-cli` has the following system-wide dependencies:
`wt_cli` has the following system-wide dependencies:
- `python3`
- `pip3`
@@ -27,7 +27,7 @@ It is also likely that, if `python3` is installed in our system, the `python` al
python3 --version
If `python3` is installed but the `python` alias is not set to it, we should either set it, or use `python3` to run `pisa-cli`.
If `python3` is installed but the `python` alias is not set to it, we should either set it, or use `python3` to run `wt_cli`.
Regarding `pip`, we can check what version is installed in our system (if any) by running:
@@ -74,7 +74,7 @@ and for `pip3`:
## Python dependencies
`pisa-cli` has the following dependencies (which can be satisfied by using `pip install -r requirements.txt`):
`wt_cli` has the following dependencies (which can be satisfied by using `pip install -r requirements.txt`):
- `cryptography`
- `requests`

View File

@@ -1,8 +1,8 @@
# Install
`pisa-cli` has some dependencies that can be satisfied by following [DEPENDENCIES.md](DEPENDENCIES.md). If your system already satisfies the dependencies, you can skip that part.
`wt_cli` has some dependencies that can be satisfied by following [DEPENDENCIES.md](DEPENDENCIES.md). If your system already satisfies the dependencies, you can skip that part.
In order to run `pisa-cli`, you should set your `PYTHONPATH` env variable to include the folder that contains the `apps` folder. You can do so by running:
In order to run `wt_cli`, you should set your `PYTHONPATH` env variable to include the folder that contains the `apps` folder. You can do so by running:
export PYTHONPATH=$PYTHONPATH:<absolute_path_to_apps>
@@ -14,7 +14,7 @@ You should also include the command in your `.bash_rc` to avoid having to run it
echo 'export PYTHONPATH=$PYTHONPATH:<absolute_path_to_apps>' >> ~/.bash_rc
Once the `PYTHONPATH` is set, you should be able to run `pisa-cli` straightaway. Try it by running:
Once the `PYTHONPATH` is set, you should be able to run `wt_cli` straightaway. Try it by running:
cd <absolute_path_to_apps>/apps/cli
python pisa-cli.py -h
python wt_cli.py -h

View File

@@ -1,9 +1,9 @@
def help_add_appointment():
return (
"NAME:"
"\tpython pisa-cli add_appointment - Registers a json formatted appointment to the PISA server."
"\tpython wt_cli add_appointment - Registers a json formatted appointment to the PISA server."
"\n\nUSAGE:"
"\tpython pisa-cli add_appointment [command options] appointment/path_to_appointment_file"
"\tpython wt_cli add_appointment [command options] appointment/path_to_appointment_file"
"\n\nDESCRIPTION:"
"\n\n\tRegisters a json formatted appointment to the PISA server."
"\n\tif -f, --file *is* specified, then the command expects a path to a json file instead of a json encoded "
@@ -17,9 +17,9 @@ def help_add_appointment():
def help_get_appointment():
return (
"NAME:"
"\tpython pisa-cli get_appointment - Gets json formatted data about an appointment from the PISA server."
"\tpython wt_cli get_appointment - Gets json formatted data about an appointment from the PISA server."
"\n\nUSAGE:"
"\tpython pisa-cli get_appointment appointment_locator"
"\tpython wt_cli get_appointment appointment_locator"
"\n\nDESCRIPTION:"
"\n\n\tGets json formatted data about an appointment from the PISA server.\n"
)

View File

@@ -1,9 +1,9 @@
# PISA-SERVER
# PISA-WT-SERVER
DEFAULT_PISA_API_SERVER = "btc.pisa.watch"
DEFAULT_PISA_API_PORT = 9814
# PISA-CLI
DATA_FOLDER = "~/.pisa_btc/"
# WT-CLI
DATA_FOLDER = "~/.wt_cli/"
CLIENT_LOG_FILE = "cli.log"
APPOINTMENTS_FOLDER_NAME = "appointment_receipts"

View File

@@ -356,7 +356,7 @@ def get_appointment(locator):
def show_usage():
return (
"USAGE: "
"\n\tpython pisa-cli.py [global options] command [command options] [arguments]"
"\n\tpython wt_cli.py [global options] command [command options] [arguments]"
"\n\nCOMMANDS:"
"\n\tadd_appointment \tRegisters a json formatted appointment to the PISA server."
"\n\tget_appointment \tGets json formatted data about an appointment from the PISA server."
@@ -365,7 +365,7 @@ def show_usage():
"\n\t-s, --server \tAPI server where to send the requests. Defaults to btc.pisa.watch (modifiable in "
"__init__.py)"
"\n\t-p, --port \tAPI port where to send the requests. Defaults to 9814 (modifiable in __init__.py)"
"\n\t-d, --debug \tshows debug information and stores it in pisa_cli.log"
"\n\t-d, --debug \tshows debug information and stores it in wt_cli.log"
"\n\t-h --help \tshows this message."
)