Skip to content
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 = <YOUR_API_KEY_ID>
Expand All @@ -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

Expand All @@ -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).
Expand Down