Release and Version History¶
x.y.z (Backlog)¶
Features and Improvements
Minor Improvements
Bugfixes
Miscellaneous
0.1.3 (2025-01-22)¶
Minor Improvements
get_pages_by_ids()now preserves the order of results to match the order of provided page IDs.
0.1.2 (2025-01-22)¶
Bugfixes
Fixed a bug in
get_pages_by_ids()where not all pages were returned due to missinglimitparameter in batch queries.
0.1.1 (2025-01-09)¶
Features and Improvements
Initial release of
docpack_confluence- a library for batch exporting Confluence pages to AI-ready formats.
Core Components
Page Model (
Page): Data model representing Confluence pages with lineage tracking, sort keys, and hierarchy properties.Entity Model (
Entity): Lightweight entity representation for efficient page/folder traversal in Confluence space hierarchies.Space Crawler (
crawl_descendants()): Crawls Confluence space hierarchies with parent clustering algorithm to handle API depth limitations.Selector System (
Selector): Gitignore-style pattern matching for precise page selection usinginclude/excludepatterns.Export Pipeline (
export_pages_to_xml_files()): Exports pages to XML-wrapped Markdown files with metadata and source URLs.All-in-One Export (
merge_files()): Merges exported files into a single knowledge base file for AI platforms.
High-Level API
SpaceExportConfig: Configuration class for single space exports with include/exclude patterns.ExportSpec: Orchestrates multi-space exports with unified output directory.
Caching Support
Built-in caching via
diskcachefor efficient repeated exports.Cache-enabled variants:
get_pages_in_space_with_cache(),get_descendants_of_page_with_cache(),crawl_descendants_with_cache().Serialization utilities:
serialize_many(),deserialize_many()for page data persistence.
Utility Functions
get_space_by_id(),get_space_by_key(): Space retrieval helpers.get_pages_by_ids(),get_pages_in_space(): Page fetching utilities.get_descendants_of_page(),get_descendants_of_folder(): Hierarchy traversal.create_pages_and_folders(): Create page/folder structures with retry logic.delete_pages_and_folders_in_space(): Clean up test data in correct dependency order.safe_write(): Safe file writing utility.
Pattern Matching
- Support for gitignore-style patterns with match modes:
/**- Include page and all descendants/*- Include descendants only (not the page itself)No suffix - Include only the specific page
parse_pattern(): Parse pattern strings into match rules.is_match(): Check if an entity matches a pattern.MatchMode: Enum defining match modes (EXACT, CHILDREN, DESCENDANTS).