Python SDK used to interact and develop with Rapid7 Surface Command

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for r7_integration_alliance from gravatar.com r7_integration_alliance

Unverified details

These details have not been verified by PyPI
Meta
  • License Expression: MIT
    SPDX License Expression
  • Author: Rapid7
  • Tags rapid7 , Rapid7 , r7_surcom_sdk , r7-surcom-sdk , SurfaceCommand , Surface , Command , sdk
  • Requires: Python >=3.11
  • Provides-Extra: debug , developer
Classifiers
Report project as malware

Project description

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

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for r7_integration_alliance from gravatar.com r7_integration_alliance

Unverified details

These details have not been verified by PyPI
Meta
  • License Expression: MIT
    SPDX License Expression
  • Author: Rapid7
  • Tags rapid7 , Rapid7 , r7_surcom_sdk , r7-surcom-sdk , SurfaceCommand , Surface , Command , sdk
  • Requires: Python >=3.11
  • Provides-Extra: debug , developer
Classifiers

Release history Release notifications | RSS feed

0.16.19

0.15.18

0.14.16

0.12.15

0.11.14

0.10.12

0.9.11

0.8.10

0.7.9

0.6.8

0.5.7

0.3.6

This version

0.2.5

0.1.4

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

r7_surcom_sdk-0.2.5.tar.gz (560.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

r7_surcom_sdk-0.2.5-py3-none-any.whl (585.1 kB view details)

Uploaded Python 3

File details

Details for the file r7_surcom_sdk-0.2.5.tar.gz.

File metadata

  • Download URL: r7_surcom_sdk-0.2.5.tar.gz
  • Upload date:
  • Size: 560.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.13

File hashes

Hashes for r7_surcom_sdk-0.2.5.tar.gz
Algorithm Hash digest
SHA256 520a4f659ba29c7802cfe2a9c40618884139cc0eedbc8baa0d4410db1fc2abce
MD5 e73936785bb1b9dac4b596a12e82a988
BLAKE2b-256 a5d9677e983161b9cdf79ad29e93b5ecb89543b4bf958591947bf2101d7fc72e

See more details on using hashes here.

File details

Details for the file r7_surcom_sdk-0.2.5-py3-none-any.whl.

File metadata

  • Download URL: r7_surcom_sdk-0.2.5-py3-none-any.whl
  • Upload date:
  • Size: 585.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.13

File hashes

Hashes for r7_surcom_sdk-0.2.5-py3-none-any.whl
Algorithm Hash digest
SHA256 6214ae6e5abd3dcd14bfa7f6630b13bc51e32fba4a1a2dab69ce356434c046c6
MD5 448bc3c61584a1116abe7a2902bd49a5
BLAKE2b-256 17f6dea623e6fcee3bfc1de58debf60818b8103f1ad75d8e1c1891960d6091ca

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page