jsonmd 0.1.0__tar.gz

jsonmd-0.1.0/PKG-INFO

@@ -0,0 +1,133 @@
+Metadata-Version: 2.4
+Name: jsonmd
+Version: 0.1.0
+Summary: JSON/JSON5 loader and dumper with raw multiline markdown block support
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Requires-Dist: json5>=0.12.0
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# jsonmd
+
+# 背景
+
+在人机协作时代，提示词和结构化文本配置会被开发者与 AI 代理高频共同编辑。
+可读性和低摩擦编辑能力会直接影响迭代速度与交付质量。
+
+`jsonmd` 用来解决 JSON 不支持原生多行字符串的问题。
+
+通过 `<md>...</md>` 语法标记，你可以在 JSON/JSON5 中嵌入原始多行文本块
+（例如 Markdown），而不需要使用 `\n` 转义符。
+
+这让在配置文件中存储富文本更直观、可读性更高。
+
+示例：
+
+```json5
+{
+  content: <md># Title
+- item
+</md>
+}
+```
+
+而不是：
+
+```json
+{
+  "content": "# Title\n- item"
+}
+```
+
+安装：
+
+```bash
+pip install /path/to/lib/jsonmd
+```
+
+开发时可编辑安装：
+
+```bash
+pip install -e /path/to/lib/jsonmd
+```
+
+使用：
+
+```python
+from jsonmd import loads, dumps
+
+text = """
+{
+  content: <md># Title
+- item
+</md>
+}
+"""
+data = loads(text)
+
+encoded = dumps({"content": "# Title\n- item"})
+```
+
+# Background
+
+In the era of human-AI collaboration, prompts and structured text configs are
+edited frequently by both developers and AI agents. Readability and low-friction
+editing directly affect iteration speed and quality.
+
+`jsonmd` solves the problem that JSON does not support native multiline strings.
+
+With `<md>...</md>` block markers, you can embed raw multiline text
+(for example Markdown) in JSON/JSON5 without `\n` escaping.
+
+This makes rich text in config files easier to read and maintain.
+
+Example:
+
+```json5
+{
+  content: <md># Title
+- item
+</md>
+}
+```
+
+instead of:
+
+```json
+{
+  "content": "# Title\n- item"
+}
+```
+
+Install:
+
+```bash
+pip install /path/to/lib/jsonmd
+```
+
+Editable install for development:
+
+```bash
+pip install -e /path/to/lib/jsonmd
+```
+
+Usage:
+
+```python
+from jsonmd import loads, dumps
+
+text = """
+{
+  content: <md># Title
+- item
+</md>
+}
+"""
+data = loads(text)
+
+encoded = dumps({"content": "# Title\n- item"})
+```

jsonmd-0.1.0/README.md

@@ -0,0 +1,120 @@
+# jsonmd
+
+# 背景
+
+在人机协作时代，提示词和结构化文本配置会被开发者与 AI 代理高频共同编辑。
+可读性和低摩擦编辑能力会直接影响迭代速度与交付质量。
+
+`jsonmd` 用来解决 JSON 不支持原生多行字符串的问题。
+
+通过 `<md>...</md>` 语法标记，你可以在 JSON/JSON5 中嵌入原始多行文本块
+（例如 Markdown），而不需要使用 `\n` 转义符。
+
+这让在配置文件中存储富文本更直观、可读性更高。
+
+示例：
+
+```json5
+{
+  content: <md># Title
+- item
+</md>
+}
+```
+
+而不是：
+
+```json
+{
+  "content": "# Title\n- item"
+}
+```
+
+安装：
+
+```bash
+pip install /path/to/lib/jsonmd
+```
+
+开发时可编辑安装：
+
+```bash
+pip install -e /path/to/lib/jsonmd
+```
+
+使用：
+
+```python
+from jsonmd import loads, dumps
+
+text = """
+{
+  content: <md># Title
+- item
+</md>
+}
+"""
+data = loads(text)
+
+encoded = dumps({"content": "# Title\n- item"})
+```
+
+# Background
+
+In the era of human-AI collaboration, prompts and structured text configs are
+edited frequently by both developers and AI agents. Readability and low-friction
+editing directly affect iteration speed and quality.
+
+`jsonmd` solves the problem that JSON does not support native multiline strings.
+
+With `<md>...</md>` block markers, you can embed raw multiline text
+(for example Markdown) in JSON/JSON5 without `\n` escaping.
+
+This makes rich text in config files easier to read and maintain.
+
+Example:
+
+```json5
+{
+  content: <md># Title
+- item
+</md>
+}
+```
+
+instead of:
+
+```json
+{
+  "content": "# Title\n- item"
+}
+```
+
+Install:
+
+```bash
+pip install /path/to/lib/jsonmd
+```
+
+Editable install for development:
+
+```bash
+pip install -e /path/to/lib/jsonmd
+```
+
+Usage:
+
+```python
+from jsonmd import loads, dumps
+
+text = """
+{
+  content: <md># Title
+- item
+</md>
+}
+"""
+data = loads(text)
+
+encoded = dumps({"content": "# Title\n- item"})
+```

