Metadata-Version: 2.1
Name: text2ipa
Version: 1.4.1rc5
Summary: Converter from text to International Phonetic Alphabets
Home-page: https://github.com/tquangsdh20/text2ipa
Author: Joseph Quang
Author-email: tquang.sdh20@hcmut.edu.vn
License: Apache 2.0
Description: <p align="center">
        <img src="https://raw.githubusercontent.com/tquangsdh20/text2ipa/master/.github/logo.svg">
        <img src="https://github.com/tquangsdh20/text2ipa/actions/workflows/test.yml/badge.svg?style=plastic"> <a href="https://app.codecov.io/gh/tquangsdh20/text2ipa/blob/af74004d58fb4cde15ea29b1184fc7a025ca9fc2/text2ipa/__main__.py"><img src="https://codecov.io/gh/tquangsdh20/text2ipa/branch/master/graphs/badge.svg?branch=master"></a> <img src="https://img.shields.io/pypi/implementation/text2ipa"> <img src = "https://img.shields.io/pypi/pyversions/text2ipa"> <img src="https://img.shields.io/badge/author-tquangsdh20-orange">
        </p>
        
        
        
        ## Installation:
        
        **Windows**
        ```
        python -m pip install text2ipa
        ```
        **macOS**
        ```
        sudo pip3 install text2ipa
        ```
        **Linux**
        ```
        pip install text2ipa
        ```
        
        ## Features
        
        - Convert English text to IPA using the [toPhonetic](https://tophonetics.com/)
        - Two options Language English UK and English US
          
        ## Examples
        
        ### Example 1: Convert a text
        
        #### Function: 
        - `get_IPA()` : Converting a text to IPA with the following parameters 
        
        #### Parameters:
        
        - `text` : The text you want to convert to IPA
        - `language` : Choose between English US and English UK ('am'/'br')
        - `proxy` : Optional parameter  
        
        #### For instance:
        
        ```python
        from text2ipa import get_IPA
        text = 'hello world'
        language = 'am'
        #Convert 'hello world' to English US International Alphabet
        ipa = get_IPA(text,language)
        print(ipa)
        ```
        ```
        >> həˈloʊ wɜrld
        ```
        ### Example 2: Convert a bulk
        
        #### Function: 
        - `get_IPAs()` : Convert the list of texts to IPA return the list of IPAs 
        
        #### Parameters:
        
        - `bulk` : The list of text want to convert to IPA
        - `language` : Choose between English US and English UK ('am'/'br')
        - `proxy` : Optional parameter  
        
        #### For instance:
        
        ```python
        from text2ipa import get_IPAs
        bulk = ['how are you?','how it\'s going?','that\'s good']
        language = 'br'
        # Convert a list of text to English UK IPA
        IPAs = get_IPAs(bulk,language)
        for ipa in IPAs:
            print(ipa)
        ```
        
        ```
        >> haʊ ɑː juː?
        >> haʊ ɪts ˈgəʊɪŋ?
        >> ðæts gʊd
        ```
        
        #### Log Changes
        
        V1.0.0 : Create new with 2 functions `get_IPA()` and `get_IPAs()`  
        V1.2.0 : Update comment and guideline in functions, fixed ERROR for setup with the other Python versions  
        V1.3.0 : Fixed MISSING install requires and update information for Python versions  
        V1.4.0 : Update building & testing for this package  
        V1.4.1 : Update format Python PEP517 for this package  
        V1.4.2 : Update coverage test for this package  
        <a href="https://github.com/tquangsdh20/text2ipa"><p align="center"><img src="https://img.shields.io/badge/Github-tquangsdh20-orange?style=social&logo=github"></p></a>
        
Platform: unix
Platform: linux
Platform: osx
Platform: cygwin
Platform: win32
Platform: macOS
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: End Users/Desktop
Classifier: Development Status :: 5 - Production/Stable
Classifier: Operating System :: OS Independent
Classifier: License :: OSI Approved :: Apache Software License
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
Description-Content-Type: text/markdown
