RegScale Python SSP Library

0.1.2 verified Mon Apr 27 auth: no python

Library for interfacing with FedRAMP system security plan templates, enabling creation, management, and export of SSPs via RegScale API. Current version 0.1.2, early-stage development with monthly releases.

pip install regscale-python-ssp

Common errors

error ModuleNotFoundError: No module named 'regscale-python-ssp' ↓

cause Attempting to import using the PyPI package name with hyphens.

fix

Use import regscale_ssp (underscores) instead.

error regscale_ssp.exceptions.AuthenticationError: Invalid API key ↓

cause Missing or incorrect API key.

fix

Set REGSCALE_API_KEY environment variable or pass valid api_key to SSPClient.

Warnings

breaking Package name uses hyphens in PyPI (regscale-python-ssp) but import uses underscores (regscale_ssp). Do not use hyphen in import. ↓

fix Use `import regscale_ssp` or `from regscale_ssp import ...`.

gotcha API key is required for all operations. Provide via REGSCALE_API_KEY environment variable or pass directly to SSPClient. ↓

fix Set environment variable or pass api_key parameter.

Imports

SSPTemplate
```
from regscale_ssp import SSPTemplate
```
SSPClient
wrong
```
from regscale_ssp.client import SSPClient
```
correct
```
from regscale_ssp import SSPClient
```
SSPClient is re-exported from main package; direct submodule import may break in future versions.

Quickstart

Initialize client with API key and create a basic SSP.

from regscale_ssp import SSPTemplate, SSPClient
import os

client = SSPClient(api_key=os.environ.get('REGSCALE_API_KEY', ''))
template = SSPTemplate(client)
result = template.create_ssp(name='Example SSP', framework='fedramp')
print(result)