Official Python SDK. Grammar checking API for Python. Also includes: style improvements, terminology checking, and plagiarism checking API.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
ProWritingAidSDK
docs
.gitignore
README.md
requirements.txt
setup.py

README.md

ProWritingAidSDK

Official ProWritingAid API Version 2

This Python package is automatically generated by the Swagger Codegen project:

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

If the python package is hosted on Github, you can install directly from Github

pip install git+https://github.com/prowriting/prowritingaid.python.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/prowriting/prowritingaid.python.git)

Then import the package:

import ProWritingAidSDK 

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import ProWritingAidSDK

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function
import ProWritingAidSDK
from ProWritingAidSDK.rest import ApiException
from pprint import pprint

configuration = ProWritingAidSDK.Configuration()
configuration.host = 'https://api.prowritingaid.com'
configuration.api_key['licenseCode'] = 'YOUR_API_KEY'

# create an instance of the API class
api_instance = ProWritingAidSDK.ContextualThesaurusApi(ProWritingAidSDK.ApiClient('https://api.prowritingaid.com'))
task_id = 'task_id_example'  # str |

try:
    api_request = ProWritingAidSDK.ContextualThesaurusRequest("This is a sample text in English to test the sdk "
                                                              "thesaurus. This is a second paragraph in the document."
                                                              " This  is a new line.",
                                                              17,
                                                              20)
    api_response = api_instance.post(api_request)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContextualThesaurusApi->get: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api.prowritingaid.com

Class Method HTTP request Description
ContextualThesaurusApi get GET /api/async/contextualthesaurus/result/{taskId} Tries to get the result of a request using the task id of the request
ContextualThesaurusApi post POST /api/async/contextualthesaurus Analyses text and returns contextual thesaurus entries
HtmlApi get GET /api/async/html/result/{taskId} Tries to get the result of a request using the task id of the request
HtmlApi post POST /api/async/html Analyses HTML and adds suggestion tags to it
SummaryApi get GET /api/async/summary/result/{taskId} Tries to get the result of a request using the task id of the request
SummaryApi post POST /api/async/summary Gets the summary analysis of a document
TextApi get GET /api/async/text/result/{taskId} Tries to get the result of a request using the task id of the request
TextApi post POST /api/async/text Analyses text and returns tags for it
ThesaurusApi post POST /api/thesaurus Returns the thesaurus entries for a specific word
WordCloudApi get GET /api/async/wordcloud/result/{taskId} Tries to get the result of a request using the task id of the request
WordCloudApi post POST /api/async/wordcloud Analyses text and returns a word cloud (as an image)

Documentation For Models

Documentation For Authorization

licenseCode

  • Type: API key
  • API key parameter name: licenseCode
  • Location: HTTP header

Author

prowritingaid.com