# Prelude SDK
Interact with the Prelude Service API via Python.
> The prelude-cli utility wraps around this SDK to provide a rich command line experience.
Install this package to write your own tooling that works with Build or Detect functionality.
- IAM: manage your account
- Build: write and maintain your collection of security tests
- Detect: schedule security tests for your endpoints
## Quick start
```bash
pip install prelude-sdk
```
## Documentation
TBD
## Testing
To test the Python SDK and Probes, run the following commands from the python/sdk/ directory:
```bash
pip install -r tests/requirements.txt
pytest tests --api https://api.preludesecurity.com --email <EMAIL>
```
Raw data
{
"_id": null,
"home_page": "https://github.com/preludeorg",
"name": "prelude-sdk",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": "Prelude Research",
"author_email": "support@preludesecurity.com",
"download_url": "https://files.pythonhosted.org/packages/8b/7a/3fc9e7bb50cefae33baadfc56c994bf798338e0e84cb792cbcf8478e2c04/prelude_sdk-1.7.8.tar.gz",
"platform": null,
"description": "# Prelude SDK\n\nInteract with the Prelude Service API via Python. \n\n> The prelude-cli utility wraps around this SDK to provide a rich command line experience.\n\nInstall this package to write your own tooling that works with Build or Detect functionality.\n\n- IAM: manage your account\n- Build: write and maintain your collection of security tests\n- Detect: schedule security tests for your endpoints\n\n## Quick start\n\n```bash\npip install prelude-sdk\n```\n\n## Documentation \n\nTBD\n\n## Testing\n\nTo test the Python SDK and Probes, run the following commands from the python/sdk/ directory:\n\n```bash\npip install -r tests/requirements.txt\npytest tests --api https://api.preludesecurity.com --email <EMAIL>\n```\n",
"bugtrack_url": null,
"license": null,
"summary": "For interacting with the Prelude API",
"version": "1.7.8",
"project_urls": {
"Homepage": "https://github.com/preludeorg"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5b4fe0bc236d2e69b4faf4f232592b55479aba41d65825619bac8a9ac84e7e87",
"md5": "622795a12349c598d54fa12476df2689",
"sha256": "aed5d5b05bec4dc01fddbf83b78da61e33d980116c73d3f6d60af55d627bcb65"
},
"downloads": -1,
"filename": "prelude_sdk-1.7.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "622795a12349c598d54fa12476df2689",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 12370,
"upload_time": "2024-07-03T22:01:04",
"upload_time_iso_8601": "2024-07-03T22:01:04.941659Z",
"url": "https://files.pythonhosted.org/packages/5b/4f/e0bc236d2e69b4faf4f232592b55479aba41d65825619bac8a9ac84e7e87/prelude_sdk-1.7.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8b7a3fc9e7bb50cefae33baadfc56c994bf798338e0e84cb792cbcf8478e2c04",
"md5": "2c3c38c1ab8c59cfb7ef7b50f36655aa",
"sha256": "51767b39b3443ec4440f3a79b16c585c865f8a1069b912b88a742053cd0c742b"
},
"downloads": -1,
"filename": "prelude_sdk-1.7.8.tar.gz",
"has_sig": false,
"md5_digest": "2c3c38c1ab8c59cfb7ef7b50f36655aa",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 19325,
"upload_time": "2024-07-03T22:01:07",
"upload_time_iso_8601": "2024-07-03T22:01:07.404680Z",
"url": "https://files.pythonhosted.org/packages/8b/7a/3fc9e7bb50cefae33baadfc56c994bf798338e0e84cb792cbcf8478e2c04/prelude_sdk-1.7.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-03 22:01:07",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "prelude-sdk"
}
JSON