viracitapada

Performs metrical analysis on ISO-15919-transliterated Sanskrit verses.

Features

• usable as a library in arbitrary projects (no CLI included, yet)
• parses lines of text into a metrical notation of long/short markers via parse_meter (see examples below)
• annotates the tokens of lines of text with their metrical position via annotate_metrical_pos (see examples below)

Installation

An example using pip:

pip install -U viracitapada

Usage

parse_meter as well as annotate_metrical_pos will return the same type of data you threw at them. This can be either a single line of text as a str ("line one"), multiple lines of text as a str ("line one\nline two\nline three") or a list[str] containing a line of text per string (["line one", "line two", "line three"]).

Some examples:

import viracitapada as vp

vp.parse_meter("agním īḷe puróhitaṁ")
# —◡ —— ◡—◡—

vp.parse_meter("úṣo yé te ̀ prá yā́meṣu yuñjáte")
# ◡— — — · ◡ ——◡ —◡— (" `" as pause)

vp.parse_meter(
    "kadā́ vaso ̀ stotráṁ háryate ā́",
    long_mark="L",
    short_mark="S",
    pause_mark="P",
)
# "SL SL P LL LSL L"

vp.parse_meter("agním īḷe puróhitaṁ\nyajñásya devám r̥tvíjam\nhótāraṁ ratnadhā́tamam")
# —◡ —— ◡—◡—\n——◡ —◡ —◡—\n——— —◡—◡—

vp.parse_meter([
    "agním īḷe puróhitaṁ",
    "yajñásya devám r̥tvíjam",
    "hótāraṁ ratnadhā́tamam",
])
# ["—◡ —— ◡—◡—", "——◡ —◡ —◡—", "——— —◡—◡—"]

vp.annotate_metrical_pos("agním īḷe puróhitaṁ")
# 1_agním 3_īḷe 5_puróhitaṁ

vp.annotate_metrical_pos(
    "agním īḷe puróhitaṁ\nyajñásya devám r̥tvíjam\nhótāraṁ ratnadhā́tamam"
)
# 1_agním 3_īḷe 5_puróhitaṁ\n1_yajñásya 4_devám 6_r̥tvíjam\n1_hótāraṁ 4_ratnadhā́tamam

vp.annotate_metrical_pos([
    "agním īḷe puróhitaṁ",
    "yajñásya devám r̥tvíjam",
    "hótāraṁ ratnadhā́tamam",
])
# ["1_agním 3_īḷe 5_puróhitaṁ", "1_yajñásya 4_devám 6_r̥tvíjam", "1_hótāraṁ 4_ratnadhā́tamam"]

Development

This project uses uv to manage dependencies. Install uv to make use of the following commands.

Install library and dependencies in a local virtual environment:

uv sync

Check code formatting, run linter:

uv run ruff format . --check
uv run ruff check .

Format code and fix linter errors:

uv run ruff format .
uv run ruff check . --fix

Run mypy to check typing:

uv run mypy

Run tests and measure test coverage:

uv run coverage run -m pytest

Run specific tests file:

uv run coverage run -m pytest tests/test_clean.py

Print coverage report of last measured test run:

uv run coverage report -m

Run everything from above to make sure things are working and in good shape (on Unix-like systems):

./pre-commit.sh