Metadata-Version: 2.1
Name: Caribe
Version: 0.0.6
Summary: Trinidad dialect to standard english
Home-page: UNKNOWN
Author: Keston Smith
Author-email: keston.smith@my.uwi.edu
License: MIT
Description: # Caribe 
        
        >This python library takes trinidadian dialect and converts it to standard english.
        Future updates would include the conversion of other caribbean dialects to standard english
        
        ____
        ## Installation
        Use the below command to install package/library
        ```
        pip install Caribe 
        
        ```
        ____
         ## Usage
         > Sample 1: Checks the dialect input against existing known phrases before decoding the sentence into a more standardized version of English language. A corrector is used to check and fix small grammatical errors.
        ```python
        # Sample 1
        import Caribe as cb
        from Caribe import trinidad_decode, trinidad_decode_split, caribe_corrector
        
        sentence = "Ah wah mi modda phone"
        standard = cb.phrase_decode(sentence)
        standard = cb.trinidad_decode(standard)
        fixed = cb.caribe_corrector(standard)
        print(fixed) #Output: I want my mother phone
        
        ```
        >Sample 2: Checks the dialect input against existing known phrases
        ```python
        # Sample 2 
        import Caribe as cb
        from Caribe import trinidad_decode, trinidad_decode_split, caribe_corrector
        
        sentence = "Waz de scene"
        standard = cb.phrase_decode(sentence)
        
        print(standard) # Outputs: How are you
        
        ```
        >Sample 3: Checks the sentence for any grammatical errors or incomplete words and corrects it.
        ```python
        #Sample 3
        import Caribe as cb
        from Caribe import trinidad_decode, trinidad_decode_split, caribe_corrector
        
        sentence = "I am playin fotball outsde"
        standard = cb.caribe_corrector(sentence)
        
        print(standard) # Outputs: I am playing football outside
        
        ```
        ---
        - ## Additional Information
            - `trinidad_decode()` : Decodes the sentence as a whole string.
            - `trinidad_decode_split()`: Decodes the sentence word by word.
            - `phrase_decode()`: Decodes the sentence against known dialect phrases.
            - `caribe_corrector()`: Corrects grammatical errors in a sentence.
        
        ---
        - ## Contact 
        For any concerns, issues with this library or want to become a collaborator to this project.
        
        Email: keston.smith@my.uwi.edu 
        
        CHANGELOG =======================================>
        
        Version 0.0.1 (16/09/2021)
        
        - Initial Release
        
        Version 0.0.2 (16/09/2021)
        
        - Minor bugs fixed
        - More words added
        
        Version 0.0.3 (16/09/2021)
        
        - Minor bugs fixed
        - More words added
        - phase decode method created
        
        Version 0.0.4 (17/09/2021)
        
        - More words added
        - caribe corrector method created
        
        Version 0.0.5 (17/09/2021)
        
        - Minor Dependency issues resolved
        
        Version 0.0.6 (17/09/2021)
        
        - More Words and phrases added
         
Keywords: converter
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Education
Classifier: Operating System :: Microsoft :: Windows :: Windows 10
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Description-Content-Type: text/markdown
