Skip to main content

WS Python SDK

Project description

Logo License CI Python 3.7 PyPI

WhiteSource Python SDK

SDK written in Python to simplify access to WhiteSource resources

The SDK contains the following modules:

  • web - Module for accessing WhiteSource Application (reports, administration, etc...).
  • client - UA wrapper layer (download UA, execute scan, read UA output files...).

Supported Operating Systems

  • Linux (Bash): CentOS, Debian, Ubuntu, RedHat
  • Windows (PowerShell): 10, 2012, 2016

How to build and install package from source

  1. Download the code: git clone
  2. Build wheel package python bdist_wheel
  3. Download wheel from GitHub and install : pip install ws-sdk*.whl

How to install package

  1. Obtain connection details from WS Application (Home > Admin > Integration)
  2. Install package from Pypi: pip install ws-sdk


# Web (WhiteSource Application)
from ws_sdk.web import WS
ws = WS(api_url="WS_URL", user_key="USER_KEY", token="ORG_TOKEN")
# Get alerts 
all_alerts = ws.get_alerts()
# Get vulnerabilities report in XLSX format
vul_report = ws.get_vulnerability(report=True)
# Get all projects ()
project_list = ws.get_projects()
# Create user in the organization
ws.create_user(name='USER_TEST1', email="USER_TEST1@EMAIL.COM", inviter_email="INVITER@EMAIL.COM")

# Client (WhiteSource Unified Agent)
from ws_sdk.client import WSClient
ws_client = WSClient(api_url="WS_URL", user_key="USER_KEY", token="ORG_TOKEN", ua_path="/UA/WORKING/DIR")
# Download latest UA jar and conf file
# Execute scan into defined project token
out = ws_client.execute_scan(scan_dir="/PATH/TO/DIR", project_token="PROJ_TOKEN")
# Read scan artifcat's policy rejection summary 
pol_rej = ws_client.get_policy_rejection_summary()

Project details

Download files

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

Files for ws-sdk, version 0.6
Filename, size File type Python version Upload date Hashes
Filename, size ws_sdk-0.6-py3-none-any.whl (32.8 kB) File type Wheel Python version py3 Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page