pangram-sdk 0.1.2__tar.gz

pangram_sdk-0.1.2/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Max Spero
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pangram_sdk-0.1.2/PKG-INFO

@@ -0,0 +1,60 @@
+Metadata-Version: 2.1
+Name: pangram-sdk
+Version: 0.1.2
+Summary: 
+Author: Max Spero
+Author-email: max@pangramlabs.com
+Requires-Python: >=3.7,<4.0
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: requests (>=2.31.0,<3.0.0)
+Description-Content-Type: text/markdown
+
+# Pangram Labs Python Package
+
+### Installation
+```
+pip install pangram-sdk
+```
+
+### Add your API key
+Either export it as a variable.
+```
+export PANGRAM_API_KEY=<your API key>
+```
+Or pass it in to the constructor:
+```
+my_api_key = ''  # Fill this in with your API key.
+classifier = PangramText(api_key=my_api_key)
+```
+
+### Make a request
+```
+from pangram import PangramText
+
+classifier = PangramText()
+result = classifier.predict(text)
+# Score in range [0, 1] where 0 is human-written and 1 is AI-generated.
+score = result['ai_likelihood']
+```
+
+### Make a batch request
+```
+from pangram import PangramText
+
+text_batch = ["abc", "def"]
+
+classifier = PangramText()
+results = classifier.batch_predict(text_batch)
+for result in results:
+    text = result['text']
+    score = result['ai_likelihood']
+```
+
+Questions? Email me at max@pangramlabs.com!
+

pangram_sdk-0.1.2/README.md

@@ -0,0 +1,42 @@
+# Pangram Labs Python Package
+
+### Installation
+```
+pip install pangram-sdk
+```
+
+### Add your API key
+Either export it as a variable.
+```
+export PANGRAM_API_KEY=<your API key>
+```
+Or pass it in to the constructor:
+```
+my_api_key = ''  # Fill this in with your API key.
+classifier = PangramText(api_key=my_api_key)
+```
+
+### Make a request
+```
+from pangram import PangramText
+
+classifier = PangramText()
+result = classifier.predict(text)
+# Score in range [0, 1] where 0 is human-written and 1 is AI-generated.
+score = result['ai_likelihood']
+```
+
+### Make a batch request
+```
+from pangram import PangramText
+
+text_batch = ["abc", "def"]
+
+classifier = PangramText()
+results = classifier.batch_predict(text_batch)
+for result in results:
+    text = result['text']
+    score = result['ai_likelihood']
+```
+
+Questions? Email me at max@pangramlabs.com!

pangram_sdk-0.1.2/pangram/__init__.py

@@ -0,0 +1,9 @@
+"""Defile all variables to be accessible from `import pangram`."""
+__version__ = "0.1.2"
+__author__ = "Max Spero"
+__email__ = "max@pangramlabs.com"
+__license__ = "MIT"
+
+from pangram.text_classifier import PangramText
+
+__all__ = ["text_classifier", "PangramText"]

pangram_sdk-0.1.2/pangram/text_classifier.py

@@ -0,0 +1,76 @@
+import requests
+import os
+from typing import List
+
+SOURCE_VERSION = "python_sdk_0.1.0"
+
+API_ENDPOINT = 'https://text.api.pangramlabs.com'
+BATCH_API_ENDPOINT = 'https://text-batch.api.pangramlabs.com'
+MAX_BATCH_SIZE = 32
+
+class PangramText:
+    def __init__(self, api_key: str = None, max_batch_size = MAX_BATCH_SIZE) -> None:
+        """
+        A classifier for text inputs using the Pangram Labs API.
+
+        This class provides synchronous and asynchronous methods to classify text by making API requests.
+
+        :param api_key: Your API key for the Pangram Labs. If not provided, the environment variable PANGRAM_API_KEY will be used.
+        :type api_key: str, optional
+        :raises ValueError: If the API key is not provided and not set in the environment.
+        """
+        if api_key is None:
+            self.api_key = os.getenv('PANGRAM_API_KEY')
+            if self.api_key is None:
+                raise ValueError("API key is required. Set the environment variable PANGRAM_API_KEY or pass it as an argument.")
+        else:
+            self.api_key = api_key
+        self.max_batch_size = max_batch_size
+
+
+    def predict(self, text: str):
+        """
+        Classify text as AI- or human-written.
+
+        Sends a request to the Pangram Text API and returns the classification result.
+
+        :param text: The text to be classified.
+        :type text: str
+        :return: The classification result from the API.
+        :rtype: dict
+        """
+        headers = {
+            'Content-Type': 'application/json',
+            'x-api-key': self.api_key,
+        }
+        input_json = {
+            "text": text,
+            "source": SOURCE_VERSION,
+        }
+        response = requests.post(API_ENDPOINT, json=input_json, headers=headers, timeout=90)
+        return response.json()
+
+
+    def batch_predict(self, text_batch: List[str]):
+        """
+        Classify a batch of text as AI- or human-written.
+
+        This method sends a batch of text to the Pangram Text API and returns the classification results.
+
+        :param text_batch: A list of strings to be classified.
+        :type text_batch: List[str]
+        :return: A list of classification results from the API for each text in the batch.
+        :rtype: List[dict]
+        """
+        if len(text_batch) > self.max_batch_size:
+            raise ValueError(f"Maximum batch size is {self.max_batch_size}.")
+        headers = {
+            'Content-Type': 'application/json',
+            'x-api-key': self.api_key,
+        }
+        input_json = {
+            "text": text_batch,
+            "source": SOURCE_VERSION,
+        }
+        response = requests.post(BATCH_API_ENDPOINT, json=input_json, headers=headers, timeout=90)
+        return response.json()["responses"]

pangram_sdk-0.1.2/pyproject.toml

@@ -0,0 +1,21 @@
+[tool.poetry]
+name = "pangram-sdk"
+version = "0.1.2"
+description = ""
+authors = ["Max Spero <max@pangramlabs.com>"]
+readme = "README.md"
+packages = [
+    { include = "pangram" }
+]
+
+[tool.poetry.dependencies]
+python = "^3.7"
+requests = "^2.31.0"
+
+[tool.poetry.dev-dependencies]
+sphinx = "^3.0"
+sphinxcontrib-httpdomain = "*"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"