refactor: reorganize examples directory with topic-based subdirectories
Reorganize examples directory into logical topic-based subdirectories with comprehensive documentation: - templates/: ISO/ARC42 documentation templates - asset-management/: Asset management prototypes and demos - essays/: Long-form content examples - invoicing/: Invoice generation examples - plugins/: Plugin development examples - issue-demos/: Issue prevention demonstrations - design-patterns/: Design pattern examples Each subdirectory includes a README.txt file with topic description and contributor signatures based on file creation timestamps. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
14
examples/asset-management/README.txt
Normal file
14
examples/asset-management/README.txt
Normal file
@@ -0,0 +1,14 @@
|
||||
Asset Management Examples
|
||||
|
||||
This directory contains prototype implementations and demonstrations for asset management
|
||||
concepts developed for Issue #141:
|
||||
|
||||
- asset_management_concept_a.py: Hash-based content-addressable storage approach
|
||||
- asset_management_concept_b.py: Alternative asset management implementation
|
||||
- demo_hash_store/: Working demonstration of hash-based asset storage with metadata
|
||||
- demo_workspace/: Example workspace showing asset management in practice
|
||||
|
||||
These examples showcase different approaches to asset deduplication, storage, and
|
||||
management within the MarkiTect ecosystem.
|
||||
|
||||
--worsch, 25-10-08
|
||||
346
examples/asset-management/asset_management_concept_a.py
Normal file
346
examples/asset-management/asset_management_concept_a.py
Normal file
@@ -0,0 +1,346 @@
|
||||
#!/usr/bin/env python3
|
||||
"""
|
||||
Implementation example for Issue #141 - Concept A: Hash-Based Asset Store
|
||||
|
||||
This is a working prototype demonstrating the hash-based content-addressable
|
||||
storage approach for asset management with deduplication.
|
||||
"""
|
||||
|
||||
import hashlib
|
||||
import sqlite3
|
||||
import json
|
||||
from datetime import datetime
|
||||
from pathlib import Path
|
||||
from typing import Dict, List, Optional, Tuple
|
||||
|
||||
|
||||
class HashBasedAssetStore:
|
||||
"""Content-addressable storage system using SHA-256 hashes."""
|
||||
|
||||
def __init__(self, store_path: Path):
|
||||
self.store_path = store_path
|
||||
self.store_path.mkdir(parents=True, exist_ok=True)
|
||||
|
||||
# Initialize database
|
||||
self.db_path = store_path / "metadata.db"
|
||||
self._init_database()
|
||||
|
||||
def _init_database(self):
|
||||
"""Initialize SQLite database with asset tables."""
|
||||
with sqlite3.connect(self.db_path) as conn:
|
||||
conn.executescript("""
|
||||
CREATE TABLE IF NOT EXISTS assets (
|
||||
content_hash TEXT PRIMARY KEY,
|
||||
file_size INTEGER NOT NULL,
|
||||
mime_type TEXT,
|
||||
original_extension TEXT,
|
||||
created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP
|
||||
);
|
||||
|
||||
CREATE TABLE IF NOT EXISTS asset_names (
|
||||
id INTEGER PRIMARY KEY AUTOINCREMENT,
|
||||
content_hash TEXT NOT NULL,
|
||||
virtual_name TEXT NOT NULL,
|
||||
document_id TEXT NOT NULL,
|
||||
created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
|
||||
FOREIGN KEY (content_hash) REFERENCES assets(content_hash)
|
||||
);
|
||||
|
||||
CREATE INDEX IF NOT EXISTS idx_asset_names_virtual
|
||||
ON asset_names(virtual_name);
|
||||
|
||||
CREATE INDEX IF NOT EXISTS idx_asset_names_document
|
||||
ON asset_names(document_id);
|
||||
""")
|
||||
|
||||
def store_asset(self, file_path: Path, document_id: str = None) -> str:
|
||||
"""Store asset and return content hash."""
|
||||
if not file_path.exists():
|
||||
raise FileNotFoundError(f"Asset file not found: {file_path}")
|
||||
|
||||
content = file_path.read_bytes()
|
||||
content_hash = hashlib.sha256(content).hexdigest()
|
||||
|
||||
# Create hash-based directory structure
|
||||
hash_dir = self.store_path / "store" / "sha256" / content_hash[:6]
|
||||
hash_dir.mkdir(parents=True, exist_ok=True)
|
||||
|
||||
file_ext = file_path.suffix
|
||||
stored_path = hash_dir / f"{content_hash}{file_ext}"
|
||||
|
||||
# Store file if it doesn't exist
|
||||
if not stored_path.exists():
|
||||
stored_path.write_bytes(content)
|
||||
|
||||
# Add to database
|
||||
with sqlite3.connect(self.db_path) as conn:
|
||||
conn.execute("""
|
||||
INSERT OR REPLACE INTO assets
|
||||
(content_hash, file_size, mime_type, original_extension)
|
||||
VALUES (?, ?, ?, ?)
|
||||
""", (content_hash, len(content), self._guess_mime_type(file_ext), file_ext))
|
||||
|
||||
print(f"✓ Stored new asset: {content_hash[:12]}...{file_ext}")
|
||||
else:
|
||||
print(f"✓ Deduplication: Asset already exists {content_hash[:12]}...{file_ext}")
|
||||
|
||||
return content_hash
|
||||
|
||||
def register_name(self, content_hash: str, virtual_name: str, document_id: str):
|
||||
"""Register a virtual name for an asset."""
|
||||
with sqlite3.connect(self.db_path) as conn:
|
||||
conn.execute("""
|
||||
INSERT INTO asset_names (content_hash, virtual_name, document_id)
|
||||
VALUES (?, ?, ?)
|
||||
""", (content_hash, virtual_name, document_id))
|
||||
|
||||
print(f"✓ Registered name: {virtual_name} -> {content_hash[:12]}...")
|
||||
|
||||
def get_asset_path(self, content_hash: str) -> Optional[Path]:
|
||||
"""Get filesystem path for asset by hash."""
|
||||
with sqlite3.connect(self.db_path) as conn:
|
||||
cursor = conn.execute("""
|
||||
SELECT original_extension FROM assets WHERE content_hash = ?
|
||||
""", (content_hash,))
|
||||
result = cursor.fetchone()
|
||||
|
||||
if result:
|
||||
extension = result[0]
|
||||
hash_dir = self.store_path / "store" / "sha256" / content_hash[:6]
|
||||
asset_path = hash_dir / f"{content_hash}{extension}"
|
||||
return asset_path if asset_path.exists() else None
|
||||
|
||||
return None
|
||||
|
||||
def resolve_name(self, virtual_name: str, document_id: str) -> Optional[str]:
|
||||
"""Resolve virtual name to content hash."""
|
||||
with sqlite3.connect(self.db_path) as conn:
|
||||
cursor = conn.execute("""
|
||||
SELECT content_hash FROM asset_names
|
||||
WHERE virtual_name = ? AND document_id = ?
|
||||
""", (virtual_name, document_id))
|
||||
result = cursor.fetchone()
|
||||
|
||||
return result[0] if result else None
|
||||
|
||||
def list_assets(self) -> List[Dict]:
|
||||
"""List all stored assets with metadata."""
|
||||
with sqlite3.connect(self.db_path) as conn:
|
||||
cursor = conn.execute("""
|
||||
SELECT a.content_hash, a.file_size, a.mime_type, a.original_extension,
|
||||
a.created_at, COUNT(an.id) as name_count
|
||||
FROM assets a
|
||||
LEFT JOIN asset_names an ON a.content_hash = an.content_hash
|
||||
GROUP BY a.content_hash
|
||||
""")
|
||||
|
||||
assets = []
|
||||
for row in cursor:
|
||||
assets.append({
|
||||
"hash": row[0],
|
||||
"size": row[1],
|
||||
"mime_type": row[2],
|
||||
"extension": row[3],
|
||||
"created": row[4],
|
||||
"reference_count": row[5]
|
||||
})
|
||||
|
||||
return assets
|
||||
|
||||
def get_document_assets(self, document_id: str) -> List[Dict]:
|
||||
"""Get all assets used by a specific document."""
|
||||
with sqlite3.connect(self.db_path) as conn:
|
||||
cursor = conn.execute("""
|
||||
SELECT an.virtual_name, an.content_hash, a.file_size, a.mime_type
|
||||
FROM asset_names an
|
||||
JOIN assets a ON an.content_hash = a.content_hash
|
||||
WHERE an.document_id = ?
|
||||
ORDER BY an.virtual_name
|
||||
""", (document_id,))
|
||||
|
||||
document_assets = []
|
||||
for row in cursor:
|
||||
document_assets.append({
|
||||
"virtual_name": row[0],
|
||||
"content_hash": row[1],
|
||||
"size": row[2],
|
||||
"mime_type": row[3]
|
||||
})
|
||||
|
||||
return document_assets
|
||||
|
||||
def _guess_mime_type(self, extension: str) -> str:
|
||||
"""Simple MIME type guessing based on extension."""
|
||||
mime_map = {
|
||||
".png": "image/png",
|
||||
".jpg": "image/jpeg",
|
||||
".jpeg": "image/jpeg",
|
||||
".gif": "image/gif",
|
||||
".svg": "image/svg+xml",
|
||||
".pdf": "application/pdf",
|
||||
".txt": "text/plain",
|
||||
".md": "text/markdown"
|
||||
}
|
||||
return mime_map.get(extension.lower(), "application/octet-stream")
|
||||
|
||||
|
||||
class MarkdownAssetProcessor:
|
||||
"""Process markdown content with hash-based asset references."""
|
||||
|
||||
def __init__(self, asset_store: HashBasedAssetStore):
|
||||
self.asset_store = asset_store
|
||||
|
||||
def import_document_assets(self, md_file: Path, assets_dir: Path, document_id: str) -> str:
|
||||
"""Import all assets for a document and update markdown references."""
|
||||
if not md_file.exists():
|
||||
raise FileNotFoundError(f"Markdown file not found: {md_file}")
|
||||
|
||||
md_content = md_file.read_text()
|
||||
|
||||
# Find all image references
|
||||
import re
|
||||
image_pattern = r'!\[([^\]]*)\]\(([^)]+)\)'
|
||||
|
||||
def replace_image_ref(match):
|
||||
alt_text = match.group(1)
|
||||
image_path = match.group(2)
|
||||
|
||||
# Look for image in assets directory
|
||||
full_image_path = assets_dir / image_path
|
||||
if full_image_path.exists():
|
||||
# Store asset and get hash
|
||||
content_hash = self.asset_store.store_asset(full_image_path, document_id)
|
||||
|
||||
# Register virtual name
|
||||
self.asset_store.register_name(content_hash, image_path, document_id)
|
||||
|
||||
# Return hash-based reference
|
||||
return f''
|
||||
else:
|
||||
print(f"⚠ Asset not found: {image_path}")
|
||||
return match.group(0) # Return original if not found
|
||||
|
||||
# Process and replace image references
|
||||
processed_md = re.sub(image_pattern, replace_image_ref, md_content)
|
||||
return processed_md
|
||||
|
||||
def export_document_assets(self, md_content: str, document_id: str, output_dir: Path) -> str:
|
||||
"""Export document with resolved asset references."""
|
||||
import re
|
||||
|
||||
def resolve_asset_ref(match):
|
||||
alt_text = match.group(1)
|
||||
asset_ref = match.group(2)
|
||||
|
||||
if asset_ref.startswith('asset://'):
|
||||
content_hash = asset_ref[8:] # Remove 'asset://' prefix
|
||||
|
||||
# Get original virtual name
|
||||
with sqlite3.connect(self.asset_store.db_path) as conn:
|
||||
cursor = conn.execute("""
|
||||
SELECT virtual_name FROM asset_names
|
||||
WHERE content_hash = ? AND document_id = ?
|
||||
""", (content_hash, document_id))
|
||||
result = cursor.fetchone()
|
||||
|
||||
if result:
|
||||
virtual_name = result[0]
|
||||
|
||||
# Copy asset to output directory
|
||||
asset_path = self.asset_store.get_asset_path(content_hash)
|
||||
if asset_path:
|
||||
output_assets_dir = output_dir / "assets"
|
||||
output_assets_dir.mkdir(exist_ok=True)
|
||||
|
||||
output_asset_path = output_assets_dir / virtual_name
|
||||
if not output_asset_path.exists():
|
||||
import shutil
|
||||
shutil.copy2(asset_path, output_asset_path)
|
||||
|
||||
return f''
|
||||
|
||||
return match.group(0) # Return original if can't resolve
|
||||
|
||||
# Process asset references
|
||||
resolved_md = re.sub(r'!\[([^\]]*)\]\(([^)]+)\)', resolve_asset_ref, md_content)
|
||||
return resolved_md
|
||||
|
||||
|
||||
def demo_hash_based_assets():
|
||||
"""Demonstrate the hash-based asset management system."""
|
||||
print("🎯 Asset Management Demo - Concept A (Hash-Based)")
|
||||
print("=" * 55)
|
||||
|
||||
# Setup
|
||||
demo_store = Path("./demo_hash_store")
|
||||
if demo_store.exists():
|
||||
import shutil
|
||||
shutil.rmtree(demo_store)
|
||||
|
||||
asset_store = HashBasedAssetStore(demo_store)
|
||||
processor = MarkdownAssetProcessor(asset_store)
|
||||
|
||||
# Create demo assets
|
||||
demo_assets = demo_store / "demo_inputs"
|
||||
demo_assets.mkdir(parents=True)
|
||||
|
||||
# Create test assets (same as Concept B demo for comparison)
|
||||
(demo_assets / "logo.png").write_text("PNG_IMAGE_CONTENT_LOGO")
|
||||
(demo_assets / "company_logo.png").write_text("PNG_IMAGE_CONTENT_LOGO") # Duplicate content
|
||||
(demo_assets / "diagram.png").write_text("PNG_IMAGE_CONTENT_DIAGRAM")
|
||||
|
||||
print(f"Created test assets: 3 files")
|
||||
|
||||
# Store assets individually to show deduplication
|
||||
print(f"\n📁 Storing assets...")
|
||||
hash1 = asset_store.store_asset(demo_assets / "logo.png", "doc1")
|
||||
hash2 = asset_store.store_asset(demo_assets / "company_logo.png", "doc2")
|
||||
hash3 = asset_store.store_asset(demo_assets / "diagram.png", "doc1")
|
||||
|
||||
# Register virtual names
|
||||
asset_store.register_name(hash1, "logo.png", "doc1")
|
||||
asset_store.register_name(hash2, "company_logo.png", "doc2") # Same content, different name
|
||||
asset_store.register_name(hash3, "diagram.png", "doc1")
|
||||
asset_store.register_name(hash3, "system_diagram.png", "doc2") # Same content, different name
|
||||
|
||||
# Show results
|
||||
print(f"\n📊 Storage Results:")
|
||||
print(f" - Files processed: 3")
|
||||
print(f" - Unique content hashes:")
|
||||
print(f" • logo.png: {hash1[:12]}...")
|
||||
print(f" • company_logo.png: {hash2[:12]}... {'(same as logo.png)' if hash1 == hash2 else '(different)'}")
|
||||
print(f" • diagram.png: {hash3[:12]}...")
|
||||
|
||||
# List all assets
|
||||
print(f"\n📋 Asset Library:")
|
||||
assets = asset_store.list_assets()
|
||||
for asset in assets:
|
||||
print(f" • {asset['hash'][:12]}...{asset['extension']} "
|
||||
f"({asset['size']} bytes, {asset['reference_count']} references)")
|
||||
|
||||
# Show document assets
|
||||
for doc_id in ["doc1", "doc2"]:
|
||||
print(f"\n📄 Document '{doc_id}' assets:")
|
||||
doc_assets = asset_store.get_document_assets(doc_id)
|
||||
for asset in doc_assets:
|
||||
print(f" • {asset['virtual_name']} -> {asset['content_hash'][:12]}... ({asset['size']} bytes)")
|
||||
|
||||
print(f"\n✅ Demo completed successfully!")
|
||||
print(f" - Asset store: {demo_store}")
|
||||
print(f" - Database: {asset_store.db_path}")
|
||||
print(f" - Storage efficiency: Perfect deduplication by content hash")
|
||||
|
||||
# Show directory structure
|
||||
print(f"\n📂 Storage directory structure:")
|
||||
import os
|
||||
for root, dirs, files in os.walk(demo_store):
|
||||
level = root.replace(str(demo_store), '').count(os.sep)
|
||||
indent = ' ' * 2 * level
|
||||
print(f"{indent}{os.path.basename(root)}/")
|
||||
subindent = ' ' * 2 * (level + 1)
|
||||
for file in files:
|
||||
print(f"{subindent}{file}")
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
demo_hash_based_assets()
|
||||
328
examples/asset-management/asset_management_concept_b.py
Normal file
328
examples/asset-management/asset_management_concept_b.py
Normal file
@@ -0,0 +1,328 @@
|
||||
#!/usr/bin/env python3
|
||||
"""
|
||||
Implementation example for Issue #141 - Concept B: Package + Symlinks Asset Management
|
||||
|
||||
This is a working prototype demonstrating the core concepts for handling images
|
||||
and file includes with automatic deduplication.
|
||||
"""
|
||||
|
||||
import hashlib
|
||||
import json
|
||||
import zipfile
|
||||
import shutil
|
||||
import os
|
||||
from datetime import datetime
|
||||
from pathlib import Path
|
||||
from typing import Dict, List, Optional, Tuple
|
||||
|
||||
|
||||
class AssetRegistry:
|
||||
"""Manages the shared asset registry for deduplication."""
|
||||
|
||||
def __init__(self, registry_path: Path):
|
||||
self.registry_path = registry_path
|
||||
self.registry_path.parent.mkdir(parents=True, exist_ok=True)
|
||||
self.registry = self._load_registry()
|
||||
|
||||
def _load_registry(self) -> Dict:
|
||||
"""Load existing registry or create empty one."""
|
||||
if self.registry_path.exists():
|
||||
try:
|
||||
return json.loads(self.registry_path.read_text())
|
||||
except (json.JSONDecodeError, IOError):
|
||||
return {"assets": {}, "version": "1.0"}
|
||||
return {"assets": {}, "version": "1.0"}
|
||||
|
||||
def _save_registry(self):
|
||||
"""Save registry to disk."""
|
||||
self.registry_path.write_text(json.dumps(self.registry, indent=2))
|
||||
|
||||
def get_content_hash(self, file_path: Path) -> str:
|
||||
"""Calculate SHA-256 hash of file content."""
|
||||
content = file_path.read_bytes()
|
||||
return hashlib.sha256(content).hexdigest()
|
||||
|
||||
def register_asset(self, file_path: Path, content_hash: str) -> Dict:
|
||||
"""Register a new asset in the registry."""
|
||||
file_size = file_path.stat().st_size
|
||||
mime_type = self._guess_mime_type(file_path.suffix)
|
||||
|
||||
asset_info = {
|
||||
"original_name": file_path.name,
|
||||
"size": file_size,
|
||||
"mime_type": mime_type,
|
||||
"extension": file_path.suffix,
|
||||
"created": datetime.now().isoformat(),
|
||||
"stored_path": f"images/{content_hash}{file_path.suffix}"
|
||||
}
|
||||
|
||||
self.registry["assets"][content_hash] = asset_info
|
||||
self._save_registry()
|
||||
return asset_info
|
||||
|
||||
def find_asset(self, content_hash: str) -> Optional[Dict]:
|
||||
"""Find asset by content hash."""
|
||||
return self.registry["assets"].get(content_hash)
|
||||
|
||||
def _guess_mime_type(self, extension: str) -> str:
|
||||
"""Simple MIME type guessing based on extension."""
|
||||
mime_map = {
|
||||
".png": "image/png",
|
||||
".jpg": "image/jpeg",
|
||||
".jpeg": "image/jpeg",
|
||||
".gif": "image/gif",
|
||||
".svg": "image/svg+xml",
|
||||
".pdf": "application/pdf",
|
||||
".txt": "text/plain",
|
||||
".md": "text/markdown"
|
||||
}
|
||||
return mime_map.get(extension.lower(), "application/octet-stream")
|
||||
|
||||
|
||||
class AssetDeduplicator:
|
||||
"""Handles asset storage and deduplication using symlinks."""
|
||||
|
||||
def __init__(self, workspace_path: Path):
|
||||
self.workspace = workspace_path
|
||||
self.shared_assets = workspace_path / "shared_assets"
|
||||
self.shared_images = self.shared_assets / "images"
|
||||
self.registry = AssetRegistry(self.shared_assets / "registry.json")
|
||||
|
||||
# Create directory structure
|
||||
self.shared_images.mkdir(parents=True, exist_ok=True)
|
||||
|
||||
def add_asset(self, source_path: Path, document_dir: Path, virtual_name: str) -> Tuple[str, Path]:
|
||||
"""
|
||||
Add asset with deduplication. Returns (content_hash, stored_path).
|
||||
"""
|
||||
if not source_path.exists():
|
||||
raise FileNotFoundError(f"Source asset not found: {source_path}")
|
||||
|
||||
# Calculate content hash
|
||||
content_hash = self.registry.get_content_hash(source_path)
|
||||
|
||||
# Check if we already have this content
|
||||
existing_asset = self.registry.find_asset(content_hash)
|
||||
|
||||
if existing_asset:
|
||||
print(f"✓ Deduplication: Found existing asset for {virtual_name}")
|
||||
stored_path = self.shared_assets / existing_asset["stored_path"]
|
||||
else:
|
||||
# Store new asset
|
||||
stored_path = self.shared_images / f"{content_hash}{source_path.suffix}"
|
||||
shutil.copy2(source_path, stored_path)
|
||||
self.registry.register_asset(source_path, content_hash)
|
||||
print(f"✓ Stored new asset: {virtual_name} -> {stored_path.name}")
|
||||
|
||||
# Create symlink in document assets directory
|
||||
self._create_asset_symlink(stored_path, document_dir, virtual_name)
|
||||
|
||||
return content_hash, stored_path
|
||||
|
||||
def _create_asset_symlink(self, stored_path: Path, document_dir: Path, virtual_name: str):
|
||||
"""Create symlink from document assets directory to shared storage."""
|
||||
assets_dir = document_dir / "assets"
|
||||
assets_dir.mkdir(parents=True, exist_ok=True)
|
||||
|
||||
link_path = assets_dir / virtual_name
|
||||
|
||||
# Remove existing link/file if present
|
||||
if link_path.exists() or link_path.is_symlink():
|
||||
link_path.unlink()
|
||||
|
||||
# Create relative symlink
|
||||
try:
|
||||
relative_target = os.path.relpath(stored_path, link_path.parent)
|
||||
link_path.symlink_to(relative_target)
|
||||
print(f"✓ Created symlink: {virtual_name} -> {relative_target}")
|
||||
except OSError as e:
|
||||
# Fallback to hard copy if symlinks fail (e.g., on Windows)
|
||||
shutil.copy2(stored_path, link_path)
|
||||
print(f"⚠ Symlink failed, copied file instead: {virtual_name} (reason: {e})")
|
||||
|
||||
|
||||
class MarkdownPackager:
|
||||
"""Handles creation and extraction of .mdpkg files."""
|
||||
|
||||
def __init__(self, workspace_path: Path):
|
||||
self.workspace = workspace_path
|
||||
self.packages_dir = workspace_path / "packages"
|
||||
self.packages_dir.mkdir(parents=True, exist_ok=True)
|
||||
|
||||
def create_package(self, document_dir: Path, package_name: str) -> Path:
|
||||
"""Create a .mdpkg ZIP package from a document directory."""
|
||||
package_path = self.packages_dir / f"{package_name}.mdpkg"
|
||||
|
||||
# Collect asset information
|
||||
assets_info = []
|
||||
assets_dir = document_dir / "assets"
|
||||
|
||||
if assets_dir.exists():
|
||||
for asset_path in assets_dir.iterdir():
|
||||
if asset_path.is_file() or asset_path.is_symlink():
|
||||
# Resolve symlink to get actual file info
|
||||
real_path = asset_path.resolve() if asset_path.is_symlink() else asset_path
|
||||
assets_info.append({
|
||||
"name": asset_path.name,
|
||||
"size": real_path.stat().st_size,
|
||||
"is_symlink": asset_path.is_symlink()
|
||||
})
|
||||
|
||||
# Create manifest
|
||||
manifest = {
|
||||
"name": package_name,
|
||||
"version": "1.0",
|
||||
"created": datetime.now().isoformat(),
|
||||
"format": "mdpkg",
|
||||
"assets": assets_info,
|
||||
"main_document": "index.md"
|
||||
}
|
||||
|
||||
# Create ZIP package
|
||||
with zipfile.ZipFile(package_path, 'w', zipfile.ZIP_DEFLATED) as zf:
|
||||
# Add manifest
|
||||
zf.writestr("manifest.json", json.dumps(manifest, indent=2))
|
||||
|
||||
# Add main document
|
||||
main_doc = document_dir / "index.md"
|
||||
if main_doc.exists():
|
||||
zf.write(main_doc, "index.md")
|
||||
|
||||
# Add assets (resolve symlinks)
|
||||
if assets_dir.exists():
|
||||
for asset_path in assets_dir.iterdir():
|
||||
if asset_path.is_file() or asset_path.is_symlink():
|
||||
real_path = asset_path.resolve() if asset_path.is_symlink() else asset_path
|
||||
zf.write(real_path, f"assets/{asset_path.name}")
|
||||
|
||||
print(f"✓ Created package: {package_path}")
|
||||
print(f" - Main document: {'✓' if main_doc.exists() else '✗'}")
|
||||
print(f" - Assets: {len(assets_info)}")
|
||||
|
||||
return package_path
|
||||
|
||||
def extract_package(self, package_path: Path, extract_name: str) -> Path:
|
||||
"""Extract a .mdpkg package to the workspace."""
|
||||
if not package_path.exists():
|
||||
raise FileNotFoundError(f"Package not found: {package_path}")
|
||||
|
||||
extract_dir = self.workspace / "documents" / extract_name
|
||||
extract_dir.mkdir(parents=True, exist_ok=True)
|
||||
|
||||
with zipfile.ZipFile(package_path, 'r') as zf:
|
||||
# Read manifest
|
||||
try:
|
||||
manifest_content = zf.read("manifest.json")
|
||||
manifest = json.loads(manifest_content)
|
||||
except (KeyError, json.JSONDecodeError):
|
||||
manifest = {"assets": []}
|
||||
|
||||
# Extract main document
|
||||
if "index.md" in zf.namelist():
|
||||
zf.extract("index.md", extract_dir)
|
||||
|
||||
# Extract assets
|
||||
assets_dir = extract_dir / "assets"
|
||||
for file_info in zf.infolist():
|
||||
if file_info.filename.startswith("assets/"):
|
||||
zf.extract(file_info.filename, extract_dir)
|
||||
|
||||
print(f"✓ Extracted package to: {extract_dir}")
|
||||
return extract_dir
|
||||
|
||||
|
||||
def demo_asset_management():
|
||||
"""Demonstrate the asset management system."""
|
||||
print("🎯 Asset Management Demo - Concept B")
|
||||
print("=" * 50)
|
||||
|
||||
# Setup workspace
|
||||
demo_workspace = Path("./demo_workspace")
|
||||
if demo_workspace.exists():
|
||||
shutil.rmtree(demo_workspace)
|
||||
|
||||
deduplicator = AssetDeduplicator(demo_workspace)
|
||||
packager = MarkdownPackager(demo_workspace)
|
||||
|
||||
# Create demo assets (simulate duplicate images)
|
||||
demo_assets = demo_workspace / "demo_assets"
|
||||
demo_assets.mkdir(parents=True, exist_ok=True)
|
||||
|
||||
# Create some test "images" (text files for demo)
|
||||
test_image1 = demo_assets / "logo.png"
|
||||
test_image2 = demo_assets / "company_logo.png"
|
||||
test_image3 = demo_assets / "diagram.png"
|
||||
|
||||
test_image1.write_text("PNG_IMAGE_CONTENT_LOGO") # Same content
|
||||
test_image2.write_text("PNG_IMAGE_CONTENT_LOGO") # Same content, different name
|
||||
test_image3.write_text("PNG_IMAGE_CONTENT_DIAGRAM") # Different content
|
||||
|
||||
print(f"Created test assets: {len(list(demo_assets.iterdir()))} files")
|
||||
|
||||
# Create two document projects
|
||||
doc1_dir = demo_workspace / "documents" / "project_a"
|
||||
doc2_dir = demo_workspace / "documents" / "project_b"
|
||||
|
||||
for doc_dir in [doc1_dir, doc2_dir]:
|
||||
doc_dir.mkdir(parents=True, exist_ok=True)
|
||||
|
||||
# Project A uses logo.png and diagram.png
|
||||
(doc1_dir / "index.md").write_text("""# Project A
|
||||
|
||||
|
||||
|
||||
|
||||
This is Project A documentation.
|
||||
""")
|
||||
|
||||
print("\n📁 Processing Project A assets...")
|
||||
deduplicator.add_asset(test_image1, doc1_dir, "logo.png")
|
||||
deduplicator.add_asset(test_image3, doc1_dir, "diagram.png")
|
||||
|
||||
# Project B uses the same logo (different filename) and same diagram
|
||||
(doc2_dir / "index.md").write_text("""# Project B
|
||||
|
||||
|
||||
|
||||
|
||||
This is Project B documentation.
|
||||
""")
|
||||
|
||||
print("\n📁 Processing Project B assets...")
|
||||
deduplicator.add_asset(test_image2, doc2_dir, "company_logo.png") # Same content as logo.png
|
||||
deduplicator.add_asset(test_image3, doc2_dir, "system_diagram.png") # Same content as diagram.png
|
||||
|
||||
# Show deduplication results
|
||||
print(f"\n📊 Deduplication Results:")
|
||||
print(f" - Original files: 3")
|
||||
print(f" - Unique content hashes: {len(deduplicator.registry.registry['assets'])}")
|
||||
print(f" - Storage efficiency: {3 - len(deduplicator.registry.registry['assets'])} duplicates eliminated")
|
||||
|
||||
# Create packages
|
||||
print(f"\n📦 Creating packages...")
|
||||
pkg_a = packager.create_package(doc1_dir, "project_a")
|
||||
pkg_b = packager.create_package(doc2_dir, "project_b")
|
||||
|
||||
print(f"\n✅ Demo completed successfully!")
|
||||
print(f" - Workspace: {demo_workspace}")
|
||||
print(f" - Shared assets: {deduplicator.shared_assets}")
|
||||
print(f" - Packages: {packager.packages_dir}")
|
||||
|
||||
# Show final directory structure
|
||||
print(f"\n📂 Final directory structure:")
|
||||
for root, dirs, files in os.walk(demo_workspace):
|
||||
level = root.replace(str(demo_workspace), '').count(os.sep)
|
||||
indent = ' ' * 2 * level
|
||||
print(f"{indent}{os.path.basename(root)}/")
|
||||
subindent = ' ' * 2 * (level + 1)
|
||||
for file in files:
|
||||
file_path = Path(root) / file
|
||||
if file_path.is_symlink():
|
||||
target = os.readlink(file_path)
|
||||
print(f"{subindent}{file} -> {target}")
|
||||
else:
|
||||
print(f"{subindent}{file}")
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
demo_asset_management()
|
||||
@@ -0,0 +1 @@
|
||||
PNG_IMAGE_CONTENT_LOGO
|
||||
@@ -0,0 +1 @@
|
||||
PNG_IMAGE_CONTENT_DIAGRAM
|
||||
@@ -0,0 +1 @@
|
||||
PNG_IMAGE_CONTENT_LOGO
|
||||
BIN
examples/asset-management/demo_hash_store/metadata.db
Normal file
BIN
examples/asset-management/demo_hash_store/metadata.db
Normal file
Binary file not shown.
@@ -0,0 +1 @@
|
||||
PNG_IMAGE_CONTENT_LOGO
|
||||
@@ -0,0 +1 @@
|
||||
PNG_IMAGE_CONTENT_DIAGRAM
|
||||
@@ -0,0 +1 @@
|
||||
PNG_IMAGE_CONTENT_LOGO
|
||||
@@ -0,0 +1 @@
|
||||
PNG_IMAGE_CONTENT_DIAGRAM
|
||||
@@ -0,0 +1 @@
|
||||
PNG_IMAGE_CONTENT_LOGO
|
||||
@@ -0,0 +1 @@
|
||||
../../../shared_assets/images/54f88ec7aa8570d4ad655943d36f5db47021501baeac8ceeb3b726157de6ebf5.png
|
||||
@@ -0,0 +1 @@
|
||||
../../../shared_assets/images/25965aaacc4f361784870ed2624f0178ea7c3cf33961ffb73ef13bafed7cd28c.png
|
||||
@@ -0,0 +1,6 @@
|
||||
# Project A
|
||||
|
||||
|
||||
|
||||
|
||||
This is Project A documentation.
|
||||
@@ -0,0 +1 @@
|
||||
../../../shared_assets/images/25965aaacc4f361784870ed2624f0178ea7c3cf33961ffb73ef13bafed7cd28c.png
|
||||
@@ -0,0 +1 @@
|
||||
../../../shared_assets/images/54f88ec7aa8570d4ad655943d36f5db47021501baeac8ceeb3b726157de6ebf5.png
|
||||
@@ -0,0 +1,6 @@
|
||||
# Project B
|
||||
|
||||
|
||||
|
||||
|
||||
This is Project B documentation.
|
||||
Binary file not shown.
Binary file not shown.
@@ -0,0 +1 @@
|
||||
PNG_IMAGE_CONTENT_LOGO
|
||||
@@ -0,0 +1 @@
|
||||
PNG_IMAGE_CONTENT_DIAGRAM
|
||||
@@ -0,0 +1,21 @@
|
||||
{
|
||||
"assets": {
|
||||
"25965aaacc4f361784870ed2624f0178ea7c3cf33961ffb73ef13bafed7cd28c": {
|
||||
"original_name": "logo.png",
|
||||
"size": 22,
|
||||
"mime_type": "image/png",
|
||||
"extension": ".png",
|
||||
"created": "2025-10-08T01:50:01.099764",
|
||||
"stored_path": "images/25965aaacc4f361784870ed2624f0178ea7c3cf33961ffb73ef13bafed7cd28c.png"
|
||||
},
|
||||
"54f88ec7aa8570d4ad655943d36f5db47021501baeac8ceeb3b726157de6ebf5": {
|
||||
"original_name": "diagram.png",
|
||||
"size": 25,
|
||||
"mime_type": "image/png",
|
||||
"extension": ".png",
|
||||
"created": "2025-10-08T01:50:01.104199",
|
||||
"stored_path": "images/54f88ec7aa8570d4ad655943d36f5db47021501baeac8ceeb3b726157de6ebf5.png"
|
||||
}
|
||||
},
|
||||
"version": "1.0"
|
||||
}
|
||||
Reference in New Issue
Block a user