Skip to main content

Official Python SDK for PatchOps Guard (patchguard.ai)

Project description

patchguard-ai — PatchOps Guard Python SDK

Official Python client for the PatchOps Guard API.

Installation

pip install patchguard-ai

Distribution name is patchguard-ai but the import name is patchguard (Django-style split — patchguard alone is taken on PyPI).

Quick start

from patchguard import PatchopsClient

with PatchopsClient(
    base_url="https://patchguard.ai",
    api_key="pk_live_...",
) as client:
    health = client.health.check()
    print(health)  # {"status": "ok", "db": True, "redis": True}

    findings = client.findings.list_unified(kind="cve", limit=50)
    for f in findings.items:
        print(f"{f.severity:8s} {f.title}")

    lb = client.benchmark.leaderboard()
    print(lb["vendors"][0]["name"])

Resources

  • client.health.check() — ping /health
  • client.findings.list_unified(kind=, severity=, limit=, offset=) — unified findings across all 10 Lanes
  • client.benchmark.leaderboard() — full vendor comparison

Errors

All API errors raise PatchopsError(status_code, detail).

License

MIT. See LICENSE.

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

patchguard_ai-0.1.1.tar.gz (4.0 kB view details)

Uploaded Source

Built Distribution

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

patchguard_ai-0.1.1-py3-none-any.whl (4.7 kB view details)

Uploaded Python 3

File details

Details for the file patchguard_ai-0.1.1.tar.gz.

File metadata

  • Download URL: patchguard_ai-0.1.1.tar.gz
  • Upload date:
  • Size: 4.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for patchguard_ai-0.1.1.tar.gz
Algorithm Hash digest
SHA256 a1882faa8b54076e17942c236058cbccfb002a0fbf89b7c0c5561d53dd98d632
MD5 d68df78ec4794b6244feecd42052850a
BLAKE2b-256 653259118253a2f28cfcf8a70c7acc0a1747634571a387250b6296f1249db24a

See more details on using hashes here.

File details

Details for the file patchguard_ai-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: patchguard_ai-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 4.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for patchguard_ai-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 790df232f617ebc3da476f902c4061074fa1c0abbf9c494570df13d4b17949e5
MD5 26a7a5fd0b44c8d01cc4d96410a348f3
BLAKE2b-256 5a5389e5f53544029e7286d2d0ea547e06a4ce5d95f55e1d581a9fe6dfc23d69

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