Skip to content

Commit b9bd880

Browse files
authored
Documentation updates
* Badges & other documentation updates
1 parent 3909f86 commit b9bd880

File tree

1 file changed

+12
-4
lines changed

1 file changed

+12
-4
lines changed

README.md

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

3+
<!-- [![image size](https://img.shields.io/docker/imagelayers/image-size/kilna/python-lambda.svg?style=plastic)](https://hub.docker.com/r/kilna/python-lambda/)
4+
[![image layers](https://img.shields.io/docker/imagelayers/layers/kilna/python-lambda.svg?style=plastic)](https://hub.docker.com/r/kilna/python-lambda/) -->
5+
[![image](https://images.microbadger.com/badges/image/kilna/python-lambda.svg)](https://microbadger.com/images/kilna/python-lambda)
6+
[![docker pulls](https://img.shields.io/docker/pulls/kilna/python-lambda.svg?style=plastic)](https://hub.docker.com/r/kilna/python-lambda/)
7+
[![docker stars](https://img.shields.io/docker/stars/kilna/python-lambda.svg?style=plastic)](https://hub.docker.com/r/kilna/python-lambda/)
8+
[![docker build](https://img.shields.io/badge/docker_build-automated-blue.svg?style=plastic)](https://cloud.docker.com/swarm/kilna/repository/docker/kilna/python-lambda/builds)
9+
[![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/)
10+
311
Lightweight docker image for running and packaging python-based AWS lambda code
412

513
## Links
@@ -16,7 +24,7 @@ In order to use this, you will have your project derive its own Dockerfile based
1624

1725
## Usage
1826

19-
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.
27+
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.
2028

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

@@ -36,7 +44,7 @@ $ docker run example-lambda-image lambda invoke
3644
|/
3745
```
3846

39-
If you would like to see if your lambda function builds properly, run:
47+
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:
4048

4149
```
4250
$ docker run example-lambda-image lambda build
@@ -57,8 +65,8 @@ dist/2017-09-01-003647-example-lambda.zip
5765
Behind the scenes, what this script does is:
5866

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

0 commit comments

Comments
 (0)