From bb6330c0fcc9387d33eea5b0b10b00e94952f295 Mon Sep 17 00:00:00 2001 From: Tim Jarrett Date: Tue, 8 Oct 2024 12:18:21 -0400 Subject: [PATCH] reorganize readme and add more auth content --- README.md | 29 ++++++++++++++++++++--------- 1 file changed, 20 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 7e32f3e..178b515 100644 --- a/README.md +++ b/README.md @@ -8,14 +8,30 @@ Not an official Veracode product. Heavily based on original work by [CTCampbell] Install from pypi: - pypi veracode_api_py + pip install veracode-api-py -(Optional) Save Veracode API credentials in `~/.veracode/credentials` +### Authenticating from a developer machine + +Save Veracode API credentials in `~/.veracode/credentials` [default] veracode_api_key_id = veracode_api_key_secret = +### Authenticating from a pipeline + +Set Veracode API credentials as environment variables. + + export VERACODE_API_KEY_ID= + export VERACODE_API_KEY_SECRET= + +### Authenticating through a proxy + +To use this library (or a script based on it) with a proxy server, set environment variables with the address of the proxy: + + export HTTP_PROXY='http://10.10.10.10:8000' + export HTTPS_PROXY='http://10.10.10.10:1212' + ## Use in your applications Import VeracodeAPI or one of the individual API classes into your code and call the methods. Most methods return JSON or XML depending on the underlying API. @@ -28,11 +44,6 @@ For detailed documentation on the available methods, please see the [veracode-ap ## Notes -1. Different API calls require different roles. Consult the [Veracode Docs](https://docs.veracode.com/r/c_role_permissions). +1. Different API calls require different roles or permissions. Consult the [Veracode Docs](https://docs.veracode.com/r/c_role_permissions). 2. This library does not include a complete set of Veracode API methods. In particular, it only provides a handful of XML API methods. -3. To use this library (or a script based on it) with a proxy server, you can set environment variables with the addresses of the proxies: - - - `export HTTP_PROXY='http://10.10.10.10:8000'` - - `export HTTPS_PROXY='http://10.10.10.10:1212'` - -4. Contributions are welcome. See the [Contributions guidelines](CONTRIBUTING.md). +3. Contributions are welcome. See the [Contributions guidelines](CONTRIBUTING.md).