Metadata-Version: 2.1
Name: grammarbot
Version: 0.1.0
Summary: Free open source grammar and spelling checker.
Home-page: https://github.com/grammarbot-api/grammarbot-py
Author: Meet Mangukiya
Author-email: info@grammarbot.io
License: MIT
Description: 
        # grammarbot-py
        
        ## Installation
        
        ```sh
        pip install grammarbot
        ```
        
        ## Usage
        
        See the example below
        
        ```py
        # import the client library
        from grammarbot import GrammarBotClient
        
        # Creating the client
        # ===================
        client = GrammarBotClient() # GrammarBotClient(api_key=python-default)
        
        # Analyzing the text
        # ==================
        
        # There is only one method to perform the analysis, viz. GrammarBotClient.check
        # method.
        
        text = 'I cant remember how to go their'
        
        # check the text, returns GrammarBotApiResponse object
        res = client.check(text) # GrammarBotApiResponse(matches=[GrammarBotMatch(offset=2, length=4, rule={'CANT'}, category={'TYPOS'}), GrammarBotMatch(offset=26, length=5, rule={'CONFUSION_RULE'}, category={'TYPOS'})])
        
        # Inspecting the GrammarBotApiResponse object
        # ===========================================
        
        # check detected language
        res.detected_language # "en-US"
        
        # check if the result is incomplete
        res.result_is_incomplete # False
        
        # see the suggestions / corrections suggested by the GrammarBot API
        # returns a list of GrammarBotMatch objects describing each replacement
        res.matches # [GrammarBotMatch(offset=2, length=4, rule={'CANT'}, category={'TYPOS'}), GrammarBotMatch(offset=26, length=5, rule={'CONFUSION_RULE'}, category={'TYPOS'})]
        
        
        # Inspecting the GrammarBotMatch object
        # =====================================
        
        match0 = match[0] # GrammarBotMatch(offset=2, length=4, rule={'CANT'}, category={'TYPOS'})
        
        
        # get replacement information
        match0.replacement_offset # 2
        match0.replacement_length # 4
        
        # get suggested replacements
        match0.replacements # ["can't", 'cannot']
        
        # get list of possible correct sentences after applying the replacements
        match0.corrections # ["I can't remember how to go their", 'I cannot remember how to go their']
        
        
        # get the rules, type and category information of the match
        match0.rule # 'CANT'
        match0.category # 'TYPOS'
        match0.type # 'Other'
        
        # getting a friendly message regarding the replacement suggestion
        match0.message # 'Did you mean "can\'t" or "cannot"?'
        
        # Getting even more information
        # =============================
        
        # if the information provided by the class properties is not enough, you can
        # always access the complete original JSON response from GrammarBotApiResponse
        # object
        res.raw_json
        ```
        
        ## API docs
        
        You can see the API documentation here: https://grammarbot-py.readthedocs.io/en/latest/
        
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Development Status :: 1 - Planning
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: >=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*
Description-Content-Type: text/markdown
