Polars RefKit

Parse, inspect, render, and format BibTeX columns inside Polars eager and lazy queries. Each source row owns an independent bibliography and citation state.

Documentation · Expression reference · Python objects

Render a citation column

Install in Python 3.11 through 3.14 with Polars 1.29 or newer:

python -m pip install polars-refkit

import polars as pl
import polars_refkit

frame = pl.DataFrame(
    {
        "bibtex": ["@article{doe2024, author={Doe, Jane}, title={Fast Citations}, year={2024}}"],
        "key": ["doe2024"],
    }
)
result = frame.select(
    citation=pl.col("bibtex").refkit.cite("key"),
    entries=pl.col("bibtex").refkit.entry_count(),
)
print(result.to_dicts())

[{'citation': '(Doe, 2024)', 'entries': 1}]

Importing polars_refkit registers pl.Expr.refkit. A string argument names a column. Use pl.lit(...) for literal bibliography text or citation keys.

Choose an operation

Task Expressions
Parse and inspect entry_count, keys, entries, can_parse, diagnostics, has_diagnostics, parse_report
Render citations cite, cite_each, cite_group
Render every entry full_bibliography
Inspect render failures render_report
Format and deduplicate tidy_bibtex, tidy_bibtex_report

Choose output="text", "html", or "rendered" on rendering expressions. Pass formatting settings as an options= dictionary. Value expressions return null on row-local failures. Reports retain structured diagnostics, errors, or rename records beside the source row.

Use with agents

The package includes version-matched task guidance:

import polars_refkit.agent

help(polars_refkit.agent)

Agent integration covers discovery. Data shapes defines reports and Pyodide records the tested browser runtime.

RefKit is alpha software. Public APIs may change before 1.0.

Apache-2.0 license · Upstream notices

Project links

Data verified by PyPI on Sep 8, 2026
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (0.3.0)

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for peter-gy from gravatar.com peter-gy

Credits

Author: Péter Ferenc Gyarmati

GitHub Statistics

Data verified by PyPI on Sep 8, 2026
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

License expression

Apache-2.0
View SPDX License List

Requires

Python <3.15, >=3.11

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

polars_refkit-0.0.8.tar.gz (93.0 kB view details)

Uploaded Source

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

polars_refkit-0.0.8-cp311-abi3-win_amd64.whl (6.1 MB view details)

Uploaded CPython 3.11+Windows x86-64

polars_refkit-0.0.8-cp311-abi3-pyemscripten_2026_0_wasm32.whl (3.8 MB view details)

Uploaded CPython 3.11+PyEmscripten 2026.0 wasm32

polars_refkit-0.0.8-cp311-abi3-manylinux_2_34_x86_64.whl (6.2 MB view details)

Uploaded CPython 3.11+manylinux: glibc 2.34+ x86-64

polars_refkit-0.0.8-cp311-abi3-macosx_11_0_arm64.whl (5.3 MB view details)

Uploaded CPython 3.11+macOS 11.0+ ARM64

File details

Details for the file polars_refkit-0.0.8.tar.gz.

File metadata

  • Download URL: polars_refkit-0.0.8.tar.gz
  • Upload date:
  • Size: 93.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.12.10 {"installer":{"name":"uv","version":"0.12.10","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for polars_refkit-0.0.8.tar.gz
Algorithm Hash digest
SHA256 ca1c305315139c9444976571da219034edf750ffd06ccd97cb672cb8ba32e07f
MD5 f63ab397d03fba8f61fd1309089feb01
BLAKE2b-256 f3c737db5ede07ddbac6ddf3329926aa2c79a8c1319cf041723a2acd3d896579

See more details on using hashes here.

File details

Details for the file polars_refkit-0.0.8-cp311-abi3-win_amd64.whl.

File metadata

  • Download URL: polars_refkit-0.0.8-cp311-abi3-win_amd64.whl
  • Upload date:
  • Size: 6.1 MB
  • Tags: CPython 3.11+, Windows x86-64
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.12.10 {"installer":{"name":"uv","version":"0.12.10","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for polars_refkit-0.0.8-cp311-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 ad146e7c523cd605cb06ac11baaff5f5d053a7104acd4aaec7597b8ecb6d6094
MD5 863eb840c28f08ab5e8b6ffdf94189cb
BLAKE2b-256 caf6f1bd28fa08a982f80d0632e28e2743693492b42da4bd6f8f1e806953622a

See more details on using hashes here.

File details

Details for the file polars_refkit-0.0.8-cp311-abi3-pyemscripten_2026_0_wasm32.whl.

File metadata

  • Download URL: polars_refkit-0.0.8-cp311-abi3-pyemscripten_2026_0_wasm32.whl
  • Upload date:
  • Size: 3.8 MB
  • Tags: CPython 3.11+, PyEmscripten 2026.0 wasm32
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.12.10 {"installer":{"name":"uv","version":"0.12.10","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for polars_refkit-0.0.8-cp311-abi3-pyemscripten_2026_0_wasm32.whl
Algorithm Hash digest
SHA256 113dead77509479bc7f231a52150980dcb5f3dc2795c2b83d41e723e6f0622d2
MD5 617f484ba11b9b8767a2c24341c4a99c
BLAKE2b-256 49541e0de4ca3f8fba707ee7f17a29c5473c15987cc4822b2ed765ae620dc49a

See more details on using hashes here.

File details

Details for the file polars_refkit-0.0.8-cp311-abi3-manylinux_2_34_x86_64.whl.

File metadata

  • Download URL: polars_refkit-0.0.8-cp311-abi3-manylinux_2_34_x86_64.whl
  • Upload date:
  • Size: 6.2 MB
  • Tags: CPython 3.11+, manylinux: glibc 2.34+ x86-64
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.12.10 {"installer":{"name":"uv","version":"0.12.10","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for polars_refkit-0.0.8-cp311-abi3-manylinux_2_34_x86_64.whl
Algorithm Hash digest
SHA256 7c04e3db061ba5a983f17996ea6ec00979eb0e9296515786e62f8cd3b2c66e9f
MD5 68fb821ded4207db359e3d2a9c271d14
BLAKE2b-256 b4d378aa77b92a558ab2798fc94057bba8c50fba6ef149005dd8401b4f6852df

See more details on using hashes here.

File details

Details for the file polars_refkit-0.0.8-cp311-abi3-macosx_11_0_arm64.whl.

File metadata

  • Download URL: polars_refkit-0.0.8-cp311-abi3-macosx_11_0_arm64.whl
  • Upload date:
  • Size: 5.3 MB
  • Tags: CPython 3.11+, macOS 11.0+ ARM64
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.12.10 {"installer":{"name":"uv","version":"0.12.10","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for polars_refkit-0.0.8-cp311-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 93c9a0211e79f75184234028bf7d33bc409d6bac2baa4eebf45a43e2436dbfb7
MD5 a4fd8b014ac133b8133ebe6cee362241
BLAKE2b-256 cee7d67c0bbff797bdcb9577cec1b6db2164365cd40d0f93123b18cf8cd4fc8f

See more details on using hashes here.

Release history Release notifications | RSS feed

0.3.0

5 files

0.2.1

5 files

0.2.0

5 files

0.1.1

5 files

0.1.0

5 files

This release

0.0.8 This release

5 files

0.0.7

5 files

0.0.5

5 files

Pre-release

0.0.4rc5

5 files

Pre-release

0.0.4rc4

5 files

Pre-release

0.0.4rc3

5 files

Pre-release

0.0.4rc2

5 files

Pre-release

0.0.4rc1

5 files

0.0.3

5 files

0.0.2

5 files

0.0.1

4 files

0.0.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page