Metadata-Version: 2.1
Name: breame
Version: 0.1.1
Summary: Breame is a lightweight Python package with a number of tools to aid in the detection of words that have dual spellings and meanings in British and American English.
Home-page: https://github.com/cdpierse/breame
Author: Charles Pierse
Author-email: charlespierse@gmail.com
License: Apache-2.0
Description: # Breame
        
        <p align="center"> ( <b>Br</b>itish <b>E</b>nglish and <b>Am</b>erican <b>E</b>nglish Language Tools) </p>
        
        <h1 align="center"></h1>
        
        <p align="center">
            <a href="https://opensource.org/licenses/Apache-2.0">
                <img src="https://img.shields.io/badge/License-Apache%202.0-blue.svg"/> 
            </a>
            <img src="./tests/static/coverage.svg">
            <a href="https://github.com/cdpierse/breame/releases">
                <img src="https://img.shields.io/pypi/v/breame?label=version"/> 
            </a>
        </p>
        
        Breame is a lightweight Python package with a number of utility tools to aid in the detection of words that have dual spellings in British and American English.
        
        Breame can also be used to detect and provide definitions for words that have different meanings in both British English and American English.
        
        Additionally, Breame includes some tooling to detect and define words and phrases that are specific to British English or American English i.e. "strop" in British English or "mailman" in American English.
        
        ## Install
        
        ```posh
        pip install breame
        ```
        
        # Documentation
        
        ## Quick Start
        
        ### Spelling Detection and Conversion
        
        Check American and British English Spelling for words exists:
        
        ```python
        from breame.spelling import american_spelling_exists, british_spelling_exists
        
        american_spelling_exists("color")
        >>> True
        british_spelling_exists("colour")
        >>> True
        ```
        
        Get British English spelling of American English word and vice versa:
        
        ```python
        from breame.spelling import get_american_spelling, get_british_spelling
        
        get_american_spelling("colour")
        >>> 'color'
        get_british_spelling("color")
        >>> 'colour'
        ```
        
        ### Detect different word meanings in British and American English
        
        ```python
        from breame.meanings import different_meanings_exist, get_meaning_definitions
        
        different_meanings_exist("football")
        >>> True
        get_meaning_definitions("football")
        >>> {'American English': 'American football',
         'British English': '(usually) Association football (US: soccer). Less frequently applies to \nRugby football (espec. Rugby union in English private schools).'}
        ```
        
        ### Detect whether a word is a term or short phrase specific to American English or British English
        
        American:
        
        ```python
        from breame.terminology import is_american_english_term, get_american_term_definition
        
        is_american_english_term("bleachers")
        >>> True
        get_american_term_definition("bleachers")
        >>> 'are the raised open air tiered rows of seats (stands) found at sports fields or at other spectator events'
        ```
        
        British:
        
        ```python
        from breame.terminology import is_british_english_term, get_british_term_definition
        
        is_british_english_term("wellies")
        >>> True
        get_british_term_definition("wellies")
        >>> 'Wellington boots, waterproof rubber boots named after the Duke of Wellington.'
        ```
        
        ## Contributions
        
        If you would like to contribute to the package or add to the data constants used for spelling, meanings, or terminology please don't hesitate to submit a PR or raise an issue. The data used is by no means an exhaustive list.
        
        ## Data Stats
        
        Stats for some of the data constants used throughout the package
        
        - \>= **690** words with multiple meanings covered in British, American, and Common English.
        - \>= **321** American English specific words or phrases.
        - \>= **605** British English specific words or phrases.
        - \>= **1730** British English spellings for American English words. `get_british_spelling()`
        - \>= **1706** American English spellings for British English words. `get_american_spelling()`
        
        ## Acknowledgements
        
        This package was inspired by the javascript library [American British English Translator](https://github.com/hyperreality/American-British-English-Translator#american-british-english-translator) by [@hyperreality](https://github.com/hyperreality) and [@jessp01](https://github.com/jessp01). All of the data constants defined in their package are gratefully used throughout breame.
        
        The sources for [American British English Translator](https://github.com/hyperreality/American-British-English-Translator#american-british-english-translator) constants are below:
        
        Uses modified versions of the following lists:
        
        - [List of words having different meanings in American and British English: A-L](https://en.wikipedia.org/wiki/List_of_words_having_different_meanings_in_British_and_American_English:_A%E2%80%93L)
        - [List of words having different meanings in American and British English: M-Z](https://en.wikipedia.org/wiki/List_of_words_having_different_meanings_in_British_and_American_English:_M%E2%80%93Z)
        - [Glossary of American terms not widely used in the United Kingdom](https://en.wikipedia.org/wiki/List_of_American_words_not_widely_used_in_the_United_Kingdom)
        - [Glossary of British terms not widely used in the United States](https://en.wikipedia.org/wiki/List_of_British_words_not_widely_used_in_the_United_States)
        - [Comprehensive list of American and British spelling differences](http://www.tysto.com/uk-us-spelling-list.html)
        
Keywords: text processing,natural language proessing,utility library,spelling,search engine
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Programming Language :: Python :: 3.8
Description-Content-Type: text/markdown
