Skip to main content

A Python library for working with digital scholarly editions in polars dataframes.

Project description

dse_polars

Work with DSE triples in a polars dataframe

Publishing for marimo HTML-WASM

This package ships as a pure-Python wheel (py3-none-any), so it can be installed in Pyodide-based marimo HTML-WASM notebooks as long as runtime package constraints are compatible.

Key compatibility choices in this project:

  • Requires-Python: >=3.13,<3.14
  • polars>=1.18.0

Build and publish:

python -m pip install -U build twine
python -m build
python -m twine check dist/*
python -m twine upload --repository testpypi dist/*
python -m twine upload dist/*

You can sanity-check that the wheel is pure Python by inspecting the wheel metadata:

unzip -p dist/*.whl '*.dist-info/WHEEL'

and confirming it includes:

Tag: py3-none-any

ctsurn_contains usage

ctsurn_contains returns a Polars expression, so you can use it directly in filter/select.

import polars as pl
from dse_polars.texts import ctsurn_contains

df = pl.DataFrame(
	{
		"urn": [
			"urn:cts:compnov:bible.genesis.sept_latin:1.1",
			"urn:cts:compnov:bible.genesis.sept_latin:2.1",
			"urn:cts:compnov:bible.exodus.sept_latin:1.1",
		]
	}
)

query = "urn:cts:compnov:bible.genesis:1"

matches = df.filter(ctsurn_contains(pl.col("urn"), query))
print(matches)

# quick boolean check with literals
is_contained = pl.select(
	ctsurn_contains(
		"urn:cts:compnov:bible.genesis.sept_latin:1.1",
		"urn:cts:compnov:bible.genesis:1",
	).alias("ok")
).item(0, 0)
print(is_contained)  # True

ptinrect usage

ptinrect returns a Polars expression, so you can use it directly in filter/select.

import polars as pl
from dse_polars.images import ptinrect

rects = pl.DataFrame(
	{
		"label": ["A", "B"],
		"x": [10.0, 100.0],
		"y": [20.0, 200.0],
		"w": [30.0, 20.0],
		"h": [40.0, 20.0],
	}
)

# filter rectangles containing a literal point (25, 35)
hits = rects.filter(ptinrect(25.0, 35.0))
print(hits)

# use point columns too
points = pl.DataFrame({"px": [25.0, 130.0], "py": [35.0, 210.0]})
checks = rects.with_columns(points).select(
	pl.col("label"),
	ptinrect(pl.col("px"), pl.col("py")).alias("contains_point"),
)
print(checks)

textcontents usage

textcontents returns a Python list of values in the text column, excluding nulls.

import polars as pl
from dse_polars.texts import textcontents

df = pl.DataFrame(
	{
		"urn": ["u1", "u2", "u3", "u4"],
		"text": ["alpha", None, "beta", "alpha"],
	}
)

contents = textcontents(df)
print(contents)  # ['alpha', 'beta', 'alpha']

Project details


Download files

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

Source Distribution

dse_polars-0.6.0.tar.gz (8.4 MB view details)

Uploaded Source

Built Distribution

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

dse_polars-0.6.0-py3-none-any.whl (8.3 kB view details)

Uploaded Python 3

File details

Details for the file dse_polars-0.6.0.tar.gz.

File metadata

  • Download URL: dse_polars-0.6.0.tar.gz
  • Upload date:
  • Size: 8.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for dse_polars-0.6.0.tar.gz
Algorithm Hash digest
SHA256 1775cbbe92edf882bc1ff06df5092b2fd78dca5801144a0c6644318adaae7003
MD5 4ebaea1d4971b7f51fbd843e50f9b683
BLAKE2b-256 7227737ba470c36669cbf5b4fe72bae9763cc9cba3d6621984682a0461e90870

See more details on using hashes here.

Provenance

The following attestation bundles were made for dse_polars-0.6.0.tar.gz:

Publisher: publish.yml on neelsmith/dse_polars

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file dse_polars-0.6.0-py3-none-any.whl.

File metadata

  • Download URL: dse_polars-0.6.0-py3-none-any.whl
  • Upload date:
  • Size: 8.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for dse_polars-0.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 631557996474fd2a4ac783c03c4d689b2007a385cbdb4265d55891f04b10116c
MD5 51ef209138db5e68338ced36fd6f2e56
BLAKE2b-256 7c220b758588fc0d7f8038ea98e3919a30af5bafe72488063f4fee310fb7ecf0

See more details on using hashes here.

Provenance

The following attestation bundles were made for dse_polars-0.6.0-py3-none-any.whl:

Publisher: publish.yml on neelsmith/dse_polars

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page