pandas-render 0.2.1__tar.gz → 0.3.1__tar.gz

pandas_render-0.3.1/.gitignore

@@ -0,0 +1,371 @@
+examples/dev_*.ipynb
+
+# Created by https://www.toptal.com/developers/gitignore/api/macos,dotenv,python,windows,intellij,visualstudiocode
+# Edit at https://www.toptal.com/developers/gitignore?templates=macos,dotenv,python,windows,intellij,visualstudiocode
+
+### dotenv ###
+.env
+
+### Intellij ###
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider
+# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
+
+# User-specific stuff
+.idea/**/workspace.xml
+.idea/**/tasks.xml
+.idea/**/usage.statistics.xml
+.idea/**/dictionaries
+.idea/**/shelf
+
+# AWS User-specific
+.idea/**/aws.xml
+
+# Generated files
+.idea/**/contentModel.xml
+
+# Sensitive or high-churn files
+.idea/**/dataSources/
+.idea/**/dataSources.ids
+.idea/**/dataSources.local.xml
+.idea/**/sqlDataSources.xml
+.idea/**/dynamic.xml
+.idea/**/uiDesigner.xml
+.idea/**/dbnavigator.xml
+
+# Gradle
+.idea/**/gradle.xml
+.idea/**/libraries
+
+# Gradle and Maven with auto-import
+# When using Gradle or Maven with auto-import, you should exclude module files,
+# since they will be recreated, and may cause churn.  Uncomment if using
+# auto-import.
+# .idea/artifacts
+# .idea/compiler.xml
+# .idea/jarRepositories.xml
+# .idea/modules.xml
+# .idea/*.iml
+# .idea/modules
+# *.iml
+# *.ipr
+
+# CMake
+cmake-build-*/
+
+# Mongo Explorer plugin
+.idea/**/mongoSettings.xml
+
+# File-based project format
+*.iws
+
+# IntelliJ
+out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Cursive Clojure plugin
+.idea/replstate.xml
+
+# SonarLint plugin
+.idea/sonarlint/
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties
+
+# Editor-based Rest Client
+.idea/httpRequests
+
+# Android studio 3.1+ serialized cache file
+.idea/caches/build_file_checksums.ser
+
+### Intellij Patch ###
+# Comment Reason: https://github.com/joeblau/gitignore.io/issues/186#issuecomment-215987721
+
+# *.iml
+# modules.xml
+# .idea/misc.xml
+# *.ipr
+
+# Sonarlint plugin
+# https://plugins.jetbrains.com/plugin/7973-sonarlint
+.idea/**/sonarlint/
+
+# SonarQube Plugin
+# https://plugins.jetbrains.com/plugin/7238-sonarqube-community-plugin
+.idea/**/sonarIssues.xml
+
+# Markdown Navigator plugin
+# https://plugins.jetbrains.com/plugin/7896-markdown-navigator-enhanced
+.idea/**/markdown-navigator.xml
+.idea/**/markdown-navigator-enh.xml
+.idea/**/markdown-navigator/
+
+# Cache file creation bug
+# See https://youtrack.jetbrains.com/issue/JBR-2257
+.idea/$CACHE_FILE$
+
+# CodeStream plugin
+# https://plugins.jetbrains.com/plugin/12206-codestream
+.idea/codestream.xml
+
+# Azure Toolkit for IntelliJ plugin
+# https://plugins.jetbrains.com/plugin/8053-azure-toolkit-for-intellij
+.idea/**/azureSettings.xml
+
+### macOS ###
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+### macOS Patch ###
+# iCloud generated files
+*.icloud
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+### Python Patch ###
+# Poetry local configuration file - https://python-poetry.org/docs/configuration/#local-configuration
+poetry.toml
+
+# ruff
+.ruff_cache/
+
+# LSP config files
+pyrightconfig.json
+
+### VisualStudioCode ###
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+!.vscode/*.code-snippets
+
+# Local History for Visual Studio Code
+.history/
+
+# Built Visual Studio Code Extensions
+*.vsix
+
+### VisualStudioCode Patch ###
+# Ignore all local history of files
+.history
+.ionide
+
+### Windows ###
+# Windows thumbnail cache files
+Thumbs.db
+Thumbs.db:encryptable
+ehthumbs.db
+ehthumbs_vista.db
+
+# Dump file
+*.stackdump
+
+# Folder config file
+[Dd]esktop.ini
+
+# Recycle Bin used on file shares
+$RECYCLE.BIN/
+
+# Windows Installer files
+*.cab
+*.msi
+*.msix
+*.msm
+*.msp
+
+# Windows shortcuts
+*.lnk
+
+# End of https://www.toptal.com/developers/gitignore/api/macos,dotenv,python,windows,intellij,visualstudiocode

pandas_render-0.3.1/CHANGELOG.md

@@ -0,0 +1,62 @@
+# Changelog
+
+## [0.3.1](https://github.com/nok/pandas-render/compare/v0.3.0...v0.3.1) (2025-04-21)
+
+
+### Documentation
+
+* Add support section ([4e0cea3](https://github.com/nok/pandas-render/commit/4e0cea3c4ff6357d9245ac61ef3fbb447b081dfd))
+* Enclose installation commands in quotes ([b97c250](https://github.com/nok/pandas-render/commit/b97c2500598ef120897f56fad6b1e57efed290f3))
+* Remove installation instructions and repository links from examples ([89fc056](https://github.com/nok/pandas-render/commit/89fc0569c36036b48b6ca6096816e183876e0378))
+* Remove license badge ([f5e8483](https://github.com/nok/pandas-render/commit/f5e84835f745c8a1c447d03a655beea1293b3095))
+* Use full image url ([d14fec3](https://github.com/nok/pandas-render/commit/d14fec36c49242c3966a68bf3c657c3e9cdbfa38))
+
+## 0.3.0 (2025-04-16)
+
+
+### ⚠ BREAKING CHANGES
+
+* Rename 'columns' to 'templates' in rendering functions for clarity
+
+### Features
+
+* Add and support `polars` DataFrame and Series ([033e2ed](https://github.com/nok/pandas-render/commit/033e2ed2a6846b94629f0527ae0c082c1c662d4a))
+* Add CLI command `pandas serve` for serving local files ([22df404](https://github.com/nok/pandas-render/commit/22df40499b97b183771e3a7e71acd9d66cca38fe))
+* Add custom column names for rendered dataframes ([7406f68](https://github.com/nok/pandas-render/commit/7406f688c88022c6de8770f756305b32852a0f6b))
+* Add examples ([258e92f](https://github.com/nok/pandas-render/commit/258e92f700fa27be92dce7dccfa1277bc34d8846))
+* Add gallery rendering feature for DataFrames ([489c27e](https://github.com/nok/pandas-render/commit/489c27ea91381c255db7f46ee623d15e65a795d6))
+* Add GitHub workflows for release and testing automation ([653ba4f](https://github.com/nok/pandas-render/commit/653ba4f6b96174a6cc54de14403bb3d95f403eb2))
+* Add Makefile for linting, testing, and setup tasks ([9f88e56](https://github.com/nok/pandas-render/commit/9f88e56c2f23db44066cdc7f92b90459c4f633d3))
+* Add option to hide table header ([42236be](https://github.com/nok/pandas-render/commit/42236be39e03512ec7ca5312fd3820a8490bf3d2))
+* Enhance Image and Link elements with default attributes ([d846a07](https://github.com/nok/pandas-render/commit/d846a072aafc9f545480e9169753916a9dc779f5))
+* Improve column order logic ([4037e76](https://github.com/nok/pandas-render/commit/4037e7635439b3e6f8730dcbfd3e58e51a1d728a))
+
+
+### Bug Fixes
+
+* Add missing dependencies ([88314c8](https://github.com/nok/pandas-render/commit/88314c8551031533fa503a3c6380cda0b02fdad0))
+* Ease versions of dependencies (main) ([42721ae](https://github.com/nok/pandas-render/commit/42721ae852b11d1d4cdfb543a08867dcfe9cffa8))
+* Update version number in tests to match current release ([bd9183f](https://github.com/nok/pandas-render/commit/bd9183f68d4adfebf6e9e5bc88caef247989c3ec))
+
+
+### Documentation
+
+* Add contributing guidelines and restructure development section in README ([8e9517c](https://github.com/nok/pandas-render/commit/8e9517c774d55e9b96d47505ec3388d2877e1f78))
+* Add funding configuration ([b973af4](https://github.com/nok/pandas-render/commit/b973af4df10a9cbf77887d1808e98b8165a6b370))
+* Add note on following Conventional Commits standard ([3d97b40](https://github.com/nok/pandas-render/commit/3d97b403d703cd2c450b527c90b86a306bc5b106))
+* Adjust image height in README for better display ([43c3776](https://github.com/nok/pandas-render/commit/43c377610cc1e5db1720adb9eb3c0fbf567f84b8))
+* Enhance README and examples ([5b1502e](https://github.com/nok/pandas-render/commit/5b1502e001e332f87bf684176bb3f91a6897847f))
+* Fix links in README for contributing guidelines and license ([a734694](https://github.com/nok/pandas-render/commit/a734694f8f1fc69fc14b93121deb72d7a4962242))
+* Update badge links for clarity and consistency ([25511ba](https://github.com/nok/pandas-render/commit/25511ba74faee3ae1a9a747a37f688a8d5b97ae8))
+* Update README to include development instructions and uv package management ([721c331](https://github.com/nok/pandas-render/commit/721c33129e87dca4f96efcd5285833c9ffa6d278))
+* Update README with enhanced description and add logo image ([a00e6cb](https://github.com/nok/pandas-render/commit/a00e6cbe2eb8fe859a88f489d83eae6303d30692))
+
+
+### Miscellaneous Chores
+
+* Release 0.3.0 ([67dc2a7](https://github.com/nok/pandas-render/commit/67dc2a795fe708bdf3ad565204bd213f3c37bf9c))
+
+
+### Code Refactoring
+
+* Rename 'columns' to 'templates' in rendering functions for clarity ([5f0dbe8](https://github.com/nok/pandas-render/commit/5f0dbe85f52ed79788a04c3c3d5db4cbc6c7f81f))

pandas_render-0.3.1/CONTRIBUTING.md

@@ -0,0 +1,50 @@
+## Development
+
+We rely on [uv](https://docs.astral.sh/uv/) for package management. Ensure uv is installed before proceeding.
+
+In addition we follow the [Conventional Commits](https://www.conventionalcommits.org/) standard to maintain a clear and organized commit history.
+
+### Environment
+
+To create a new local environment in `./.venv`, run:
+```bash
+uv sync --all-groups
+```
+
+Alternatively, execute:
+```bash
+make setup
+```
+
+Both commands will set up your environment with the necessary dependencies.
+
+### Testing
+
+To run all unit tests based on [pytest](https://github.com/pytest-dev/pytest/), run:
+```bash
+uv run pytest --cov-report term --cov-report html --cov
+```
+
+Alternatively, execute:
+```bash
+make test
+```
+
+### Linting
+
+We use [ruff](https://github.com/astral-sh/ruff) for linting.
+
+Install ruff using:
+```bash
+uv tool install ruff
+```
+
+Run the following command to analyze linting issues:
+```bash
+uvx ruff check .
+```
+
+Alternatively, execute:
+```bash
+make lint
+```

{pandas-render-0.2.1 → pandas_render-0.3.1}/LICENSE

@@ -1,6 +1,7 @@
 BSD 3-Clause License
 
-Copyright (c) 2021, Darius Morawiec
+Copyright (c) 2021-Present, Darius Morawiec
+
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

pandas_render-0.3.1/PKG-INFO

@@ -0,0 +1,103 @@
+Metadata-Version: 2.4
+Name: pandas-render
+Version: 0.3.1
+Summary: A pandas extension for rendering DataFrames
+Project-URL: Repository, https://github.com/nok/pandas-render
+Project-URL: Issues, https://github.com/nok/pandas-render/issues
+Author-email: Darius Morawiec <nok@users.noreply.github.com>
+License-Expression: BSD-3-Clause
+License-File: LICENSE
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Scientific/Engineering :: Visualization
+Requires-Python: >=3.9
+Requires-Dist: ipython>=7.11.1
+Requires-Dist: jinja2>=3.0.0
+Requires-Dist: typer>=0.15.2
+Provides-Extra: examples
+Requires-Dist: jupyterlab>=4.3.6; extra == 'examples'
+Provides-Extra: pandas
+Requires-Dist: pandas>=1.0.0; extra == 'pandas'
+Provides-Extra: polars
+Requires-Dist: polars>=1.0.0; extra == 'polars'
+Description-Content-Type: text/markdown
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/nok/pandas-render/refs/heads/main/assets/pandas-render.png" alt="pandas-render" height=130>
+</p>
+
+<h1 align="center">pandas-render</h1>
+
+<p align="center">Render <a href="https://github.com/pandas-dev/pandas" target="_pandas">pandas</a> or <a href="https://github.com/pola-rs/polars" target="_polars">polars</a> DataFrames and Series as HTML tables with flexibility for formatting and styling.</p>
+
+<div align="center">
+
+![GitHub Repo stars](https://img.shields.io/github/stars/nok/pandas-render)
+[![Ko-fi](https://img.shields.io/badge/Ko--fi-FF5E5B?logo=ko-fi&logoColor=white)](https://ko-fi.com/nok)
+
+</div>
+
+
+## Installation
+
+```bash
+pip install "pandas-render[pandas]"
+```
+
+```bash
+pip install "pandas-render[polars]"
+```
+
+
+## Usage
+
+This is a simple example that demonstrates the basic functionality. The column names are used to match individual [Jinja2](https://github.com/pallets/jinja) templates. And `{{ content }}` is the placeholder for the content of the original cell.
+
+```python
+from pandas_render import pandas as pd
+
+df = pd.DataFrame(
+    [
+        dict(name="Alice", age=25, hobbies=["coding"]),
+        dict(name="Bob", age=30, hobbies=["reading", "hiking"]),
+    ]
+)
+
+df.render(
+    templates=dict(
+        name="<strong>{{ content }}</strong>",
+        age="{{ content }} years old",
+        hobbies="<em>{{ content|join(', ') }}</em>",
+    ),
+    table_column_names=["Name", "Age", "Hobbies"],
+)
+```
+
+The result is a rendered dataframe:
+
+<table class="dataframe"><thead><tr><th>Name</th><th>Age</th><th>Hobbies</th></tr></thead><tbody><tr><td><strong>Alice</strong></td><td>25 years old</td><td><em>coding</em></td></tr><tr><td><strong>Bob</strong></td><td>30 years old</td><td><em>reading, hiking</em></td></tr></tbody></table>
+
+
+## Examples
+
+Exciting and more powerful features can be explored and learned in the [Getting Started](examples/01_getting_started.ipynb) notebook.
+
+List of all notebooks with examples:
+
+- [Getting Started](examples/01_getting_started.ipynb) ✨
+- [Components](examples/02_components.ipynb)
+
+
+## Support
+
+Do you like this project? Fuel it with a ☕ coffee on [Ko-fi](https://ko-fi.com/nok). Every little bit helps and means a lot!
+
+
+## Contributing
+
+We encourage you to contribute to this project! Please check out the [contributing guidelines](CONTRIBUTING.md) about how to proceed.
+
+
+## License
+
+This package is Open Source Software released under the [BSD-3-Clause](LICENSE) license.

pandas_render-0.3.1/README.md

@@ -0,0 +1,79 @@
+<p align="center">
+  <img src="https://raw.githubusercontent.com/nok/pandas-render/refs/heads/main/assets/pandas-render.png" alt="pandas-render" height=130>
+</p>
+
+<h1 align="center">pandas-render</h1>
+
+<p align="center">Render <a href="https://github.com/pandas-dev/pandas" target="_pandas">pandas</a> or <a href="https://github.com/pola-rs/polars" target="_polars">polars</a> DataFrames and Series as HTML tables with flexibility for formatting and styling.</p>
+
+<div align="center">
+
+![GitHub Repo stars](https://img.shields.io/github/stars/nok/pandas-render)
+[![Ko-fi](https://img.shields.io/badge/Ko--fi-FF5E5B?logo=ko-fi&logoColor=white)](https://ko-fi.com/nok)
+
+</div>
+
+
+## Installation
+
+```bash
+pip install "pandas-render[pandas]"
+```
+
+```bash
+pip install "pandas-render[polars]"
+```
+
+
+## Usage
+
+This is a simple example that demonstrates the basic functionality. The column names are used to match individual [Jinja2](https://github.com/pallets/jinja) templates. And `{{ content }}` is the placeholder for the content of the original cell.
+
+```python
+from pandas_render import pandas as pd
+
+df = pd.DataFrame(
+    [
+        dict(name="Alice", age=25, hobbies=["coding"]),
+        dict(name="Bob", age=30, hobbies=["reading", "hiking"]),
+    ]
+)
+
+df.render(
+    templates=dict(
+        name="<strong>{{ content }}</strong>",
+        age="{{ content }} years old",
+        hobbies="<em>{{ content|join(', ') }}</em>",
+    ),
+    table_column_names=["Name", "Age", "Hobbies"],
+)
+```
+
+The result is a rendered dataframe:
+
+<table class="dataframe"><thead><tr><th>Name</th><th>Age</th><th>Hobbies</th></tr></thead><tbody><tr><td><strong>Alice</strong></td><td>25 years old</td><td><em>coding</em></td></tr><tr><td><strong>Bob</strong></td><td>30 years old</td><td><em>reading, hiking</em></td></tr></tbody></table>
+
+
+## Examples
+
+Exciting and more powerful features can be explored and learned in the [Getting Started](examples/01_getting_started.ipynb) notebook.
+
+List of all notebooks with examples:
+
+- [Getting Started](examples/01_getting_started.ipynb) ✨
+- [Components](examples/02_components.ipynb)
+
+
+## Support
+
+Do you like this project? Fuel it with a ☕ coffee on [Ko-fi](https://ko-fi.com/nok). Every little bit helps and means a lot!
+
+
+## Contributing
+
+We encourage you to contribute to this project! Please check out the [contributing guidelines](CONTRIBUTING.md) about how to proceed.
+
+
+## License
+
+This package is Open Source Software released under the [BSD-3-Clause](LICENSE) license.