jsonmd-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

jsonmd-0.1.0/setup.py

@@ -0,0 +1,14 @@
+from setuptools import find_packages, setup
+
+
+setup(
+    name="jsonmd",
+    version="0.1.0",
+    description="JSON/JSON5 loader and dumper with raw multiline markdown block support",
+    long_description=open("README.md", encoding="utf-8").read(),
+    long_description_content_type="text/markdown",
+    python_requires=">=3.9",
+    package_dir={"": "src"},
+    packages=find_packages("src"),
+    install_requires=["json5>=0.12.0"],
+)

jsonmd-0.1.0/src/jsonmd/__init__.py

@@ -0,0 +1,3 @@
+from .core import dump, dumps, load, loads
+
+__all__ = ["loads", "load", "dumps", "dump"]

jsonmd-0.1.0/src/jsonmd/core.py

@@ -0,0 +1,148 @@
+from __future__ import annotations
+
+import json
+import re
+import warnings
+from pathlib import Path
+from typing import Any, TextIO
+
+import json5
+
+_MD_BLOCK_RE = re.compile(
+    r"(?P<prefix>:\s*)<<<(?P<tag>[A-Z][A-Z0-9_-]*)[ \t]*\n"
+    r"(?P<body>.*?)\n"
+    r"(?P=tag)(?=\s*[,}\]])",
+    re.S,
+)
+_ANGLE_BLOCK_RE = re.compile(
+    r"(?P<prefix>:\s*)<(?P<tag>[a-z][a-z0-9_-]*)>"
+    r"(?P<body>.*?)"
+    r"</(?P=tag)>(?P<tail>.*?)(?=\s*[,}\]])",
+    re.S,
+)
+_IDENT_RE = re.compile(r"^[A-Za-z_$][A-Za-z0-9_$]*$")
+
+
+def _rewrite_markdown_blocks(text: str) -> str:
+    def repl_heredoc(match: re.Match[str]) -> str:
+        body = match.group("body")
+        return match.group("prefix") + json.dumps(body, ensure_ascii=False)
+
+    def repl_angle(match: re.Match[str]) -> str:
+        body = match.group("body")
+        tail = match.group("tail")
+        if tail.strip():
+            tag = match.group("tag")
+            warnings.warn(
+                f"Potential early </{tag}> close detected; "
+                "trailing content before separator was included as text.",
+                stacklevel=2,
+            )
+            body += tail
+        return match.group("prefix") + json.dumps(body, ensure_ascii=False)
+
+    out = _ANGLE_BLOCK_RE.sub(repl_angle, text)
+    out = _MD_BLOCK_RE.sub(repl_heredoc, out)
+    return out
+
+
+def loads(text: str) -> Any:
+    rewritten = _rewrite_markdown_blocks(text)
+    return json5.loads(rewritten)
+
+
+def load(path: str | Path, encoding: str = "utf-8") -> Any:
+    with open(path, "r", encoding=encoding) as f:
+        return loads(f.read())
+
+
+def _choose_md_tag(text: str, base_tag: str = "MD") -> str:
+    lines = set(text.splitlines())
+    if base_tag not in lines:
+        return base_tag
+
+    i = 2
+    while True:
+        candidate = f"{base_tag}{i}"
+        if candidate not in lines:
+            return candidate
+        i += 1
+
+
+def _choose_angle_tag(text: str, base_tag: str = "md") -> str:
+    tag = base_tag
+    i = 2
+    while f"</{tag}>" in text:
+        tag = f"{base_tag}{i}"
+        i += 1
+    return tag
+
+
+def _dump_key(key: str) -> str:
+    return key if _IDENT_RE.match(key) else json5.dumps(key)
+
+
+def _dump_value(
+    value: Any,
+    indent: int,
+    level: int,
+    md_tag: str,
+    block_style: str,
+) -> str:
+    if isinstance(value, dict):
+        if not value:
+            return "{}"
+        pad = " " * (indent * level)
+        child_pad = " " * (indent * (level + 1))
+        items = []
+        for k, v in value.items():
+            items.append(
+                f"{child_pad}{_dump_key(str(k))}: "
+                f"{_dump_value(v, indent, level + 1, md_tag, block_style)}"
+            )
+        return "{\n" + ",\n".join(items) + f"\n{pad}}}"
+
+    if isinstance(value, list):
+        if not value:
+            return "[]"
+        pad = " " * (indent * level)
+        child_pad = " " * (indent * (level + 1))
+        items = [
+            f"{child_pad}{_dump_value(v, indent, level + 1, md_tag, block_style)}"
+            for v in value
+        ]
+        return "[\n" + ",\n".join(items) + f"\n{pad}]"
+
+    if isinstance(value, str) and "\n" in value:
+        if block_style == "angle":
+            tag = _choose_angle_tag(value, md_tag)
+            return f"<{tag}>{value}</{tag}>"
+        tag = _choose_md_tag(value, md_tag.upper())
+        return f"<<<{tag}\n{value}\n{tag}"
+
+    return json5.dumps(value, ensure_ascii=False)
+
+
+def dumps(
+    value: Any,
+    *,
+    indent: int = 2,
+    md_tag: str = "md",
+    block_style: str = "angle",
+) -> str:
+    if block_style not in {"angle", "heredoc"}:
+        raise ValueError("block_style must be 'angle' or 'heredoc'")
+    return _dump_value(
+        value, indent=indent, level=0, md_tag=md_tag, block_style=block_style
+    )
+
+
+def dump(
+    value: Any,
+    fp: TextIO,
+    *,
+    indent: int = 2,
+    md_tag: str = "md",
+    block_style: str = "angle",
+) -> None:
+    fp.write(dumps(value, indent=indent, md_tag=md_tag, block_style=block_style))

