inkletter 0.1.0__tar.gz

inkletter-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 CrocoCode.co
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

inkletter-0.1.0/PKG-INFO

@@ -0,0 +1,106 @@
+Metadata-Version: 2.4
+Name: inkletter
+Version: 0.1.0
+Summary: Markdown to MJML/HTML converter and previewer
+Author-email: Laurent Pauloin <laurent@crococode.co>
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: click==8.2.1
+Requires-Dist: jinja2==3.1.6
+Requires-Dist: mistune==3.1.3
+Requires-Dist: mjml-python==1.3.5
+Dynamic: license-file
+
+# Inkletter
+
+**Write your emails like prose, send them like a pro.**
+
+Inkletter is a magical little tool that transforms your plain Markdown files into beautiful, 
+responsive MJML and HTML email layouts, ready to be previewed, shared or sent to the world.
+
+## Why Inkletter?
+
+Because writing HTML emails by hand is like ironing socks: pointless and painful.
+
+With Inkletter, you write your content in **Markdown** (like a decent human being), 
+and we turn it into **gorgeous, mobile-friendly HTML emails** powered by MJML.
+
+Built with care, clarity and just enough elegance, 
+the kind that pairs well with good typography and strong espresso.
+
+## Features
+
+- ✅ Convert Markdown to MJML
+- ✅ Convert Markdown to full responsive HTML
+- ✅ Live preview in your browser
+- ✅ Device simulator (iPhone, iPad, Desktop, etc.)
+- ✅ One command, zero headache
+- ✅ No vendor lock-in, fully offline
+
+## ✨ Live Samples
+
+Explore the included examples to see Inkletter in action:
+- 🔍 [sample.md](sample/sample.md) — the original Markdown source
+- 💎 [sample.html](sample/sample.html) — the final responsive HTML output
+- 🎨 [preview.html](sample/preview.html) — the interactive split preview (Markdown / MJML / Rendered)
+
+## Installation
+
+Make sure you have Python 3.8+ installed on your system.
+
+Then in your terminal:
+
+```bash
+pip install inkletter
+```
+
+Or for development:
+
+```bash
+git clone https://github.com/your-name/inkletter.git
+cd inkletter
+pip install -e .
+```
+
+## How it works
+
+### 1. Preview your Markdown as a responsive email
+
+```bash
+inkletter preview yourfile.md
+```
+
+This opens a split view in your browser with:
+- Your original Markdown
+- The generated MJML
+- A live rendered email with responsive device preview
+
+Yes, even iPhone 14. You’re welcome.
+
+
+### 2. Convert and export to HTML
+
+```bash
+inkletter md2mjml input.md -o output.html –view
+```
+
+This will:
+- Convert the Markdown to MJML
+- Render it into clean HTML
+- Save the HTML to `output.html`
+- Optionally open it in your browser with `–view`
+
+No fuss. No noise. Just results.
+
+
+## Contributing
+
+French or not, you are welcome to contribute.
+Fork it, branch it, test it, PR it — with love.
+
+## License
+
+MIT — but don’t forget to say “merci” 😉
+
+### Made with ❤️ and `markdown` in France.

inkletter-0.1.0/README.md

