# Veracode API Python
Python helper library for working with the Veracode APIs. Handles retries, pagination, and other features of the modern Veracode REST APIs.
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`
[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.
You can find sample scripts for some APIs in the [Samples folder](https://github.com/veracode/veracode-api-py/tree/main/samples).
## Docs
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).
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. Contributions are welcome. See the [Contributions guidelines](CONTRIBUTING.md).
Raw data
{
"_id": null,
"home_page": "https://github.com/tjarrettveracode",
"name": "veracode-api-py",
"maintainer": null,
"docs_url": null,
"requires_python": ">3.7",
"maintainer_email": null,
"keywords": "veracode, veracode-api",
"author": "Tim Jarrett",
"author_email": "Tim Jarrett <tjarrett@veracode.com>",
"download_url": "https://files.pythonhosted.org/packages/67/53/c5304b2b9966ca592e289d76f21c1b86340c0fe7f78828633eaa0ef69e53/veracode_api_py-0.9.57.tar.gz",
"platform": null,
"description": "# Veracode API Python\n\nPython helper library for working with the Veracode APIs. Handles retries, pagination, and other features of the modern Veracode REST APIs.\n\nNot an official Veracode product. Heavily based on original work by [CTCampbell](https://github.com/ctcampbell).\n\n## Setup\n\nInstall from pypi:\n\n pip install veracode-api-py\n\n### Authenticating from a developer machine\n\nSave Veracode API credentials in `~/.veracode/credentials`\n\n [default]\n veracode_api_key_id = <YOUR_API_KEY_ID>\n veracode_api_key_secret = <YOUR_API_KEY_SECRET>\n\n### Authenticating from a pipeline\n\nSet Veracode API credentials as environment variables.\n\n export VERACODE_API_KEY_ID=<YOUR_API_KEY_ID>\n export VERACODE_API_KEY_SECRET=<YOUR_API_KEY_SECRET>\n\n### Authenticating through a proxy\n\nTo use this library (or a script based on it) with a proxy server, set environment variables with the address of the proxy:\n\n export HTTP_PROXY='http://10.10.10.10:8000'\n export HTTPS_PROXY='http://10.10.10.10:1212'\n\n## Use in your applications\n\nImport 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.\n\nYou can find sample scripts for some APIs in the [Samples folder](https://github.com/veracode/veracode-api-py/tree/main/samples).\n\n## Docs\n\nFor 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).\n\n## Notes\n\n1. Different API calls require different roles or permissions. Consult the [Veracode Docs](https://docs.veracode.com/r/c_role_permissions).\n2. This library does not include a complete set of Veracode API methods. In particular, it only provides a handful of XML API methods.\n3. Contributions are welcome. See the [Contributions guidelines](CONTRIBUTING.md).\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python helper library for working with the Veracode APIs. Handles retries, pagination, and other features of the modern Veracode REST APIs.",
"version": "0.9.57",
"project_urls": {
"Bug Tracker": "https://github.com/veracode/veracode-api-py/issues",
"Download": "https://github.com/veracode/veracode-api-py/archive/v_0957.tar.gz",
"Homepage": "https://github.com/veracode/veracode-api-py"
},
"split_keywords": [
"veracode",
" veracode-api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "76bbeb67db17a80ae9eb93fb4702cb5f90bf36dc47cfb82d0dc34f1e3d4cb7ae",
"md5": "de9e26940e581b18a56e1fcec80eae68",
"sha256": "223c7e5125bdaf01c53d21ce66d5c3309454f196990ac3ffde7fc43e1565ac0e"
},
"downloads": -1,
"filename": "veracode_api_py-0.9.57-py3-none-any.whl",
"has_sig": false,
"md5_digest": "de9e26940e581b18a56e1fcec80eae68",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">3.7",
"size": 35083,
"upload_time": "2024-12-02T22:06:45",
"upload_time_iso_8601": "2024-12-02T22:06:45.979958Z",
"url": "https://files.pythonhosted.org/packages/76/bb/eb67db17a80ae9eb93fb4702cb5f90bf36dc47cfb82d0dc34f1e3d4cb7ae/veracode_api_py-0.9.57-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6753c5304b2b9966ca592e289d76f21c1b86340c0fe7f78828633eaa0ef69e53",
"md5": "247ff8342c074ce1f0b3a87983d85b0d",
"sha256": "872def9a2e9fe5c56ea01802e1ae3a982fdde723c87890e2ed2349a491b5588a"
},
"downloads": -1,
"filename": "veracode_api_py-0.9.57.tar.gz",
"has_sig": false,
"md5_digest": "247ff8342c074ce1f0b3a87983d85b0d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">3.7",
"size": 34031,
"upload_time": "2024-12-02T22:06:47",
"upload_time_iso_8601": "2024-12-02T22:06:47.632327Z",
"url": "https://files.pythonhosted.org/packages/67/53/c5304b2b9966ca592e289d76f21c1b86340c0fe7f78828633eaa0ef69e53/veracode_api_py-0.9.57.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-02 22:06:47",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "veracode",
"github_project": "veracode-api-py",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "requests",
"specs": [
[
">=",
"2.32.0"
]
]
},
{
"name": "veracode-api-signing",
"specs": [
[
">=",
"24.11.0"
]
]
},
{
"name": "Pygments",
"specs": [
[
">=",
"2.9.0"
]
]
},
{
"name": "idna",
"specs": [
[
">=",
"3.7"
]
]
},
{
"name": "certifi",
"specs": [
[
">=",
"2024.7.4"
]
]
}
],
"lcname": "veracode-api-py"
}
JSON
