Quick start¶
Installing¶
Dependencies¶
PysKOM does not have any hard dependencies but some features require dependencies.
Client shell¶
prompt_toolkit
Client shell¶
Arguments¶
usage: python -m pyskom.client.shell [-h] [--host HOST] [-p PORT]
Named Arguments¶
- --host
Default:
'totoro.lysator.liu.se'- -p, --port
Default:
4894
The shell is a REPL where every command is parsed by argparse. Commands can be entered ether by there name (i.e. lookup-z-name) or there call number (i.e. 76). Type help to print usage.
Shell usage¶
usage: [-h] {help,?,get-info,94,get-person-stat,49,get-unread-confs,52,login,62,set-client-version,69,lookup-z-name,76,get-uconf-stat,78,create-text,86,get-text-stat,90,get-conf-stat,91,query-read-texts,107,set-connection-time-format,120} ...
Positional Arguments¶
- action
Possible choices: help, ?, get-info, 94, get-person-stat, 49, get-unread-confs, 52, login, 62, set-client-version, 69, lookup-z-name, 76, get-uconf-stat, 78, create-text, 86, get-text-stat, 90, get-conf-stat, 91, query-read-texts, 107, set-connection-time-format, 120
Action
Sub-commands¶
help (?)¶
Show help
help [-h]
get-info (94)¶
get-info [94] call
get-info [-h]
get-person-stat (49)¶
[49] call
get-person-stat [-h] person
Positional Arguments¶
- person
Person id to loop up
get-unread-confs (52)¶
[52] call
get-unread-confs [-h] [person]
Positional Arguments¶
- person
Person id
login (62)¶
login [62] call
login [-h] [-i] person
Positional Arguments¶
- person
Person id to login as
Named Arguments¶
- -i, --invisible
Login as invisible
Default:
False
set-client-version (69)¶
Call [69]
set-client-version [-h] name version
Positional Arguments¶
- name
Client name
- version
Client version
lookup-z-name (76)¶
Call [76]
lookup-z-name [-h] [-p WANT_PERS] [-c WANT_CONFS] name
Positional Arguments¶
- name
Lookup name
Named Arguments¶
- -p, --want-pers
Default:
True- -c, --want-confs
Default:
False
get-uconf-stat (78)¶
Call [78]
get-uconf-stat [-h] conference
Positional Arguments¶
- conference
Lookup id
create-text (86)¶
Create text
create-text [-h] [-r RECIPIENT]
Named Arguments¶
- -r, --recipient
Conference id
get-text-stat (90)¶
Call [90]
get-text-stat [-h] text_no
Positional Arguments¶
- text_no
Text number
get-conf-stat (91)¶
Call [91]
get-conf-stat [-h] id
Positional Arguments¶
- id
Lookup id
query-read-texts (107)¶
Call [107]
query-read-texts [-h] [--person PERSON] [--want-read-ranges WANT_READ_RANGES] [--max-ranges MAX_RANGES] conference
Positional Arguments¶
- conference
conference
Named Arguments¶
- --person
person
- --want-read-ranges
Want read ranges
Default:
True- --max-ranges
Max ranges
Default:
0
set-connection-time-format (120)¶
Call [120]
set-connection-time-format [-h] use_utc
Positional Arguments¶
- use_utc