From 43455364e0ecd623c9b20ab5fd094aafb15d1a34 Mon Sep 17 00:00:00 2001 From: leafee98 Date: Thu, 15 Sep 2022 15:37:54 +0800 Subject: [PATCH] add help message --- bistu_wifi/__main__.py | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/bistu_wifi/__main__.py b/bistu_wifi/__main__.py index 898a053..6b3fe90 100644 --- a/bistu_wifi/__main__.py +++ b/bistu_wifi/__main__.py @@ -4,6 +4,7 @@ import os import logging import configparser import argparse +from argparse import RawDescriptionHelpFormatter from bistu_wifi.bistu_wifi import logger from bistu_wifi.bistu_wifi import login from bistu_wifi.bistu_wifi import logout @@ -20,8 +21,15 @@ DEFAULT_CONFIG_LOCATION = os.path.join(XDG_CONFIG_HOME, 'bistu-wifi/auth.ini') def main(): - parser = argparse.ArgumentParser() - parser.description = 'login or logout bistu wifi' + parser = argparse.ArgumentParser(formatter_class=RawDescriptionHelpFormatter) + + parser.description = 'Login or logout bistu wifi, by sending a post request to authorization host' + + parser.epilog = 'The format of config file is like below\n\n' \ + ' [DEFAULT]\n' \ + ' username = 202000000\n' \ + ' password = Bistu000000\n' \ + ' host = 10.1.206.13\n' parser.add_argument('-u', '--username', nargs='?', type=str, help='username you use to login bistu wifi') @@ -32,7 +40,8 @@ def main(): parser.add_argument('-o', '--logout', action='store_true', help='logout bistu wifi. try to login if not privided') parser.add_argument('-c', '--config', nargs='?', default=DEFAULT_CONFIG_LOCATION, - type=str, help='load info(username, password, host) from config file') + type=str, help='load info(username, password, host) from config file. ' + f'Will try {DEFAULT_CONFIG_LOCATION} if not provided.') parser.add_argument('--notime', action='store_true', help='don\'t output time field in log')