confluence-ai 0.1.0__tar.gz

confluence_ai-0.1.0/PKG-INFO

@@ -0,0 +1,217 @@
+Metadata-Version: 2.4
+Name: confluence-ai
+Version: 0.1.0
+Summary: General-purpose AI-powered Confluence toolkit — export, publish, and describe pages
+Author: Confluence AI Contributors
+License: MIT
+Keywords: confluence,markdown,export,publish,ai,gliffy
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Documentation
+Classifier: Topic :: Text Processing :: Markup
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: click>=8.1.0
+Requires-Dist: atlassian-python-api>=3.41.0
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: requests>=2.31.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.4.0; extra == "dev"
+Requires-Dist: hypothesis>=6.90.0; extra == "dev"
+Requires-Dist: pytest-mock; extra == "dev"
+Provides-Extra: anthropic
+Requires-Dist: anthropic>=0.30.0; extra == "anthropic"
+Provides-Extra: openai
+Requires-Dist: openai>=1.0.0; extra == "openai"
+Provides-Extra: bedrock
+Requires-Dist: boto3>=1.28.0; extra == "bedrock"
+Requires-Dist: botocore[crt]>=1.28.0; extra == "bedrock"
+Provides-Extra: all
+Requires-Dist: anthropic>=0.30.0; extra == "all"
+Requires-Dist: openai>=1.0.0; extra == "all"
+Requires-Dist: boto3>=1.28.0; extra == "all"
+Requires-Dist: botocore[crt]>=1.28.0; extra == "all"
+
+# confluence-ai
+
+General-purpose AI-powered Confluence toolkit — export, publish, and describe pages.
+
+## Library Usage
+
+### Export a Page
+
+```python
+from confluence_ai import export_page, ImageDescriberConfig
+
+# Export with AI-powered image descriptions
+result = export_page(
+    "https://acme.atlassian.net/wiki/spaces/ENG/pages/123456/My-Page",
+    "./output",
+    email="user@acme.com",
+    api_token="your-api-token",
+    ai_config=ImageDescriberConfig(
+        provider="bedrock",
+        model="us.anthropic.claude-sonnet-4-20250514-v1:0",
+    ),
+)
+print(f"Exported to: {result.markdown_path}")
+print(f"Images: {result.images_downloaded}, Descriptions: {result.descriptions_generated}")
+
+# Export without AI descriptions
+result = export_page(
+    "https://acme.atlassian.net/wiki/spaces/ENG/pages/123456/My-Page",
+    "./output",
+    email="user@acme.com",
+    api_token="your-api-token",
+)
+```
+
+### Publish a Page
+
+```python
+from confluence_ai import publish_page
+
+url = publish_page(
+    "<h1>Report</h1><p>Analysis results...</p>",
+    email="user@acme.com",
+    api_token="your-api-token",
+    base_url="https://acme.atlassian.net/wiki",
+    space_key="ENG",
+    title="Gap Analysis Report - 2024-01-15",
+    parent_page_id="123456",
+)
+print(f"Published: {url}")
+```
+
+### Export as JSON
+
+```python
+from confluence_ai import export_page
+
+result = export_page(
+    "https://acme.atlassian.net/wiki/spaces/ENG/pages/123456/My-Page",
+    "./output",
+    email="user@acme.com",
+    api_token="your-api-token",
+    output_format="json",
+)
+```
+
+## Extension Points
+
+### Custom Image Describer
+
+Subclass `ImageDescriber` and register it to use your own vision model:
+
+```python
+from confluence_ai import ImageDescriber, ImageDescriberConfig, ImageContext, register_describer
+
+class LocalLlavaDescriber(ImageDescriber):
+    """Image describer using a local LLaVA model."""
+
+    def describe(self, image_path: str, context: ImageContext) -> str:
+        # Call your local model here
+        return f"Description of {context.filename}"
+
+# Register the custom provider
+register_describer("local-llava", LocalLlavaDescriber)
+
+# Use it via the standard factory
+from confluence_ai import create_describer
+
+describer = create_describer(ImageDescriberConfig(provider="local-llava", model="llava-1.5"))
+description = describer.describe("diagram.png", ImageContext(is_gliffy=True))
+```
+
+### Custom Output Renderer
+
+Subclass `OutputRenderer` to export pages in formats beyond Markdown and JSON:
+
+```python
+from confluence_ai import OutputRenderer, register_renderer
+from confluence_ai.models import ContentNode, PageMetadata
+
+class ReStructuredTextRenderer(OutputRenderer):
+    """Render Confluence pages as reStructuredText."""
+
+    def render(
+        self,
+        nodes: list[ContentNode],
+        metadata: PageMetadata,
+        descriptions: dict[str, str] | None = None,
+    ) -> str:
+        # Convert nodes to RST format
+        lines = [metadata.page_title, "=" * len(metadata.page_title), ""]
+        # ... render nodes ...
+        return "\n".join(lines)
+
+# Register and use
+register_renderer("rst", ReStructuredTextRenderer)
+
+from confluence_ai import export_page
+
+result = export_page(
+    "https://acme.atlassian.net/wiki/spaces/ENG/pages/123456/My-Page",
+    "./output",
+    email="user@acme.com",
+    api_token="your-api-token",
+    output_format="rst",
+)
+```
+
+## CLI Usage
+
+### confluence-export
+
+```bash
+# Basic export (no AI descriptions)
+confluence-export \
+  "https://acme.atlassian.net/wiki/spaces/ENG/pages/12345/My-Page" \
+  ./output \
+  --email user@example.com \
+  --api-token YOUR_API_TOKEN \
+  --no-ai
+
+# Export with AI image descriptions
+confluence-export \
+  "https://acme.atlassian.net/wiki/spaces/ENG/pages/12345/My-Page" \
+  ./output \
+  --email user@example.com \
+  --api-token YOUR_API_TOKEN \
+  --ai-provider anthropic \
+  --ai-api-key YOUR_ANTHROPIC_KEY
+```
+
+| Option | Env Variable | Description |
+|---|---|---|
+| `--email` | `CONFLUENCE_EMAIL` | Confluence account email |
+| `--api-token` | `CONFLUENCE_API_TOKEN` | Confluence Cloud API token |
+| `--ai-provider` | `CONFLUENCE_EXPORT_AI_PROVIDER` | AI provider: `anthropic`, `openai`, or `bedrock` |
+| `--ai-model` | `CONFLUENCE_EXPORT_AI_MODEL` | AI model name |
+| `--ai-api-key` | `ANTHROPIC_API_KEY` / `OPENAI_API_KEY` | AI provider API key |
+| `--no-ai` | — | Skip AI image description generation |
+| `--verbose` | — | Enable DEBUG-level logging |
+
+## Installation
+
+```bash
+pip install confluence-ai
+
+# With AI provider support
+pip install "confluence-ai[bedrock]"    # Amazon Bedrock (Claude)
+pip install "confluence-ai[openai]"     # OpenAI GPT-4o
+pip install "confluence-ai[anthropic]"  # Anthropic Claude (direct API)
+pip install "confluence-ai[all]"        # All providers
+```
+
+Requires Python 3.10+.
+
+## License
+
+MIT

