sapling-py 4.0.2__tar.gz → 4.1.0__tar.gz

sapling_py-4.1.0/PKG-INFO

@@ -0,0 +1,102 @@
+Metadata-Version: 2.4
+Name: sapling-py
+Version: 4.1.0
+Summary: Sapling Python Client
+Home-page: https://sapling.ai
+Author: Sapling Intelligence
+Author-email: info@sapling.ai
+License: Apache License 2.0
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: responses; extra == "test"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# Sapling Python Client
+
+Python SDK wrapper for the [Sapling.ai API](https://sapling.ai/docs).
+
+Try our [grammar check demo](https://sapling.ai/grammar-check).
+Compare against leading grammar checking tools and APIs like Grammarly (Grammerly), LanguageTool, ProWritingAid and Ginger.
+
+## Overview
+
+Sapling is a toolkit for helping developers build language model-powered applications.
+The API provides spelling and grammar checking, autocomplete, tone detection, rephrasing, AI detection, and more.
+
+Key Features:
+- **60% More Corrections**: Outperforms [competing solutions](https://sapling.ai/comparison/api#sapling) at similar accuracy levels using state-of-the-art generative AI models.
+- **Real-Time Performance**: Experience the same low-latency corrections as Sapling's native integrations.
+- **Comprehensive Error Detection**: Identifies over 20 error types including prepositions, noun forms, verb tense, with both high-level and fine-grained error information.
+- **Domain-Specific Models**: Get corrections optimized for your content type, from academic writing, to doctors notes, to user-generated reviews.
+- **Enterprise-Grade Security**: Features include no data retention policies, [self-hosted/on-premises](https://sapling.ai/onprem) deployment options, and enterprise-grade [security policies and procedures](https://sapling.ai/security).
+- **Rich Text Editor Integration**: Supports TinyMCE, CKEditor, QuillJS, Trix, ProseMirror, WordPress, Draft.js, Froala, Lexical and more. For web-based editors, consider using our [JavaScript SDK](https://sapling.ai/docs/sdk/JavaScript/quickstart) for display UI components.
+
+## Installation
+
+Install the `sapling-py` package with [pip](https://pip.pypa.io/en/stable/installation/)
+
+```
+python -m pip install sapling-py
+```
+
+## Documentation
+Documentation for the client is available at [Read the Docs](https://sapling.readthedocs.io/) and
+documentation for the HTTP API is available at [Sapling.ai](https://sapling.ai/docs).
+
+## Quickstart
+
+- Register for an account at [Sapling.ai](https://sapling.ai).
+- After registering and signing in, generate a development API key in your [dashboard](https://sapling.ai/user_settings).
+- Install the Python client by following the installation steps above.
+
+```python
+from sapling import SaplingClient
+
+API_KEY = '<YOUR_API_KEY>'
+client = SaplingClient(api_key=API_KEY)
+edits = client.edits('Lets get started!', session_id='test_session')
+```
+
+The result should be an array of edits of this form:
+
+```json
+[{
+  "id": "aa5ee291-a073-5146-8ebc-c9c899d01278",
+  "sentence": "Lets get started!",
+  "sentence_start": 0,
+  "start": 0,
+  "end": 4,
+  "replacement": "Let's",
+  "error_type": "R:OTHER",
+  "general_error_type": "Other",
+}]
+```
+
+Get a production key by following [this documentation](https://sapling.ai/docs/api/api-access).
+
+Here's some more information on [request options and response structure](https://sapling.ai/docs/api/edits-overview).
+
+## License
+
+Copyright 2024--present Sapling Intelligence, Inc.
+
+Licensed under the Apache License, Version 2.0.

sapling_py-4.1.0/README.md

@@ -0,0 +1,70 @@
+# Sapling Python Client
+
+Python SDK wrapper for the [Sapling.ai API](https://sapling.ai/docs).
+
+Try our [grammar check demo](https://sapling.ai/grammar-check).
+Compare against leading grammar checking tools and APIs like Grammarly (Grammerly), LanguageTool, ProWritingAid and Ginger.
+
+## Overview
+
+Sapling is a toolkit for helping developers build language model-powered applications.
+The API provides spelling and grammar checking, autocomplete, tone detection, rephrasing, AI detection, and more.
+
+Key Features:
+- **60% More Corrections**: Outperforms [competing solutions](https://sapling.ai/comparison/api#sapling) at similar accuracy levels using state-of-the-art generative AI models.
+- **Real-Time Performance**: Experience the same low-latency corrections as Sapling's native integrations.
+- **Comprehensive Error Detection**: Identifies over 20 error types including prepositions, noun forms, verb tense, with both high-level and fine-grained error information.
+- **Domain-Specific Models**: Get corrections optimized for your content type, from academic writing, to doctors notes, to user-generated reviews.
+- **Enterprise-Grade Security**: Features include no data retention policies, [self-hosted/on-premises](https://sapling.ai/onprem) deployment options, and enterprise-grade [security policies and procedures](https://sapling.ai/security).
+- **Rich Text Editor Integration**: Supports TinyMCE, CKEditor, QuillJS, Trix, ProseMirror, WordPress, Draft.js, Froala, Lexical and more. For web-based editors, consider using our [JavaScript SDK](https://sapling.ai/docs/sdk/JavaScript/quickstart) for display UI components.
+
+## Installation
+
+Install the `sapling-py` package with [pip](https://pip.pypa.io/en/stable/installation/)
+
+```
+python -m pip install sapling-py
+```
+
+## Documentation
+Documentation for the client is available at [Read the Docs](https://sapling.readthedocs.io/) and
+documentation for the HTTP API is available at [Sapling.ai](https://sapling.ai/docs).
+
+## Quickstart
+
+- Register for an account at [Sapling.ai](https://sapling.ai).
+- After registering and signing in, generate a development API key in your [dashboard](https://sapling.ai/user_settings).
+- Install the Python client by following the installation steps above.
+
+```python
+from sapling import SaplingClient
+
+API_KEY = '<YOUR_API_KEY>'
+client = SaplingClient(api_key=API_KEY)
+edits = client.edits('Lets get started!', session_id='test_session')
+```
+
+The result should be an array of edits of this form:
+
+```json
+[{
+  "id": "aa5ee291-a073-5146-8ebc-c9c899d01278",
+  "sentence": "Lets get started!",
+  "sentence_start": 0,
+  "start": 0,
+  "end": 4,
+  "replacement": "Let's",
+  "error_type": "R:OTHER",
+  "general_error_type": "Other",
+}]
+```
+
+Get a production key by following [this documentation](https://sapling.ai/docs/api/api-access).
+
+Here's some more information on [request options and response structure](https://sapling.ai/docs/api/edits-overview).
+
+## License
+
+Copyright 2024--present Sapling Intelligence, Inc.
+
+Licensed under the Apache License, Version 2.0.

{sapling_py-4.0.2 → sapling_py-4.1.0}/sapling/__init__.py

@@ -1,8 +1,9 @@
 """Sapling Python Client"""
 
-from .client import SaplingClient
+from .client import SaplingClient, SaplingError
 from .version import __version__
 
 __all__ = [
   "SaplingClient",
+  "SaplingError",
 ]

{sapling_py-4.0.2 → sapling_py-4.1.0}/sapling/client.py

@@ -1,6 +1,21 @@
 import requests
 import uuid
 
+
+class SaplingError(Exception):
+    '''
+    Raised when the Sapling API returns a non-2xx response.
+
+    :ivar status_code: HTTP status code returned by the API.
+    :ivar body: Raw response body returned by the API (may be empty).
+    '''
+
+    def __init__(self, status_code, body=None):
+        self.status_code = status_code
+        self.body = body
+        super().__init__(f'HTTP {status_code}: {body}')
+
+
 class SaplingClient:
     '''
     Sapling client class. Provides a mapping of Python functions to Sapling HTTP REST APIs.
@@ -28,6 +43,32 @@ class SaplingClient:
         self.pathname = pathname or '/api/v1/'
         self.url_endpoint = self.hostname + self.pathname
         self.default_session_id = str(uuid.uuid4())
+        self.session = requests.Session()
+
+    def _request(self, url, data):
+        '''
+        Issues a POST request to the Sapling API and returns the parsed JSON body.
+
+        :param url: Fully-qualified endpoint URL.
+        :type url: str
+        :param data: JSON-serializable request body.
+        :type data: dict
+        :rtype: dict, list, or None
+        :raises SaplingError: If the API responds with a non-2xx status code.
+        '''
+        resp = self.session.post(
+            url,
+            json=data,
+            timeout=self.timeout,
+        )
+        if not 200 <= resp.status_code < 300:
+            raise SaplingError(resp.status_code, resp.text)
+        if not resp.content:
+            return None
+        try:
+            return resp.json()
+        except ValueError:
+            return None
 
     def edits(
         self,
@@ -140,14 +181,7 @@ class SaplingClient:
         if is_anon_user is not None:
             data['is_anon_user'] = is_anon_user
 
-        resp = requests.post(
-            url,
-            json=data,
-            timeout=self.timeout,
-        )
-        if 200 <= resp.status_code < 300:
-            return resp.json()
-        raise Exception(f'HTTP {resp.status_code}: {resp.text}')
+        return self._request(url, data)
 
     def accept_edit(
         self,
@@ -179,14 +213,7 @@ class SaplingClient:
         if user_id is not None:
             data['user_id'] = user_id
 
-        resp = requests.post(
-            url,
-            json=data,
-            timeout=self.timeout,
-        )
-        if 200 <= resp.status_code < 300:
-            return
-        raise Exception(f'HTTP {resp.status_code}: resp.text')
+        self._request(url, data)
 
     def reject_edit(
         self,
@@ -218,14 +245,7 @@ class SaplingClient:
         if user_id is not None:
             data['user_id'] = user_id
 
-        resp = requests.post(
-            url,
-            json=data,
-            timeout=self.timeout,
-        )
-        if 200 <= resp.status_code < 300:
-            return
-        raise Exception(f'HTTP {resp.status_code}: resp.text')
+        self._request(url, data)
 
     def spellcheck(
         self,
@@ -255,8 +275,8 @@ class SaplingClient:
         :type lang: str
         :param auto_apply: Whether to return a field with edits applied to the text. Cannot be set with multiple_edits option.
         :type auto_apply: bool
-        :param advanced_edits: additional edit checking options
-        :type advanced_edits: dict
+        :param user_data: Optional custom data (e.g. a personal dictionary) to inform spellchecking.
+        :type user_data: dict
         :param variety: Specifies regional English variety preference. Defaults to the configuration in the user Sapling dashboard.
         :type variety: str
         :param user_id: Track IDs representing your end users
@@ -343,14 +363,7 @@ class SaplingClient:
         if is_anon_user is not None:
             data['is_anon_user'] = is_anon_user
 
-        resp = requests.post(
-            url,
-            json=data,
-            timeout=self.timeout,
-        )
-        if 200 <= resp.status_code < 300:
-            return resp.json()
-        raise Exception(f'HTTP {resp.status_code}: {resp.text}')
+        return self._request(url, data)
 
 
     def complete(
@@ -374,14 +387,7 @@ class SaplingClient:
             'session_id': session_id,
         }
 
-        resp = requests.post(
-            url,
-            json=data,
-            timeout=self.timeout,
-        )
-        if 200 <= resp.status_code < 300:
-            return resp.json()
-        raise Exception(f'HTTP {resp.status_code}: {resp.text}')
+        return self._request(url, data)
 
     def accept_complete(
         self,
@@ -404,7 +410,7 @@ class SaplingClient:
         :type completion: str
         '''
         url = f'{self.url_endpoint}complete/{complete_uuid}/accept'
-        session_id = session_id or uuid.uuid4()
+        session_id = session_id or self.default_session_id
         data = {
             'key': self.api_key,
             'session_id': session_id,
@@ -413,14 +419,7 @@ class SaplingClient:
                 'completion': completion,
             }
         }
-        resp = requests.post(
-            url,
-            json=data,
-            timeout=self.timeout,
-        )
-        if 200 <= resp.status_code < 300:
-            return
-        raise Exception(f'HTTP {resp.status_code}: resp.text')
+        self._request(url, data)
 
     def aidetect(
         self,
@@ -430,7 +429,7 @@ class SaplingClient:
         '''
         Score a piece of text on how likely it was generated by AI.
 
-        :param text: Text to
+        :param text: Text to score for AI-generated content.
         :type text: str
         :param sent_scores: If true, each sentence will also be scored individually.
         :type sent_scores: bool
@@ -449,14 +448,7 @@ class SaplingClient:
         }
         if sent_scores is not None:
             data['sent_scores'] = sent_scores
-        resp = requests.post(
-            url,
-            json=data,
-            timeout=self.timeout,
-        )
-        if 200 <= resp.status_code < 300:
-            return resp.json()
-        raise Exception(f'HTTP {resp.status_code}: resp.text')
+        return self._request(url, data)
 
     def chunk_text(
         self,
@@ -487,14 +479,7 @@ class SaplingClient:
         }
         if step_size is not None:
             data['step_size'] = step_size
-        resp = requests.post(
-            url,
-            json=data,
-            timeout=self.timeout,
-        )
-        if 200 <= resp.status_code < 300:
-            return resp.json()
-        raise Exception(f'HTTP {resp.status_code}: {resp.text}')
+        return self._request(url, data)
 
     def chunk_html(
         self,
@@ -527,14 +512,7 @@ class SaplingClient:
         }
         if step_size is not None:
             data['step_size'] = step_size
-        resp = requests.post(
-            url,
-            json=data,
-            timeout=self.timeout,
-        )
-        if 200 <= resp.status_code < 300:
-            return resp.json()
-        raise Exception(f'HTTP {resp.status_code}: {resp.text}')
+        return self._request(url, data)
 
     def postprocess(
         self,
@@ -578,11 +556,188 @@ class SaplingClient:
             'session_id': session_id,
             'operations': operations,
         }
-        resp = requests.post(
-            url,
-            json=data,
-            timeout=self.timeout,
-        )
-        if 200 <= resp.status_code < 300:
-            return resp.json()
-        raise Exception(f'HTTP {resp.status_code}: {resp.text}')
+        return self._request(url, data)
+
+    def rephrase(
+        self,
+        text,
+        mapping=None,
+        tone_mapping=None,
+        tense_mapping=None,
+        num_results=None,
+        session_id=None,
+    ):
+        '''
+        Rephrases the input text, optionally applying a style transformation.
+
+        Given an input sentence, returns output sentences that preserve meaning
+        but use alternative phrasings or styles.
+
+        :param text: Text to rephrase. Current maximum length is 400 characters.
+        :type text: str
+        :param mapping: The transformation to apply. Defaults to `paraphrase`.
+            Options include: `paraphrase`, `informal_to_formal`, `passive_to_active`,
+            `active_to_passive`, `sentence_split`, `expand`, and `switch_tone`.
+        :type mapping: str
+        :param tone_mapping: Target tone when `mapping` is `switch_tone`. Options
+            include: `straightforward`, `confident`, `friendly`, and `empathetic`.
+        :type tone_mapping: str
+        :param tense_mapping: Target tense transformation, when applicable.
+        :type tense_mapping: str
+        :param num_results: Number of results to return (currently only for
+            `paraphrase`). Minimum 1, maximum 8. Defaults to 5.
+        :type num_results: int
+        :param session_id: Unique name or UUID of document or portion of text that is being processed
+        :type session_id: str
+        :rtype: dict
+        :return:
+            - results: List of rephrases, each with `original`, `replacement`,
+              `rephrase_type`, `model_version`, and `hash`.
+        '''
+        url = self.url_endpoint + 'rephrase'
+        session_id = session_id or self.default_session_id
+        data = {
+            'key': self.api_key,
+            'text': text,
+            'session_id': session_id,
+        }
+        if mapping is not None:
+            data['mapping'] = mapping
+        if tone_mapping is not None:
+            data['tone_mapping'] = tone_mapping
+        if tense_mapping is not None:
+            data['tense_mapping'] = tense_mapping
+        if num_results is not None:
+            data['num_results'] = num_results
+        return self._request(url, data)
+
+    def summarize(
+        self,
+        text,
+    ):
+        '''
+        Summarizes a longer document into a shorter, more digestible one.
+
+        :param text: Input document to summarize.
+        :type text: str
+        :rtype: dict
+        :return:
+            - result: The summarized text.
+        '''
+        url = self.url_endpoint + 'summarize'
+        data = {
+            'key': self.api_key,
+            'text': text,
+        }
+        return self._request(url, data)
+
+    def tone(
+        self,
+        text,
+    ):
+        '''
+        Detects the tone of the provided text across 28 fine-grained categories.
+
+        The overall tone is returned along with the tone for each sentence.
+
+        :param text: Text to analyze the tone for.
+        :type text: str
+        :rtype: dict
+        :return:
+            - sents: The sentences the text contains.
+            - overall: List of ``(probability, tone, emoji)`` tuples for the whole text.
+            - results: For each sentence, a list of ``(probability, tone, emoji)`` tuples.
+        '''
+        url = self.url_endpoint + 'tone'
+        data = {
+            'key': self.api_key,
+            'text': text,
+        }
+        return self._request(url, data)
+
+    def sentiment(
+        self,
+        text,
+    ):
+        '''
+        Detects the sentiment (positive, negative, or neutral) of the provided text.
+
+        The overall sentiment is returned along with the sentiment for each sentence.
+
+        :param text: Text to analyze the sentiment for.
+        :type text: str
+        :rtype: dict
+        :return:
+            - sents: The sentences the text contains.
+            - overall: List of ``(probability, sentiment)`` tuples for the whole text.
+            - results: For each sentence, a list of ``(probability, sentiment)`` tuples.
+        '''
+        url = self.url_endpoint + 'sentiment'
+        data = {
+            'key': self.api_key,
+            'text': text,
+        }
+        return self._request(url, data)
+
+    def quality(
+        self,
+        text,
+    ):
+        '''
+        Computes a quality score for the provided text based on how "surprising"
+        the text is to the model. Lower surprisal corresponds to higher scores.
+
+        :param text: Text to compute a quality score for.
+        :type text: str
+        :rtype: dict
+        :return:
+            - score: A score from 1 (low quality) to 5 (high quality).
+        '''
+        url = self.url_endpoint + 'quality'
+        data = {
+            'key': self.api_key,
+            'text': text,
+        }
+        return self._request(url, data)
+
+    def langdetect(
+        self,
+        text,
+    ):
+        '''
+        Identifies the language of the provided text.
+
+        :param text: Text to identify the language for.
+        :type text: str
+        :rtype: dict
+        :return:
+            - lang: The detected language code.
+            - conf: Confidence score for the detection result.
+        '''
+        url = self.url_endpoint + 'langdetect'
+        data = {
+            'key': self.api_key,
+            'text': text,
+        }
+        return self._request(url, data)
+
+    def profanity(
+        self,
+        text,
+    ):
+        '''
+        Checks the provided text for profanity, returning a 0/1 label per token.
+
+        :param text: Text to check for profanity.
+        :type text: str
+        :rtype: dict
+        :return:
+            - toks: The tokens (words) detected in the text.
+            - labels: For each token, 0 (not profanity) or 1 (profanity).
+        '''
+        url = self.url_endpoint + 'profanity'
+        data = {
+            'key': self.api_key,
+            'text': text,
+        }
+        return self._request(url, data)

sapling_py-4.1.0/sapling/version.py

@@ -0,0 +1 @@
+__version__ = '4.1.0'

sapling_py-4.1.0/sapling_py.egg-info/PKG-INFO

@@ -0,0 +1,102 @@
+Metadata-Version: 2.4
+Name: sapling-py
+Version: 4.1.0
+Summary: Sapling Python Client
+Home-page: https://sapling.ai
+Author: Sapling Intelligence
+Author-email: info@sapling.ai
+License: Apache License 2.0
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: responses; extra == "test"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# Sapling Python Client
+
+Python SDK wrapper for the [Sapling.ai API](https://sapling.ai/docs).
+
+Try our [grammar check demo](https://sapling.ai/grammar-check).
+Compare against leading grammar checking tools and APIs like Grammarly (Grammerly), LanguageTool, ProWritingAid and Ginger.
+
+## Overview
+
+Sapling is a toolkit for helping developers build language model-powered applications.
+The API provides spelling and grammar checking, autocomplete, tone detection, rephrasing, AI detection, and more.
+
+Key Features:
+- **60% More Corrections**: Outperforms [competing solutions](https://sapling.ai/comparison/api#sapling) at similar accuracy levels using state-of-the-art generative AI models.
+- **Real-Time Performance**: Experience the same low-latency corrections as Sapling's native integrations.
+- **Comprehensive Error Detection**: Identifies over 20 error types including prepositions, noun forms, verb tense, with both high-level and fine-grained error information.
+- **Domain-Specific Models**: Get corrections optimized for your content type, from academic writing, to doctors notes, to user-generated reviews.
+- **Enterprise-Grade Security**: Features include no data retention policies, [self-hosted/on-premises](https://sapling.ai/onprem) deployment options, and enterprise-grade [security policies and procedures](https://sapling.ai/security).
+- **Rich Text Editor Integration**: Supports TinyMCE, CKEditor, QuillJS, Trix, ProseMirror, WordPress, Draft.js, Froala, Lexical and more. For web-based editors, consider using our [JavaScript SDK](https://sapling.ai/docs/sdk/JavaScript/quickstart) for display UI components.
+
+## Installation
+
+Install the `sapling-py` package with [pip](https://pip.pypa.io/en/stable/installation/)
+
+```
+python -m pip install sapling-py
+```
+
+## Documentation
+Documentation for the client is available at [Read the Docs](https://sapling.readthedocs.io/) and
+documentation for the HTTP API is available at [Sapling.ai](https://sapling.ai/docs).
+
+## Quickstart
+
+- Register for an account at [Sapling.ai](https://sapling.ai).
+- After registering and signing in, generate a development API key in your [dashboard](https://sapling.ai/user_settings).
+- Install the Python client by following the installation steps above.
+
+```python
+from sapling import SaplingClient
+
+API_KEY = '<YOUR_API_KEY>'
+client = SaplingClient(api_key=API_KEY)
+edits = client.edits('Lets get started!', session_id='test_session')
+```
+
+The result should be an array of edits of this form:
+
+```json
+[{
+  "id": "aa5ee291-a073-5146-8ebc-c9c899d01278",
+  "sentence": "Lets get started!",
+  "sentence_start": 0,
+  "start": 0,
+  "end": 4,
+  "replacement": "Let's",
+  "error_type": "R:OTHER",
+  "general_error_type": "Other",
+}]
+```
+
+Get a production key by following [this documentation](https://sapling.ai/docs/api/api-access).
+
+Here's some more information on [request options and response structure](https://sapling.ai/docs/api/edits-overview).
+
+## License
+
+Copyright 2024--present Sapling Intelligence, Inc.
+
+Licensed under the Apache License, Version 2.0.

{sapling_py-4.0.2 → sapling_py-4.1.0}/sapling_py.egg-info/SOURCES.txt

@@ -9,4 +9,5 @@ sapling_py.egg-info/SOURCES.txt
 sapling_py.egg-info/dependency_links.txt
 sapling_py.egg-info/requires.txt
 sapling_py.egg-info/top_level.txt
-test/__init__.py
+test/__init__.py
+test/test_client.py

sapling_py-4.1.0/sapling_py.egg-info/requires.txt

@@ -0,0 +1,5 @@
+requests
+
+[test]
+pytest
+responses

{sapling_py-4.0.2 → sapling_py-4.1.0}/sapling_py.egg-info/top_level.txt

@@ -1,2 +1 @@
 sapling
-test

{sapling_py-4.0.2 → sapling_py-4.1.0}/setup.py

@@ -20,13 +20,22 @@ setup(
     author_email='info@sapling.ai',
     license='Apache License 2.0',
     classifiers=[
-        'Development Status :: 3 - Alpha',
+        'Development Status :: 5 - Production/Stable',
+        'License :: OSI Approved :: Apache Software License',
         'Programming Language :: Python :: 3',
+        'Programming Language :: Python :: 3 :: Only',
     ],
-    packages=find_packages(),
+    packages=find_packages(exclude=['test', 'test.*']),
     package_data={'':[]},
     include_package_data=True,
+    python_requires='>=3.7',
     install_requires=[
         'requests'
     ],
+    extras_require={
+        'test': [
+            'pytest',
+            'responses',
+        ],
+    },
 )

sapling_py-4.1.0/test/test_client.py

@@ -0,0 +1,158 @@
+import json
+
+import pytest
+import responses
+
+from sapling import SaplingClient, SaplingError
+
+API_KEY = 'a' * 32
+BASE = 'https://api.sapling.ai/api/v1/'
+
+
+@pytest.fixture
+def client():
+    return SaplingClient(api_key=API_KEY)
+
+
+def _last_request_body():
+    '''Return the JSON body of the most recent mocked request.'''
+    return json.loads(responses.calls[-1].request.body)
+
+
+@responses.activate
+def test_edits_returns_json_and_sends_key(client):
+    responses.add(
+        responses.POST,
+        BASE + 'edits',
+        json={'edits': [{'replacement': "Let's"}]},
+        status=200,
+    )
+    result = client.edits('Lets go', session_id='s1')
+    assert result == {'edits': [{'replacement': "Let's"}]}
+    body = _last_request_body()
+    assert body['key'] == API_KEY
+    assert body['text'] == 'Lets go'
+    assert body['session_id'] == 's1'
+
+
+@responses.activate
+def test_edits_uses_default_session_id(client):
+    responses.add(responses.POST, BASE + 'edits', json={'edits': []}, status=200)
+    client.edits('hi')
+    assert _last_request_body()['session_id'] == client.default_session_id
+
+
+@responses.activate
+def test_optional_params_only_sent_when_provided(client):
+    responses.add(responses.POST, BASE + 'edits', json={'edits': []}, status=200)
+    client.edits('hi')
+    body = _last_request_body()
+    for absent in ('lang', 'variety', 'medical', 'advanced_edits', 'user_id', 'is_anon_user'):
+        assert absent not in body
+    # auto_apply defaults to False and is always included
+    assert body['auto_apply'] is False
+
+
+@responses.activate
+def test_error_response_raises_saplingerror_with_body(client):
+    responses.add(
+        responses.POST,
+        BASE + 'edits',
+        json={'msg': 'Invalid text.'},
+        status=400,
+    )
+    with pytest.raises(SaplingError) as exc_info:
+        client.edits('hi')
+    err = exc_info.value
+    assert err.status_code == 400
+    # Regression test: the response body must be interpolated into the message.
+    assert 'Invalid text.' in str(err)
+    assert 'Invalid text.' in err.body
+
+
+@responses.activate
+def test_accept_edit_error_includes_body(client):
+    '''Regression: accept_edit previously never interpolated resp.text.'''
+    responses.add(
+        responses.POST,
+        BASE + 'edits/some-uuid/accept',
+        json={'msg': 'Not found'},
+        status=404,
+    )
+    with pytest.raises(SaplingError) as exc_info:
+        client.accept_edit('some-uuid', session_id='s1')
+    assert 'Not found' in str(exc_info.value)
+
+
+@responses.activate
+def test_accept_edit_success_returns_none(client):
+    responses.add(responses.POST, BASE + 'edits/some-uuid/accept', body='', status=200)
+    assert client.accept_edit('some-uuid') is None
+
+
+@responses.activate
+def test_reject_edit_success_returns_none(client):
+    responses.add(responses.POST, BASE + 'edits/some-uuid/reject', body='', status=200)
+    assert client.reject_edit('some-uuid') is None
+
+
+@responses.activate
+def test_accept_complete_sends_string_session_id(client):
+    '''Regression: session_id fallback must be a str, not a uuid.UUID.'''
+    responses.add(responses.POST, BASE + 'complete/c-uuid/accept', body='', status=200)
+    client.accept_complete('c-uuid', 'the query', 'the completion')
+    body = _last_request_body()
+    assert isinstance(body['session_id'], str)
+    assert body['session_id'] == client.default_session_id
+    assert body['context'] == {'query': 'the query', 'completion': 'the completion'}
+
+
+@responses.activate
+def test_aidetect_error_includes_body(client):
+    '''Regression: aidetect previously never interpolated resp.text.'''
+    responses.add(responses.POST, BASE + 'aidetect', json={'msg': 'boom'}, status=500)
+    with pytest.raises(SaplingError) as exc_info:
+        client.aidetect('some text')
+    assert 'boom' in str(exc_info.value)
+
+
+@responses.activate
+def test_rephrase_sends_expected_params(client):
+    responses.add(responses.POST, BASE + 'rephrase', json={'results': []}, status=200)
+    client.rephrase('hey wuts up', mapping='informal_to_formal', num_results=3)
+    body = _last_request_body()
+    assert body['text'] == 'hey wuts up'
+    assert body['mapping'] == 'informal_to_formal'
+    assert body['num_results'] == 3
+    assert 'session_id' in body
+    # Unset optional params should be omitted.
+    assert 'tone_mapping' not in body
+    assert 'tense_mapping' not in body
+
+
+@pytest.mark.parametrize(
+    'method,path,payload',
+    [
+        ('summarize', 'summarize', {'result': 'short'}),
+        ('tone', 'tone', {'overall': [], 'results': [], 'sents': []}),
+        ('sentiment', 'sentiment', {'overall': [], 'results': [], 'sents': []}),
+        ('quality', 'quality', {'score': 3.5}),
+        ('langdetect', 'langdetect', {'lang': 'en', 'conf': 0.99}),
+        ('profanity', 'profanity', {'toks': ['a'], 'labels': [0]}),
+    ],
+)
+@responses.activate
+def test_single_text_endpoints(client, method, path, payload):
+    responses.add(responses.POST, BASE + path, json=payload, status=200)
+    result = getattr(client, method)('some text')
+    assert result == payload
+    body = _last_request_body()
+    assert body == {'key': API_KEY, 'text': 'some text'}
+
+
+@responses.activate
+def test_hostname_and_pathname_override():
+    client = SaplingClient(api_key=API_KEY, hostname='http://localhost:5000', pathname='/api/v1/')
+    responses.add(responses.POST, 'http://localhost:5000/api/v1/edits', json={'edits': []}, status=200)
+    client.edits('hi')
+    assert responses.calls[-1].request.url == 'http://localhost:5000/api/v1/edits'

sapling_py-4.0.2/PKG-INFO

@@ -1,94 +0,0 @@
-Metadata-Version: 2.1
-Name: sapling-py
-Version: 4.0.2
-Summary: Sapling Python Client
-Home-page: https://sapling.ai
-Author: Sapling Intelligence
-Author-email: info@sapling.ai
-License: Apache License 2.0
-Classifier: Development Status :: 3 - Alpha
-Classifier: Programming Language :: Python :: 3
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: requests
-
-# Sapling Python Client
-
-Python wrapper for the [Sapling.ai API](https://sapling.ai/api).
-
-Try out a [grammar check demo](https://sapling.ai/grammar-check).
-Compare against grammar checking tools and APIs like Grammarly (Grammerly), LanguageTool, ProWritingAid and Ginger.
-
-Functionality
---------
-
-Sapling is an AI messaging assistant.
-The API currently offers spelling and grammar checking endpoints.
-
-Benefits include:
-- **60% more grammar corrections**: compared to [other systems](https://sapling.ai/comparison/api) at similar accuracy using state-of-the-art machine learning systems for natural language processing.
-- **Low Latency**: Achieve the same real-time performance that users of Sapling's own interface experience.
-- **Over 20 error types**: Error categories such as preposition, noun form, and verb tense, including both high-level and fine-grained error information.
-- **Custom Models**: Get corrections and edits tuned to the domain of your text—for example academic writing vs. subtitles.
-- **Enterprise Security**: Ask us about our no data retention policies, [self-hosted/on-premises](https://sapling.ai/onprem) deployment options, and other [cybersecurity policies and procedures](https://sapling.ai/security).
-- **Rich Text Editor Support**: TinyMCE, CKEditor, QuillJS, Trix, ProseMirror, WordPress, Draft.js, Froala, Lexical and others. Consider using [Sapling's JavaScript SDK](https://sapling.ai/docs/sdk/JavaScript/quickstart) for displaying the API's outputs on webpage editors.
-
-
-Installation
---------
-
-Install the `sapling-py` package with [pip](https://pip.pypa.io/en/stable/installation/)
-
-
-```
-python -m pip install sapling-py
-```
-
-
-Documentation
--------------
-
-Documentation for the client is available at [Read the Docs](https://sapling.readthedocs.io/) and
-documentation for the HTTP API is available at [Sapling.ai](https://sapling.ai/docs).
-
-
-Quickstart
------------
-
-- Register for an account at [Sapling.ai](https://sapling.ai).
-- After registering and signing in, generate a development API key in your [dashboard](https://sapling.ai/user_settings).
-- Install the Python client by following the installation steps above.
-
-```python
-from sapling import SaplingClient
-
-API_KEY = '<YOUR_API_KEY>'
-client = SaplingClient(api_key=API_KEY)
-edits = client.edits('Lets get started!', session_id='test_session')
-```
-
-The result should be an array of edits of this form:
-
-```json
-[{
-  "id": "aa5ee291-a073-5146-8ebc-c9c899d01278",
-  "sentence": "Lets get started!",
-  "sentence_start": 0,
-  "start": 0,
-  "end": 4,
-  "replacement": "Let's",
-  "error_type": "R:OTHER",
-  "general_error_type": "Other",
-}]
-```
-
-Get a production key by following [this documentation](https://sapling.ai/docs/api/api-access).
-
-Here's some more information on [request options and response structure](https://sapling.ai/docs/api/edits-overview).
-
-License
--------
-
-Copyright 2022 Sapling Intelligence, Inc.
-
-Licensed under the Apache License, Version 2.0.

sapling_py-4.0.2/README.md

@@ -1,80 +0,0 @@
-# Sapling Python Client
-
-Python wrapper for the [Sapling.ai API](https://sapling.ai/api).
-
-Try out a [grammar check demo](https://sapling.ai/grammar-check).
-Compare against grammar checking tools and APIs like Grammarly (Grammerly), LanguageTool, ProWritingAid and Ginger.
-
-Functionality
---------
-
-Sapling is an AI messaging assistant.
-The API currently offers spelling and grammar checking endpoints.
-
-Benefits include:
-- **60% more grammar corrections**: compared to [other systems](https://sapling.ai/comparison/api) at similar accuracy using state-of-the-art machine learning systems for natural language processing.
-- **Low Latency**: Achieve the same real-time performance that users of Sapling's own interface experience.
-- **Over 20 error types**: Error categories such as preposition, noun form, and verb tense, including both high-level and fine-grained error information.
-- **Custom Models**: Get corrections and edits tuned to the domain of your text—for example academic writing vs. subtitles.
-- **Enterprise Security**: Ask us about our no data retention policies, [self-hosted/on-premises](https://sapling.ai/onprem) deployment options, and other [cybersecurity policies and procedures](https://sapling.ai/security).
-- **Rich Text Editor Support**: TinyMCE, CKEditor, QuillJS, Trix, ProseMirror, WordPress, Draft.js, Froala, Lexical and others. Consider using [Sapling's JavaScript SDK](https://sapling.ai/docs/sdk/JavaScript/quickstart) for displaying the API's outputs on webpage editors.
-
-
-Installation
---------
-
-Install the `sapling-py` package with [pip](https://pip.pypa.io/en/stable/installation/)
-
-
-```
-python -m pip install sapling-py
-```
-
-
-Documentation
--------------
-
-Documentation for the client is available at [Read the Docs](https://sapling.readthedocs.io/) and
-documentation for the HTTP API is available at [Sapling.ai](https://sapling.ai/docs).
-
-
-Quickstart
------------
-
-- Register for an account at [Sapling.ai](https://sapling.ai).
-- After registering and signing in, generate a development API key in your [dashboard](https://sapling.ai/user_settings).
-- Install the Python client by following the installation steps above.
-
-```python
-from sapling import SaplingClient
-
-API_KEY = '<YOUR_API_KEY>'
-client = SaplingClient(api_key=API_KEY)
-edits = client.edits('Lets get started!', session_id='test_session')
-```
-
-The result should be an array of edits of this form:
-
-```json
-[{
-  "id": "aa5ee291-a073-5146-8ebc-c9c899d01278",
-  "sentence": "Lets get started!",
-  "sentence_start": 0,
-  "start": 0,
-  "end": 4,
-  "replacement": "Let's",
-  "error_type": "R:OTHER",
-  "general_error_type": "Other",
-}]
-```
-
-Get a production key by following [this documentation](https://sapling.ai/docs/api/api-access).
-
-Here's some more information on [request options and response structure](https://sapling.ai/docs/api/edits-overview).
-
-License
--------
-
-Copyright 2022 Sapling Intelligence, Inc.
-
-Licensed under the Apache License, Version 2.0.

sapling_py-4.0.2/sapling/version.py

@@ -1 +0,0 @@
-__version__ = '4.0.2'

sapling_py-4.0.2/sapling_py.egg-info/PKG-INFO

@@ -1,94 +0,0 @@
-Metadata-Version: 2.1
-Name: sapling-py
-Version: 4.0.2
-Summary: Sapling Python Client
-Home-page: https://sapling.ai
-Author: Sapling Intelligence
-Author-email: info@sapling.ai
-License: Apache License 2.0
-Classifier: Development Status :: 3 - Alpha
-Classifier: Programming Language :: Python :: 3
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: requests
-
-# Sapling Python Client
-
-Python wrapper for the [Sapling.ai API](https://sapling.ai/api).
-
-Try out a [grammar check demo](https://sapling.ai/grammar-check).
-Compare against grammar checking tools and APIs like Grammarly (Grammerly), LanguageTool, ProWritingAid and Ginger.
-
-Functionality
---------
-
-Sapling is an AI messaging assistant.
-The API currently offers spelling and grammar checking endpoints.
-
-Benefits include:
-- **60% more grammar corrections**: compared to [other systems](https://sapling.ai/comparison/api) at similar accuracy using state-of-the-art machine learning systems for natural language processing.
-- **Low Latency**: Achieve the same real-time performance that users of Sapling's own interface experience.
-- **Over 20 error types**: Error categories such as preposition, noun form, and verb tense, including both high-level and fine-grained error information.
-- **Custom Models**: Get corrections and edits tuned to the domain of your text—for example academic writing vs. subtitles.
-- **Enterprise Security**: Ask us about our no data retention policies, [self-hosted/on-premises](https://sapling.ai/onprem) deployment options, and other [cybersecurity policies and procedures](https://sapling.ai/security).
-- **Rich Text Editor Support**: TinyMCE, CKEditor, QuillJS, Trix, ProseMirror, WordPress, Draft.js, Froala, Lexical and others. Consider using [Sapling's JavaScript SDK](https://sapling.ai/docs/sdk/JavaScript/quickstart) for displaying the API's outputs on webpage editors.
-
-
-Installation
---------
-
-Install the `sapling-py` package with [pip](https://pip.pypa.io/en/stable/installation/)
-
-
-```
-python -m pip install sapling-py
-```
-
-
-Documentation
--------------
-
-Documentation for the client is available at [Read the Docs](https://sapling.readthedocs.io/) and
-documentation for the HTTP API is available at [Sapling.ai](https://sapling.ai/docs).
-
-
-Quickstart
------------
-
-- Register for an account at [Sapling.ai](https://sapling.ai).
-- After registering and signing in, generate a development API key in your [dashboard](https://sapling.ai/user_settings).
-- Install the Python client by following the installation steps above.
-
-```python
-from sapling import SaplingClient
-
-API_KEY = '<YOUR_API_KEY>'
-client = SaplingClient(api_key=API_KEY)
-edits = client.edits('Lets get started!', session_id='test_session')
-```
-
-The result should be an array of edits of this form:
-
-```json
-[{
-  "id": "aa5ee291-a073-5146-8ebc-c9c899d01278",
-  "sentence": "Lets get started!",
-  "sentence_start": 0,
-  "start": 0,
-  "end": 4,
-  "replacement": "Let's",
-  "error_type": "R:OTHER",
-  "general_error_type": "Other",
-}]
-```
-
-Get a production key by following [this documentation](https://sapling.ai/docs/api/api-access).
-
-Here's some more information on [request options and response structure](https://sapling.ai/docs/api/edits-overview).
-
-License
--------
-
-Copyright 2022 Sapling Intelligence, Inc.
-
-Licensed under the Apache License, Version 2.0.

sapling_py-4.0.2/sapling_py.egg-info/requires.txt

@@ -1 +0,0 @@
-requests