@@ -0,0 +1,92 @@
+# Inkletter
+
+**Write your emails like prose, send them like a pro.**
+
+Inkletter is a magical little tool that transforms your plain Markdown files into beautiful, 
+responsive MJML and HTML email layouts, ready to be previewed, shared or sent to the world.
+
+## Why Inkletter?
+
+Because writing HTML emails by hand is like ironing socks: pointless and painful.
+
+With Inkletter, you write your content in **Markdown** (like a decent human being), 
+and we turn it into **gorgeous, mobile-friendly HTML emails** powered by MJML.
+
+Built with care, clarity and just enough elegance, 
+the kind that pairs well with good typography and strong espresso.
+
+## Features
+
+- ✅ Convert Markdown to MJML
+- ✅ Convert Markdown to full responsive HTML
+- ✅ Live preview in your browser
+- ✅ Device simulator (iPhone, iPad, Desktop, etc.)
+- ✅ One command, zero headache
+- ✅ No vendor lock-in, fully offline
+
+## ✨ Live Samples
+
+Explore the included examples to see Inkletter in action:
+- 🔍 [sample.md](sample/sample.md) — the original Markdown source
+- 💎 [sample.html](sample/sample.html) — the final responsive HTML output
+- 🎨 [preview.html](sample/preview.html) — the interactive split preview (Markdown / MJML / Rendered)
+
+## Installation
+
+Make sure you have Python 3.8+ installed on your system.
+
+Then in your terminal:
+
+```bash
+pip install inkletter
+```
+
+Or for development:
+
+```bash
+git clone https://github.com/your-name/inkletter.git
+cd inkletter
+pip install -e .
+```
+
+## How it works
+
+### 1. Preview your Markdown as a responsive email
+
+```bash
+inkletter preview yourfile.md
+```
+
+This opens a split view in your browser with:
+- Your original Markdown
+- The generated MJML
+- A live rendered email with responsive device preview
+
+Yes, even iPhone 14. You’re welcome.
+
+
+### 2. Convert and export to HTML
+
+```bash
+inkletter md2mjml input.md -o output.html –view
+```
+
+This will:
+- Convert the Markdown to MJML
+- Render it into clean HTML
+- Save the HTML to `output.html`
+- Optionally open it in your browser with `–view`
+
+No fuss. No noise. Just results.
+
+
+## Contributing
+
+French or not, you are welcome to contribute.
+Fork it, branch it, test it, PR it — with love.
+
+## License
+
+MIT — but don’t forget to say “merci” 😉
+
+### Made with ❤️ and `markdown` in France.

inkletter-0.1.0/inkletter/__init__.py

@@ -0,0 +1,10 @@
+def parse_markdown(markdown_text: str) -> list:
+    """Parse le Markdown enrichi et retourne l'AST."""
+
+
+def ast_to_mjml(ast: list) -> str:
+    """Transforme l'AST en MJML."""
+
+
+def markdown_to_mjml(markdown_text: str) -> str:
+    """Pipeline complet: Markdown -> AST -> MJML."""

inkletter-0.1.0/inkletter/ast.py

