Metadata-Version: 2.4
Name: sandhi
Version: 1.0.0
Summary: Sanskrit Sandhi Module
Home-page: https://github.com/hrishikeshrt/sandhi
Author: Hrishikesh Terdalkar
Author-email: hrishikeshrt@linuxmail.org
License: GNU General Public License v3
Keywords: sandhi
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Requires-Python: >=3.6
Description-Content-Type: text/x-rst
License-File: LICENSE
License-File: AUTHORS.rst
Requires-Dist: indic_transliteration
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: keywords
Dynamic: license
Dynamic: license-file
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

===============
Sanskrit Sandhi
===============


.. image:: https://img.shields.io/pypi/v/sandhi
        :target: https://pypi.python.org/pypi/sandhi


.. image:: https://readthedocs.org/projects/sandhi/badge/?version=latest
        :target: https://sandhi.readthedocs.io/en/latest/?version=latest
        :alt: Documentation Status

.. image:: https://img.shields.io/pypi/pyversions/sandhi
        :target: https://pypi.python.org/pypi/sandhi
        :alt: Python Version Support

.. image:: https://img.shields.io/github/issues/hrishikeshrt/sandhi
        :target: https://github.com/hrishikeshrt/sandhi/issues
        :alt: GitHub Issues

.. image:: https://img.shields.io/github/followers/hrishikeshrt?style=social
        :target: https://github.com/hrishikeshrt
        :alt: GitHub Followers


.. image:: https://img.shields.io/twitter/follow/hrishikeshrt?style=social
        :target: https://twitter.com/hrishikeshrt
        :alt: Twitter Followers



Sanskrit Sandhi Module


* Free software: GNU General Public License v3
* Documentation: https://sandhi.readthedocs.io.


Features
========

* Form Sandhi using Ashtadhyayi Rules

Install
=======

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

.. code-block:: console

    $ pip install sandhi

Usage
=====

Library
-------

To use Sanskrit Sandhi in a project,

.. code-block:: python

    import sandhi

    S = sandhi.Sandhi()
    sandhi = S.sandhi("रामः", "राजमणिः")

    # print(sandhi)
    # [['रामो राजमणिः', 'ससजुषो रुः (८।२।६६)-> हशि च (६।१।११४)-> आद् गुणः (६।१।८७)', 'रुत्व-> उत्व-> गुण-सन्धिः']]

Command-line
------------

After installation, a ``sandhi`` command is available:

.. code-block:: console

    $ sandhi रामः राजमणिः
    1. रामो राजमणिः | ससजुषो रुः (८।२।६६)-> हशि च (६।१।११४)-> आद् गुणः (६।१।८७) | रुत्व-> उत्व-> गुण-सन्धिः

To print only the resulting forms (without sutra and sandhi type), use:

.. code-block:: console

    $ sandhi --quiet रामः राजमणिः
    रामो राजमणिः

Credits
=======

* This package was converted from Perl version obtainable from Samsaadhanii_
* This package was created with Cookiecutter_ and the `hrishikeshrt/cookiecutter-pypackage`_ project template.

.. _Samsaadhanii: https://github.com/samsaadhanii/scl
.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`hrishikeshrt/cookiecutter-pypackage`: https://github.com/hrishikeshrt/cookiecutter-pypackage


History
=======

1.0.0 (2025-12-10)
------------------

* Marked the project as Production/Stable and bumped the version to 1.0.0.
* Implemented a usable command-line interface (``sandhi``) wrapping ``sandhi.Sandhi``.
* Documented CLI usage alongside the library API in ``README.rst`` and ``USAGE.rst``.
* Added tests for the CLI to complement the existing rule and transliteration tests.
* Updated CI and metadata for consistent Python 3 support.

0.1.0 (2022-07-03)
------------------

* First release on PyPI.
