Skip to main content

Grammar Check is a simple tool for checking the grammar and spelling of a text. It returns the corrected text.

Project description

Grammar Check API

Grammar Check is a simple tool for checking the grammar and spelling of a text. It returns the corrected text.

Build Status Code Climate Prod Ready

This is a Python API Wrapper for the Grammar Check API


Installation

Using pip:

pip install apiverve-grammarcheck

Using pip3:

pip3 install apiverve-grammarcheck

Configuration

Before using the grammarcheck API client, you have to setup your account and obtain your API Key. You can get it by signing up at https://apiverve.com


Quick Start

Here's a simple example to get you started quickly:

from apiverve_grammarcheck.apiClient import GrammarcheckAPIClient

# Initialize the client with your APIVerve API key
api = GrammarcheckAPIClient("[YOUR_API_KEY]")

query = { "text": "The the pig snorted when I saw it on the barn gate. I was a little mad becuase it woke up my pupppppy" }

try:
    # Make the API call
    result = api.execute(query)

    # Print the result
    print(result)
except Exception as e:
    print(f"Error: {e}")

Usage

The Grammar Check API documentation is found here: https://docs.apiverve.com/ref/grammarcheck. You can find parameters, example responses, and status codes documented here.

Setup

# Import the client module
from apiverve_grammarcheck.apiClient import GrammarcheckAPIClient

# Initialize the client with your APIVerve API key
api = GrammarcheckAPIClient("[YOUR_API_KEY]")

Perform Request

Using the API client, you can perform requests to the API.

Define Query
query = { "text": "The the pig snorted when I saw it on the barn gate. I was a little mad becuase it woke up my pupppppy" }
Simple Request
# Make a request to the API
result = api.execute(query)

# Print the result
print(result)
Example Response
{
  "status": "ok",
  "error": null,
  "data": {
    "modified": true,
    "text": "The pig snorted when I saw it on the barn gate. I Was a little mad because it woke up my puppy."
  }
}

Error Handling

The API client provides comprehensive error handling through the GrammarcheckAPIClientError exception. Here are some examples:

Basic Error Handling

from apiverve_grammarcheck.apiClient import GrammarcheckAPIClient, GrammarcheckAPIClientError

api = GrammarcheckAPIClient("[YOUR_API_KEY]")

query = { "text": "The the pig snorted when I saw it on the barn gate. I was a little mad becuase it woke up my pupppppy" }

try:
    result = api.execute(query)
    print("Success!")
    print(result)
except GrammarcheckAPIClientError as e:
    print(f"API Error: {e.message}")
    if e.status_code:
        print(f"Status Code: {e.status_code}")
    if e.response:
        print(f"Response: {e.response}")

Handling Specific Error Types

from apiverve_grammarcheck.apiClient import GrammarcheckAPIClient, GrammarcheckAPIClientError

api = GrammarcheckAPIClient("[YOUR_API_KEY]")

query = { "text": "The the pig snorted when I saw it on the barn gate. I was a little mad becuase it woke up my pupppppy" }

try:
    result = api.execute(query)

    # Check for successful response
    if result.get('status') == 'success':
        print("Request successful!")
        print(result.get('data'))
    else:
        print(f"API returned an error: {result.get('error')}")

except GrammarcheckAPIClientError as e:
    # Handle API client errors
    if e.status_code == 401:
        print("Unauthorized: Invalid API key")
    elif e.status_code == 429:
        print("Rate limit exceeded")
    elif e.status_code >= 500:
        print("Server error - please try again later")
    else:
        print(f"API error: {e.message}")
except Exception as e:
    # Handle unexpected errors
    print(f"Unexpected error: {str(e)}")

Using Context Manager (Recommended)

The client supports the context manager protocol for automatic resource cleanup:

from apiverve_grammarcheck.apiClient import GrammarcheckAPIClient, GrammarcheckAPIClientError

query = { "text": "The the pig snorted when I saw it on the barn gate. I was a little mad becuase it woke up my pupppppy" }

# Using context manager ensures proper cleanup
with GrammarcheckAPIClient("[YOUR_API_KEY]") as api:
    try:
        result = api.execute(query)
        print(result)
    except GrammarcheckAPIClientError as e:
        print(f"Error: {e.message}")
# Session is automatically closed here

Advanced Features

Debug Mode

Enable debug logging to see detailed request and response information:

from apiverve_grammarcheck.apiClient import GrammarcheckAPIClient

# Enable debug mode
api = GrammarcheckAPIClient("[YOUR_API_KEY]", debug=True)

query = { "text": "The the pig snorted when I saw it on the barn gate. I was a little mad becuase it woke up my pupppppy" }

# Debug information will be printed to console
result = api.execute(query)

Manual Session Management

If you need to manually manage the session lifecycle:

from apiverve_grammarcheck.apiClient import GrammarcheckAPIClient

api = GrammarcheckAPIClient("[YOUR_API_KEY]")

query = { "text": "The the pig snorted when I saw it on the barn gate. I was a little mad becuase it woke up my pupppppy" }

try:
    result = api.execute(query)
    print(result)
finally:
    # Manually close the session when done
    api.close()

Customer Support

Need any assistance? Get in touch with Customer Support.


Updates

Stay up to date by following @apiverveHQ on Twitter.


Legal

All usage of the APIVerve website, API, and services is subject to the APIVerve Terms of Service and all legal documents and agreements.


License

Licensed under the The MIT License (MIT)

Copyright (©) 2026 APIVerve, and EvlarSoft LLC

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

apiverve_grammarcheck-1.1.14.tar.gz (10.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

apiverve_grammarcheck-1.1.14-py3-none-any.whl (10.4 kB view details)

Uploaded Python 3

File details

Details for the file apiverve_grammarcheck-1.1.14.tar.gz.

File metadata

  • Download URL: apiverve_grammarcheck-1.1.14.tar.gz
  • Upload date:
  • Size: 10.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.10

File hashes

Hashes for apiverve_grammarcheck-1.1.14.tar.gz
Algorithm Hash digest
SHA256 2173bc6c6d6a0737dbbb1c196d288eebdf3ec261051ff5f73839e11abb389f59
MD5 d85d6b4778f4b98d337b536b05bf45fd
BLAKE2b-256 475486641ed8fe18d4ba402ff0c566fe9b3564d790025fef1d362bba06f28cc6

See more details on using hashes here.

File details

Details for the file apiverve_grammarcheck-1.1.14-py3-none-any.whl.

File metadata

File hashes

Hashes for apiverve_grammarcheck-1.1.14-py3-none-any.whl
Algorithm Hash digest
SHA256 3f455f9b37c991c3ef873a0fb2a600023d59b9634802db7db3af1e9505e0390b
MD5 6f3359ec2b8610dbb78db75ebd3e4b52
BLAKE2b-256 b5490122d22e72709399a56d7ec9ce5ce28982ebc6c5b0f78ca0cc759b1d1b0e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page