confluence_ai-0.1.0/README.md

@@ -0,0 +1,177 @@
+# confluence-ai
+
+General-purpose AI-powered Confluence toolkit — export, publish, and describe pages.
+
+## Library Usage
+
+### Export a Page
+
+```python
+from confluence_ai import export_page, ImageDescriberConfig
+
+# Export with AI-powered image descriptions
+result = export_page(
+    "https://acme.atlassian.net/wiki/spaces/ENG/pages/123456/My-Page",
+    "./output",
+    email="user@acme.com",
+    api_token="your-api-token",
+    ai_config=ImageDescriberConfig(
+        provider="bedrock",
+        model="us.anthropic.claude-sonnet-4-20250514-v1:0",
+    ),
+)
+print(f"Exported to: {result.markdown_path}")
+print(f"Images: {result.images_downloaded}, Descriptions: {result.descriptions_generated}")
+
+# Export without AI descriptions
+result = export_page(
+    "https://acme.atlassian.net/wiki/spaces/ENG/pages/123456/My-Page",
+    "./output",
+    email="user@acme.com",
+    api_token="your-api-token",
+)
+```
+
+### Publish a Page
+
+```python
+from confluence_ai import publish_page
+
+url = publish_page(
+    "<h1>Report</h1><p>Analysis results...</p>",
+    email="user@acme.com",
+    api_token="your-api-token",
+    base_url="https://acme.atlassian.net/wiki",
+    space_key="ENG",
+    title="Gap Analysis Report - 2024-01-15",
+    parent_page_id="123456",
+)
+print(f"Published: {url}")
+```
+
+### Export as JSON
+
+```python
+from confluence_ai import export_page
+
+result = export_page(
+    "https://acme.atlassian.net/wiki/spaces/ENG/pages/123456/My-Page",
+    "./output",
+    email="user@acme.com",
+    api_token="your-api-token",
+    output_format="json",
+)
+```
+
+## Extension Points
+
+### Custom Image Describer
+
+Subclass `ImageDescriber` and register it to use your own vision model:
+
+```python
+from confluence_ai import ImageDescriber, ImageDescriberConfig, ImageContext, register_describer
+
+class LocalLlavaDescriber(ImageDescriber):
+    """Image describer using a local LLaVA model."""
+
+    def describe(self, image_path: str, context: ImageContext) -> str:
+        # Call your local model here
+        return f"Description of {context.filename}"
+
+# Register the custom provider
+register_describer("local-llava", LocalLlavaDescriber)
+
+# Use it via the standard factory
+from confluence_ai import create_describer
+
+describer = create_describer(ImageDescriberConfig(provider="local-llava", model="llava-1.5"))
+description = describer.describe("diagram.png", ImageContext(is_gliffy=True))
+```
+
+### Custom Output Renderer
+
+Subclass `OutputRenderer` to export pages in formats beyond Markdown and JSON:
+
+```python
+from confluence_ai import OutputRenderer, register_renderer
+from confluence_ai.models import ContentNode, PageMetadata
+
+class ReStructuredTextRenderer(OutputRenderer):
+    """Render Confluence pages as reStructuredText."""
+
+    def render(
+        self,
+        nodes: list[ContentNode],
+        metadata: PageMetadata,
+        descriptions: dict[str, str] | None = None,
+    ) -> str:
+        # Convert nodes to RST format
+        lines = [metadata.page_title, "=" * len(metadata.page_title), ""]
+        # ... render nodes ...
+        return "\n".join(lines)
+
+# Register and use
+register_renderer("rst", ReStructuredTextRenderer)
+
+from confluence_ai import export_page
+
+result = export_page(
+    "https://acme.atlassian.net/wiki/spaces/ENG/pages/123456/My-Page",
+    "./output",
+    email="user@acme.com",
+    api_token="your-api-token",
+    output_format="rst",
+)
+```
+
+## CLI Usage
+
+### confluence-export
+
+```bash
+# Basic export (no AI descriptions)
+confluence-export \
+  "https://acme.atlassian.net/wiki/spaces/ENG/pages/12345/My-Page" \
+  ./output \
+  --email user@example.com \
+  --api-token YOUR_API_TOKEN \
+  --no-ai
+
+# Export with AI image descriptions
+confluence-export \
+  "https://acme.atlassian.net/wiki/spaces/ENG/pages/12345/My-Page" \
+  ./output \
+  --email user@example.com \
+  --api-token YOUR_API_TOKEN \
+  --ai-provider anthropic \
+  --ai-api-key YOUR_ANTHROPIC_KEY
+```
+
+| Option | Env Variable | Description |
+|---|---|---|
+| `--email` | `CONFLUENCE_EMAIL` | Confluence account email |
+| `--api-token` | `CONFLUENCE_API_TOKEN` | Confluence Cloud API token |
+| `--ai-provider` | `CONFLUENCE_EXPORT_AI_PROVIDER` | AI provider: `anthropic`, `openai`, or `bedrock` |
+| `--ai-model` | `CONFLUENCE_EXPORT_AI_MODEL` | AI model name |
+| `--ai-api-key` | `ANTHROPIC_API_KEY` / `OPENAI_API_KEY` | AI provider API key |
+| `--no-ai` | — | Skip AI image description generation |
+| `--verbose` | — | Enable DEBUG-level logging |
+
+## Installation
+
+```bash
+pip install confluence-ai
+
+# With AI provider support
+pip install "confluence-ai[bedrock]"    # Amazon Bedrock (Claude)
+pip install "confluence-ai[openai]"     # OpenAI GPT-4o
+pip install "confluence-ai[anthropic]"  # Anthropic Claude (direct API)
+pip install "confluence-ai[all]"        # All providers
+```
+
+Requires Python 3.10+.
+
+## License
+
+MIT

