Skip to content

Commit 2a7eece

Browse files
authored
Merge pull request #16 from yxd-hde/i-15
Update help messages
2 parents 88bee13 + 8f2f6aa commit 2a7eece

File tree

3 files changed

+36
-23
lines changed

3 files changed

+36
-23
lines changed

README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -28,26 +28,28 @@ Run `python-lambda-local -h` to see the help.
2828
```
2929
usage: python-lambda-local [-h] [-l LIBRARY_PATH] [-f HANDLER_FUNCTION]
3030
[-t TIMEOUT] [-a ARN_STRING] [-v VERSION_NAME]
31+
[--version]
3132
FILE EVENT
3233
3334
Run AWS Lambda function written in Python on local machine.
3435
3536
positional arguments:
36-
FILE Lambda function file name
37-
EVENT Event data file name.
37+
FILE lambda function file name
38+
EVENT event data file name
3839
3940
optional arguments:
4041
-h, --help show this help message and exit
4142
-l LIBRARY_PATH, --library LIBRARY_PATH
42-
Path of 3rd party libraries.
43+
path of 3rd party libraries
4344
-f HANDLER_FUNCTION, --function HANDLER_FUNCTION
44-
Lambda function handler name. Default: "handler".
45+
lambda function handler name, default: "handler"
4546
-t TIMEOUT, --timeout TIMEOUT
46-
Seconds until lambda function timeout. Default: 3
47+
seconds until lambda function timeout, default: 3
4748
-a ARN_STRING, --arn-string ARN_STRING
48-
arn string for function
49+
ARN string for lambda function
4950
-v VERSION_NAME, --version-name VERSION_NAME
50-
function version name
51+
lambda function version name
52+
--version print the version of python-lambda-local and exit
5153
```
5254

5355
### Prepare development directory

README.rst

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -33,26 +33,28 @@ Run ``python-lambda-local -h`` to see the help.
3333

3434
usage: python-lambda-local [-h] [-l LIBRARY_PATH] [-f HANDLER_FUNCTION]
3535
[-t TIMEOUT] [-a ARN_STRING] [-v VERSION_NAME]
36+
[--version]
3637
FILE EVENT
3738

3839
Run AWS Lambda function written in Python on local machine.
3940

4041
positional arguments:
41-
FILE Lambda function file name
42-
EVENT Event data file name.
42+
FILE lambda function file name
43+
EVENT event data file name
4344

4445
optional arguments:
4546
-h, --help show this help message and exit
4647
-l LIBRARY_PATH, --library LIBRARY_PATH
47-
Path of 3rd party libraries.
48+
path of 3rd party libraries
4849
-f HANDLER_FUNCTION, --function HANDLER_FUNCTION
49-
Lambda function handler name. Default: "handler".
50+
lambda function handler name, default: "handler"
5051
-t TIMEOUT, --timeout TIMEOUT
51-
Seconds until lambda function timeout. Default: 3
52+
seconds until lambda function timeout, default: 3
5253
-a ARN_STRING, --arn-string ARN_STRING
53-
arn string for function
54+
ARN string for lambda function
5455
-v VERSION_NAME, --version-name VERSION_NAME
55-
function version name
56+
lambda function version name
57+
--version print the version of python-lambda-local and exit
5658

5759
Prepare development directory
5860
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

lambda_local/__init__.py

Lines changed: 18 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,14 @@
99
import argparse
1010
import sys
1111
from multiprocessing import Process
12+
import pkg_resources
1213

1314
from .main import run
1415

1516

17+
__version__ = pkg_resources.require("python-lambda-local")[0].version
18+
19+
1620
def main():
1721
args = parse_args()
1822

@@ -27,23 +31,28 @@ def parse_args():
2731
parser = argparse.ArgumentParser(description="Run AWS Lambda function" +
2832
" written in Python on local machine.")
2933
parser.add_argument("file", metavar="FILE", type=str,
30-
help="Lambda function file name")
34+
help="lambda function file name")
3135
parser.add_argument("event", metavar="EVENT", type=str,
32-
help="Event data file name.")
36+
help="event data file name")
3337
parser.add_argument("-l", "--library", metavar="LIBRARY_PATH",
34-
type=str, help="Path of 3rd party libraries.")
38+
type=str, help="path of 3rd party libraries")
3539
parser.add_argument("-f", "--function", metavar="HANDLER_FUNCTION",
3640
type=str, default="handler",
37-
help="Lambda function handler name. \
38-
Default: \"handler\".")
41+
help="lambda function handler name, \
42+
default: \"handler\"")
3943
parser.add_argument("-t", "--timeout", metavar="TIMEOUT", type=int,
4044
default=3,
41-
help="Seconds until lambda function timeout. \
42-
Default: 3")
45+
help="seconds until lambda function timeout, \
46+
default: 3")
4347
parser.add_argument("-a", "--arn-string", metavar="ARN_STRING", type=str,
44-
default="", help="arn string for function")
48+
default="", help="ARN string for lambda function")
4549
parser.add_argument("-v", "--version-name", metavar="VERSION_NAME",
46-
type=str, default="", help="function version name")
50+
type=str, default="",
51+
help="lambda function version name")
52+
53+
parser.add_argument("--version", action="version",
54+
version="%(prog)s " + __version__,
55+
help="print the version of python-lambda-local and exit")
4756

4857
return parser.parse_args()
4958

0 commit comments

Comments
 (0)