|
1 | | -# local development |
| 1 | +# IBM Cloud Functions runtime for python |
| 2 | + |
| 3 | +WARNING: Work in Progress (WIP) not ready for production |
| 4 | + |
| 5 | +[](https://travis-ci.org/ibm-functions/runtime-python) |
| 6 | + |
| 7 | +The runtime provides [python v3](python3/) with a set of [python packages](python/requirements.txt) |
| 8 | + |
| 9 | +The runtime provides the following npm packages for [IBM Cloud](https://bluemix.net): |
| 10 | +- IBM DB2/DashDB and IBM Informix [[email protected]](https://pypi.python.org/pypi/ibm_db) |
| 11 | +- IBM Cloudant [[email protected]](https://pypi.python.org/pypi/cloudant) |
| 12 | +- IBM Watson Developer Cloud Python SDK [[email protected]](https://pypi.python.org/pypi/watson-developer-cloud) |
| 13 | + |
| 14 | +### How to use as a docker Action |
| 15 | +To use as a docker action |
| 16 | +``` |
| 17 | +bx wsk action update myAction myAction.js --docker ibmfunctions/action-python-v3 |
| 18 | +``` |
| 19 | +This works on any deployment of Apache OpenWhisk or IBM Cloud Functions |
| 20 | + |
| 21 | +### Future: IBM Cloud Functions (based on Apache OpenWhisk) |
| 22 | +To use as a python kind action |
| 23 | +``` |
| 24 | +bx wsk action update myAction myAction --kind python:3 |
| 25 | +``` |
| 26 | +Tip: Not available yet in the IBM Cloud |
| 27 | + |
| 28 | +### Working with the local git repo |
| 29 | +Prerequisite: *Export* OPENWHISK_HOME to point to your incubator/openwhisk cloned directory. |
| 30 | + |
| 31 | +``` |
| 32 | +./gradlew nodejs8:distDocker |
| 33 | +``` |
| 34 | +This will produce the image `whisk/action-python-v3` |
| 35 | + |
| 36 | +Build and Push image |
2 | 37 | ``` |
3 | | -./gradlew python3:distDocker |
4 | 38 | docker login |
5 | | -./gradlew python3:distDocker -PdockerImagePrefix=<YourDockerId> -PdockerRegistry=docker.io |
6 | | -cd $OPENWHISK_HOME |
7 | | -bin/wskdev teardown -t <currentEnvironmentName> |
8 | | -cd ansible/environments/ |
9 | | -ln -s /path/to/runtime-python3/ansible/environments/local ./local-ibm-py |
10 | | -cd .. |
11 | | -ansible-playbook -i environments/local-ibm-py setup.yml |
12 | | -ansible-playbook -i environments/local-ibm-py couchdb.yml -e mode=clean |
13 | | -ansible-playbook -i environments/local-ibm-py couchdb.yml |
14 | | -ansible-playbook -i environments/local-ibm-py initdb.yml |
15 | | -ansible-playbook -i environments/local-ibm-py wipe.yml |
16 | | -cd $OPENWHISK_HOME |
17 | | -./gradlew distDocker |
18 | | -cd ansible |
19 | | -ansible-playbook -i environments/local-ibm-py openwhisk.yml -e mode=clean |
20 | | -ansible-playbook -i environments/local-ibm-py openwhisk.yml |
21 | | -ansible-playbook -i environments/local-ibm-py postdeploy.yml |
22 | | -
|
23 | | -``` |
24 | | - |
25 | | -Create a python action and put it in file `test.py`: |
26 | | -``` |
27 | | -def main(args): |
28 | | - return {"message":"Successfully called Simple Python Action"} |
29 | | -``` |
30 | | - |
31 | | -Run: |
32 | | -``` |
33 | | -wsk -i action create test test.py --kind "python-ibm:3" |
34 | | -wsk -i action invoke test -b |
35 | | -``` |
| 39 | +./gradlew python3:distDocker -PdockerImagePrefix=$prefix-user -PdockerRegistry=docker.io |
| 40 | +``` |
| 41 | + |
| 42 | +Deploy OpenWhisk using ansible environment that adds the new king `python:3` |
| 43 | +Assuming you have OpenWhisk already deploy localy and `OPENWHISK_HOME` pointing to root directory of OpenWhisk core repository. |
| 44 | + |
| 45 | +Set `ROOTDIR` to the root directory of this repository. |
| 46 | + |
| 47 | +Redeploy OpenWhisk |
| 48 | +``` |
| 49 | +cd $OPENWHISK_HOME/ansible |
| 50 | +ANSIBLE_CMD="ansible-playbook -i ${ROOTDIR}/ansible/environments/local" |
| 51 | +$ANSIBLE_CMD setup.yml |
| 52 | +$ANSIBLE_CMD couchdb.yml |
| 53 | +$ANSIBLE_CMD initdb.yml |
| 54 | +$ANSIBLE_CMD wipe.yml |
| 55 | +$ANSIBLE_CMD openwhisk.yml |
| 56 | +``` |
| 57 | + |
| 58 | +To use as docker action push to your own dockerhub account |
| 59 | +``` |
| 60 | +docker tag whisk/action-python-v3 $user_prefix/action-python-v3 |
| 61 | +docker push $user_prefix/action-python-v3 |
| 62 | +``` |
| 63 | +Then create the action using your the image from dockerhub |
| 64 | +``` |
| 65 | +wsk action update myAction myAction.py --docker $user_prefix/action-python-v3 |
| 66 | +``` |
| 67 | +The `$user_prefix` is usually your dockerhub user id. |
| 68 | + |
| 69 | +### Testing |
| 70 | + |
| 71 | + |
| 72 | +To run all tests: `./gradlew tests:test` this include tests depending on credentials |
| 73 | + |
| 74 | +To run all tests except those which do not rely on credentials `./gradlew tests:testWithoutCredentials` |
| 75 | + |
| 76 | +To run a single test-class: `./gradlew tests:test --tests <SomeGradleTestFilter>` |
| 77 | + |
| 78 | + |
| 79 | +# License |
| 80 | +[Apache 2.0](LICENSE.txt) |
0 commit comments