# 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/52/9c/346976e9b21f154289b0bc4476a9e827ab54922e31d56c613a723409a74c/prelude_sdk-2.5.24.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.24",
"project_urls": {
"Homepage": "https://github.com/preludeorg"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "f42ec1c3a72d1ce3d3048347964c97fbfdd3db2df8224c6152c37db56a9f83c4",
"md5": "8b7e7002a01e81977e250d59dbdaee9e",
"sha256": "72e14746ecb596d6eaba4e068d60291243d2422d31596c7f2a88d19f3da2907b"
},
"downloads": -1,
"filename": "prelude_sdk-2.5.24-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8b7e7002a01e81977e250d59dbdaee9e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 17019,
"upload_time": "2025-02-05T20:49:55",
"upload_time_iso_8601": "2025-02-05T20:49:55.132149Z",
"url": "https://files.pythonhosted.org/packages/f4/2e/c1c3a72d1ce3d3048347964c97fbfdd3db2df8224c6152c37db56a9f83c4/prelude_sdk-2.5.24-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "529c346976e9b21f154289b0bc4476a9e827ab54922e31d56c613a723409a74c",
"md5": "c5d0a86e68f48150d758a4ef15408031",
"sha256": "badc9f1b32c41f37d4e3f8955a9d63019147ed150f933bf4e88b6c1f7b1952ce"
},
"downloads": -1,
"filename": "prelude_sdk-2.5.24.tar.gz",
"has_sig": false,
"md5_digest": "c5d0a86e68f48150d758a4ef15408031",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 24133,
"upload_time": "2025-02-05T20:49:56",
"upload_time_iso_8601": "2025-02-05T20:49:56.772791Z",
"url": "https://files.pythonhosted.org/packages/52/9c/346976e9b21f154289b0bc4476a9e827ab54922e31d56c613a723409a74c/prelude_sdk-2.5.24.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-05 20:49:56",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "prelude-sdk"
}
JSON