sapling-py 4.2.0__tar.gz → 4.4.0__tar.gz

{sapling_py-4.2.0/sapling_py.egg-info → sapling_py-4.4.0}/PKG-INFO

@@ -1,11 +1,12 @@
 Metadata-Version: 2.4
 Name: sapling-py
-Version: 4.2.0
+Version: 4.4.0
 Summary: Sapling Python Client
-Home-page: https://sapling.ai
-Author: Sapling Intelligence
-Author-email: info@sapling.ai
+Author-email: Sapling Intelligence <info@sapling.ai>
 License: Apache License 2.0
+Project-URL: Homepage, https://sapling.ai
+Project-URL: Documentation, https://sapling.readthedocs.io/
+Project-URL: Repository, https://github.com/saplingai/sapling-py
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Programming Language :: Python :: 3
@@ -17,18 +18,7 @@ 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
 
@@ -41,8 +31,8 @@ Compare against leading grammar checking tools and APIs like Grammarly (Grammerl
 
 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,
-zero-shot text classification, structured data extraction, PII detection and redaction, content safety
-scoring, SEO analysis, and more.
+zero-shot text classification, structured data extraction, translation, PII detection and redaction,
+content safety scoring, SEO analysis, 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.
@@ -54,12 +44,19 @@ Key Features:
 
 ## Installation
 
-Install the `sapling-py` package with [pip](https://pip.pypa.io/en/stable/installation/)
+Install the `sapling-py` package from PyPI with
+[pip](https://pip.pypa.io/en/stable/installation/):
 
-```
+```sh
 python -m pip install sapling-py
 ```
 
+Or add it to a [uv](https://docs.astral.sh/uv/) project:
+
+```sh
+uv add 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).

{sapling_py-4.2.0 → sapling_py-4.4.0}/README.md

@@ -9,8 +9,8 @@ Compare against leading grammar checking tools and APIs like Grammarly (Grammerl
 
 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,
-zero-shot text classification, structured data extraction, PII detection and redaction, content safety
-scoring, SEO analysis, and more.
+zero-shot text classification, structured data extraction, translation, PII detection and redaction,
+content safety scoring, SEO analysis, 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.
@@ -22,12 +22,19 @@ Key Features:
 
 ## Installation
 
-Install the `sapling-py` package with [pip](https://pip.pypa.io/en/stable/installation/)
+Install the `sapling-py` package from PyPI with
+[pip](https://pip.pypa.io/en/stable/installation/):
 
-```
+```sh
 python -m pip install sapling-py
 ```
 
+Or add it to a [uv](https://docs.astral.sh/uv/) project:
+
+```sh
+uv add 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).

sapling_py-4.4.0/pyproject.toml

@@ -0,0 +1,42 @@
+[build-system]
+requires = ["setuptools>=61"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "sapling-py"
+dynamic = ["version"]
+description = "Sapling Python Client"
+readme = "README.md"
+requires-python = ">=3.7"
+license = { text = "Apache License 2.0" }
+authors = [
+    { name = "Sapling Intelligence", email = "info@sapling.ai" },
+]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "License :: OSI Approved :: Apache Software License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+]
+dependencies = [
+    "requests",
+]
+
+[project.optional-dependencies]
+test = [
+    "pytest",
+    "responses",
+]
+
+[project.urls]
+Homepage = "https://sapling.ai"
+Documentation = "https://sapling.readthedocs.io/"
+Repository = "https://github.com/saplingai/sapling-py"
+
+[tool.setuptools.dynamic]
+version = { attr = "sapling.version.__version__" }
+
+[tool.setuptools.packages.find]
+include = ["sapling", "sapling.*"]
+exclude = ["test", "test.*"]
+namespaces = false

{sapling_py-4.2.0 → sapling_py-4.4.0}/sapling/client.py

@@ -718,6 +718,63 @@ class SaplingClient:
             data['context'] = context
         return self._request(url, data)
 
+    def translate(
+        self,
+        text,
+        target_lang,
+        source_lang=None,
+        formality=None,
+    ):
+        '''
+        Translates text into a target language with an LLM, preserving line
+        breaks, markup and placeholders in place. The response reports the
+        language the text was actually written in (detected, not assumed from
+        the hint).
+
+        Example::
+
+            client.translate(
+                'Hello world.\\nSee you at 5pm.',
+                target_lang='fr',
+            )
+            # {'translation': 'Bonjour le monde.\\nÀ 17h.',
+            #  'source_lang': 'en', 'source_lang_name': 'English',
+            #  'target_lang': 'fr', 'target_lang_name': 'French'}
+
+        :param text: Text to translate, up to 5,000 characters. Markup and
+            whitespace are preserved, not stripped.
+        :type text: str
+        :param target_lang: Language to translate into: an ISO 639 code
+            (``'fr'``, ``'zh-TW'``) or an English language name
+            (``'French'``). Region variants ``zh-CN``/``zh-TW``/``zh-HK``,
+            ``pt-BR``/``pt-PT``, ``en-GB``/``en-US``, ``fr-CA`` and ``es-419``
+            are supported as targets.
+        :type target_lang: str
+        :param source_lang: Optional hint for the source language, same forms
+            as ``target_lang``. The text itself wins if they disagree.
+        :type source_lang: str
+        :param formality: Optional register: ``'formal'`` (vous/Sie/usted) or
+            ``'informal'`` (tu/du/tú). Omit for the model default.
+        :type formality: str
+        :rtype: dict
+        :return:
+            - translation: The translated text, structure preserved.
+            - source_lang / source_lang_name: The detected source language
+              (``'und'`` and ``None`` when undetermined).
+            - target_lang / target_lang_name: The normalized target.
+        '''
+        url = self.url_endpoint + 'translate'
+        data = {
+            'key': self.api_key,
+            'text': text,
+            'target_lang': target_lang,
+        }
+        if source_lang is not None:
+            data['source_lang'] = source_lang
+        if formality is not None:
+            data['formality'] = formality
+        return self._request(url, data)
+
     def tone(
         self,
         text,
@@ -869,6 +926,7 @@ class SaplingClient:
         self,
         text,
         threshold=None,
+        spans=None,
     ):
         '''
         Scores the provided text on seven content-safety categories: toxicity,
@@ -879,12 +937,19 @@ class SaplingClient:
         :param threshold: Score at or above which a category is flagged.
             Between 0 and 1 inclusive; the API defaults to 0.5.
         :type threshold: float
+        :param spans: When True, the response also includes the offending
+            passages as spans, each with its text, start/end character offsets
+            into the submitted text, per-passage category scores, and
+            flagged_categories. The API defaults to False.
+        :type spans: bool
         :rtype: dict
         :return:
             - scores: A probability from 0 to 1 for each category.
             - flagged: True if any category scored at or above the threshold.
             - flagged_categories: Categories that scored at or above the threshold.
             - threshold: The threshold that was applied.
+            - spans: Only with spans=True — the offending passages, most
+              severe first, as {text, start, end, scores, flagged_categories}.
         '''
         url = self.url_endpoint + 'safety'
         data = {
@@ -893,6 +958,8 @@ class SaplingClient:
         }
         if threshold is not None:
             data['threshold'] = threshold
+        if spans is not None:
+            data['spans'] = spans
         return self._request(url, data)
 
     def pii(

sapling_py-4.4.0/sapling/version.py

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

{sapling_py-4.2.0 → sapling_py-4.4.0/sapling_py.egg-info}/PKG-INFO

@@ -1,11 +1,12 @@
 Metadata-Version: 2.4
 Name: sapling-py
-Version: 4.2.0
+Version: 4.4.0
 Summary: Sapling Python Client
-Home-page: https://sapling.ai
-Author: Sapling Intelligence
-Author-email: info@sapling.ai
+Author-email: Sapling Intelligence <info@sapling.ai>
 License: Apache License 2.0
+Project-URL: Homepage, https://sapling.ai
+Project-URL: Documentation, https://sapling.readthedocs.io/
+Project-URL: Repository, https://github.com/saplingai/sapling-py
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Programming Language :: Python :: 3
@@ -17,18 +18,7 @@ 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
 
@@ -41,8 +31,8 @@ Compare against leading grammar checking tools and APIs like Grammarly (Grammerl
 
 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,
-zero-shot text classification, structured data extraction, PII detection and redaction, content safety
-scoring, SEO analysis, and more.
+zero-shot text classification, structured data extraction, translation, PII detection and redaction,
+content safety scoring, SEO analysis, 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.
@@ -54,12 +44,19 @@ Key Features:
 
 ## Installation
 
-Install the `sapling-py` package with [pip](https://pip.pypa.io/en/stable/installation/)
+Install the `sapling-py` package from PyPI with
+[pip](https://pip.pypa.io/en/stable/installation/):
 
-```
+```sh
 python -m pip install sapling-py
 ```
 
+Or add it to a [uv](https://docs.astral.sh/uv/) project:
+
+```sh
+uv add 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).

{sapling_py-4.2.0 → sapling_py-4.4.0}/sapling_py.egg-info/SOURCES.txt

@@ -1,5 +1,6 @@
 LICENSE
 README.md
+pyproject.toml
 setup.py
 sapling/__init__.py
 sapling/client.py
@@ -14,4 +15,5 @@ test/test_client.py
 test/test_extract.py
 test/test_pii.py
 test/test_safety.py
-test/test_seo.py
+test/test_seo.py
+test/test_translate.py

sapling_py-4.4.0/setup.py

@@ -0,0 +1,53 @@
+"""Compatibility entry point for tools that still invoke ``setup.py`` directly.
+
+Modern build frontends use the metadata in ``pyproject.toml``. The explicit
+fallback keeps direct invocations working with setuptools versions that predate
+PEP 621 support.
+"""
+
+from pathlib import Path
+
+import setuptools
+from setuptools import find_packages, setup
+
+
+def _legacy_setup_kwargs():
+    this_directory = Path(__file__).parent
+    version = {}
+    exec((this_directory / 'sapling/version.py').read_text(), version)
+
+    return {
+        'name': 'sapling-py',
+        'version': version['__version__'],
+        'description': 'Sapling Python Client',
+        'long_description': (this_directory / 'README.md').read_text(),
+        'long_description_content_type': 'text/markdown',
+        'url': 'https://sapling.ai',
+        'author': 'Sapling Intelligence',
+        'author_email': 'info@sapling.ai',
+        'license': 'Apache License 2.0',
+        'classifiers': [
+            'Development Status :: 5 - Production/Stable',
+            'License :: OSI Approved :: Apache Software License',
+            'Programming Language :: Python :: 3',
+            'Programming Language :: Python :: 3 :: Only',
+        ],
+        'packages': find_packages(exclude=['test', 'test.*']),
+        'include_package_data': True,
+        'python_requires': '>=3.7',
+        'install_requires': ['requests'],
+        'extras_require': {
+            'test': [
+                'pytest',
+                'responses',
+            ],
+        },
+    }
+
+
+try:
+    setuptools_major_version = int(setuptools.__version__.partition('.')[0])
+except (AttributeError, ValueError):
+    setuptools_major_version = 0
+
+setup(**_legacy_setup_kwargs() if setuptools_major_version < 61 else {})

sapling_py-4.4.0/test/test_safety.py

@@ -0,0 +1,56 @@
+import json
+
+import pytest
+import responses
+
+from sapling import SaplingClient
+
+API_KEY = 'a' * 32
+BASE = 'https://api.sapling.ai/api/v1/'
+
+
+@pytest.fixture
+def client():
+    return SaplingClient(api_key=API_KEY)
+
+
+@responses.activate
+def test_safety_threshold_sent_when_provided(client):
+    responses.add(responses.POST, BASE + 'safety', json={'flagged': False}, status=200)
+    client.safety('some text', threshold=0.8)
+    body = json.loads(responses.calls[-1].request.body)
+    assert body == {'key': API_KEY, 'text': 'some text', 'threshold': 0.8}
+
+
+@responses.activate
+def test_safety_threshold_omitted_by_default(client):
+    responses.add(responses.POST, BASE + 'safety', json={'flagged': False}, status=200)
+    client.safety('some text')
+    body = json.loads(responses.calls[-1].request.body)
+    assert 'threshold' not in body
+
+
+@responses.activate
+def test_safety_spans_sent_when_provided(client):
+    responses.add(responses.POST, BASE + 'safety', json={'flagged': False}, status=200)
+    client.safety('some text', spans=True)
+    body = json.loads(responses.calls[-1].request.body)
+    assert body == {'key': API_KEY, 'text': 'some text', 'spans': True}
+
+
+@responses.activate
+def test_safety_spans_false_still_sent_explicitly(client):
+    # spans=False is a real value (not "unset"): send it rather than silently
+    # dropping it, mirroring the threshold-style None sentinel.
+    responses.add(responses.POST, BASE + 'safety', json={'flagged': False}, status=200)
+    client.safety('some text', spans=False)
+    body = json.loads(responses.calls[-1].request.body)
+    assert body['spans'] is False
+
+
+@responses.activate
+def test_safety_spans_omitted_by_default(client):
+    responses.add(responses.POST, BASE + 'safety', json={'flagged': False}, status=200)
+    client.safety('some text')
+    body = json.loads(responses.calls[-1].request.body)
+    assert 'spans' not in body

sapling_py-4.4.0/test/test_translate.py

@@ -0,0 +1,81 @@
+import json
+
+import pytest
+import responses
+
+from sapling import SaplingClient, SaplingError
+
+API_KEY = 'a' * 32
+BASE = 'https://api.sapling.ai/api/v1/'
+
+TEXT = 'Hello world.\nSee you at 5pm.'
+
+TRANSLATE_RESPONSE = {
+    'translation': 'Bonjour le monde.\nÀ 17h.',
+    'source_lang': 'en',
+    'source_lang_name': 'English',
+    'target_lang': 'fr',
+    'target_lang_name': 'French',
+}
+
+
+@pytest.fixture
+def client():
+    return SaplingClient(api_key=API_KEY)
+
+
+def _last_request_body():
+    return json.loads(responses.calls[-1].request.body)
+
+
+@responses.activate
+def test_translate_returns_json_and_sends_key(client):
+    responses.add(responses.POST, BASE + 'translate',
+                  json=TRANSLATE_RESPONSE, status=200)
+    result = client.translate(TEXT, target_lang='fr')
+    assert result == TRANSLATE_RESPONSE
+    body = _last_request_body()
+    assert body == {'key': API_KEY, 'text': TEXT, 'target_lang': 'fr'}
+
+
+@responses.activate
+def test_translate_posts_to_translate_endpoint(client):
+    responses.add(responses.POST, BASE + 'translate',
+                  json=TRANSLATE_RESPONSE, status=200)
+    client.translate(TEXT, target_lang='fr')
+    assert responses.calls[-1].request.url == BASE + 'translate'
+
+
+@responses.activate
+def test_translate_optional_params_sent_only_when_given(client):
+    responses.add(responses.POST, BASE + 'translate',
+                  json=TRANSLATE_RESPONSE, status=200)
+    client.translate(TEXT, target_lang='fr')
+    body = _last_request_body()
+    assert 'source_lang' not in body
+    assert 'formality' not in body
+
+    client.translate(TEXT, target_lang='fr',
+                     source_lang='en', formality='formal')
+    body = _last_request_body()
+    assert body['source_lang'] == 'en'
+    assert body['formality'] == 'formal'
+
+
+@responses.activate
+def test_translate_accepts_names_and_region_variants(client):
+    responses.add(responses.POST, BASE + 'translate',
+                  json=dict(TRANSLATE_RESPONSE, target_lang='zh-TW',
+                            target_lang_name='Traditional Chinese'),
+                  status=200)
+    result = client.translate(TEXT, target_lang='Traditional Chinese')
+    assert result['target_lang'] == 'zh-TW'
+    assert _last_request_body()['target_lang'] == 'Traditional Chinese'
+
+
+@responses.activate
+def test_translate_http_error_raises_sapling_error(client):
+    responses.add(responses.POST, BASE + 'translate',
+                  json={'msg': 'Unknown language: "Klingon".'}, status=400)
+    with pytest.raises(SaplingError):
+        client.translate(TEXT, target_lang='Klingon')

sapling_py-4.2.0/sapling/version.py

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

sapling_py-4.2.0/setup.py

@@ -1,41 +0,0 @@
-# Always prefer setuptools over distutils
-from pathlib import Path
-from setuptools import setup, find_packages
-
-this_directory = Path(__file__).parent
-print(this_directory / 'sapling/version.py')
-print(this_directory / "README.md")
-# load module version
-exec(open(this_directory / 'sapling/version.py').read())
-long_description = (this_directory / "README.md").read_text()
-
-setup(
-    name='sapling-py',
-    version=__version__,
-    description='Sapling Python Client',
-    long_description=long_description,
-    long_description_content_type='text/markdown',
-    url='https://sapling.ai',
-    author='Sapling Intelligence',
-    author_email='info@sapling.ai',
-    license='Apache License 2.0',
-    classifiers=[
-        'Development Status :: 5 - Production/Stable',
-        'License :: OSI Approved :: Apache Software License',
-        'Programming Language :: Python :: 3',
-        'Programming Language :: Python :: 3 :: Only',
-    ],
-    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.2.0/test/test_safety.py

@@ -1,30 +0,0 @@
-import json
-
-import pytest
-import responses
-
-from sapling import SaplingClient
-
-API_KEY = 'a' * 32
-BASE = 'https://api.sapling.ai/api/v1/'
-
-
-@pytest.fixture
-def client():
-    return SaplingClient(api_key=API_KEY)
-
-
-@responses.activate
-def test_safety_threshold_sent_when_provided(client):
-    responses.add(responses.POST, BASE + 'safety', json={'flagged': False}, status=200)
-    client.safety('some text', threshold=0.8)
-    body = json.loads(responses.calls[-1].request.body)
-    assert body == {'key': API_KEY, 'text': 'some text', 'threshold': 0.8}
-
-
-@responses.activate
-def test_safety_threshold_omitted_by_default(client):
-    responses.add(responses.POST, BASE + 'safety', json={'flagged': False}, status=200)
-    client.safety('some text')
-    body = json.loads(responses.calls[-1].request.body)
-    assert 'threshold' not in body