andf 1.0.0__tar.gz

andf-1.0.0/PKG-INFO

@@ -0,0 +1,238 @@
+Metadata-Version: 2.4
+Name: andf
+Version: 1.0.0
+Summary: AI Native Document Format — self-contained HTML documents with embedded JSON, opening like a PDF in any browser
+Author: ANDF Authors
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/andf-format/andf
+Project-URL: Documentation, https://github.com/andf-format/andf#readme
+Project-URL: Issues, https://github.com/andf-format/andf/issues
+Keywords: document,format,ai,pdf,viewer,html
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Text Processing :: Markup :: HTML
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Intended Audience :: Developers
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: build; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Dynamic: author
+Dynamic: requires-python
+
+# ANDF — AI Native Document Format
+
+**ANDF** (`.andf`) is a document format built for AI-native workflows. Every `.andf` file is a self-contained HTML file that:
+
+- **Opens in any browser instantly** — looks and feels like a PDF (toolbar, dark background, white pages, page numbers)
+- **Is trivially parseable by AI** — structured JSON is embedded in a `<script type="application/andf+json">` tag
+- **Requires no install, no server, no extension**
+
+---
+
+## Quick Start
+
+```python
+from andf import ANDFDocument
+
+doc = ANDFDocument()
+doc.set_metadata(title="My Report", authors=["Alice"])
+
+sec = doc.add_section("intro", "Introduction")
+sec.heading("Welcome", level=2)
+sec.paragraph("Hello from **ANDF**! This is *important*.")
+sec.callout("Remember to save your work!", variant="tip", title="Tip")
+sec.table(
+    headers=["Name", "Score"],
+    rows=[["Alice", "95"], ["Bob", "87"]],
+    caption="Table 1: Results",
+)
+sec.code("print('hello world')", language="python")
+
+doc.save("report.andf")
+doc.open_in_browser("report.andf")  # opens in browser
+```
+
+---
+
+## Installation
+
+```bash
+pip install .
+```
+
+Or install in development mode:
+
+```bash
+pip install -e .
+```
+
+---
+
+## CLI
+
+```bash
+# Create a blank document
+andf new output.andf
+
+# Open in browser
+andf open output.andf
+
+# Extract embedded JSON
+andf parse output.andf --pretty
+
+# Validate format
+andf validate output.andf
+
+# Show metadata
+andf info output.andf
+
+# AI layer summary
+andf ai output.andf
+```
+
+---
+
+## File Format
+
+An `.andf` file is an HTML file. The complete document data is embedded as JSON:
+
+```html
+<script type="application/andf+json">
+{
+  "andf_version": "1.0",
+  "document_id": "...",
+  "metadata": { "title": "...", "authors": [...] },
+  "sections": [...],
+  "blocks": { "blk_xxx": { "type": "paragraph", "text": "..." } },
+  ...
+}
+</script>
+```
+
+AI tools extract it with a single regex:
+
+```python
+import re, json
+
+pattern = re.compile(
+    r'<script[^>]+type=["\']application/andf\+json["\'][^>]*>(.*?)</script>',
+    re.DOTALL
+)
+data = json.loads(pattern.search(open("file.andf").read()).group(1))
+```
+
+---
+
+## Block Types
+
+| Type | Description |
+|------|-------------|
+| `heading` | Section heading (levels 1–6) |
+| `paragraph` | Body text with `**bold**`, `*italic*`, `` `code` ``, `[ref]` markup |
+| `image` | Embedded image from assets |
+| `table` | Data table with headers and rows |
+| `list` | Ordered or unordered list with nesting |
+| `code` | Syntax-highlighted code block |
+| `quote` | Block quote with optional attribution |
+| `callout` | Highlighted box: info / warning / error / success / tip |
+| `separator` | Horizontal rule |
+| `pagebreak` | Explicit page break |
+
+---
+
+## Themes
+
+```python
+doc.set_theme("default")    # Inter sans-serif, clean
+doc.set_theme("academic")   # Georgia serif, formal
+doc.set_theme("corporate")  # Arial, business blue headings
+doc.set_theme("minimal")    # System UI, minimal color
+```
+
+---
+
+## AI Layer
+
+```python
+from andf import ANDFDocument, ANDFAILayer
+
+doc = ANDFDocument.from_file("report.andf")
+layer = ANDFAILayer(doc)
+
+# Plain text
+text = layer.full_text()
+
+# Markdown (best for LLM input)
+md = layer.to_markdown()
+
+# RAG chunks
+chunks = layer.context_chunks(max_chars=4000)
+
+# Document summary
+summary = layer.document_summary()
+print(summary["key_points"])
+
+# High-importance blocks
+important = layer.blocks_by_importance(min_importance=4)
+```
+
+---
+
+## Project Structure
+
+```
+andf/
+├── __init__.py     # Public API
+├── document.py     # ANDFDocument model + fluent builder
+├── renderer.py     # HTML renderer
+├── parser.py       # Parser + validator
+├── ai_layer.py     # AI extraction layer
+└── cli.py          # Command-line interface
+
+spec/
+└── ANDF-1.0.md     # Format specification
+
+examples/
+├── create_examples.py
+├── research_paper.andf
+├── business_report.andf
+├── legal_contract.andf
+└── technical_manual.andf
+
+tests/
+└── test_andf.py
+```
+
+---
+
+## Generate Examples
+
+```bash
+python examples/create_examples.py
+```
+
+Opens each `.andf` file in your browser to see the viewer.
+
+---
+
+## Run Tests
+
+```bash
+python -m pytest tests/ -v
+```
+
+---
+
+## Specification
+
+See [`spec/ANDF-1.0.md`](spec/ANDF-1.0.md) for the complete format specification.
+
+---
+
+## License
+
+Apache 2.0

