Skip to content

Commit bb6330c

Browse files
reorganize readme and add more auth content
1 parent 4979777 commit bb6330c

File tree

1 file changed

+20
-9
lines changed

1 file changed

+20
-9
lines changed

README.md

Lines changed: 20 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,30 @@ Not an official Veracode product. Heavily based on original work by [CTCampbell]
88

99
Install from pypi:
1010

11-
pypi veracode_api_py
11+
pip install veracode-api-py
1212

13-
(Optional) Save Veracode API credentials in `~/.veracode/credentials`
13+
### Authenticating from a developer machine
14+
15+
Save Veracode API credentials in `~/.veracode/credentials`
1416

1517
[default]
1618
veracode_api_key_id = <YOUR_API_KEY_ID>
1719
veracode_api_key_secret = <YOUR_API_KEY_SECRET>
1820

21+
### Authenticating from a pipeline
22+
23+
Set Veracode API credentials as environment variables.
24+
25+
export VERACODE_API_KEY_ID=<YOUR_API_KEY_ID>
26+
export VERACODE_API_KEY_SECRET=<YOUR_API_KEY_SECRET>
27+
28+
### Authenticating through a proxy
29+
30+
To use this library (or a script based on it) with a proxy server, set environment variables with the address of the proxy:
31+
32+
export HTTP_PROXY='http://10.10.10.10:8000'
33+
export HTTPS_PROXY='http://10.10.10.10:1212'
34+
1935
## Use in your applications
2036

2137
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
2844

2945
## Notes
3046

31-
1. Different API calls require different roles. Consult the [Veracode Docs](https://docs.veracode.com/r/c_role_permissions).
47+
1. Different API calls require different roles or permissions. Consult the [Veracode Docs](https://docs.veracode.com/r/c_role_permissions).
3248
2. This library does not include a complete set of Veracode API methods. In particular, it only provides a handful of XML API methods.
33-
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:
34-
35-
- `export HTTP_PROXY='http://10.10.10.10:8000'`
36-
- `export HTTPS_PROXY='http://10.10.10.10:1212'`
37-
38-
4. Contributions are welcome. See the [Contributions guidelines](CONTRIBUTING.md).
49+
3. Contributions are welcome. See the [Contributions guidelines](CONTRIBUTING.md).

0 commit comments

Comments
 (0)