confluence-as 1.0.0__py3-none-any.whl

confluence_as/__init__.py

@@ -0,0 +1,330 @@
+"""
+Confluence AS
+
+Python library for Confluence Cloud REST API - shared utilities for Confluence automation.
+
+This module provides common utilities for all Confluence skills:
+- ConfluenceClient: HTTP client with retry logic
+- ConfigManager: Environment variable configuration
+- Error handling: Exception hierarchy and decorators
+- Validators: Input validation utilities
+- Formatters: Output formatting utilities
+- ADF Helper: Atlassian Document Format utilities
+- XHTML Helper: Legacy storage format utilities
+- Cache: Response caching
+
+Required Environment Variables:
+    CONFLUENCE_SITE_URL - Confluence Cloud URL (e.g., https://your-site.atlassian.net)
+    CONFLUENCE_EMAIL - Email address for authentication
+    CONFLUENCE_API_TOKEN - API token for authentication
+
+Usage:
+    from confluence_as import (
+        ConfluenceClient,
+        get_confluence_client,
+        handle_errors,
+        ValidationError,
+    )
+
+    # Get a configured client (uses environment variables)
+    client = get_confluence_client()
+
+    # Or create directly
+    client = ConfluenceClient(
+        base_url="https://your-site.atlassian.net",
+        email="your-email@example.com",
+        api_token="your-api-token"
+    )
+
+    # Get a page
+    page = client.get("/api/v2/pages/12345")
+"""
+
+__version__ = "1.0.0"
+
+# Client
+# Batch processing (from base library)
+from assistant_skills_lib.batch_processor import (
+    BatchConfig,
+    BatchProcessor,
+    BatchProgress,
+    CheckpointManager,
+    generate_operation_id,
+    get_recommended_batch_size,
+    list_pending_checkpoints,
+)
+
+# Cache (from base library)
+from assistant_skills_lib.cache import (
+    Cache,
+    cached,
+    get_cache,
+    invalidate,
+)
+
+# Request Batcher (from base library)
+from assistant_skills_lib.request_batcher import (
+    BatchError,
+    BatchResult,
+    RequestBatcher,
+)
+
+# ADF Helper
+from .adf_helper import (
+    adf_to_markdown,
+    adf_to_text,
+    create_adf_doc,
+    create_blockquote,
+    create_bullet_list,
+    create_code_block,
+    create_heading,
+    create_link,
+    create_ordered_list,
+    create_paragraph,
+    create_rule,
+    create_table,
+    create_text,
+    is_markdown_block_start,  # Re-exported alias for backward compatibility
+    markdown_to_adf,
+    text_to_adf,
+    validate_adf,
+)
+
+# Autocomplete Cache
+from .autocomplete_cache import (
+    AutocompleteCache,
+    get_autocomplete_cache,
+)
+
+# Config
+from .config_manager import (
+    ConfigManager,
+    get_confluence_client,
+)
+from .confluence_client import ConfluenceClient, create_client
+
+# Credential Manager
+from .credential_manager import (
+    ConfluenceCredentialManager,
+    CredentialBackend,
+    CredentialNotFoundError,
+    get_credential_manager,
+    get_credentials,
+    is_keychain_available,
+    store_credentials,
+    validate_credentials,
+)
+
+# Errors
+from .error_handler import (
+    AuthenticationError,
+    ConflictError,
+    ConfluenceError,
+    ErrorContext,
+    NotFoundError,
+    PermissionError,
+    RateLimitError,
+    ServerError,
+    ValidationError,
+    extract_error_message,
+    handle_confluence_error,
+    handle_errors,
+    print_error,
+    sanitize_error_message,
+)
+
+# Formatters
+from .formatters import (
+    Colors,
+    export_csv,
+    format_attachment,
+    format_blogpost,
+    format_comment,
+    format_comments,
+    format_json,
+    format_label,
+    format_page,
+    format_search_results,
+    format_space,
+    format_table,
+    format_timestamp,
+    format_version,
+    print_info,
+    print_success,
+    print_warning,
+    strip_html_tags,
+    truncate,
+)
+
+# Markdown Parser (shared)
+from .markdown_parser import (
+    is_block_start,
+    parse_markdown,
+)
+
+# Space Context
+from .space_context import (
+    SpaceContext,
+    clear_context_cache,
+    format_context_summary,
+    get_common_labels,
+    get_page_defaults,
+    get_space_context,
+    get_top_contributors,
+    has_space_context,
+    suggest_parent_page,
+)
+
+# Validators
+from .validators import (
+    validate_content_type,
+    validate_cql,
+    validate_email,
+    validate_file_path,
+    validate_issue_key,
+    validate_jql_query,
+    validate_label,
+    validate_limit,
+    validate_page_id,
+    validate_space_key,
+    validate_title,
+    validate_url,
+)
+
+# XHTML Helper
+from .xhtml_helper import (
+    adf_to_xhtml,
+    extract_text_from_xhtml,
+    markdown_to_xhtml,
+    validate_xhtml,
+    wrap_in_storage_format,
+    xhtml_to_adf,
+    xhtml_to_markdown,
+)
+
+__all__ = [
+    # Version
+    "__version__",
+    # Batch Processing
+    "BatchConfig",
+    "BatchProcessor",
+    "BatchProgress",
+    "CheckpointManager",
+    "generate_operation_id",
+    "get_recommended_batch_size",
+    "list_pending_checkpoints",
+    # Request Batcher
+    "BatchError",
+    "BatchResult",
+    "RequestBatcher",
+    # Client
+    "ConfluenceClient",
+    "create_client",
+    # Config
+    "ConfigManager",
+    "get_confluence_client",
+    # Credential Manager
+    "ConfluenceCredentialManager",
+    "CredentialBackend",
+    "CredentialNotFoundError",
+    "get_credential_manager",
+    "get_credentials",
+    "is_keychain_available",
+    "store_credentials",
+    "validate_credentials",
+    # Errors
+    "ConfluenceError",
+    "AuthenticationError",
+    "PermissionError",
+    "ValidationError",
+    "NotFoundError",
+    "RateLimitError",
+    "ConflictError",
+    "ServerError",
+    "handle_confluence_error",
+    "handle_errors",
+    "print_error",
+    "sanitize_error_message",
+    "extract_error_message",
+    "ErrorContext",
+    # Validators
+    "validate_page_id",
+    "validate_space_key",
+    "validate_cql",
+    "validate_content_type",
+    "validate_file_path",
+    "validate_url",
+    "validate_email",
+    "validate_title",
+    "validate_label",
+    "validate_limit",
+    "validate_issue_key",
+    "validate_jql_query",
+    # Formatters
+    "Colors",
+    "format_page",
+    "format_blogpost",
+    "format_space",
+    "format_comment",
+    "format_comments",
+    "format_search_results",
+    "format_table",
+    "format_json",
+    "format_timestamp",
+    "format_attachment",
+    "format_label",
+    "format_version",
+    "export_csv",
+    "print_success",
+    "print_warning",
+    "print_info",
+    "truncate",
+    "strip_html_tags",
+    # Markdown Parser
+    "parse_markdown",
+    "is_block_start",
+    # ADF Helper
+    "create_adf_doc",
+    "create_paragraph",
+    "create_text",
+    "create_heading",
+    "create_bullet_list",
+    "create_ordered_list",
+    "create_code_block",
+    "create_blockquote",
+    "create_rule",
+    "create_table",
+    "create_link",
+    "text_to_adf",
+    "markdown_to_adf",
+    "adf_to_text",
+    "adf_to_markdown",
+    "validate_adf",
+    "is_markdown_block_start",
+    # XHTML Helper
+    "xhtml_to_markdown",
+    "markdown_to_xhtml",
+    "xhtml_to_adf",
+    "adf_to_xhtml",
+    "extract_text_from_xhtml",
+    "wrap_in_storage_format",
+    "validate_xhtml",
+    # Cache
+    "Cache",
+    "get_cache",
+    "cached",
+    "invalidate",
+    # Autocomplete Cache
+    "AutocompleteCache",
+    "get_autocomplete_cache",
+    # Space Context
+    "SpaceContext",
+    "get_space_context",
+    "clear_context_cache",
+    "has_space_context",
+    "get_page_defaults",
+    "get_common_labels",
+    "get_top_contributors",
+    "suggest_parent_page",
+    "format_context_summary",
+]