shellder 0.1.0__tar.gz

shellder-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Soorya Prakash R
+
+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.

shellder-0.1.0/PKG-INFO

@@ -0,0 +1,79 @@
+Metadata-Version: 2.4
+Name: shellder
+Version: 0.1.0
+Summary: Python client for the Shellder prompt API
+Author: Soorya Prakash R
+License: MIT
+Keywords: prompt,prompt-engineering,ai,shellder
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# Shellder
+
+Python client for the Shellder prompt API. Optimize prompts, scrub PII and run safety checks in one call.
+
+## Install
+
+```
+pip install shellder
+```
+
+## Get an API key
+
+Sign in at the Shellder website, open **API Management** and generate a key (starts with `shld_`).
+
+## Usage
+
+```python
+from shellder import Shellder
+
+client = Shellder(api_key="YOUR_API_KEY")  # or set the SHELLDER_API_KEY environment variable
+
+prompt = client.prompts.create(
+    input="Send an email to user@example.com explaining our project timeline.",
+    safety_check=True,
+    pii_scrubbing=True,
+    optimize=True,
+    preserve_variables=["user@example.com"],
+)
+
+print(prompt.output_text)  # optimized prompt (None if blocked by the safety check)
+print(prompt.usage)        # e.g. {'remaining': 14, 'daily_count': 1, 'limit': 15, ...}
+```
+
+## Response
+
+| Property | Description |
+|---|---|
+| `output_text` | Optimized prompt, or the PII-sanitized prompt if `optimize=False`. `None` if blocked. |
+| `blocked` | `True` if the safety check blocked the request. |
+| `safety` | Safety result (`is_safe`, `flagged_categories`, ...). |
+| `pii` | PII result (`detected`, `entities_found`, `sanitized_prompt`). |
+| `usage` | Daily usage (`remaining`, `daily_count`, `limit`). |
+
+## Errors
+
+```python
+from shellder import Shellder, ShellderError
+
+try:
+    Shellder(api_key="bad").prompts.create(input="hi")
+except ShellderError as e:
+    print(e.status, e.message)  # e.g. 401 Unauthorized: API key is invalid.
+```
+
+| Status | Meaning |
+|---|---|
+| 400 | Bad request (missing or too long `input`). |
+| 401 | Invalid API key. |
+| 403 | API key is paused. |
+| 429 | Daily limit reached (resets at 00:00 UTC). |
+
+## License
+
+MIT

shellder-0.1.0/README.md

@@ -0,0 +1,64 @@
+# Shellder
+
+Python client for the Shellder prompt API. Optimize prompts, scrub PII and run safety checks in one call.
+
+## Install
+
+```
+pip install shellder
+```
+
+## Get an API key
+
+Sign in at the Shellder website, open **API Management** and generate a key (starts with `shld_`).
+
+## Usage
+
+```python
+from shellder import Shellder
+
+client = Shellder(api_key="YOUR_API_KEY")  # or set the SHELLDER_API_KEY environment variable
+
+prompt = client.prompts.create(
+    input="Send an email to user@example.com explaining our project timeline.",
+    safety_check=True,
+    pii_scrubbing=True,
+    optimize=True,
+    preserve_variables=["user@example.com"],
+)
+
+print(prompt.output_text)  # optimized prompt (None if blocked by the safety check)
+print(prompt.usage)        # e.g. {'remaining': 14, 'daily_count': 1, 'limit': 15, ...}
+```
+
+## Response
+
+| Property | Description |
+|---|---|
+| `output_text` | Optimized prompt, or the PII-sanitized prompt if `optimize=False`. `None` if blocked. |
+| `blocked` | `True` if the safety check blocked the request. |
+| `safety` | Safety result (`is_safe`, `flagged_categories`, ...). |
+| `pii` | PII result (`detected`, `entities_found`, `sanitized_prompt`). |
+| `usage` | Daily usage (`remaining`, `daily_count`, `limit`). |
+
+## Errors
+
+```python
+from shellder import Shellder, ShellderError
+
+try:
+    Shellder(api_key="bad").prompts.create(input="hi")
+except ShellderError as e:
+    print(e.status, e.message)  # e.g. 401 Unauthorized: API key is invalid.
+```
+
+| Status | Meaning |
+|---|---|
+| 400 | Bad request (missing or too long `input`). |
+| 401 | Invalid API key. |
+| 403 | API key is paused. |
+| 429 | Daily limit reached (resets at 00:00 UTC). |
+
+## License
+
+MIT

shellder-0.1.0/pyproject.toml

