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

0.2.5

This version

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.1.4.tar.gz (543.0 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.1.4-py3-none-any.whl (563.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: r7_surcom_sdk-0.1.4.tar.gz
  • Upload date:
  • Size: 543.0 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.1.4.tar.gz
Algorithm Hash digest
SHA256 9fc0e08e5fd2d1b4a92fbd3e93977c3b322ffb8b84c97a734596c42e16eb52da
MD5 5997d284830fc0ab7b725cfd20236b45
BLAKE2b-256 4e2f98118f0541964c81fa652e958dbe6717be80e80f51757cb9c045e5b088d1

See more details on using hashes here.

File details

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

File metadata

  • Download URL: r7_surcom_sdk-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 563.2 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.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 b007ce16dee3b4673d6f11197225a4bf51915740f3e231cac6ed2ca19fad2a4e
MD5 38dc315bf291eabd6fea48cb70b6456d
BLAKE2b-256 bde777174a008afba7804aaf7c22b6b1fa7c571658e080d9069c442498127725

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