jsonmd-0.1.0/src/jsonmd.egg-info/PKG-INFO

@@ -0,0 +1,133 @@
+Metadata-Version: 2.4
+Name: jsonmd
+Version: 0.1.0
+Summary: JSON/JSON5 loader and dumper with raw multiline markdown block support
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Requires-Dist: json5>=0.12.0
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# jsonmd
+
+# 背景
+
+在人机协作时代，提示词和结构化文本配置会被开发者与 AI 代理高频共同编辑。
+可读性和低摩擦编辑能力会直接影响迭代速度与交付质量。
+
+`jsonmd` 用来解决 JSON 不支持原生多行字符串的问题。
+
+通过 `<md>...</md>` 语法标记，你可以在 JSON/JSON5 中嵌入原始多行文本块
+（例如 Markdown），而不需要使用 `\n` 转义符。
+
+这让在配置文件中存储富文本更直观、可读性更高。
+
+示例：
+
+```json5
+{
+  content: <md># Title
+- item
+</md>
+}
+```
+
+而不是：
+
+```json
+{
+  "content": "# Title\n- item"
+}
+```
+
+安装：
+
+```bash
+pip install /path/to/lib/jsonmd
+```
+
+开发时可编辑安装：
+
+```bash
+pip install -e /path/to/lib/jsonmd
+```
+
+使用：
+
+```python
+from jsonmd import loads, dumps
+
+text = """
+{
+  content: <md># Title
+- item
+</md>
+}
+"""
+data = loads(text)
+
+encoded = dumps({"content": "# Title\n- item"})
+```
+
+# Background
+
+In the era of human-AI collaboration, prompts and structured text configs are
+edited frequently by both developers and AI agents. Readability and low-friction
+editing directly affect iteration speed and quality.
+
+`jsonmd` solves the problem that JSON does not support native multiline strings.
+
+With `<md>...</md>` block markers, you can embed raw multiline text
+(for example Markdown) in JSON/JSON5 without `\n` escaping.
+
+This makes rich text in config files easier to read and maintain.
+
+Example:
+
+```json5
+{
+  content: <md># Title
+- item
+</md>
+}
+```
+
+instead of:
+
+```json
+{
+  "content": "# Title\n- item"
+}
+```
+
+Install:
+
+```bash
+pip install /path/to/lib/jsonmd
+```
+
+Editable install for development:
+
+```bash
+pip install -e /path/to/lib/jsonmd
+```
+
+Usage:
+
+```python
+from jsonmd import loads, dumps
+
+text = """
+{
+  content: <md># Title
+- item
+</md>
+}
+"""
+data = loads(text)
+
+encoded = dumps({"content": "# Title\n- item"})
+```

jsonmd-0.1.0/src/jsonmd.egg-info/SOURCES.txt

@@ -0,0 +1,9 @@
+README.md
+setup.py
+src/jsonmd/__init__.py
+src/jsonmd/core.py
+src/jsonmd.egg-info/PKG-INFO
+src/jsonmd.egg-info/SOURCES.txt
+src/jsonmd.egg-info/dependency_links.txt
+src/jsonmd.egg-info/requires.txt
+src/jsonmd.egg-info/top_level.txt

jsonmd-0.1.0/src/jsonmd.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

jsonmd-0.1.0/src/jsonmd.egg-info/requires.txt

@@ -0,0 +1 @@
+json5>=0.12.0

jsonmd-0.1.0/src/jsonmd.egg-info/top_level.txt

@@ -0,0 +1 @@
+jsonmd