Metadata-Version: 2.4
Name: fmjl
Version: 0.5.0
Summary: FMJL (.fmjl): one document, two forms. JSON Lines container, Markdown text, LaTeX formulas, HTML merged-cell tables, built for RAG. Converter, checker, PDF and Word importers, retriever chunks.
Author: Rupak Kumar
License: MIT
Project-URL: Homepage, https://github.com/rupakkumar-76319/fmjl
Project-URL: Rulebook, https://github.com/rupakkumar-76319/fmjl/blob/main/rulebook/fmjl_rulebook_v0.5.md
Project-URL: Issues, https://github.com/rupakkumar-76319/fmjl/issues
Keywords: fmjl,jsonl,markdown,rag,document,pdf,docx,retrieval
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Text Processing :: Markup :: Markdown
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: jsonschema>=4
Provides-Extra: pdf
Requires-Dist: pymupdf>=1.24; extra == "pdf"
Dynamic: license-file

# FMJL

FMJL, short for Format, Markdown, JSON Lines, stores a document as one JSON object per line: one element (heading, paragraph, table, formula, image, caption...) with a stable id, a content hash, its page and position, and who may read it. People write and edit the same document as normal Markdown; the tool converts both ways without renumbering anything.

    pip install fmjl            # converter, checker, Word importer, chunks
    pip install fmjl[pdf]       # adds the PDF importer (PyMuPDF)

    fmjl notes.md               # Markdown  -> notes.fmjl, then checks it
    fmjl notes.fmjl             # .fmjl     -> notes.md, ids kept
    fmjl report.pdf             # PDF       -> report.fmjl, report.md, images/
    fmjl report.docx            # Word      -> the same
    fmjl chunks report.fmjl     # retriever-ready chunks as JSON Lines

From Python: `import fmjl`; `fmjl.load`, `fmjl.chunks`, `fmjl.changed_chunks`, `fmjl.check`.

Rulebook, examples, benchmark and the VS Code extension: https://github.com/rupakkumar-76319/fmjl