andf-1.0.0/README.md

@@ -0,0 +1,213 @@
+# ANDF — AI Native Document Format
+
+**ANDF** (`.andf`) is a document format built for AI-native workflows. Every `.andf` file is a self-contained HTML file that:
+
+- **Opens in any browser instantly** — looks and feels like a PDF (toolbar, dark background, white pages, page numbers)
+- **Is trivially parseable by AI** — structured JSON is embedded in a `<script type="application/andf+json">` tag
+- **Requires no install, no server, no extension**
+
+---
+
+## Quick Start
+
+```python
+from andf import ANDFDocument
+
+doc = ANDFDocument()
+doc.set_metadata(title="My Report", authors=["Alice"])
+
+sec = doc.add_section("intro", "Introduction")
+sec.heading("Welcome", level=2)
+sec.paragraph("Hello from **ANDF**! This is *important*.")
+sec.callout("Remember to save your work!", variant="tip", title="Tip")
+sec.table(
+    headers=["Name", "Score"],
+    rows=[["Alice", "95"], ["Bob", "87"]],
+    caption="Table 1: Results",
+)
+sec.code("print('hello world')", language="python")
+
+doc.save("report.andf")
+doc.open_in_browser("report.andf")  # opens in browser
+```
+
+---
+
+## Installation
+
+```bash
+pip install .
+```
+
+Or install in development mode:
+
+```bash
+pip install -e .
+```
+
+---
+
+## CLI
+
+```bash
+# Create a blank document
+andf new output.andf
+
+# Open in browser
+andf open output.andf
+
+# Extract embedded JSON
+andf parse output.andf --pretty
+
+# Validate format
+andf validate output.andf
+
+# Show metadata
+andf info output.andf
+
+# AI layer summary
+andf ai output.andf
+```
+
+---
+
+## File Format
+
+An `.andf` file is an HTML file. The complete document data is embedded as JSON:
+
+```html
+<script type="application/andf+json">
+{
+  "andf_version": "1.0",
+  "document_id": "...",
+  "metadata": { "title": "...", "authors": [...] },
+  "sections": [...],
+  "blocks": { "blk_xxx": { "type": "paragraph", "text": "..." } },
+  ...
+}
+</script>
+```
+
+AI tools extract it with a single regex:
+
+```python
+import re, json
+
+pattern = re.compile(
+    r'<script[^>]+type=["\']application/andf\+json["\'][^>]*>(.*?)</script>',
+    re.DOTALL
+)
+data = json.loads(pattern.search(open("file.andf").read()).group(1))
+```
+
+---
+
+## Block Types
+
+| Type | Description |
+|------|-------------|
+| `heading` | Section heading (levels 1–6) |
+| `paragraph` | Body text with `**bold**`, `*italic*`, `` `code` ``, `[ref]` markup |
+| `image` | Embedded image from assets |
+| `table` | Data table with headers and rows |
+| `list` | Ordered or unordered list with nesting |
+| `code` | Syntax-highlighted code block |
+| `quote` | Block quote with optional attribution |
+| `callout` | Highlighted box: info / warning / error / success / tip |
+| `separator` | Horizontal rule |
+| `pagebreak` | Explicit page break |
+
+---
+
+## Themes
+
+```python
+doc.set_theme("default")    # Inter sans-serif, clean
+doc.set_theme("academic")   # Georgia serif, formal
+doc.set_theme("corporate")  # Arial, business blue headings
+doc.set_theme("minimal")    # System UI, minimal color
+```
+
+---
+
+## AI Layer
+
+```python
+from andf import ANDFDocument, ANDFAILayer
+
+doc = ANDFDocument.from_file("report.andf")
+layer = ANDFAILayer(doc)
+
+# Plain text
+text = layer.full_text()
+
+# Markdown (best for LLM input)
+md = layer.to_markdown()
+
+# RAG chunks
+chunks = layer.context_chunks(max_chars=4000)
+
+# Document summary
+summary = layer.document_summary()
+print(summary["key_points"])
+
+# High-importance blocks
+important = layer.blocks_by_importance(min_importance=4)
+```
+
+---
+
+## Project Structure
+
+```
+andf/
+├── __init__.py     # Public API
+├── document.py     # ANDFDocument model + fluent builder
+├── renderer.py     # HTML renderer
+├── parser.py       # Parser + validator
+├── ai_layer.py     # AI extraction layer
+└── cli.py          # Command-line interface
+
+spec/
+└── ANDF-1.0.md     # Format specification
+
+examples/
+├── create_examples.py
+├── research_paper.andf
+├── business_report.andf
+├── legal_contract.andf
+└── technical_manual.andf
+
+tests/
+└── test_andf.py
+```
+
+---
+
+## Generate Examples
+
+```bash
+python examples/create_examples.py
+```
+
+Opens each `.andf` file in your browser to see the viewer.
+
+---
+
+## Run Tests
+
+```bash
+python -m pytest tests/ -v
+```
+
+---
+
+## Specification
+
+See [`spec/ANDF-1.0.md`](spec/ANDF-1.0.md) for the complete format specification.
+
+---
+
+## License
+
+Apache 2.0

