A package format for document outlines and resources. Docpack files (.docpack) are zip archives containing an outline JSON file and associated resource files.
pip install -e .# Create a docpack from an outline
docpack_file create --outline outline.json --output document.docpack
# Extract a docpack
docpack_file extract document.docpack --dir extracted/
# Validate a docpack
docpack_file validate document.docpack
# List docpack contents
docpack_file list document.docpackfrom docpack import DocpackHandler
from pathlib import Path
# Create a docpack
outline_data = {"title": "My Document", "sections": [...]}
resource_files = [Path("file1.txt"), Path("file2.md")]
DocpackHandler.create_package(outline_data, resource_files, Path("output.docpack"))
# Extract a docpack
outline_data, resource_files = DocpackHandler.extract_package(
Path("document.docpack"),
Path("extract_dir")
)The outline JSON should follow the document generator format with:
title: Document titlegeneral_instruction: Overall instructions for document generationresources: Array of resource objects withkey,path,title, anddescriptionsections: Array of section objects withtitle,prompt,sections(for nesting), andrefs