ssb-flextab 0.9.2__tar.gz

ssb_flextab-0.9.2/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright © 2026 Kristian LØønø
+
+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.

ssb_flextab-0.9.2/PKG-INFO

@@ -0,0 +1,108 @@
+Metadata-Version: 2.4
+Name: ssb-flextab
+Version: 0.9.2
+Summary: SSB flextab
+License-Expression: MIT
+License-File: LICENSE
+Author: Kristian Lønø
+Author-email: krl@ssb.no
+Maintainer: Statistics Norway, IT-Architecture Department (702)
+Requires-Python: >=3.12
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Dist: numpy (>=2.2.6,<3.0.0)
+Requires-Dist: openpyxl (>=3.1.0,<4.0.0)
+Requires-Dist: pandas (>=2.2.3,<4.0.0)
+Requires-Dist: pandas-stubs (>=3.0.5.260730,<4.0.0.0)
+Project-URL: Changelog, https://github.com/statisticsnorway/ssb-flextab/releases
+Project-URL: Documentation, https://statisticsnorway.github.io/ssb-flextab
+Project-URL: Homepage, https://github.com/statisticsnorway/ssb-flextab
+Project-URL: Repository, https://github.com/statisticsnorway/ssb-flextab
+Description-Content-Type: text/markdown
+
+# SSB flextab
+
+[![PyPI](https://img.shields.io/pypi/v/ssb-flextab.svg)][pypi status]
+[![Status](https://img.shields.io/pypi/status/ssb-flextab.svg)][pypi status]
+[![Python Version](https://img.shields.io/pypi/pyversions/ssb-flextab)][pypi status]
+[![License](https://img.shields.io/pypi/l/ssb-flextab)][license]
+
+[![Documentation](https://github.com/statisticsnorway/ssb-flextab/actions/workflows/docs.yml/badge.svg)][documentation]
+[![Tests](https://github.com/statisticsnorway/ssb-flextab/actions/workflows/tests.yml/badge.svg)][tests]
+[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=statisticsnorway_ssb-flextab&metric=coverage)][sonarcov]
+[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=statisticsnorway_ssb-flextab&metric=alert_status)][sonarquality]
+
+[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)][pre-commit]
+[![Black](https://img.shields.io/badge/code%20style-black-000000.svg)][black]
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+[![Poetry](https://img.shields.io/endpoint?url=https://python-poetry.org/badge/v0.json)][poetry]
+
+[pypi status]: https://pypi.org/project/ssb-flextab/
+[documentation]: https://statisticsnorway.github.io/ssb-flextab
+[tests]: https://github.com/statisticsnorway/ssb-flextab/actions?workflow=Tests
+[sonarcov]: https://sonarcloud.io/summary/overall?id=statisticsnorway_ssb-flextab
+[sonarquality]: https://sonarcloud.io/summary/overall?id=statisticsnorway_ssb-flextab
+[pre-commit]: https://github.com/pre-commit/pre-commit
+[black]: https://github.com/psf/black
+[poetry]: https://python-poetry.org/
+
+## Features
+
+Flextab is a Python package for making *flex*ible *tab*ulation. It is made with Claude AI, models Sonnet 4.5 and Sonnet 5.
+
+Flextab is inspired by the Sas procedure [proc tabulate]( https://documentation.sas.com/doc/en/pgmsascdc/9.4_3.5/proc/n00yutbvvckjwrn1ldg5xkvjy1pu.htm) which again was based on the [tpl language](https://en.wikipedia.org/wiki/TPL_Tables)
+
+It makes flexible tables in two dimensions, rows an columns, based on Pandas dataframes.
+
+## Requirements
+
+- pandas
+- numpy
+- openpyxl when exporting tables to Excel
+
+## Installation
+
+You can install _SSB flextab_ via [pip] from [PyPI]:
+
+```console
+pip install ssb-flextab
+```
+
+## Usage
+
+A [tutorial](docs/flextab_tutorial.md) is found in the in the `docs` folder.
+
+## Contributing
+
+Contributions are very welcome.
+To learn more, see the [Contributor Guide].
+
+## License
+
+Distributed under the terms of the [MIT license][license],
+_SSB flextab_ is free and open source software.
+
+## Issues
+
+If you encounter any problems,
+please [file an issue] along with a detailed description.
+
+## Credits
+
+This project was generated from [Statistics Norway]'s [SSB PyPI Template].
+
+[statistics norway]: https://www.ssb.no/en
+[pypi]: https://pypi.org/
+[ssb pypi template]: https://github.com/statisticsnorway/ssb-pypitemplate
+[file an issue]: https://github.com/statisticsnorway/ssb-flextab/issues
+[pip]: https://pip.pypa.io/
+
+<!-- github-only -->
+
+[license]: https://github.com/statisticsnorway/ssb-flextab/blob/main/LICENSE
+[contributor guide]: https://github.com/statisticsnorway/ssb-flextab/blob/main/CONTRIBUTING.md
+[reference guide]: https://statisticsnorway.github.io/ssb-flextab/reference.html
+

ssb_flextab-0.9.2/README.md

@@ -0,0 +1,82 @@
+# SSB flextab
+
+[![PyPI](https://img.shields.io/pypi/v/ssb-flextab.svg)][pypi status]
+[![Status](https://img.shields.io/pypi/status/ssb-flextab.svg)][pypi status]
+[![Python Version](https://img.shields.io/pypi/pyversions/ssb-flextab)][pypi status]
+[![License](https://img.shields.io/pypi/l/ssb-flextab)][license]
+
+[![Documentation](https://github.com/statisticsnorway/ssb-flextab/actions/workflows/docs.yml/badge.svg)][documentation]
+[![Tests](https://github.com/statisticsnorway/ssb-flextab/actions/workflows/tests.yml/badge.svg)][tests]
+[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=statisticsnorway_ssb-flextab&metric=coverage)][sonarcov]
+[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=statisticsnorway_ssb-flextab&metric=alert_status)][sonarquality]
+
+[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)][pre-commit]
+[![Black](https://img.shields.io/badge/code%20style-black-000000.svg)][black]
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+[![Poetry](https://img.shields.io/endpoint?url=https://python-poetry.org/badge/v0.json)][poetry]
+
+[pypi status]: https://pypi.org/project/ssb-flextab/
+[documentation]: https://statisticsnorway.github.io/ssb-flextab
+[tests]: https://github.com/statisticsnorway/ssb-flextab/actions?workflow=Tests
+[sonarcov]: https://sonarcloud.io/summary/overall?id=statisticsnorway_ssb-flextab
+[sonarquality]: https://sonarcloud.io/summary/overall?id=statisticsnorway_ssb-flextab
+[pre-commit]: https://github.com/pre-commit/pre-commit
+[black]: https://github.com/psf/black
+[poetry]: https://python-poetry.org/
+
+## Features
+
+Flextab is a Python package for making *flex*ible *tab*ulation. It is made with Claude AI, models Sonnet 4.5 and Sonnet 5.
+
+Flextab is inspired by the Sas procedure [proc tabulate]( https://documentation.sas.com/doc/en/pgmsascdc/9.4_3.5/proc/n00yutbvvckjwrn1ldg5xkvjy1pu.htm) which again was based on the [tpl language](https://en.wikipedia.org/wiki/TPL_Tables)
+
+It makes flexible tables in two dimensions, rows an columns, based on Pandas dataframes.
+
+## Requirements
+
+- pandas
+- numpy
+- openpyxl when exporting tables to Excel
+
+## Installation
+
+You can install _SSB flextab_ via [pip] from [PyPI]:
+
+```console
+pip install ssb-flextab
+```
+
+## Usage
+
+A [tutorial](docs/flextab_tutorial.md) is found in the in the `docs` folder.
+
+## Contributing
+
+Contributions are very welcome.
+To learn more, see the [Contributor Guide].
+
+## License
+
+Distributed under the terms of the [MIT license][license],
+_SSB flextab_ is free and open source software.
+
+## Issues
+
+If you encounter any problems,
+please [file an issue] along with a detailed description.
+
+## Credits
+
+This project was generated from [Statistics Norway]'s [SSB PyPI Template].
+
+[statistics norway]: https://www.ssb.no/en
+[pypi]: https://pypi.org/
+[ssb pypi template]: https://github.com/statisticsnorway/ssb-pypitemplate
+[file an issue]: https://github.com/statisticsnorway/ssb-flextab/issues
+[pip]: https://pip.pypa.io/
+
+<!-- github-only -->
+
+[license]: https://github.com/statisticsnorway/ssb-flextab/blob/main/LICENSE
+[contributor guide]: https://github.com/statisticsnorway/ssb-flextab/blob/main/CONTRIBUTING.md
+[reference guide]: https://statisticsnorway.github.io/ssb-flextab/reference.html

ssb_flextab-0.9.2/pyproject.toml

@@ -0,0 +1,178 @@
+[project]
+name = "ssb-flextab"
+version = "0.9.2"
+description = "SSB flextab"
+authors = [{ name = "Kristian Lønø", email = "krl@ssb.no" }]
+maintainers = [{ name = "Statistics Norway, IT-Architecture Department (702)" }]
+license = "MIT"
+readme = "README.md"
+requires-python = ">=3.12"
+dynamic = ["classifiers"]
+dependencies = [
+    "numpy>=2.2.6,<3.0.0",
+    "pandas>=2.2.3,<4.0.0",
+    "openpyxl>=3.1.0,<4.0.0",
+    "pandas-stubs (>=3.0.5.260730,<4.0.0.0)",
+]
+
+[project.urls]
+homepage = "https://github.com/statisticsnorway/ssb-flextab"
+repository = "https://github.com/statisticsnorway/ssb-flextab"
+documentation = "https://statisticsnorway.github.io/ssb-flextab"
+Changelog = "https://github.com/statisticsnorway/ssb-flextab/releases"
+
+[project.scripts]
+ssb-flextab = "ssb_flextab.__main__:main"
+
+[dependency-groups]
+lint = [
+    "black[jupyter]>=25.11.0",
+    "pre-commit>=4.4.0",
+    "pre-commit-hooks>=6.0.0",
+    "pydoclint>=0.8.3",
+    "ruff>=0.14.5",
+]
+doc = [
+    "furo>=2025.9.25",
+    "myst-parser>=4.0.1",
+    "sphinx>=8.2.3",
+    "sphinx-autobuild>=2025.8.25",
+    "sphinx-autodoc-typehints>=3.5.2",
+    "sphinx-click>=6.1.0",
+]
+
+# Type hint stubs should be placed in the dev dependency group
+dev = [
+    {include-group = "lint"},
+    {include-group = "doc"},
+    "coverage[toml]>=7.11.3",
+    "deptry>=0.24.0; python_version < '4.0'",
+    "ipykernel>=7.3.0,<8.0.0",
+    "mypy>=1.18.2",
+    "pygments>=2.19.0",
+    "pytest>=9.0.0",
+    "typeguard>=2.13.3",
+    "xdoctest[colors]>=1.3.0",
+    "pandas-stubs (>=3.0.5.260730,<4.0.0.0)",
+    "types-openpyxl (>=3.1.5.20260827,<4.0.0.0)",
+]
+
+[tool.poetry]
+classifiers = ["Development Status :: 4 - Beta"]
+requires-poetry = ">=2.3"
+packages = [{ include = "ssb_flextab", from = "src" }]
+
+[tool.poetry.requires-plugins]
+poetry-plugin-export = ">=1.9"
+
+[tool.pytest.ini_options]
+pythonpath = ["src"]
+
+[tool.coverage.paths]
+source = ["src", "*/site-packages"]
+tests = ["tests", "*/tests"]
+
+[tool.coverage.run]
+branch = true
+source = ["ssb_flextab", "tests"]
+relative_files = true
+
+[tool.coverage.report]
+show_missing = true
+fail_under = 50
+
+[tool.deptry.per_rule_ignores]
+DEP001 = ["nox", "nox_poetry"]  # packages available by default
+
+[tool.mypy]
+mypy_path = "src"
+strict = true
+warn_unreachable = true
+pretty = true
+show_column_numbers = true
+show_error_context = true
+
+[tool.pydoclint]
+style = "numpy"
+exclude = '\.git|\.nox'
+arg-type-hints-in-docstring = true
+check-return-types = false
+check-yield-types = false
+allow-init-docstring = true
+quiet = true
+
+[tool.ruff]
+force-exclude = true  # Apply excludes to pre-commit
+show-fixes = true
+src = ["src", "tests"]
+target-version = "py313"  # Minimum Python version supported
+include = ["*.py", "*.pyi", "**/pyproject.toml", "*.ipynb"]
+extend-exclude = [
+    "__pycache__",
+    "old",
+    ".ipynb_checkpoints",
+    "noxfile.py",
+    "docs/conf.py",
+]
+
+# Ruff rules may be customized as desired: https://docs.astral.sh/ruff/rules/
+[tool.ruff.lint]
+select = [
+    "A",    # prevent using keywords that clobber python builtins
+    "ANN",  # check type annotations
+    "B",    # bugbear: security warnings
+    "D",    # documentation
+    "E",    # pycodestyle
+    "F",    # pyflakes
+    "ISC",  # implicit string concatenation
+    "I",    # sort imports
+    "UP",   # alert you when better syntax is available in your python version
+    "RUF",  # the ruff developer's own rules
+]
+ignore = [
+    "ANN202", # Don't require return type annotation for private functions.
+    "ANN401", # Allow type annotation with type Any.
+    "D100",   # Supress undocumented-public-module. Only doc of public api required.
+    "FBT001", # Allow boolean positional arguments in a function.
+    "FBT002", # Allow boolean default positional arguments in a function.
+    "E402",   # Supress module-import-not-at-top-of-file, needed in jupyter notebooks.
+    "E501",   # Supress line-too-long warnings: trust black's judgement on this one.
+    "PLR2004", # Allow to compare with unnamed numerical constants.
+]
+external = ["DOC"]  # Avoiding removing any codes starting with `DOC` from any `# noqa` directives.
+
+[tool.ruff.lint.isort]
+force-single-line = true
+
+[tool.ruff.lint.mccabe]
+max-complexity = 15
+
+[tool.ruff.lint.pydocstyle]
+convention = "numpy"  # You can also use "google".
+
+[tool.ruff.lint.pylint]
+max-args = 8
+
+[tool.ruff.lint.pep8-naming]
+classmethod-decorators = ["classmethod", "validator", "root_validator", "pydantic.validator"]
+
+[tool.ruff.lint.per-file-ignores]
+"*/__init__.py" = ["F401"]
+"**/tests/*" = [
+    "ANN001",  # type annotations don't add value for test functions
+    "ANN002",  # type annotations don't add value for test functions
+    "ANN003",  # type annotations don't add value for test functions
+    "ANN201",  # type annotations don't add value for test functions
+    "ANN204",  # type annotations don't add value for test functions
+    "ANN205",  # type annotations don't add value for test functions
+    "ANN206",  # type annotations don't add value for test functions
+    "D100",    # docstrings are overkill for test functions
+    "D101",
+    "D102",
+    "D103",
+    "S101",    # asserts are encouraged in pytest
+]
+
+[build-system]
+requires = ["poetry-core>=2.0.0,<3.0.0"]
+build-backend = "poetry.core.masonry.api"

ssb_flextab-0.9.2/src/ssb_flextab/__init__.py

@@ -0,0 +1,13 @@
+"""Tools for creating flexible summary tables with pandas."""
+
+from .flextab import flextab
+from .formatting import flextab_to_markdown
+from .formatting import flextab_to_string
+from .result import FlextabResult
+
+__all__ = [
+    "FlextabResult",
+    "flextab",
+    "flextab_to_markdown",
+    "flextab_to_string",
+]