# 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.10",
"maintainer_email": null,
"keywords": null,
"author": "Prelude Research",
"author_email": "support@preludesecurity.com",
"download_url": "https://files.pythonhosted.org/packages/5f/ae/44fa45aa629f25fc8a51301358b4ed9168e1302feb8d3d32e69a6da2b936/prelude_sdk-2.5.0.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": "2.5.0",
"project_urls": {
"Homepage": "https://github.com/preludeorg"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1212d15aca1de1251bc2b36c341a9462838a27a7ee7d993b7b3abdceb2213118",
"md5": "61f301fd198cb99345df114fe220b7f9",
"sha256": "36d287017b600ab9318692cd6c20128268484fe479149d6eae9e4ed609cb5dc9"
},
"downloads": -1,
"filename": "prelude_sdk-2.5.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "61f301fd198cb99345df114fe220b7f9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 12987,
"upload_time": "2024-10-16T15:34:19",
"upload_time_iso_8601": "2024-10-16T15:34:19.080893Z",
"url": "https://files.pythonhosted.org/packages/12/12/d15aca1de1251bc2b36c341a9462838a27a7ee7d993b7b3abdceb2213118/prelude_sdk-2.5.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5fae44fa45aa629f25fc8a51301358b4ed9168e1302feb8d3d32e69a6da2b936",
"md5": "97e12793b260082e240d7b858a2001c0",
"sha256": "d98f1649956ed311462d09a54a646b9746598890f4f6a0c64c0feffeb18a50b1"
},
"downloads": -1,
"filename": "prelude_sdk-2.5.0.tar.gz",
"has_sig": false,
"md5_digest": "97e12793b260082e240d7b858a2001c0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 19501,
"upload_time": "2024-10-16T15:34:21",
"upload_time_iso_8601": "2024-10-16T15:34:21.626500Z",
"url": "https://files.pythonhosted.org/packages/5f/ae/44fa45aa629f25fc8a51301358b4ed9168e1302feb8d3d32e69a6da2b936/prelude_sdk-2.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-16 15:34:21",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "prelude-sdk"
}
JSON