andf-1.0.0/andf/__init__.py

@@ -0,0 +1,52 @@
+"""
+ANDF — AI Native Document Format
+=================================
+A self-contained HTML file format that looks like a PDF in the browser
+and is trivially parseable by AI tools.
+
+Quick start::
+
+    from andf import ANDFDocument
+
+    doc = ANDFDocument()
+    doc.set_metadata(title="My Document", authors=["Alice"])
+    sec = doc.add_section("intro", "Introduction")
+    sec.heading("Welcome", level=2)
+    sec.paragraph("Hello from **ANDF**!")
+    doc.save("output.andf")
+
+    # Open in browser
+    doc.open_in_browser("output.andf")
+
+    # Parse an existing file
+    doc2 = ANDFDocument.from_file("output.andf")
+
+    # AI extraction
+    from andf import ANDFAILayer
+    layer = ANDFAILayer(doc2)
+    print(layer.to_markdown())
+"""
+
+from .document import ANDFDocument
+from .parser import ANDFParser
+from .ai_layer import ANDFAILayer
+
+
+def load(path: str) -> ANDFDocument:
+    """Load an ANDF document from a file path."""
+    return ANDFDocument.from_file(path)
+
+
+def save(doc: ANDFDocument, path: str) -> None:
+    """Save an ANDF document to a file path."""
+    doc.save(path)
+
+
+def open_in_browser(path: str) -> None:
+    """Open an existing .andf file in the default browser."""
+    from .cli import _open_in_browser
+    _open_in_browser(path)
+
+
+__version__ = "1.0.0"
+__all__ = ["ANDFDocument", "ANDFParser", "ANDFAILayer", "load", "save", "open_in_browser"]