diff --git a/README.md b/README.md index 178b515..3e54b8c 100644 --- a/README.md +++ b/README.md @@ -4,15 +4,16 @@ Python helper library for working with the Veracode APIs. Handles retries, pagin Not an official Veracode product. Heavily based on original work by [CTCampbell](https://github.com/ctcampbell). -## Setup + +## Setup Install from pypi: pip install veracode-api-py ### Authenticating from a developer machine +Save Veracode API credentials in `~/.veracode/credentials' -Save Veracode API credentials in `~/.veracode/credentials` [default] veracode_api_key_id = @@ -31,6 +32,7 @@ To use this library (or a script based on it) with a proxy server, set environme export HTTP_PROXY='http://10.10.10.10:8000' export HTTPS_PROXY='http://10.10.10.10:1212' + ## Use in your applications @@ -42,6 +44,7 @@ You can find sample scripts for some APIs in the [Samples folder](https://github For detailed documentation on the available methods, please see the [veracode-api-py docs](https://github.com/veracode/veracode-api-py/blob/main/docs/docs.md). + ## Notes 1. Different API calls require different roles or permissions. Consult the [Veracode Docs](https://docs.veracode.com/r/c_role_permissions).