Why Use This Library?

• Precise Selection: Use gitignore-style include/exclude patterns to export exactly the pages you need

• AI-Ready Output: Generates XML-wrapped Markdown with source URLs and metadata

• All-in-One Export: Merge all pages into a single file for easy drag-and-drop to AI platforms

• Multi-Space Support: Export from multiple Confluence spaces (even different sites) in one operation

• Deep Hierarchy Support: Handles Confluence’s API depth limitations automatically

Quick Example

from pathlib import Path
from sanhe_confluence_sdk import Confluence
from docpack_confluence.api import SpaceExportConfig, ExportSpec

# Setup client
client = Confluence(
    url="https://your-domain.atlassian.net",
    username="your-email@example.com",
    password="your-api-token",  # From https://id.atlassian.com/manage-profile/security/api-tokens
)

# Export with include/exclude patterns
spec = ExportSpec(
    space_configs=[
        SpaceExportConfig(
            client=client,
            space_key="DOCS",
            include=[
                "https://your-domain.atlassian.net/wiki/spaces/DOCS/pages/123/User-Guide/**",
            ],
            exclude=[
                "https://your-domain.atlassian.net/wiki/spaces/DOCS/pages/456/Internal/**",
            ],
        ),
    ],
    dir_out=Path("./export"),
)
spec.export()

# Output:
# ./export/
#   space_key_DOCS/
#     User Guide ~ Getting Started.xml
#     User Guide ~ Configuration.xml
#     ...
#   all_in_one_knowledge_base.txt  <- Ready for AI platforms!

Pattern Syntax:

• /** - Include page and all descendants

• /* - Include descendants only (not the page itself)

• No suffix - Include only the specific page

Install

$ pip install docpack-confluence

For full documentation, visit docpack-confluence.readthedocs.io.