@@ -0,0 +1,21 @@
+[build-system]
+requires = ["setuptools>=61"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "shellder"
+version = "0.1.0"
+description = "Python client for the Shellder prompt API"
+readme = "README.md"
+requires-python = ">=3.8"
+license = { text = "MIT" }
+authors = [{ name = "Soorya Prakash R" }]
+keywords = ["prompt", "prompt-engineering", "ai", "shellder"]
+classifiers = [
+  "Programming Language :: Python :: 3",
+  "License :: OSI Approved :: MIT License",
+  "Operating System :: OS Independent",
+]
+
+[tool.setuptools]
+py-modules = ["shellder"]

shellder-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

shellder-0.1.0/shellder.egg-info/PKG-INFO

@@ -0,0 +1,79 @@
+Metadata-Version: 2.4
+Name: shellder
+Version: 0.1.0
+Summary: Python client for the Shellder prompt API
+Author: Soorya Prakash R
+License: MIT
+Keywords: prompt,prompt-engineering,ai,shellder
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# Shellder
+
+Python client for the Shellder prompt API. Optimize prompts, scrub PII and run safety checks in one call.
+
+## Install
+
+```
+pip install shellder
+```
+
+## Get an API key
+
+Sign in at the Shellder website, open **API Management** and generate a key (starts with `shld_`).
+
+## Usage
+
+```python
+from shellder import Shellder
+
+client = Shellder(api_key="YOUR_API_KEY")  # or set the SHELLDER_API_KEY environment variable
+
+prompt = client.prompts.create(
+    input="Send an email to user@example.com explaining our project timeline.",
+    safety_check=True,
+    pii_scrubbing=True,
+    optimize=True,
+    preserve_variables=["user@example.com"],
+)
+
+print(prompt.output_text)  # optimized prompt (None if blocked by the safety check)
+print(prompt.usage)        # e.g. {'remaining': 14, 'daily_count': 1, 'limit': 15, ...}
+```
+
+## Response
+
+| Property | Description |
+|---|---|
+| `output_text` | Optimized prompt, or the PII-sanitized prompt if `optimize=False`. `None` if blocked. |
+| `blocked` | `True` if the safety check blocked the request. |
+| `safety` | Safety result (`is_safe`, `flagged_categories`, ...). |
+| `pii` | PII result (`detected`, `entities_found`, `sanitized_prompt`). |
+| `usage` | Daily usage (`remaining`, `daily_count`, `limit`). |
+
+## Errors
+
+```python
+from shellder import Shellder, ShellderError
+
+try:
+    Shellder(api_key="bad").prompts.create(input="hi")
+except ShellderError as e:
+    print(e.status, e.message)  # e.g. 401 Unauthorized: API key is invalid.
+```
+
+| Status | Meaning |
+|---|---|
+| 400 | Bad request (missing or too long `input`). |
+| 401 | Invalid API key. |
+| 403 | API key is paused. |
+| 429 | Daily limit reached (resets at 00:00 UTC). |
+
+## License
+
+MIT

shellder-0.1.0/shellder.egg-info/SOURCES.txt

@@ -0,0 +1,8 @@
+LICENSE
+README.md
+pyproject.toml
+shellder.py
+shellder.egg-info/PKG-INFO
+shellder.egg-info/SOURCES.txt
+shellder.egg-info/dependency_links.txt
+shellder.egg-info/top_level.txt

shellder-0.1.0/shellder.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

shellder-0.1.0/shellder.egg-info/top_level.txt

@@ -0,0 +1 @@
+shellder

shellder-0.1.0/shellder.py

@@ -0,0 +1,83 @@
+"""Shellder Python client (standard library only).
+
+    from shellder import Shellder
+    client = Shellder(api_key="YOUR_API_KEY")   # or set SHELLDER_API_KEY
+    prompt = client.prompts.create(input="Explain how AI works in a few words")
+    print(prompt.output_text)
+"""
+import json
+import os
+import urllib.error
+import urllib.request
+
+DEFAULT_URL = "https://prompt-enhancer-api.shellderbrain.workers.dev/api/v1/optimize"
+
+
+class ShellderError(Exception):
+    def __init__(self, status, message):
+        super().__init__(f"[{status}] {message}")
+        self.status = status
+        self.message = message
+
+
+class Prompt:
+    def __init__(self, data):
+        self.raw = data
+        self.safety = data.get("safety", {})
+        self.pii = data.get("pii_scrubbing", {})
+        self.optimization = data.get("optimization", {})
+        self.usage = data.get("usage", {})
+
+    @property
+    def blocked(self):
+        return self.safety.get("action_taken") == "blocked"
+
+    @property
+    def output_text(self):
+        """Optimized prompt, else the PII-sanitized prompt. None if blocked by the safety check."""
+        if self.blocked:
+            return None
+        return self.optimization.get("optimized_prompt") or self.pii.get("sanitized_prompt")
+
+
+class _Prompts:
+    def __init__(self, client):
+        self._c = client
+
+    def create(self, input, *, safety_check=True, pii_scrubbing=True, optimize=True, preserve_variables=None):
+        body = {
+            "prompt": input,
+            "options": {
+                "safety_check": safety_check,
+                "pii_scrubbing": pii_scrubbing,
+                "optimize": optimize,
+                "preserve_variables": preserve_variables or [],
+            },
+        }
+        return Prompt(self._c._post(body))
+
+
+class Shellder:
+    def __init__(self, api_key=None, base_url=DEFAULT_URL, timeout=60):
+        self.api_key = api_key or os.environ.get("SHELLDER_API_KEY")
+        if not self.api_key:
+            raise ValueError("Provide api_key or set SHELLDER_API_KEY")
+        self.base_url, self.timeout = base_url, timeout
+        self.prompts = _Prompts(self)
+
+    def _post(self, body):
+        req = urllib.request.Request(
+            self.base_url,
+            data=json.dumps(body).encode(),
+            headers={"Content-Type": "application/json", "x-api-key": self.api_key, "User-Agent": "shellder-python/0.1"},
+            method="POST",
+        )
+        try:
+            with urllib.request.urlopen(req, timeout=self.timeout) as r:
+                return json.load(r)
+        except urllib.error.HTTPError as e:
+            try:
+                msg = json.load(e).get("error", e.reason)
+            except Exception:
+                msg = e.reason
+            raise ShellderError(e.code, msg) from None