Metadata-Version: 1.1
Name: transliterate
Version: 0.1
Summary: Transliteration app for Python
Home-page: https://bitbucket.org/barseghyanartur/transliterate
Author: Artur Barseghyan
Author-email: artur.barseghyan@gmail.com
License: GPL 2.0/LGPL 2.1
Description: Package
        ==================================
        transliterate
        
        Description
        ==================================
        Transliterator for Python. Transliterates (unicode) strings according to the rules specified in the language packs.
        
        Installation
        ==================================
        1. Install translit into your Python path:
        
            $ pip install transliterate
        
        That's all. See the `Usage and examples` section for more.
        
        Usage and examples
        ==================================
        Required imports
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        >>> from transliterate import autodiscover
        >>> from transliterate.utils import translit, get_available_languages
        
        Original text
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        >>> text = "Lorem ipsum dolor sit amet"
        
        Transliteration to Armenian
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        >>> print translit(text, 'am')
        Լօրեմ իպսում դօլօր սիտ ամետ
        
        Transliteration to Russian
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        >>> print translit(text, 'ru')
        Лорэм ипсум долор сит амэт
        
        List of available (registered) languages
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        >>> print get_available_languages()
        ['ru', 'hy']
        
        Reversed transliteration from Armenian
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        >>> text = "Լօրեմ իպսում դօլօր սիտ ամետ"
        >>> print translit(text, 'hy', reversed=True)
        Lorem ipsum dolor sit amet
        
        Reversed transliteration from Russian
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        >>> text = "Лорем ипсум долор сит амет"
        >>> print translit(text, 'ru', reversed=True)
        Lorеm ipsum dolor sit amеt
        
        Testing the decorator
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        >>> from transliterate.decorators import transliterate_function
        >>> @transliterate_function(language_code='hy')
        >>> def decorator_test(text):
        >>>     return text
        >>>
        >>> print decorator_test(u"Lorem ipsum dolor sit amet")
        Լօրեմ իպսում դօլօր սիտ ամետ
        
        Registering a custom language pack
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        >>> from transliterate.base import TranslitLanguagePack, registry
        >>>
        >>> class ExampleLanguagePack(TranslitLanguagePack):
        >>>     language_code = "example"
        >>>     language_name = "Example"
        >>>     mapping = (
        >>>         u"abcdefghij",
        >>>         u"1234567890",
        >>>     )
        >>>
        >>> registry.register(ExampleLanguagePack)
        >>>
        >>> print get_available_languages()
        ['ru', 'hy', 'example']
        >>> 
        >>> print translit(text, 'example')
        Lor5m 9psum 4olor s9t 1m5t
        
        Missing a language pack?
        ==================================
        Missing a language pack for your own language? Contribute to the project by making one and it will appear in a new
        version (which will be released very quickly).
        
        License
        ==================================
        GPL 2.0/LGPL 2.1
        
        Support
        ==================================
        For any issues contact me at the e-mail given in the `Author` section.
        
        Author
        ==================================
        Artur Barseghyan <artur.barseghyan@gmail.com>
        
Keywords: translit,transliteration
Platform: UNKNOWN
Classifier: Programming Language :: Python
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
