sapling-py 4.1.0__py3-none-any.whl

sapling/__init__.py

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

sapling/client.py

@@ -0,0 +1,743 @@
+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.
+
+    :param api_key: 32-character API key
+    :type api_key: str
+    :param timeout: Timeout for API call in seconds. Defaults to 120 seconds.
+    :type timeout: int
+    :param hostname: Hostname override for SDK and self-hosted deployments.
+    :type hostname: str
+    :param pathname: Pathname override for SDK and self-hosted deployments as well as version requirements.
+    :type pathname: str
+    '''
+
+    def __init__(
+        self,
+        api_key,
+        timeout=120,
+        hostname=None,
+        pathname=None,
+    ):
+        self.api_key = api_key
+        self.timeout = timeout
+        self.hostname = hostname or 'https://api.sapling.ai'
+        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,
+        text,
+        session_id=None,
+        lang=None,
+        variety=None,
+        medical=None,
+        auto_apply=False,
+        advanced_edits=None,
+        user_id=None,
+        is_anon_user=None,
+    ):
+        '''
+        Fetches edits (including for grammar and spelling) for provided text.
+
+        :param text: Text to process for edits.
+        :type text: str
+        :param session_id: Unique name or UUID of document or portion of text that is being checked
+        :type session_id: str
+        :param lang: 2 letter ISO 639-1 language code
+        :type lang: str
+        :param variety: Specifies regional English variety preference. Defaults to the configuration in the user Sapling dashboard.
+        :type variety: str
+        :param medical: If true, the backend will apply Sapling's medical dictionary.
+        :type medical: bool
+        :param auto_apply: Whether to return a field with edits applied to the text
+        :type auto_apply: bool
+        :param advanced_edits: Additional edit configurations
+        :type advanced_edits: dict
+        :param user_id: Track IDs representing your end users
+        :type user_id: str
+        :param is_anon_user: If user_id represents a logged-in or anonymous user
+        :type is_anon_user: bool
+        :rtype: dict
+        :return:
+            - edits: List of Edits:
+                - sentence: Unedited sentence
+                - sentence_start: Offset of sentence from start of text
+                - start: Offset of edit start relative to sentence
+                - end: Offset of edit end relative to sentence
+                - replacement: Suggested replacement
+                - error_type: Error type
+                - general_error_type: General Error type
+            - applied_text: Transformed text if auto_apply is set.
+
+        Supported languages:
+            - `de`:  German (Deutsch)
+            - `el`:  Greek (Ελληνικά)
+            - `en`:  English (US/UK/CA/AU)
+            - `es`:  Spanish (Español)
+            - `fr`:  French  (Français) (`fr-fr` and `fr-ca` coming soon)
+            - `it`:  Italian (Italiano)
+            - `jp`:  Japanese (日本語)
+            - `ko`:  Korean (한국어)
+            - `nl`:  Dutch (Nederlands)
+            - `pl`:  Polish (Polski)
+            - `pt`:  Portuguese (Português) (`pt-pt` and `pt-br` coming soon)
+            - `sv`:  Swedish (Svenska)
+            - `tl`:  Tagalog
+            - `zh`:  Chinese (中文)
+
+        Supported varieties:
+            - `us-variety`: American English
+            - `gb-variety`: British English
+            - `au-variety`: Australian English
+            - `ca-variety`: Canadian English
+            - `null-variety`: Don't suggest changes based on English variety
+
+        Supported advanced_edit options:
+            - advanced_edits
+            - adverbs
+            - simplifications
+            - hard_to_read
+            - qualifiers
+            - voice
+            - dei
+            - gender
+            - gender_pronoun
+            - gender_noun
+            - gender_id
+            - sensitivity
+            - disability
+            - age
+            - race
+            - social_class
+            - violence
+        '''
+
+        url = self.url_endpoint + 'edits'
+        session_id = session_id or self.default_session_id
+        data = {
+            'key': self.api_key,
+            'text': text,
+            'session_id': session_id,
+        }
+        if lang is not None:
+            data['lang'] = lang
+        if variety is not None:
+            data['variety'] = variety
+        if medical is not None:
+            data['medical'] = medical
+        if auto_apply is not None:
+            data['auto_apply'] = auto_apply
+        if advanced_edits is not None:
+            data['advanced_edits'] = advanced_edits
+
+        if user_id is not None:
+            data['user_id'] = user_id
+        if is_anon_user is not None:
+            data['is_anon_user'] = is_anon_user
+
+        return self._request(url, data)
+
+    def accept_edit(
+        self,
+        edit_uuid,
+        session_id=None,
+        user_id=None,
+    ):
+        '''
+        Use this API endpoint to have Sapling adapt its system over time.
+
+        Each suggested edit has an edit UUID. You can pass this information back to Sapling to
+        indicate the edit suggestion was helpful.
+        For each unique edit in each document, use the accept or reject API endpoint only once in total.
+
+        :param edit_uuid: Opaque UUID of the edit returned from the edits endpoint
+        :type edit_uuid: str, uuid
+        :param session_id: Unique name or UUID of text that is being processed
+        :type session_id: str
+        :param user_id: Track IDs representing your end users
+        :type user_id: str
+        '''
+        url = f'{self.url_endpoint}edits/{edit_uuid}/accept'
+        session_id = session_id or self.default_session_id
+        data = {
+            'key': self.api_key,
+            'session_id': session_id,
+        }
+
+        if user_id is not None:
+            data['user_id'] = user_id
+
+        self._request(url, data)
+
+    def reject_edit(
+        self,
+        edit_uuid,
+        session_id=None,
+        user_id=None,
+    ):
+        '''
+        Use this API endpoint to have Sapling not recommend the same edit anymore.
+
+        Each suggested edit has an edit UUID. You can pass this information back to Sapling to
+        indicate the edit suggestion was not helpful.
+        For each unique edit in each document, use the accept or reject API endpoint only once in total.
+
+        :param edit_uuid: Opaque UUID of the edit returned from the edits endpoint
+        :type edit_uuid: str, uuid
+        :param session_id: Unique name or UUID of text that is being processed
+        :type session_id: str
+        :param user_id: Track IDs representing your end users
+        :type user_id: str
+        '''
+        url = f'{self.url_endpoint}edits/{edit_uuid}/reject'
+        session_id = session_id or self.default_session_id
+        data = {
+            'key': self.api_key,
+            'session_id': session_id,
+        }
+
+        if user_id is not None:
+            data['user_id'] = user_id
+
+        self._request(url, data)
+
+    def spellcheck(
+        self,
+        text,
+        session_id=None,
+        min_length=None,
+        multiple_edits=None,
+        lang=None,
+        auto_apply=False,
+        variety=None,
+        user_data=None,
+        user_id=None,
+        is_anon_user=None
+    ):
+        '''
+        Fetches spelling (no grammar or phrase level) edits for provided text.
+
+        :param text: Text to process for edits.
+        :type text: str
+        :param session_id: Unique name or UUID of document or portion of text that is being checked
+        :type session_id: str
+        :param min_length: Default is 3. Minimum character length of words to suggest corrections for. Setting this too low will result in much higher false positives.
+        :type min_length: int
+        :param multiple_edits: Default is false. If true, will return `candidates` field containing list of other potential corrections for each error.
+        :type multiple_edits: bool
+        :param lang: Default is English. Specify a language to spellcheck the text against.
+        :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 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
+        :type user_id: str
+        :param is_anon_user: If user_id represents a logged-in or anonymous user
+        :type is_anon_user: bool
+
+        :rtype: list[dict]
+
+        Supported languages:
+            - `en`: English
+            - `ar`: عربي
+            - `bg`: български
+            - `ca`: català
+            - `cs`: čeština
+            - `da`: dansk
+            - `de`: Deutsch
+            - `el`: Ελληνικά
+            - `es`: español
+            - `et`: eesti keel
+            - `fa`: فارسی
+            - `fi`: suomi
+            - `fr`: français (`fr-fr` and `fr-ca` coming soon)
+            - `he`: עִבְרִית
+            - `hi`: हिन्दी",
+            - `hr`: hrvatski,
+            - `hu`: magyar nyelv
+            - `id`: bahasa Indonesia
+            - `is`: íslenska
+            - `it`: italiano
+            - `jp/ja`: 日本語
+            - `ko`: 한국어
+            - `lt`: lietuvių kalba
+            - `lv`: latviešu valoda
+            - `nl`: Nederlands
+            - `no`: norsk
+            - `pl`: polski
+            - `pt`: português
+            - `ro`: limba română
+            - `ru`: русский
+            - `sk`: slovenčina
+            - `sq`: shqip
+            - `sr`: srpski
+            - `sv`: svenska
+            - `th`: ภาษาไทย
+            - `tl`: Tagalog / ᜆᜄᜎᜓᜄ᜔
+            - `tr`: Türkçe
+            - `uk`: Українська мова
+            - `vi`: Tiếng Việt
+            - `zh`: 中文
+
+
+        Supported varieties:
+            - `us-variety`: American English
+            - `gb-variety`: British English
+            - `au-variety`: Australian English
+            - `ca-variety`: Canadian English
+            - `null-variety`: Don't suggest changes based on English variety
+
+        '''
+        url = self.url_endpoint + 'spellcheck'
+        session_id = session_id or self.default_session_id
+        data = {
+            'key': self.api_key,
+            'text': text,
+            'session_id': session_id,
+        }
+
+        if min_length is not None:
+            data['min_length'] = min_length
+        if multiple_edits is not None:
+            data['multiple_edits'] = multiple_edits
+        if lang is not None:
+            data['lang'] = lang
+        if auto_apply is not None:
+            data['auto_apply'] = auto_apply
+        if variety is not None:
+            data['variety'] = variety
+        if user_data is not None:
+            data['user_data'] = user_data
+
+        if user_id is not None:
+            data['user_id'] = user_id
+        if is_anon_user is not None:
+            data['is_anon_user'] = is_anon_user
+
+        return self._request(url, data)
+
+
+    def complete(
+        self,
+        query,
+        session_id=None,
+    ):
+        '''
+        Provides predictions of the next few characters or words
+
+        :param query: Text to get completions against.
+        :type query: str
+        :param session_id: Unique name or UUID of document or portion of text that is being checked
+        :type session_id: str
+        '''
+        url = self.url_endpoint + 'complete'
+        session_id = session_id or self.default_session_id
+        data = {
+            'key': self.api_key,
+            'query': query,
+            'session_id': session_id,
+        }
+
+        return self._request(url, data)
+
+    def accept_complete(
+        self,
+        complete_uuid,
+        query,
+        completion,
+        session_id=None,
+    ):
+        '''
+        Use this API endpoint to have Sapling improve completions over time.
+
+        Each suggested autocomplete has a UUID. You can pass this information back to Sapling to
+        indicate the suggestion was helpful.
+
+        :param complete_uuid: Opaque UUID of the edit returned from the complete endpoint.
+        :type complete_uuid: str, uuid
+        :param query: The query text passed to the complete endpoint.
+        :type query: str
+        :param completion: The suggested completion text returned from the complete endpoint.
+        :type completion: str
+        '''
+        url = f'{self.url_endpoint}complete/{complete_uuid}/accept'
+        session_id = session_id or self.default_session_id
+        data = {
+            'key': self.api_key,
+            'session_id': session_id,
+            'context': {
+                'query': query,
+                'completion': completion,
+            }
+        }
+        self._request(url, data)
+
+    def aidetect(
+        self,
+        text,
+        sent_scores=None,
+    ):
+        '''
+        Score a piece of text on how likely it was generated by AI.
+
+        :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
+
+        :rtype: dict
+        :return:
+            - score: float between 0 and 1, probability that text is AI generated
+            - sentence_scores: If sent_scores is set, will return a list of scores per sentence.
+            - text: text that was processed
+
+        '''
+        url = f'{self.url_endpoint}aidetect'
+        data = {
+            'key': self.api_key,
+            'text': text,
+        }
+        if sent_scores is not None:
+            data['sent_scores'] = sent_scores
+        return self._request(url, data)
+
+    def chunk_text(
+        self,
+        text,
+        max_length,
+        step_size=None,
+    ):
+        '''
+        Break an input text into blocks of length of most max_length. When splitting the text, the API follows the following preference stack:
+
+        page break > paragraph breaks > line breaks > tabs > punctuation > all other whitespace
+
+        :param text: Text to be chunked
+        :type text: str
+        :param max_length: Maximum length of text segments.
+        :type max_length: integer
+        :param step_size: Size of window to look for split points.
+        :type step_size: integer
+        :rtype: dict
+        :return:
+            - chunks: List of resulting chunks
+        '''
+        url = f'{self.url_endpoint}ingest/chunk_text'
+        data = {
+            'key': self.api_key,
+            'text': text,
+            'max_length': max_length
+        }
+        if step_size is not None:
+            data['step_size'] = step_size
+        return self._request(url, data)
+
+    def chunk_html(
+        self,
+        html,
+        max_length,
+        step_size=None,
+    ):
+        '''
+        Break an input text into blocks of length of most max_length. When splitting the text, the API follows the following preference stack:
+
+        page break > paragraph breaks > line breaks > tabs > punctuation > all other whitespace
+
+        Note: This endpoint not only breaks up the HTML but also discards all HTML tags, resulting in plain text.
+
+        :param html: HTML to be chunked
+        :type html: str
+        :param max_length: Maximum length of text segments.
+        :type max_length: integer
+        :param step_size: Size of window to look for split points.
+        :type step_size: integer
+        :rtype: dict
+        :return:
+            - chunks: List of resulting chunks representing the segmented text contained within the HTML
+        '''
+        url = f'{self.url_endpoint}ingest/chunk_html'
+        data = {
+            'key': self.api_key,
+            'html': html,
+            'max_length': max_length
+        }
+        if step_size is not None:
+            data['step_size'] = step_size
+        return self._request(url, data)
+
+    def postprocess(
+        self,
+        text,
+        session_id,
+        operations,
+    ):
+        '''
+        Performs a variety of operations that are useful for working with the outputs of an NLP (whether human or AI) system. These include:
+            - Fixing or restoring punctuation
+            - Fixing capitalization
+            - Fixing or restoring whitespace
+
+        Example use cases include repairing transcriptions or captions.
+
+        :param text: Text to postprocess
+        :type text: str
+        :param session_id: Unique name or UUID of document or portion of text that is being chunked
+        :type text: str
+        :param operations: Operations to apply. The currently accepted operations are:
+            - capitalize
+            - punctuate
+            - fixspaces
+
+        :type operations: list[str]
+        :rtype: list[dict]
+        :return:
+            Same as the edits endpoint:
+            - sentence: Unedited sentence
+            - sentence_start: Offset of sentence from start of text
+            - start: Offset of edit start relative to sentence
+            - end: Offset of edit end relative to sentence
+            - replacement: Suggested replacement
+            - error_type: Error type
+            - general_error_type: General Error type
+        '''
+        url = f'{self.url_endpoint}postprocess'
+        data = {
+            'key': self.api_key,
+            'text': text,
+            'session_id': session_id,
+            'operations': operations,
+        }
+        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/version.py

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

sapling_py-4.1.0.dist-info/METADATA

@@ -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.dist-info/RECORD

@@ -0,0 +1,8 @@
+sapling/__init__.py,sha256=Fbgr7l2gvBTdhNUp_gLr8GAgFA-5dot1IpBsURxmRY8,162
+sapling/client.py,sha256=GQDup8fLwExrGuGUvoO2ork13HvPXRZFWDow3GMfYFc,24994
+sapling/version.py,sha256=_fosQb59FTQQCtQqbaLmneA_xX6SrQbaKaEobCMMzGk,22
+sapling_py-4.1.0.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+sapling_py-4.1.0.dist-info/METADATA,sha256=9k6Y6ZsB7YLHntz9iOXQ1okpfVMQwSY0yUrOUbpSMnQ,3957
+sapling_py-4.1.0.dist-info/WHEEL,sha256=K260EYznzXsJYBQGqmI8VTxEdiZYNvDZwW9cBh9-_MA,91
+sapling_py-4.1.0.dist-info/top_level.txt,sha256=MHKGXD8i2vBIWWvWyRgPzoT15juqU2qsCfabvBSRw2E,8
+sapling_py-4.1.0.dist-info/RECORD,,

sapling_py-4.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (83.0.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

sapling_py-4.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

sapling_py-4.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+sapling