Metadata-Version: 1.1
Name: PyAvroPhonetic
Version: 0.1.2
Summary: Python implementation of Avro Phonetic
Home-page: https://github.com/kaustavdm/pyAvroPhonetic
Author: Kaustav Das Modak
Author-email: kaustav.dasmodak@yahoo.co.in
License: GNU GPL v3 or later
Description: ==============
        pyAvroPhonetic
        ==============
        
        A Python implementation of the popular Bengali phonetic-typing software
        `Avro Phonetic`_.
        
        Branch: Master: |Master| | Develop: |Develop|
        
        Overview
        ========
        
        pyAvroPhonetic provides a Python package that can be imported and used
        by other Python programs or scripts. It implements the *Avro Phonetic
        Dictionary Search Library* by `Mehdi Hasan Khan`_.
        
        *N.B. This package is still experimental and is not (yet) fit for
        production use.*
        
        Inspirations
        ------------
        
        This package is inspired from `Rifat Nabi`_\'s `jsAvroPhonetic`_. So
        far, the code is a direct (and shameless) translation of
        jsAvroPhonetic into Python.
        
        Installation
        ============
        
        Using Git:
        
        ::
        
            $ git clone https://github.com/kaustavdm/pyAvroPhonetic
            $ cd pyAvroPhonetic
            $ sudo python setup.py install
        
        
        Using Pip:
        
        ::
        
            $ sudo pip install PyAvroPhonetic
        
        
        Usage
        =====
        
        At present only a subset of features have been implemented. When
        implemented, the parser can be accessed as:
        
        ::
        
            >>> from pyavrophonetic import avro
            >>> avro.parse('aami banglay gaan gai')
        
        Contributing
        ============
        
        **Fork** -> **Do your changes** -> **Send a Pull Request**. It's that
        easy!
        
        Coding style follows `PEP 8`_ along with `PEP 257`_ for Docstring
        conventions.
        
        Also, if you find any bugs, please report them in the Issues queue. As
        always, before you report any new issue, please check that it has not
        been already posted by someone else.
        
        License
        =======
        
        Copyright (C) 2013 Kaustav Das Modak <kaustav.dasmodak@yahoo.co.in>.
        
        ::
        
            This file is part of pyAvroPhonetic.
        
            pyAvroPhonetic is free software: you can redistribute it and/or modify
            it under the terms of the GNU General Public License as published by
            the Free Software Foundation, either version 3 of the License, or
            (at your option) any later version.
        
            pyAvroPhonetic is distributed in the hope that it will be useful,
            but WITHOUT ANY WARRANTY; without even the implied warranty of
            MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
            GNU General Public License for more details.
        
            You should have received a copy of the GNU General Public License
            along with pyAvroPhonetic.  If not, see <http://www.gnu.org/licenses/>.
        
        The full license text can be found in ``LICENSE``.
        
        .. _Avro Phonetic: http://omicronlab.com
        .. _Mehdi Hasan Khan: https://github.com/omicronlab
        .. _Rifat Nabi: https://github.com/torifat
        .. _jsAvroPhonetic: https://github.com/torifat/jsAvroPhonetic
        .. _PEP 8: http://www.python.org/dev/peps/pep-0008/
        .. _PEP 257: http://www.python.org/dev/peps/pep-0257/
        .. |Master| image:: https://travis-ci.org/kaustavdm/pyAvroPhonetic.png?branch=master
           :target: https://travis-ci.org/kaustavdm/pyAvroPhonetic
        .. |Develop| image:: https://travis-ci.org/kaustavdm/pyAvroPhonetic.png?branch=develop
           :target: https://travis-ci.org/kaustavdm/pyAvroPhonetic
        
Platform: UNKNOWN
Classifier: Development Status :: 1 - Planning
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 2.5
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
