diff --git a/Running-the-Client.md b/Running-the-Client.md new file mode 100644 index 0000000..eed271d --- /dev/null +++ b/Running-the-Client.md @@ -0,0 +1,22 @@ +As mentioned in the project README (see Client), there are two PyKMIP clients. The first, `kmip/services/kmip_client`, supports more features but is also a bit harder to use, requiring more knowledge of PyKMIP core objects to interact with properly. The second client, `kmip/pie/client`, was built to be simpler to use with a more Pythonic interface. It wraps the original client but doesn't expose as much functionality. + +The PyKMIP clients are meant to be used in Python programs; they are not standalone applications and there is no CLI wrapper or utility for them. For examples on how to use the clients, see the different client demos in `kmip/demos/units` and `kmip/demos/pie`. + +To run any of the demos, use the following types of commands. + +To show help and usage information: + + $ python path/to/demo/script -h + +To run the client demo with a specific configuration section: + + $ python path/to/demo/script -c section + +where 'section' is the label for the configuration section you want to use. For example, if the client configuration section you want to use is: + + [my_client] + ... + +you would use the following command: + + $ python path/to/demo/script -c my_client