# Surface Command SDK
The `surcom-sdk` provides tools to develop Surface Command data connectors for the Rapid7 platform.
## Installation
* To install the `surcom-sdk`, run:
```
pip install r7-surcom-sdk
```
* To verify the installed version, run:
```
surcom --version
```
* To install the SDK with the dependencies needed to debug a connector, run:
```
pip install 'r7-surcom-sdk[debug]'
```
## Configuration
* Once installed, use the `config init` command to setup the `surcom-sdk`:
```
surcom config init
```
## Documentation
* All SDK commands have detailed help hints. Append `--help` to any command to view them:
```
surcom connector --help
```
Raw data
{
"_id": null,
"home_page": null,
"name": "r7-surcom-sdk",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": "rapid7, Rapid7, r7_surcom_sdk, r7-surcom-sdk, SurfaceCommand, Surface, Command, sdk",
"author": null,
"author_email": "Rapid7 <integrationalliance@rapid7.com>",
"download_url": "https://files.pythonhosted.org/packages/4e/2f/98118f0541964c81fa652e958dbe6717be80e80f51757cb9c045e5b088d1/r7_surcom_sdk-0.1.4.tar.gz",
"platform": null,
"description": "# Surface Command SDK\n\nThe `surcom-sdk` provides tools to develop Surface Command data connectors for the Rapid7 platform.\n\n## Installation\n* To install the `surcom-sdk`, run:\n\n ```\n pip install r7-surcom-sdk\n ```\n\n* To verify the installed version, run:\n\n ```\n surcom --version\n ```\n\n* To install the SDK with the dependencies needed to debug a connector, run:\n ```\n pip install 'r7-surcom-sdk[debug]'\n ```\n\n## Configuration\n* Once installed, use the `config init` command to setup the `surcom-sdk`:\n\n ```\n surcom config init\n ```\n\n## Documentation\n* All SDK commands have detailed help hints. Append `--help` to any command to view them:\n ```\n surcom connector --help\n ```\n",
"bugtrack_url": null,
"license": null,
"summary": "Python SDK used to interact and develop with Rapid7 Surface Command",
"version": "0.1.4",
"project_urls": null,
"split_keywords": [
"rapid7",
" rapid7",
" r7_surcom_sdk",
" r7-surcom-sdk",
" surfacecommand",
" surface",
" command",
" sdk"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "bde777174a008afba7804aaf7c22b6b1fa7c571658e080d9069c442498127725",
"md5": "38dc315bf291eabd6fea48cb70b6456d",
"sha256": "b007ce16dee3b4673d6f11197225a4bf51915740f3e231cac6ed2ca19fad2a4e"
},
"downloads": -1,
"filename": "r7_surcom_sdk-0.1.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "38dc315bf291eabd6fea48cb70b6456d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 563221,
"upload_time": "2025-07-30T17:14:09",
"upload_time_iso_8601": "2025-07-30T17:14:09.079345Z",
"url": "https://files.pythonhosted.org/packages/bd/e7/77174a008afba7804aaf7c22b6b1fa7c571658e080d9069c442498127725/r7_surcom_sdk-0.1.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "4e2f98118f0541964c81fa652e958dbe6717be80e80f51757cb9c045e5b088d1",
"md5": "5997d284830fc0ab7b725cfd20236b45",
"sha256": "9fc0e08e5fd2d1b4a92fbd3e93977c3b322ffb8b84c97a734596c42e16eb52da"
},
"downloads": -1,
"filename": "r7_surcom_sdk-0.1.4.tar.gz",
"has_sig": false,
"md5_digest": "5997d284830fc0ab7b725cfd20236b45",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 543044,
"upload_time": "2025-07-30T17:14:10",
"upload_time_iso_8601": "2025-07-30T17:14:10.202070Z",
"url": "https://files.pythonhosted.org/packages/4e/2f/98118f0541964c81fa652e958dbe6717be80e80f51757cb9c045e5b088d1/r7_surcom_sdk-0.1.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-30 17:14:10",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "r7-surcom-sdk"
}
JSON