texer 0.5.12__py3-none-any.whl

texer-0.5.12.dist-info/METADATA

@@ -0,0 +1,263 @@
+Metadata-Version: 2.4
+Name: texer
+Version: 0.5.12
+Summary: Generate LaTeX tables and figures with glom-style specs
+Author-email: Thibaut Lamadon <thibaut.lamadon@example.com>
+License-Expression: MIT
+Keywords: latex,tables,pgfplots,tikz,typesetting,scientific
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Text Processing :: Markup :: LaTeX
+Classifier: Topic :: Scientific/Engineering
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: glom>=23.0.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
+Requires-Dist: mypy>=1.0.0; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: mkdocs>=1.5.0; extra == "docs"
+Requires-Dist: mkdocs-material>=9.5.0; extra == "docs"
+Requires-Dist: mkdocstrings[python]>=0.24.0; extra == "docs"
+Requires-Dist: numpy>=1.20.0; extra == "docs"
+Dynamic: license-file
+
+# texer
+
+[![PyPI version](https://badge.fury.io/py/texer.svg)](https://pypi.org/project/texer/)
+[![Documentation](https://img.shields.io/badge/docs-GitHub%20Pages-blue)](https://tlamadon.github.io/texer)
+
+Generate LaTeX tables and figures (PGFPlots) with Python using a glom-style spec system.
+
+## Installation
+
+```bash
+pip install texer
+```
+
+## Quick Start
+
+### Tables
+
+```python
+from texer import Table, Tabular, Row, Ref, Iter, Format, evaluate
+
+# Define structure with specs
+table = Table(
+    Tabular(
+        columns="lcc",
+        header=Row("Experiment", "Result", "Error"),
+        rows=Iter(
+            Ref("experiments"),
+            template=Row(
+                Ref("name"),
+                Format(Ref("result"), ".3f"),
+                Format(Ref("error"), ".1%"),
+            )
+        ),
+        toprule=True,
+        bottomrule=True,
+    ),
+    caption=Ref("table_title"),
+    label="tab:results",
+)
+
+# Provide data
+data = {
+    "table_title": "Experimental Results",
+    "experiments": [
+        {"name": "Trial A", "result": 3.14159, "error": 0.023},
+        {"name": "Trial B", "result": 2.71828, "error": 0.015},
+    ]
+}
+
+print(evaluate(table, data))
+```
+
+### Plots
+
+```python
+from texer import PGFPlot, Axis, AddPlot, Coordinates, Ref, Iter, evaluate
+
+plot = PGFPlot(
+    Axis(
+        xlabel=Ref("x_label"),
+        ylabel=Ref("y_label"),
+        grid=True,
+        plots=[
+            AddPlot(
+                color="blue",
+                mark="*",
+                coords=Coordinates(
+                    Iter(Ref("measurements"), x=Ref("time"), y=Ref("value"))
+                ),
+            )
+        ],
+        legend=[Ref("series_name")],
+    )
+)
+
+data = {
+    "x_label": "Time (hours)",
+    "y_label": "Temperature (°C)",
+    "series_name": "Sensor 1",
+    "measurements": [
+        {"time": 0, "value": 20.5},
+        {"time": 1, "value": 22.3},
+        {"time": 2, "value": 25.1},
+    ]
+}
+
+print(evaluate(plot, data))
+```
+
+### Saving and Compiling
+
+Save to file and compile to PDF directly:
+
+```python
+from texer import Table, Tabular, Row, evaluate
+
+table = Table(
+    Tabular(columns="lc", rows=[Row("Name", "Value")]),
+    caption="Results",
+)
+
+# Save to .tex file
+evaluate(table, output_file="table.tex")
+
+# Save with preamble for standalone compilation
+evaluate(table, output_file="table.tex", with_preamble=True)
+
+# Compile directly to PDF
+pdf_path = evaluate(table, output_file="table.tex", compile=True)
+```
+
+### Cycle Lists
+
+PGFPlots cycle lists allow you to define a sequence of styles that are automatically applied to successive `\addplot` commands. When using cycle lists, `AddPlot` automatically generates `\addplot+` (instead of `\addplot`) when no explicit styling is provided, allowing PGFPlots to pick the next style from the cycle list:
+
+```python
+from texer import PGFPlot, Axis, AddPlot, Coordinates
+
+# Using a predefined cycle list
+plot = PGFPlot(
+    Axis(
+        cycle_list_name="color list",
+        plots=[
+            # These generate \addplot+ to use cycle list styles
+            AddPlot(coords=Coordinates([(0, 0), (1, 1), (2, 4)])),
+            AddPlot(coords=Coordinates([(0, 1), (1, 2), (2, 3)])),
+        ],
+    )
+)
+
+# Custom cycle list with style dictionaries
+plot = PGFPlot(
+    Axis(
+        cycle_list=[
+            {"color": "blue", "mark": "*", "line width": "2pt"},
+            {"color": "red", "mark": "square*", "line width": "2pt"},
+            {"color": "green", "mark": "triangle*", "line width": "2pt"},
+        ],
+        plots=[
+            # Automatically uses \addplot+ to apply cycle list styles
+            AddPlot(coords=Coordinates([(0, 1), (1, 2), (2, 4)])),
+            AddPlot(coords=Coordinates([(0, 2), (1, 3), (2, 5)])),
+        ],
+    )
+)
+
+# Simple color cycle
+plot = PGFPlot(
+    Axis(
+        cycle_list=["blue", "red", "green"],
+        plots=[
+            AddPlot(coords=Coordinates([(0, 0), (1, 1)])),
+            AddPlot(coords=Coordinates([(0, 1), (1, 2)])),
+        ],
+    )
+)
+
+# Override cycle list with explicit styling
+plot = PGFPlot(
+    Axis(
+        cycle_list=["blue", "red", "green"],
+        plots=[
+            # This uses the cycle list (generates \addplot+)
+            AddPlot(coords=Coordinates([(0, 0), (1, 1)])),
+            # This overrides with explicit styling (generates \addplot)
+            AddPlot(color="purple", mark="x", coords=Coordinates([(0, 1), (1, 2)])),
+        ],
+    )
+)
+```
+
+## Documentation
+
+For complete documentation, visit: **[Documentation Site](https://tlamadon.github.io/texer)**
+
+Or build the docs locally:
+
+```bash
+pip install -e ".[docs]"
+mkdocs serve
+```
+
+Then open http://127.0.0.1:8000
+
+## Key Features
+
+- **Data-driven**: Separate structure from data
+- **Type-safe**: Full type hints and mypy support
+- **Glom-style specs**: Familiar pattern for data extraction
+- **LaTeX best practices**: Automatic escaping, booktabs tables
+- **NumPy integration**: Direct support for NumPy arrays
+- **PDF compilation**: Built-in `compile=True` option in `evaluate()`
+
+## Core Concepts
+
+texer uses **specs** to describe how to extract and transform data:
+
+- **`Ref("path")`** - Access data by path (e.g., `Ref("user.name")`)
+- **`Iter(source, template=...)`** - Loop over collections
+- **`Format(value, ".2f")`** - Format values
+- **`Cond(test, if_true, if_false)`** - Conditional logic
+- **`Raw(r"\textbf{bold}")`** - Unescaped LaTeX
+
+See the [Core Concepts](docs/getting-started/core-concepts.md) guide for details.
+
+## LaTeX Requirements
+
+For PDF compilation, you need a LaTeX distribution:
+
+- **Ubuntu/Debian**: `sudo apt-get install texlive-latex-base texlive-pictures`
+- **macOS**: `brew install --cask mactex`
+- **Windows**: [MiKTeX](https://miktex.org/) or [TeX Live](https://www.tug.org/texlive/)
+
+## Development
+
+```bash
+# Install dev dependencies
+pip install -e ".[dev]"
+
+# Run tests
+pytest
+
+# Type checking
+mypy src
+```
+
+## License
+
+MIT

texer-0.5.12.dist-info/RECORD

@@ -0,0 +1,11 @@
+texer/__init__.py,sha256=IvFrW7nmFkj_v3OHW7E8nl6EoKuE2qFpdRTXpwkmP3Y,856
+texer/eval.py,sha256=K7hM4o2y2alM0xTEVQoCz9MFSAYFgFf-xoWCXiN81gM,8966
+texer/pgfplots.py,sha256=cLhEL5CgyB16UdPrRxmLCd8OR_uONBXAv7kd9CYPQaI,51656
+texer/specs.py,sha256=RCHhK01YeJU7qL2E9sHBNiJrbL6j3V5wfnT9stZTm44,17070
+texer/tables.py,sha256=vLHbGt8pn8w5n9deD3JmD6M49M46mb0q1fCJLRibX2k,10053
+texer/utils.py,sha256=Y-eneJzArMSU_6Kdqf_iIOklc1rHEQ4cFk7SxtcNjH8,8814
+texer-0.5.12.dist-info/licenses/LICENSE,sha256=dUhuoK-TCRQMpuLEAdfme-qPSJI0TlcH9jlNxeg9_EQ,1056
+texer-0.5.12.dist-info/METADATA,sha256=6c9zumIyRBEk26yOfcZc3v-JcR_1XC5p7p5qDP8Rww4,7233
+texer-0.5.12.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+texer-0.5.12.dist-info/top_level.txt,sha256=c4hgYulO-XqUdfmX4S2j8rubo5KjdvsqhgaVmDsVgkU,6
+texer-0.5.12.dist-info/RECORD,,

texer-0.5.12.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

texer-0.5.12.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024
+
+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.

texer-0.5.12.dist-info/top_level.txt

@@ -0,0 +1 @@
+texer