yerba 0.0.3a0.dev2__tar.gz → 0.2.0__tar.gz

{yerba-0.0.3a0.dev2 → yerba-0.2.0}/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 Bernardo Español
+Copyright (c) 2026 Bernardo L. Español
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

yerba-0.2.0/PKG-INFO

@@ -0,0 +1,94 @@
+Metadata-Version: 2.4
+Name: yerba
+Version: 0.2.0
+Summary: Python-driven presentation tool: Markdown decks laid out in Python, rendered to PDF
+Author-email: "Bernardo L. Español" <esp.bernardo@gmail.com>
+License-Expression: MIT
+Project-URL: Repository, https://github.com/bersp/mate
+Project-URL: Issues, https://github.com/bersp/mate/issues
+Keywords: presentation,slides,markdown,pdf
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Multimedia :: Graphics :: Presentation
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy
+Requires-Dist: typst>=0.14
+Requires-Dist: rich>=13
+Requires-Dist: markdown-it-py>=3
+Requires-Dist: mdit-py-plugins>=0.4
+Requires-Dist: pyyaml>=6
+Requires-Dist: pygments>=2.15
+Dynamic: license-file
+
+<p align="center">
+    <a href="https://github.com/bersp/mate">
+        <img src="https://raw.githubusercontent.com/bersp/mate/master/.github/assets/logo.png" alt="mate" width="90%">
+    </a>
+</p>
+<br />
+
+`mate` is a Python application for creating presentations by writing Markdown files. The goal is to build aesthetically pleasing presentations in a short amount of time while staying highly customizable and versatile: the content is plain Markdown, and the details can be tweaked with a short, clean syntax (or at least that's the intention).
+
+The idea behind `mate` is to create slides fast, in a declarative and programmatic way, and let the template take care of arranging things and giving them their look. Since the content knows nothing about the aesthetics, restyling a whole presentation amounts to switching its template.
+
+Templates get a lot of freedom and tools, and they are constructive: a template can be as small as a background change or as ambitious as a full visual identity, with its own functions and slide designs, and a deck can combine several of them.
+
+## Features
+
+- Slides are written in plain Markdown: `#` opens a slide, and bold, italics, code and math work as usual.
+- Whatever Markdown cannot express, the extended syntax can: any element of a slide can be created, styled, positioned and aligned.
+- Templates control fonts, colors, backgrounds and slide logic. Use a built-in one, or write your own as a small Python file next to your deck.
+- Slides reveal their content in stages, with a versatile system of pauses, in-place reveals and overwrites.
+- There is a drawing API as well: shapes, Bézier curves, images and gradients can go on a slide alongside the text.
+- `mate` is fast: everything is heavily cached, so builds stay quick even for large decks.
+- There is nothing else to install: no LaTeX, no external tools. The rendering backend ships inside the package.
+
+## Getting started
+
+_To get_ `mate`, _all you need is_ `yerba`:
+
+```bash
+pip install yerba
+```
+
+Write a deck:
+
+```markdown
+# A slide title
+
+Some content with **bold**, _italic_ and inline $x^2$ math.
+
+Words can be styled in place: [this is red][color="red"], and
+[this is translucent and smaller][opacity=0.4, fontsize=7].
+
+> pause
+
+- Bullet points work as usual
+- and this list appears after the pause.
+
+# Another slide
+## With a subtitle
+
+More content.
+```
+
+and build it:
+
+```bash
+mate slides.md
+```
+
+The PDF lands next to the source, as `slides.pdf`.
+
+See the [docs](https://github.com/bersp/mate/blob/master/docs/README.md) for the full Markdown syntax, front matter, templates, and the Python API.
+
+## Backends
+
+The code is built to support different backends. Typst is the only one supported today; new backends will follow once the current one is fully functional and free of known bugs.
+
+## License
+
+MIT. The bundled fonts keep their own licenses (SIL OFL 1.1, under `fonts/`).

yerba-0.2.0/README.md

@@ -0,0 +1,69 @@
+<p align="center">
+    <a href="https://github.com/bersp/mate">
+        <img src="https://raw.githubusercontent.com/bersp/mate/master/.github/assets/logo.png" alt="mate" width="90%">
+    </a>
+</p>
+<br />
+
+`mate` is a Python application for creating presentations by writing Markdown files. The goal is to build aesthetically pleasing presentations in a short amount of time while staying highly customizable and versatile: the content is plain Markdown, and the details can be tweaked with a short, clean syntax (or at least that's the intention).
+
+The idea behind `mate` is to create slides fast, in a declarative and programmatic way, and let the template take care of arranging things and giving them their look. Since the content knows nothing about the aesthetics, restyling a whole presentation amounts to switching its template.
+
+Templates get a lot of freedom and tools, and they are constructive: a template can be as small as a background change or as ambitious as a full visual identity, with its own functions and slide designs, and a deck can combine several of them.
+
+## Features
+
+- Slides are written in plain Markdown: `#` opens a slide, and bold, italics, code and math work as usual.
+- Whatever Markdown cannot express, the extended syntax can: any element of a slide can be created, styled, positioned and aligned.
+- Templates control fonts, colors, backgrounds and slide logic. Use a built-in one, or write your own as a small Python file next to your deck.
+- Slides reveal their content in stages, with a versatile system of pauses, in-place reveals and overwrites.
+- There is a drawing API as well: shapes, Bézier curves, images and gradients can go on a slide alongside the text.
+- `mate` is fast: everything is heavily cached, so builds stay quick even for large decks.
+- There is nothing else to install: no LaTeX, no external tools. The rendering backend ships inside the package.
+
+## Getting started
+
+_To get_ `mate`, _all you need is_ `yerba`:
+
+```bash
+pip install yerba
+```
+
+Write a deck:
+
+```markdown
+# A slide title
+
+Some content with **bold**, _italic_ and inline $x^2$ math.
+
+Words can be styled in place: [this is red][color="red"], and
+[this is translucent and smaller][opacity=0.4, fontsize=7].
+
+> pause
+
+- Bullet points work as usual
+- and this list appears after the pause.
+
+# Another slide
+## With a subtitle
+
+More content.
+```
+
+and build it:
+
+```bash
+mate slides.md
+```
+
+The PDF lands next to the source, as `slides.pdf`.
+
+See the [docs](https://github.com/bersp/mate/blob/master/docs/README.md) for the full Markdown syntax, front matter, templates, and the Python API.
+
+## Backends
+
+The code is built to support different backends. Typst is the only one supported today; new backends will follow once the current one is fully functional and free of known bugs.
+
+## License
+
+MIT. The bundled fonts keep their own licenses (SIL OFL 1.1, under `fonts/`).

yerba-0.2.0/pyproject.toml

@@ -0,0 +1,50 @@
+[build-system]
+requires = ["setuptools>=77"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "yerba"
+version = "0.2.0"
+description = "Python-driven presentation tool: Markdown decks laid out in Python, rendered to PDF"
+readme = "README.md"
+license = "MIT"
+license-files = ["LICENSE"]
+requires-python = ">=3.10"
+dependencies = ["numpy", "typst>=0.14", "rich>=13", "markdown-it-py>=3", "mdit-py-plugins>=0.4", "pyyaml>=6", "pygments>=2.15"]
+authors = [
+  {name = "Bernardo L. Español", email = "esp.bernardo@gmail.com"},
+]
+keywords = ["presentation", "slides", "markdown", "pdf"]
+classifiers = [
+  "Development Status :: 3 - Alpha",
+  "Environment :: Console",
+  "Programming Language :: Python :: 3",
+  "Topic :: Multimedia :: Graphics :: Presentation",
+]
+
+[project.urls]
+Repository = "https://github.com/bersp/mate"
+Issues = "https://github.com/bersp/mate/issues"
+
+[project.scripts]
+mate = "mate.cli:main"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+mate = ["fonts/*/*.ttf", "fonts/*/OFL.txt", "fonts/README.md"]
+
+[tool.ruff]
+line-length = 88
+
+[tool.ruff.lint]
+# E/W: pycodestyle (E501 enforces the line width on every line, docstrings included)
+# F: pyflakes  D: pydocstyle (docstring style)
+select = ["E", "F", "W", "D"]
+# Docstrings are written only when they add information, so the
+# "missing docstring" family is not enforced; only docstring *style* is.
+ignore = ["D100", "D101", "D102", "D103", "D104", "D105", "D106", "D107"]
+
+[tool.ruff.lint.pydocstyle]
+convention = "numpy"

yerba-0.2.0/src/mate/__init__.py

@@ -0,0 +1,74 @@
+from .config import config
+from .core import (
+    Vec,
+    Anchor,
+    Element,
+    Drawable,
+    Gradient,
+    PresentationTemplateBase,
+    Presentation,
+    Slide,
+    Snapshot,
+    IDRegistry,
+    id_registry,
+    measure_all,
+)
+from .elements import (
+    Circle,
+    Code,
+    Close,
+    CubicTo,
+    Curve,
+    CurveSegment,
+    Ellipse,
+    Group,
+    HSpace,
+    Image,
+    Line,
+    LineTo,
+    MoveTo,
+    Polygon,
+    QuadTo,
+    Rectangle,
+    Text,
+    VSpace,
+)
+from .composition import arrange, Layout, Region, layout_to_group
+
+__all__ = [
+    "Vec",
+    "Anchor",
+    "Element",
+    "Drawable",
+    "Gradient",
+    "PresentationTemplateBase",
+    "Presentation",
+    "Slide",
+    "Snapshot",
+    "Circle",
+    "Close",
+    "Code",
+    "CubicTo",
+    "Curve",
+    "CurveSegment",
+    "Ellipse",
+    "Group",
+    "HSpace",
+    "Image",
+    "Line",
+    "LineTo",
+    "MoveTo",
+    "Polygon",
+    "QuadTo",
+    "Rectangle",
+    "Text",
+    "VSpace",
+    "IDRegistry",
+    "id_registry",
+    "measure_all",
+    "config",
+    "arrange",
+    "Layout",
+    "Region",
+    "layout_to_group",
+]

yerba-0.2.0/src/mate/backends/__init__.py

@@ -0,0 +1,3 @@
+from .typst import TypstRenderer, TypstMeasurer
+
+__all__ = ["TypstRenderer", "TypstMeasurer"]