summaryrefslogtreecommitdiffstats
path: root/onap-dcae-cbs-docker-client/README.md
diff options
context:
space:
mode:
authorTommy Carpenter <tommy@research.att.com>2018-02-22 14:32:46 -0500
committerTommy Carpenter <tommy@research.att.com>2018-02-22 14:32:49 -0500
commitd1a814370eb3e45368af9d6a76f8ded77cca5c82 (patch)
treedef567f5c53833ba75170517f5d00625438e66b9 /onap-dcae-cbs-docker-client/README.md
parent44f0f8f2c3615b19b2c254fc3e2509116433e18a (diff)
Implement the CBS 2.0.0 API
Change-Id: Iadf9e3d071ea24e240599fca2c13d1251e31f729 Issue-ID: DCAEGEN2-351 Signed-off-by: Tommy Carpenter <tommy@research.att.com>
Diffstat (limited to 'onap-dcae-cbs-docker-client/README.md')
-rw-r--r--onap-dcae-cbs-docker-client/README.md7
1 files changed, 4 insertions, 3 deletions
diff --git a/onap-dcae-cbs-docker-client/README.md b/onap-dcae-cbs-docker-client/README.md
index 1e622a7..81a8ef0 100644
--- a/onap-dcae-cbs-docker-client/README.md
+++ b/onap-dcae-cbs-docker-client/README.md
@@ -1,11 +1,11 @@
# Python CBS Docker Client
-Used for DCAE Dockerized microservices written in Python. Pulls your configuration from the config_binding_service. Expects that CONSUL_HOST and HOSTNAME are set as env variables, which is true in DCAE.
+Used for DCAE Dockerized microservices written in Python. Pulls your configuration from the config_binding_service. Expects that CONSUL_HOST and HOSTNAME are set as env variables, which is true in DCAE.
# Client Usage
## Development outside of Docker
-To test your raw code without Docker, you will need to set the env variables CONSUL_HOST and HOSTNAME (name of your key to pull from) that are set in DCAEs Docker enviornment.
+To test your raw code without Docker, you will need to set the env variables CONSUL_HOST and HOSTNAME (name of your key to pull from) that are set in DCAEs Docker enviornment.
1. `CONSUL_HOST` is the hostname only of the Consul instance you are talking to
2. HOSTNAME is the name of your component in Consul
@@ -13,6 +13,7 @@ To test your raw code without Docker, you will need to set the env variables CON
```
>>> from onap_dcae_cbs_docker_client import client
>>> client.get_config()
+>>> client.get_all()
```
# Installation
@@ -24,6 +25,6 @@ pip install onap-dcae-cbs-docker-client
# Testing
```
-tox -c tox-local.ini
+tox
```