Skip to content

README.md

Latest commit

 

History

History
105 lines (74 loc) · 2.98 KB

README.md

File metadata and controls

105 lines (74 loc) · 2.98 KB

Repello Artemis SDK

A Python client SDK for triggering actions on Repello's Artemis Platform.

Installation

You can install the package from PyPI:

pip install repello-artemis-sdk

Requirements

  • Python 3.10 or higher
  • requests library (automatically installed as a dependency)

Quick Start

from repello_artemis_sdk import RepelloArtemisClient
from repello_artemis_sdk.enums import ScanType

# Initialize the client with your credentials
client = RepelloArtemisClient(
    client_id="your-client-id",
    client_secret="your-client-secret",
    log_to_console=True,  # Optional: Enable console logging
    log_to_file="artemis.log"  # Optional: Log to file
)

# Trigger a single scan type on an asset
client.assets.trigger_scan("asset_id", ScanType.quick_scan)

# Trigger multiple scan types on an asset
client.assets.trigger_scan("asset_id", [ScanType.quick_scan, ScanType.safety_scan])

Features

  • Simple, intuitive API for interacting with Repello's Artemis Platform
  • Supports single or multiple scan types for assets in a single request
  • Configurable logging (console and/or file)
  • Type hints for better IDE integration

Authentication

The SDK uses client credentials for authentication. You need to provide your client_id and client_secret when initializing the client:

client = RepelloArtemisClient(client_id, client_secret)

Head to platform.repello.ai and login to your account, go to the CI/CD page, create a client secret, then copy the client ID and client secret.

API Reference

Client Initialization

RepelloArtemisClient(
    client_id: str,
    client_secret: str,
    log_to_console: bool = False,
    log_to_file: str = None
)

Parameters:

  • client_id: Your Repello Artemis client ID
  • client_secret: Your Repello Artemis client secret
  • log_to_console: (Optional) Enable logging to console
  • log_to_file: (Optional) Path to log file

Assets

Trigger Scan

client.assets.trigger_scan(asset_id: str, scan_type: Union[ScanType, List[ScanType]])

Parameters:

  • asset_id: ID of the asset to scan
  • scan_type: Type of scan to perform (from ScanType enum) or a list of scan types

Available scan types:

  • ScanType.quick_scan: Performs a quick scan on the asset
  • ScanType.safety_scan: Performs a safety scan on the asset
  • ScanType.owasp: Performs an OWASP guideline-based scan
  • ScanType.mitre: Performs a MITRE ATT&CK framework-based scan
  • ScanType.nist: Performs a NIST standards-based scan
  • ScanType.whistleblower: Performs a whistleblower vulnerability scan
  • ScanType.fingerprint: Performs a digital fingerprinting scan

Changelog

See the CHANGELOG.md file for details on all changes and releases.

License

This project is licensed under the Apache License 2.0 - see the details in the license file.

Issues

If you encounter any problems, please file an issue at the GitHub repository.