@@ -0,0 +1,277 @@
+class Node:
+    def __init__(self):
+        self.annotations = {}
+
+    def get_children(self):
+        return []
+
+    def __repr__(self):
+        return f"{self.__class__.__name__}()"
+
+
+class BlockNode(Node):
+    def __init__(self, children):
+        super().__init__()
+        if children is None:
+            self.children = []
+        else:
+            self.children = children if isinstance(children, list) else [children]
+
+    def get_children(self):
+        return self.children
+
+
+# --- Text elements ---
+
+class Text(Node):
+    pass
+
+
+class TextBlock(Text, BlockNode):
+    pass
+
+
+class LiteralText(Text):
+    def __init__(self, value):
+        super().__init__()
+        self.value = value
+
+    def __repr__(self):
+        return f"LiteralText('{self.value}')"
+
+
+class CodeSpan(Text):
+    def __init__(self, code):
+        self.code = code
+        super().__init__()
+
+    def __repr__(self):
+        return f"CodeSpan(code='{self.code}')"
+
+
+class Emphasis(TextBlock):
+    def __repr__(self):
+        return "Emphasis()"
+
+
+class Strong(TextBlock):
+    def __repr__(self):
+        return "Strong()"
+
+
+class StrikeThrough(TextBlock):
+    def __repr__(self):
+        return "StrikeThrough()"
+
+
+class Link(TextBlock):
+    def __init__(self, text, href, title=None):
+        super().__init__(text)
+        self.href = href
+        self.title = title
+
+    def __repr__(self):
+        return f"Link(href='{self.href}', title='{self.title}')"
+
+
+# --- Block elements ---
+
+
+class Document(BlockNode):
+    def __repr__(self):
+        return "Document()"
+
+
+class Paragraph(BlockNode):
+    def __repr__(self):
+        return "Paragraph()"
+
+
+class Heading(BlockNode):
+    def __init__(self, level, text):
+        super().__init__(text)
+        self.level = level
+
+    def __repr__(self):
+        return f"Heading(level={self.level})"
+
+
+class BlockText(BlockNode):
+    def __repr__(self):
+        return "BlockText()"
+
+
+class BlockQuote(BlockNode):
+    def __repr__(self):
+        return "BlockQuote()"
+
+
+class BlockCode(BlockNode):
+    def __init__(self, code=None, language=None, children=None):
+        super().__init__(children)
+        self.code = code
+        self.language = language
+
+    def __repr__(self):
+        return f"BlockCode(language='{self.language}', code='{self.code}')"
+
+
+# --- Image element ---
+
+
+class Image(Node):
+    def __init__(self, url, alt_text=None, title=None):
+        super().__init__()
+        self.url = url
+        self.alt_text = alt_text
+        self.title = title
+
+    def get_children(self):
+        return [self.alt_text]
+
+    def __repr__(self):
+        return (
+            f"Image(url='{self.url}', title='{self.title}', alt_text='{self.alt_text}'"
+        )
+
+
+class ImageLink(Node):
+    def __init__(self, img, href, title=None):
+        super().__init__()
+        self.img = img
+        self.href = href
+        self.title = title
+
+    def get_children(self):
+        return [self.img]
+
+    def __repr__(self):
+        return f"ImageLink(href='{self.href}', img='{self.img}', title='{self.title}')"
+
+
+# --- Terminal elements ---
+
+
+class Terminal(Node):
+    pass
+
+
+class TextTerminal(Text, Terminal):
+    pass
+
+
+class ThematicBreak(Terminal):
+    def __repr__(self):
+        return "ThematicBreak()"
+
+
+class LineBreak(TextTerminal):
+    def __repr__(self):
+        return "LineBreak()"
+
+
+class SoftBreak(TextTerminal):
+    def __repr__(self):
+        return "SoftBreak()"
+
+
+class BlankLine(TextTerminal):
+    def __repr__(self):
+        return "BlankLine()"
+
+
+# --- List elements ---
+
+
+class List(Node):
+    def __init__(self, elements, ordered=False):
+        super().__init__()
+        self.elements = elements
+        self.ordered = ordered
+
+    def get_children(self):
+        return self.elements
+
+    def __repr__(self):
+        return f"List(ordered={self.ordered})"
+
+
+class ListItem(BlockNode):
+    def __init__(self, children):
+        super().__init__(children)
+
+    def __repr__(self):
+        return "ListItem()"
+
+
+class TaskListItem(BlockNode):
+    def __init__(self, children, checked=False):
+        super().__init__(children)
+        self.checked = checked
+
+    def __repr__(self):
+        return f"TaskListItem(checked={self.checked})"
+
+
+# --- Table elements ---
+
+
+class Table(Node):
+    def __init__(self, header=None, rows=None):
+        super().__init__()
+        self.header = header
+        self.rows = rows
+
+    def get_children(self):
+        if self.header is None:
+            if self.rows is None:
+                children = []
+            else:
+                children = self.rows
+        else:
+            children = [self.header] + self.rows
+        return children
+
+    def __repr__(self):
+        return "Table()"
+
+
+class TableRow(Node):
+    def __init__(self, row, is_header=False):
+        super().__init__()
+        self.row = row
+        self.is_header = is_header
+
+    def get_children(self):
+        return self.row
+
+    def __repr__(self):
+        return f"TableRow(is_header={self.is_header})"
+
+
+class TableCell(BlockNode):
+    def __init__(self, cell, align=None):
+        super().__init__(cell)
+        self.align = align
+
+
+class TableHeaderCell(TableCell):
+    def __repr__(self):
+        return f"TableHeaderCell(align={self.align})"
+
+
+class TableRegularCell(TableCell):
+    def __repr__(self):
+        return f"TableRegularCell(align={self.align})"
+
+
+class TableHeader(Node):
+    def __init__(self, headers):
+        super().__init__()
+        self.headers = headers
+
+    def get_children(self):
+        return self.headers
+
+    def __repr__(self):
+        return "TableHeader()"

