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

Uploaded CPython 3.10+Windows x86-64

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

Uploaded CPython 3.10+PyEmscripten 2026.0 wasm32

polars_refkit-0.1.1-cp310-abi3-manylinux_2_34_x86_64.whl (6.2 MB view details)

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

polars_refkit-0.1.1-cp310-abi3-macosx_11_0_arm64.whl (5.3 MB view details)

Uploaded CPython 3.10+macOS 11.0+ ARM64

File details

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

File metadata

  • Download URL: polars_refkit-0.1.1.tar.gz
  • Upload date:
  • Size: 93.5 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.1.1.tar.gz
Algorithm Hash digest
SHA256 9180c6e9699583e8880fe1537b0506d5ff38895da5d33de836430a304cf08907
MD5 75e816c75ad9a5d2c52d2cb4ba7e22bf
BLAKE2b-256 2e82b6792f6b553373a658907cfe2d29ba7fe3a0488368ddce978d9100641423

See more details on using hashes here.

File details

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

File metadata

  • Download URL: polars_refkit-0.1.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.1.1-cp310-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 a5a2a6d4fefaff2d6a9b25d98640feca192f2ed0a010102fb17d2a34eabc9429
MD5 abaea94ee3179b58293e9b2d938684b6
BLAKE2b-256 b33f4801116913d36498ece94629157cbf33b3179681b74a371847fba5b24ad9

See more details on using hashes here.

File details

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

File metadata

  • Download URL: polars_refkit-0.1.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.1.1-cp310-abi3-pyemscripten_2026_0_wasm32.whl
Algorithm Hash digest
SHA256 522cd2d71ac476d86f37b5fe025ddccd0be2b932472b7efb6bdb9208ce463f77
MD5 3f4c10519335764ce32dbfc32ba91ad1
BLAKE2b-256 bcc4cb85880d4079fa1dcb2c0763cbaa8488478c70010892a29792f3bfa15c22

See more details on using hashes here.

File details

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

File metadata

  • Download URL: polars_refkit-0.1.1-cp310-abi3-manylinux_2_34_x86_64.whl
  • Upload date:
  • Size: 6.2 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.1.1-cp310-abi3-manylinux_2_34_x86_64.whl
Algorithm Hash digest
SHA256 8ef1c73e31464a1247e49efaaeac9f2e73b66969658830b4b2c8de417ad069b2
MD5 1fc8e8fe51dacb4d90859b66e6886914
BLAKE2b-256 8bbbe09bdaf8af49968346cae240950771dcae1802aaa02ce80862336d2dba0e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: polars_refkit-0.1.1-cp310-abi3-macosx_11_0_arm64.whl
  • Upload date:
  • Size: 5.3 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.1.1-cp310-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 4e329396008198dcb9b1b6e09edef98ecc11a82b3fdc7efa959c0323a84af8da
MD5 9f2836f364d3a135a7bc0f23bc16c055
BLAKE2b-256 bb97d8944f2b092241288594d8a1c14f4baa0c8db804ee3658ab7ccf26059147

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

This release

0.1.1 This release

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