Skip to main content

CleanLibrary Python SDK — HttpVerdictClient + HttpRemediationClient + HttpEnrichClient triad (sister-shape with @cleanstart/cleanlib-sdk v0.4.4)

Project description

cleanlib-sdk

CleanLibrary Python SDK — asyncio + httpx; mirrors the Rust cleanlib-client HTTP surface.

Status: v0.4.3 — production-ready.

Install

pip install cleanlib-sdk

Usage

import asyncio
from cleanlib_sdk import Client, PolicyDenyError, RiskAcceptanceRequiredError

async def main() -> None:
    async with Client(
        endpoint="https://cleanapp.clnstrt.dev",
        api_key="clk_std_...",   # opaque CleanLibrary access key
    ) as c:
        try:
            v = await c.fetch_verdict("npm", "lodash", "4.17.21")
            print(f"{v.decision} composite_score={v.composite_score}")
            print(f"reasoning: {v.reasoning}")
        except PolicyDenyError as e:
            print(f"DENIED [{e.reason_code}]: {e.message}")
        except RiskAcceptanceRequiredError as e:
            print(f"RISK ACCEPT REQUIRED: {e.message}")
            if e.docs_url:
                print(f"see: {e.docs_url}")

asyncio.run(main())

Error hierarchy

All errors descend from CleanLibraryError. Subclasses:

Exception HTTP Triggered by
PolicyDenyError 403 / 451 POLICY_DENY_VERDICT / POLICY_DENY_RULE_EXPLICIT
IntegrityFailureError 403 INTEGRITY_FAILURE
RateLimitExceededError 429 tier-throttled; carries retry_after_seconds
RiskAcceptanceRequiredError 403 RISK_ACCEPTANCE_REQUIRED
AuthenticationError 401 / 403 KEY_INVALID / KEY_EXPIRED / KEY_SCOPE_INSUFFICIENT
InsufficientDataError 403 INSUFFICIENT_DATA_FAIL_CLOSED
PackageNotFoundError 404 not in catalog + ingest declined
ServerError 5xx retryable on 502/503/504
TransportError network / TLS / timeout / DNS
ParseError response body shape mismatch

Development

pip install -e ".[dev]"
pytest
ruff check .

Cross-references

License

Proprietary — CleanStart.

Project details


Download files

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

Source Distribution

cleanlib_sdk-0.4.5.tar.gz (25.4 kB view details)

Uploaded Source

Built Distribution

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

cleanlib_sdk-0.4.5-py3-none-any.whl (34.5 kB view details)

Uploaded Python 3

File details

Details for the file cleanlib_sdk-0.4.5.tar.gz.

File metadata

  • Download URL: cleanlib_sdk-0.4.5.tar.gz
  • Upload date:
  • Size: 25.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.6

File hashes

Hashes for cleanlib_sdk-0.4.5.tar.gz
Algorithm Hash digest
SHA256 daf123e3abd8a295c5c02b1f330086a91a984bc5743318636c7e15cc2228e0e7
MD5 9f110e2f1bb431ec15ecb92c089766c7
BLAKE2b-256 45535afe924a5413d0c940033d566bc7d4f21005edf773b90879d35db1a50ab4

See more details on using hashes here.

File details

Details for the file cleanlib_sdk-0.4.5-py3-none-any.whl.

File metadata

  • Download URL: cleanlib_sdk-0.4.5-py3-none-any.whl
  • Upload date:
  • Size: 34.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.6

File hashes

Hashes for cleanlib_sdk-0.4.5-py3-none-any.whl
Algorithm Hash digest
SHA256 a1b539b5c01b542a3bb79722ed3f1a8c3a15af29acd9c9d08dfe7aab2ebdea33
MD5 ac7505e5ebcd45a9ef19381169285107
BLAKE2b-256 480f040b73f864e71954f1b8ddb2bd869ac542721db675892fc40a8fdc6a52aa

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