inkletter-0.1.0/inkletter/cli.py

@@ -0,0 +1,94 @@
+from pathlib import Path
+import tempfile
+import webbrowser
+
+import click
+from jinja2 import Environment, FileSystemLoader
+
+from inkletter.md_to_html import parse_markdown_to_html, parse_mjml_to_html
+from inkletter.md_to_mjml import parse_markdown_to_mjml
+
+BASE_DIR = Path(__file__).resolve().parent
+TEMPLATES_DIR = BASE_DIR / "templates"
+
+@click.group()
+def cli():
+    """Inkletter CLI — Convert and preview Markdown as MJML"""
+    pass
+
+
+@cli.command()
+@click.argument("filepath", type=click.Path(exists=True, dir_okay=False, path_type=Path))
+@click.option("-o", "--output", type=click.Path(dir_okay=False, writable=True, path_type=Path), help="Output HTML file path")
+def preview(filepath: Path, output: Path | None):
+    """
+    Convert a Markdown file into MJML, then into HTML, and preview it in a browser.
+    """
+    try:
+        # Load Markdown
+        markdown_text = filepath.read_text(encoding="utf-8")
+
+        # Markdown → MJML
+        mjml_code = parse_markdown_to_mjml(
+            markdown_text,
+            print_ast=False,
+            use_style=True,
+        )
+
+        # MJML → HTML
+        html_output = parse_mjml_to_html(mjml_code)
+
+        # Render with Jinja2
+        env = Environment(loader=FileSystemLoader(str(TEMPLATES_DIR)))
+        template = env.get_template("preview.html")
+        rendered = template.render(
+            MD_CONTENT=markdown_text,
+            MJML_CONTENT=mjml_code,
+            HTML_CONTENT=html_output,
+        )
+
+        if output:
+            output.write_text(rendered, encoding="utf-8")
+            out_path = output
+        else:
+            with tempfile.NamedTemporaryFile("w", suffix=".html", encoding="utf-8", delete=False) as f:
+                f.write(rendered)
+                out_path = Path(f.name)
+
+        webbrowser.open(f"file://{out_path.resolve().as_uri()}")
+
+        click.secho(f"✅ Preview opened in browser:\n{out_path}", fg="green")
+
+    except Exception as e:
+        click.secho(f"❌ Error: {e}", fg="red", err=True)
+
+@cli.command()
+@click.argument("filepath", type=click.Path(exists=True, dir_okay=False, path_type=Path))
+@click.option("-o", "--output", type=click.Path(dir_okay=False, writable=True, path_type=Path), help="Output HTML file path")
+@click.option("--view/--no-view", default=False, help="Open the result in a browser (default: false)")
+def md2mjml(filepath: Path, output: Path | None, view: bool):
+    """Convert Markdown to MJML then HTML, optionally save and open it."""
+    try:
+        # Lire Markdown
+        markdown_text = filepath.read_text(encoding="utf-8")
+
+        # Markdown → HTML
+        html_output = parse_markdown_to_html(markdown_text)
+
+
+        if output:
+            output.write_text(html_output, encoding="utf-8")
+            out_path = output
+        else:
+            with tempfile.NamedTemporaryFile("w", suffix=".html", encoding="utf-8", delete=False) as f:
+                f.write(html_output)
+                out_path = Path(f.name)
+
+        click.secho(f"✅ HTML written to: {out_path}", fg="green")
+
+        if view:
+            webbrowser.open(f"file://{out_path.resolve().as_uri()}")
+
+    except Exception as e:
+        click.secho(f"❌ Error: {e}", fg="red", err=True)
+