confluence_ai-0.1.0/pyproject.toml

@@ -0,0 +1,60 @@
+[build-system]
+requires = ["setuptools>=68.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "confluence-ai"
+version = "0.1.0"
+description = "General-purpose AI-powered Confluence toolkit — export, publish, and describe pages"
+readme = "README.md"
+license = {text = "MIT"}
+requires-python = ">=3.10"
+authors = [
+    {name = "Confluence AI Contributors"},
+]
+keywords = ["confluence", "markdown", "export", "publish", "ai", "gliffy"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Documentation",
+    "Topic :: Text Processing :: Markup",
+    "Typing :: Typed",
+]
+dependencies = [
+    "click>=8.1.0",
+    "atlassian-python-api>=3.41.0",
+    "pyyaml>=6.0",
+    "requests>=2.31.0",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.4.0",
+    "hypothesis>=6.90.0",
+    "pytest-mock",
+]
+anthropic = ["anthropic>=0.30.0"]
+openai = ["openai>=1.0.0"]
+bedrock = ["boto3>=1.28.0", "botocore[crt]>=1.28.0"]
+all = ["anthropic>=0.30.0", "openai>=1.0.0", "boto3>=1.28.0", "botocore[crt]>=1.28.0"]
+
+[project.scripts]
+confluence-export = "confluence_ai.cli:main"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+confluence_ai = ["py.typed"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+pythonpath = ["src"]
+
+[tool.hypothesis]
+database_backend = "directory"

confluence_ai-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

confluence_ai-0.1.0/src/confluence_ai/__init__.py

@@ -0,0 +1,85 @@
+"""AI-powered Confluence toolkit — export, publish, and describe pages.
+
+Programmatic API for Confluence Cloud: read pages, resolve user mentions,
+download attachments, describe images via multimodal AI, render to
+Markdown or JSON (or custom formats), and publish HTML back to Confluence.
+"""
+
+from __future__ import annotations
+
+__version__ = "0.1.0"
+
+# --- Core classes ---
+from confluence_ai.client import ConfluenceClient
+from confluence_ai.describer import ImageDescriber
+from confluence_ai.downloader import AssetDownloader
+from confluence_ai.output_renderer import OutputRenderer, register_renderer
+from confluence_ai.parser import StorageFormatParser
+from confluence_ai.renderer import MarkdownRenderer
+from confluence_ai.url_parser import URLParser
+
+# --- Factory & registry functions ---
+from confluence_ai.providers import create_describer, register_describer
+
+# --- Convenience functions ---
+from confluence_ai.export import export_page
+from confluence_ai.publish import publish_page
+
+# --- Config & result models ---
+from confluence_ai.models import (
+    ExportResult,
+    ImageContext,
+    ImageDescriberConfig,
+    PageMetadata,
+)
+
+# --- Exceptions ---
+from confluence_ai.exceptions import (
+    AuthenticationError,
+    ConfluenceConnectionError,
+    DownloadError,
+    ExporterError,
+    FileSystemError,
+    ImageDescriptionError,
+    InvalidURLError,
+    PageNotFoundError,
+    ParseError,
+)
+
+# Importing this ensures the built-in JSON renderer registers itself.
+from confluence_ai import json_renderer  # noqa: F401
+
+__all__ = [
+    # Version
+    "__version__",
+    # Core classes
+    "ConfluenceClient",
+    "StorageFormatParser",
+    "MarkdownRenderer",
+    "AssetDownloader",
+    "ImageDescriber",
+    "URLParser",
+    "OutputRenderer",
+    # Factory & registry
+    "create_describer",
+    "register_describer",
+    "register_renderer",
+    # Convenience functions
+    "export_page",
+    "publish_page",
+    # Models
+    "ImageDescriberConfig",
+    "ImageContext",
+    "PageMetadata",
+    "ExportResult",
+    # Exceptions
+    "ExporterError",
+    "InvalidURLError",
+    "AuthenticationError",
+    "ConfluenceConnectionError",
+    "PageNotFoundError",
+    "ParseError",
+    "DownloadError",
+    "ImageDescriptionError",
+    "FileSystemError",
+]