sanskrit-text 1.0.0

Sanskrit Text Utility Functions

Sanskrit Text (Devanagari) Utility Functions

• Free software: GNU General Public License v3

• Documentation: https://sanskrit-text.readthedocs.io.

Features

• Syllabification

• Varṇa Viccheda

• Pratyāhāra Encoding-Decoding

• Uccāraṇa Sthāna Yatna Utility

• Several other utility functions

Install

To install Sanskrit Text, run this command in your terminal:

$ pip install sanskrit-text

Usage

Python API

import sanskrit_text as skt

text = "कवि भारतः"

# Clean text (keep only Sanskrit letters and spaces)
clean_text = skt.clean(text)

# Syllabification
syllables = skt.get_syllables(text)

# Varṇa decomposition and join
viccheda = skt.split_varna(text, technical=True, flat=True)
reconstructed = skt.join_varna(viccheda)

# Ucchāraṇa information
ucchaarana = skt.get_ucchaarana(text)
signature = skt.get_signature(text)

Command Line Interface

After installation, the skt command provides a small CLI:

# Clean text
$ echo "अ b १।" | skt clean
अ

# Get syllables (JSON output)
$ skt syllables "कवि भारतः"

# Varṇa decomposition (technical, flat list)
$ skt split-varna --technical --flat "कवि भारतः"

# Ucchāraṇa and signature (JSON output)
$ skt ucchaarana "कवि"
$ skt signature "कवि"

Credits

This package was created with Cookiecutter and the hrishikeshrt/cookiecutter-pypackage project template.

History

Unreleased

• Add a command-line interface (skt) with subcommands for cleaning text, obtaining syllables and varṇa decomposition.

• Add a basic unit test suite covering core utilities and the CLI.

• Fix marker_to_swara for extended mātrā characters.

• Update packaging metadata and Trove classifiers for a production-ready release.

0.2.3 (2022-09-14)

• Clarify documentation for join_varna and update general project documentation.

0.2.2 (2022-09-13)

• Add two missing nuktā consonants to the alphabet definitions.

0.2.1 (2022-09-07)

• Resolve a merge issue affecting the codebase.

0.2.0 (2022-09-07)

• Reformat code with Black and improve documentation.

0.1.1 (2022-07-05)

• Packaging and release metadata updates.

0.1.0 (2022-07-03)

• First release on PyPI.