bugbounty-ksp-api-client 1.0.0

Official Python SDK for BugBountyKE-KSP platform API

BugBountyKE-KSP Python SDK

Official Python SDK for the BugBountyKE-KSP Platform.

pip install bugbounty-ksp

Features

• ✨ Official SDK with full type hints
• 🔐 Secure API key authentication
• 📤 Publish articles with image support
• ⚡ Comprehensive error handling
• 🧪 98% test coverage (68 tests)
• 📚 Full documentation & examples

Quick Start

from bugbounty_ksp import BugBountyKSPAPIClient
import os

# Get API key from environment
api_key = os.environ['BUGBOUNTY_API_KEY']

# Create client
client = BugBountyKSPAPIClient(api_key=api_key)

# Publish article
response = client.publish_article(
    title="Security Vulnerability Report",
    content="# Vulnerability Details\n\nDetails here...",
    frontmatter={
        "title": "Security Vulnerability Report",
        "tags": ["security", "bug-bounty"],
        "category": "web"
    },
    images={},
    file_path="/path/to/article.md"
)

print(f"Published! View at: {response.web_url}")

Installation

From PyPI (Recommended)

pip install bugbounty-ksp

From Source

git clone https://github.com/bugbountyksp/bugbounty-ksp-api-client.git
cd bugbounty-ksp-api-client
pip install -e .

Documentation

• Usage Guide - How to use the SDK
• API Reference - Complete API documentation
• Development Guide - Contributing & development
• Examples - Code examples

Getting Your API Key

1. Log in to https://bugbountyke-ksp.com
2. Go to Settings → API Keys
3. Click "Generate New Key"
4. Copy the key immediately (shown only once)
5. Store securely in environment variables

# .env or environment
export BUGBOUNTY_API_KEY="sk_test_your_key_here"

Error Handling

from bugbounty_ksp import BugBountyKSPAPIClient
from bugbounty_ksp.api.exceptions import (
    ValidationError,
    AuthenticationError,
    APIError,
)

try:
    response = client.publish_article(...)
except ValidationError as e:
    print(f"Invalid input: {e}")
except AuthenticationError as e:
    print(f"Invalid API key: {e}")
except APIError as e:
    print(f"API error: {e}")

Development

# Setup
python -m venv venv
source venv/bin/activate
pip install -e ".[dev]"

# Run tests
pytest -v

# Code quality
black src/ tests/
flake8 src/ tests/
mypy src/

Testing

68 tests with 98% code coverage:

pytest -v --cov=bugbounty_ksp

Tests included for:

• Authentication & API key validation
• Article publishing & management
• Error handling & edge cases
• API key generation & security
• Configuration & integration

License

MIT License - see LICENSE

Support

• 📖 Documentation
• 🐛 Issues
• 📧 Support: [e-mail]

---

Made with ❤️ by BugBountyKE-KSP Team