Skip to content

Commit

Permalink
reorganize readme and add more auth content
Browse files Browse the repository at this point in the history
  • Loading branch information
tjarrettveracode committed Oct 8, 2024
1 parent 4979777 commit bb6330c
Showing 1 changed file with 20 additions and 9 deletions.
29 changes: 20 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 = <YOUR_API_KEY_ID>
veracode_api_key_secret = <YOUR_API_KEY_SECRET>

### Authenticating from a pipeline

Set Veracode API credentials as environment variables.

export VERACODE_API_KEY_ID=<YOUR_API_KEY_ID>
export VERACODE_API_KEY_SECRET=<YOUR_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.
Expand All @@ -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).

0 comments on commit bb6330c

Please sign in to comment.