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.10 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

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.10

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.2.1.tar.gz (93.2 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.2.1-cp310-abi3-win_amd64.whl (6.1 MB view details)

Uploaded CPython 3.10+Windows x86-64

polars_refkit-0.2.1-cp310-abi3-pyemscripten_2026_0_wasm32.whl (3.8 MB view details)

Uploaded CPython 3.10+PyEmscripten 2026.0 wasm32

polars_refkit-0.2.1-cp310-abi3-manylinux_2_34_x86_64.whl (6.1 MB view details)

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

polars_refkit-0.2.1-cp310-abi3-macosx_11_0_arm64.whl (5.2 MB view details)

Uploaded CPython 3.10+macOS 11.0+ ARM64

File details

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

File metadata

  • Download URL: polars_refkit-0.2.1.tar.gz
  • Upload date:
  • Size: 93.2 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.2.1.tar.gz
Algorithm Hash digest
SHA256 d126245afa0eac5d2602545302fbba29aa4631744625367cd244dbfcc8fe6d2c
MD5 322ac75945f3c4184a55d31a570cc71d
BLAKE2b-256 f4a06e17ed75560342bdc6023b9f6d199bad3a3fb8c3b9b1a530ef706a108930

See more details on using hashes here.

File details

Details for the file polars_refkit-0.2.1-cp310-abi3-win_amd64.whl.

File metadata

  • Download URL: polars_refkit-0.2.1-cp310-abi3-win_amd64.whl
  • Upload date:
  • Size: 6.1 MB
  • Tags: CPython 3.10+, 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.2.1-cp310-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 26016b6fdaa0d616586af5acd2b18d81447bd30bfd0b40591edab30ed6402136
MD5 61c208ea386424fe5574815612dbc4d4
BLAKE2b-256 69e1a582da597cad2ebab08a974ac5ea1c33f3f6fff853581c1093f93da0ad35

See more details on using hashes here.

File details

Details for the file polars_refkit-0.2.1-cp310-abi3-pyemscripten_2026_0_wasm32.whl.

File metadata

  • Download URL: polars_refkit-0.2.1-cp310-abi3-pyemscripten_2026_0_wasm32.whl
  • Upload date:
  • Size: 3.8 MB
  • Tags: CPython 3.10+, 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.2.1-cp310-abi3-pyemscripten_2026_0_wasm32.whl
Algorithm Hash digest
SHA256 01115addd89bc1f53490f8d75205ca1bbf0a90b5c714acc334e0552be8d78466
MD5 434d2c7e590c5c30460badb46d0d0cd6
BLAKE2b-256 f213c4f785270a7539d2397c0249c9db798a75a1502d5f369b3106eb9b3084b9

See more details on using hashes here.

File details

Details for the file polars_refkit-0.2.1-cp310-abi3-manylinux_2_34_x86_64.whl.

File metadata

  • Download URL: polars_refkit-0.2.1-cp310-abi3-manylinux_2_34_x86_64.whl
  • Upload date:
  • Size: 6.1 MB
  • Tags: CPython 3.10+, 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.2.1-cp310-abi3-manylinux_2_34_x86_64.whl
Algorithm Hash digest
SHA256 a15c9e1bb06e782d207a8faeb692a7d8dbe9bd3534545d876cf865798441b2f4
MD5 0a042ae77b7d14cc4b85113c9bf2340b
BLAKE2b-256 484997241c7cb5e58ff23abe5f86acad0707c459faf2793b1f52d7c667bc5166

See more details on using hashes here.

File details

Details for the file polars_refkit-0.2.1-cp310-abi3-macosx_11_0_arm64.whl.

File metadata

  • Download URL: polars_refkit-0.2.1-cp310-abi3-macosx_11_0_arm64.whl
  • Upload date:
  • Size: 5.2 MB
  • Tags: CPython 3.10+, 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.2.1-cp310-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 33e734a30efb337c2c0ea568de9fa51e8ab61d2f69838ae91e3841ea56024103
MD5 bb13ef4182f32ed8279c1fbe8316e16d
BLAKE2b-256 5b21bca6cc2c7c3bf4f92148bd47598772ac28de309047bdf97462d903cd73a4

See more details on using hashes here.

Release history Release notifications | RSS feed

0.3.0

5 files

This release

0.2.1 This release

5 files

0.2.0

5 files

0.1.1

5 files

0.1.0

5 files

0.0.8

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