Skip to content

Commit 5c88a53

Browse files
committed
Badge & other documentation updates
1 parent 0baba92 commit 5c88a53

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

README.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
11
# python-lambda-docker
22

3+
4+
35
[![github downloads](https://img.shields.io/github/downloads/kilna/python-lambda-docker/total.svg?style=plastic)](https://github.com/kilna/python-lambda-docker/graphs/traffic)
46
[![docker pulls](https://img.shields.io/docker/pulls/kilna/python-lambda.svg?style=plastic)](https://hub.docker.com/r/kilna/python-lambda/)
57
[![docker stars](https://img.shields.io/docker/stars/kilna/python-lambda.svg?style=plastic)](https://hub.docker.com/r/kilna/python-lambda/)
6-
[![docker build](https://img.shields.io/docker/automated/kilna/python-lambda.svg?style=plastic)](https://cloud.docker.com/swarm/kilna/repository/docker/kilna/python-lambda/builds)
7-
[![build stars](https://img.shields.io/docker/build/kilna/python-lambda.svg?style=plastic)](https://cloud.docker.com/swarm/kilna/repository/docker/kilna/python-lambda/builds)
8-
[![image size](https://img.shields.io/docker/imagelayers/image-size/kilna/python-lambda.svg?style=plastic)](https://hub.docker.com/r/kilna/python-lambda/)
9-
[![image layers](https://img.shields.io/docker/imagelayers/layers/kilna/python-lambda.svg?style=plastic)](https://hub.docker.com/r/kilna/python-lambda/)
8+
[![docker build](https://img.shields.io/badge/automated-green.svg?style=plastic)](https://cloud.docker.com/swarm/kilna/repository/docker/kilna/python-lambda/builds)
9+
<!-- [![image size](https://img.shields.io/docker/imagelayers/image-size/kilna/python-lambda.svg?style=plastic)](https://hub.docker.com/r/kilna/python-lambda/)
10+
[![image layers](https://img.shields.io/docker/imagelayers/layers/kilna/python-lambda.svg?style=plastic)](https://hub.docker.com/r/kilna/python-lambda/) -->
1011
[![python versions](https://img.shields.io/badge/python-2.7,_3.3,_3.4,_3.5,_3.6-blue.svg?style=plastic)](https://github.com/kilna/python-lambda-docker/)
1112

1213
Lightweight docker image for running and packaging python-based AWS lambda code
@@ -25,7 +26,7 @@ In order to use this, you will have your project derive its own Dockerfile based
2526

2627
## Usage
2728

28-
An example of a usable project can be found in the [example/](./example/) directory. This lambda function takes a JSON input file like the provided [event.json](./example/event.json) and returns an ASCII-art version of the text described in it. The provided [Dockerfile](./example/Dockerfile) derives from this image and loads the current workspace into the image, then installs dependencies from the [requirements.txt](./example/requirements.txt) file.
29+
An example of a usable project can be found in the [example/](./example/) directory. This lambda function in [service.py](./example/service.py) takes a JSON input file like the one provided in [event.json](./example/event.json) and returns an ASCII-art version of the text described in it. The provided [Dockerfile](./example/Dockerfile) derives from this image and loads the current workspace into the image at the path _/lambda_, then installs dependencies from the [requirements.txt](./example/requirements.txt) file.
2930

3031
To build a docker image called _example-lambda-image_ with the example lambda function in it, run:
3132

@@ -45,7 +46,7 @@ $ docker run example-lambda-image lambda invoke
4546
|/
4647
```
4748

48-
If you would like to see if your lambda function builds properly, run:
49+
If you would like to see if your lambda function build (which will package the lambda and all dependencies within the container into a zip file), run:
4950

5051
```
5152
$ docker run example-lambda-image lambda build
@@ -66,8 +67,8 @@ dist/2017-09-01-003647-example-lambda.zip
6667
Behind the scenes, what this script does is:
6768

6869
* Removes any log and dist files from prior runs
69-
* Runs 'lambda build' and store the log in _/lambda/build.log_ in the container
70-
* If present and executable, run _/lambda/run_tests_ and store the log in /lambda/test.log in the container
70+
* Runs 'lambda build' and stores the log in _/lambda/build.log_ in the container
71+
* If present and executable, run _/lambda/run_tests_ and stores the log in /lambda/test.log in the container
7172
* Tars the log files, and the contents of the dist directory in /lambda on the container and pipes it to standard output
7273
* Untars the contents bundled up within the container, and extracts them into your current directory
7374

0 commit comments

Comments
 (0)