typ-tables 0.1.0__tar.gz

typ_tables-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 Benjamin Askew-Gale
+
+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.

typ_tables-0.1.0/PKG-INFO

@@ -0,0 +1,108 @@
+Metadata-Version: 2.4
+Name: typ-tables
+Version: 0.1.0
+Summary: Add your description here
+Keywords: tables,Typst
+Author: Benjamin Askew-Gale
+License-Expression: MIT
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Scientific/Engineering :: Visualization
+Project-URL: homepage, https://github.com/BenGale93/typ-tables
+Project-URL: documentation, https://bengale93.github.io/typ-tables/
+Requires-Python: >=3.11
+Requires-Dist: narwhals>=2.7.0
+Description-Content-Type: text/markdown
+
+# typ-tables
+
+Inspired by
+[great_tables](https://posit-dev.github.io/great-tables/articles/intro.html), a
+way to turn DataFrames into Typst tables.
+
+Tables that look like
+
+![rendered table](./docs/images/readme_snippet.png)
+
+Created using the following Python script:
+
+```python
+import polars as pl
+from typ_tables import TypTable
+
+df = pl.DataFrame(
+    {
+        "string": ["a", "b", "c"],
+        "int": [10, 10000, 1000000],
+        "float": [0.000001, 0.1368753, 163985.8374],
+    }
+)
+
+table = TypTable(df)
+result = table.to_typst()
+```
+
+Which gives you the following typst snippet:
+
+```typ
+#table(
+  columns: 3,
+  column-gutter: (),
+  row-gutter: (),
+  stroke: none,
+  align: (auto, auto, auto),
+  inset: 0% + 5pt,
+  table.header(table.cell(
+  stroke: (bottom: 1.2pt),
+  [string],
+), table.cell(
+  stroke: (bottom: 1.2pt),
+  [int],
+), table.cell(
+  stroke: (bottom: 1.2pt),
+  [float],
+),),
+  table.cell(
+  colspan: 1,
+  stroke: (bottom: 0.6pt),
+  [a],
+), table.cell(
+  colspan: 1,
+  stroke: (bottom: 0.6pt),
+  [10],
+), table.cell(
+  colspan: 1,
+  stroke: (bottom: 0.6pt),
+  [1e-06],
+),
+  table.cell(
+  colspan: 1,
+  stroke: (bottom: 0.6pt),
+  [b],
+), table.cell(
+  colspan: 1,
+  stroke: (bottom: 0.6pt),
+  [10000],
+), table.cell(
+  colspan: 1,
+  stroke: (bottom: 0.6pt),
+  [0.1368753],
+),
+  table.cell(
+  colspan: 1,
+  stroke: (bottom: 0.6pt),
+  [c],
+), table.cell(
+  colspan: 1,
+  stroke: (bottom: 0.6pt),
+  [1000000],
+), table.cell(
+  colspan: 1,
+  stroke: (bottom: 0.6pt),
+  [163985.8374],
+),
+)
+```

typ_tables-0.1.0/README.md

@@ -0,0 +1,89 @@
+# typ-tables
+
+Inspired by
+[great_tables](https://posit-dev.github.io/great-tables/articles/intro.html), a
+way to turn DataFrames into Typst tables.
+
+Tables that look like
+
+![rendered table](./docs/images/readme_snippet.png)
+
+Created using the following Python script:
+
+```python
+import polars as pl
+from typ_tables import TypTable
+
+df = pl.DataFrame(
+    {
+        "string": ["a", "b", "c"],
+        "int": [10, 10000, 1000000],
+        "float": [0.000001, 0.1368753, 163985.8374],
+    }
+)
+
+table = TypTable(df)
+result = table.to_typst()
+```
+
+Which gives you the following typst snippet:
+
+```typ
+#table(
+  columns: 3,
+  column-gutter: (),
+  row-gutter: (),
+  stroke: none,
+  align: (auto, auto, auto),
+  inset: 0% + 5pt,
+  table.header(table.cell(
+  stroke: (bottom: 1.2pt),
+  [string],
+), table.cell(
+  stroke: (bottom: 1.2pt),
+  [int],
+), table.cell(
+  stroke: (bottom: 1.2pt),
+  [float],
+),),
+  table.cell(
+  colspan: 1,
+  stroke: (bottom: 0.6pt),
+  [a],
+), table.cell(
+  colspan: 1,
+  stroke: (bottom: 0.6pt),
+  [10],
+), table.cell(
+  colspan: 1,
+  stroke: (bottom: 0.6pt),
+  [1e-06],
+),
+  table.cell(
+  colspan: 1,
+  stroke: (bottom: 0.6pt),
+  [b],
+), table.cell(
+  colspan: 1,
+  stroke: (bottom: 0.6pt),
+  [10000],
+), table.cell(
+  colspan: 1,
+  stroke: (bottom: 0.6pt),
+  [0.1368753],
+),
+  table.cell(
+  colspan: 1,
+  stroke: (bottom: 0.6pt),
+  [c],
+), table.cell(
+  colspan: 1,
+  stroke: (bottom: 0.6pt),
+  [1000000],
+), table.cell(
+  colspan: 1,
+  stroke: (bottom: 0.6pt),
+  [163985.8374],
+),
+)
+```

typ_tables-0.1.0/pyproject.toml

@@ -0,0 +1,129 @@
+[project]
+name = "typ-tables"
+dynamic = []
+description = "Add your description here"
+readme = "README.md"
+requires-python = ">=3.11"
+dependencies = [
+    "narwhals>=2.7.0",
+]
+license = "MIT"
+authors = [
+    { name = "Benjamin Askew-Gale" },
+]
+classifiers = [
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: Scientific/Engineering :: Visualization",
+]
+keywords = [
+    "tables",
+    "Typst",
+]
+version = "0.1.0"
+
+[project.urls]
+homepage = "https://github.com/BenGale93/typ-tables"
+documentation = "https://bengale93.github.io/typ-tables/"
+
+[project.scripts]
+
+[dependency-groups]
+dev = [
+    { include-group = "lint" },
+    { include-group = "test" },
+    { include-group = "typing" },
+]
+docs = [
+    "mkdocstrings>=1.0.4",
+    "mkdocstrings-python>=2.0.3",
+    "pillow>=12.2.0",
+    "zensical>=0.0.38",
+]
+lint = [
+    "ruff>=0.15.6",
+]
+test = [
+    "pytest>=9.0.2",
+    "pytest-randomly>=4.0.1",
+    "pytest-cov>=7.0.0",
+    "inline-snapshot>=0.32.5",
+    "polars>=1.39.3",
+    "typst>=0.14.8",
+    "pandas>=3.0.0",
+    "pyarrow>=20.0.0",
+]
+typing = [
+    "pyrefly>=0.61.0",
+]
+typing-test = [
+    { include-group = "test" },
+    { include-group = "typing" },
+]
+
+[build-system]
+requires = [
+    "pdm-backend==2.4.7",
+]
+build-backend = "pdm.backend"
+
+[tool.pdm.version]
+source = "scm"
+
+[tool.uv]
+resolution = "lowest-direct"
+
+[tool.ruff]
+line-length = 100
+target-version = "py311"
+
+[tool.ruff.format]
+docstring-code-format = true
+
+[tool.ruff.lint]
+select = [
+    "ALL",
+]
+ignore = [
+    "COM812",
+    "ISC001",
+    "ANN401",
+    "SLF001",
+    "DTZ",
+]
+
+[tool.ruff.lint.per-file-ignores]
+"tests/**" = [
+    "D",
+    "S",
+    "ANN",
+    "PLR2004",
+]
+
+[tool.ruff.lint.pydocstyle]
+convention = "google"
+
+[tool.coverage.report]
+exclude_also = [
+    "if t.TYPE_CHECKING",
+    "@t.overload",
+    "@abstractmethod",
+    "if TYPE_CHECKING",
+]
+show_missing = true
+
+[tool.coverage.run]
+branch = true
+
+[tool.pytest.ini_options]
+addopts = "--cov=src/ --cov-report="
+filterwarnings = [
+    "ignore::DeprecationWarning::",
+    "default::DeprecationWarning:typ-tables.*:",
+]
+
+[tool.inline-snapshot]
+format-command = "uv run ruff format --stdin-filename {filename}"