Skip to content

Dev branch #123

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
pvenkatram-vera wants to merge 5 commits into from
Closed

Dev branch #123

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
0044376
Update README with proxy server usage instructions
pvenkatram-vera Sep 24, 2026
4bee49a
Remove extra line in README authentication section
pvenkatram-vera Sep 24, 2026
8a87166
Update README.md
pvenkatram-vera Sep 24, 2026
22a6c21
Update README.md
pvenkatram-vera Sep 25, 2026
ebd985a
Correct README formatting for Veracode API credentials
pvenkatram-vera Sep 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,13 @@ 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

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 +30,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 +42,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