shieldcortex 0.1.0__tar.gz

shieldcortex-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,24 @@
+name: Publish to PyPI
+
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - name: Install build tools
+        run: pip install build
+      - name: Build package
+        run: python -m build
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

shieldcortex-0.1.0/.github/workflows/test.yml

@@ -0,0 +1,27 @@
+name: Tests
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: pip install -e ".[dev]"
+      - name: Lint
+        run: ruff check src/
+      - name: Type check
+        run: mypy src/shieldcortex/ --ignore-missing-imports
+      - name: Test
+        run: pytest tests/ -v

shieldcortex-0.1.0/.gitignore

@@ -0,0 +1,17 @@
+__pycache__/
+*.py[cod]
+*$py.class
+*.egg-info/
+dist/
+build/
+.eggs/
+*.egg
+.mypy_cache/
+.ruff_cache/
+.pytest_cache/
+.venv/
+venv/
+env/
+*.so
+.coverage
+htmlcov/

shieldcortex-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Drakon Systems Ltd
+
+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.

shieldcortex-0.1.0/PKG-INFO

@@ -0,0 +1,191 @@
+Metadata-Version: 2.4
+Name: shieldcortex
+Version: 0.1.0
+Summary: Official Python SDK for the ShieldCortex API — AI memory security scanning
+Project-URL: Homepage, https://shieldcortex.ai
+Project-URL: Documentation, https://shieldcortex.ai/docs
+Project-URL: Repository, https://github.com/Drakon-Systems-Ltd/shieldcortex-python
+Project-URL: Bug Tracker, https://github.com/Drakon-Systems-Ltd/shieldcortex-python/issues
+Author-email: Drakon Systems Ltd <support@shieldcortex.ai>
+License: MIT
+License-File: LICENSE
+Keywords: ai,defence,firewall,memory,prompt-injection,security,shieldcortex
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Security
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Requires-Dist: httpx>=0.27.0
+Provides-Extra: crewai
+Requires-Dist: crewai>=0.28.0; extra == 'crewai'
+Provides-Extra: dev
+Requires-Dist: build>=1.0.0; extra == 'dev'
+Requires-Dist: mypy>=1.8.0; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.23.0; extra == 'dev'
+Requires-Dist: pytest>=8.0.0; extra == 'dev'
+Requires-Dist: respx>=0.21.0; extra == 'dev'
+Requires-Dist: ruff>=0.2.0; extra == 'dev'
+Provides-Extra: langchain
+Requires-Dist: langchain-core>=0.1.0; extra == 'langchain'
+Description-Content-Type: text/markdown
+
+# shieldcortex
+
+[![PyPI](https://img.shields.io/pypi/v/shieldcortex)](https://pypi.org/project/shieldcortex/)
+[![Python](https://img.shields.io/pypi/pyversions/shieldcortex)](https://pypi.org/project/shieldcortex/)
+[![License](https://img.shields.io/pypi/l/shieldcortex)](LICENSE)
+
+Official Python SDK for the [ShieldCortex](https://shieldcortex.ai) API — AI memory security scanning.
+
+ShieldCortex is a 6-layer defence pipeline that protects AI agent memory from prompt injection, credential leaks, encoding attacks, and more.
+
+## Installation
+
+```bash
+pip install shieldcortex
+```
+
+With framework integrations:
+
+```bash
+pip install shieldcortex[crewai]     # CrewAI memory guard
+pip install shieldcortex[langchain]  # LangChain callback handler
+```
+
+## Quick Start
+
+```python
+from shieldcortex import ShieldCortex
+
+client = ShieldCortex(api_key="sc_live_...")
+
+# Scan user input before storing in memory
+result = client.scan("user input here")
+
+if not result.allowed:
+    print(f"Blocked: {result.firewall.reason}")
+    print(f"Threats: {result.firewall.threat_indicators}")
+else:
+    print(f"Safe (trust: {result.trust.score})")
+```
+
+## Async Support
+
+```python
+from shieldcortex import AsyncShieldCortex
+
+async with AsyncShieldCortex(api_key="sc_live_...") as client:
+    result = await client.scan("user input here")
+```
+
+## Batch Scanning
+
+```python
+from shieldcortex import BatchItem
+
+result = client.scan_batch([
+    BatchItem(content="memory entry 1"),
+    BatchItem(content="memory entry 2"),
+])
+print(f"Scanned: {result.total_scanned}, Threats: {result.threats}")
+```
+
+## Audit Logs
+
+```python
+from shieldcortex import AuditQuery
+
+# Query with filters
+logs = client.get_audit_logs(AuditQuery(level="BLOCK", limit=10))
+
+# Auto-paginate through all entries
+for entry in client.iter_audit_logs():
+    print(entry.id, entry.firewall_result)
+
+# Export as CSV
+csv = client.export_audit_logs(format="csv")
+```
+
+## CrewAI Integration
+
+Scan all memory writes before they reach your store:
+
+```python
+from shieldcortex import ShieldCortex
+from shieldcortex.integrations.crewai import ShieldCortexMemoryGuard, MemoryBlockedError
+
+client = ShieldCortex(api_key="sc_live_...")
+guard = ShieldCortexMemoryGuard(client, mode="strict")
+
+try:
+    guard.check("content to remember")
+    # Safe — save to memory store
+except MemoryBlockedError as e:
+    print(f"Blocked: {e.result.firewall.reason}")
+```
+
+## LangChain Integration
+
+Scan LLM inputs and outputs automatically:
+
+```python
+from shieldcortex import AsyncShieldCortex
+from shieldcortex.integrations.langchain import ShieldCortexCallbackHandler
+
+client = AsyncShieldCortex(api_key="sc_live_...")
+handler = ShieldCortexCallbackHandler(client, raise_on_block=True)
+
+# Pass to any LangChain component
+llm = ChatOpenAI(callbacks=[handler])
+```
+
+## Error Handling
+
+```python
+from shieldcortex.errors import AuthError, RateLimitError, ValidationError
+
+try:
+    result = client.scan("content")
+except AuthError:
+    print("Invalid API key")
+except RateLimitError as e:
+    print(f"Rate limited, retry after {e.retry_after}s")
+except ValidationError:
+    print("Invalid request")
+```
+
+## Full API Coverage
+
+The SDK covers all ShieldCortex API endpoints:
+
+| Category | Methods |
+|----------|---------|
+| **Scanning** | `scan()`, `scan_batch()`, `scan_skill()` |
+| **Audit** | `get_audit_logs()`, `get_audit_entry()`, `get_audit_stats()`, `get_audit_trends()`, `export_audit_logs()`, `iter_audit_logs()` |
+| **Quarantine** | `get_quarantine()`, `get_quarantine_item()`, `review_quarantine_item()` |
+| **API Keys** | `create_api_key()`, `list_api_keys()`, `revoke_api_key()` |
+| **Teams** | `get_team()`, `update_team()`, `get_team_members()`, `get_usage()` |
+| **Invites** | `create_invite()`, `list_invites()`, `delete_invite()`, `resend_invite()` |
+| **Billing** | `create_checkout_session()`, `create_portal_session()` |
+| **Devices** | `get_devices()`, `register_device()`, `update_device()`, `device_heartbeat()` |
+| **Alerts** | `get_alerts()`, `create_alert()`, `update_alert()`, `delete_alert()` |
+| **Webhooks** | `get_webhooks()`, `create_webhook()`, `update_webhook()`, `delete_webhook()`, `test_webhook()`, `get_webhook_deliveries()` |
+| **Firewall Rules** | `get_firewall_rules()`, `get_active_firewall_rules()`, `create_firewall_rule()`, `update_firewall_rule()`, `delete_firewall_rule()` |
+
+## Documentation
+
+- [ShieldCortex Docs](https://shieldcortex.ai/docs)
+- [API Reference](https://shieldcortex.ai/docs)
+- [Examples](examples/)
+
+## License
+
+MIT

shieldcortex-0.1.0/README.md

@@ -0,0 +1,152 @@
+# shieldcortex
+
+[![PyPI](https://img.shields.io/pypi/v/shieldcortex)](https://pypi.org/project/shieldcortex/)
+[![Python](https://img.shields.io/pypi/pyversions/shieldcortex)](https://pypi.org/project/shieldcortex/)
+[![License](https://img.shields.io/pypi/l/shieldcortex)](LICENSE)
+
+Official Python SDK for the [ShieldCortex](https://shieldcortex.ai) API — AI memory security scanning.
+
+ShieldCortex is a 6-layer defence pipeline that protects AI agent memory from prompt injection, credential leaks, encoding attacks, and more.
+
+## Installation
+
+```bash
+pip install shieldcortex
+```
+
+With framework integrations:
+
+```bash
+pip install shieldcortex[crewai]     # CrewAI memory guard
+pip install shieldcortex[langchain]  # LangChain callback handler
+```
+
+## Quick Start
+
+```python
+from shieldcortex import ShieldCortex
+
+client = ShieldCortex(api_key="sc_live_...")
+
+# Scan user input before storing in memory
+result = client.scan("user input here")
+
+if not result.allowed:
+    print(f"Blocked: {result.firewall.reason}")
+    print(f"Threats: {result.firewall.threat_indicators}")
+else:
+    print(f"Safe (trust: {result.trust.score})")
+```
+
+## Async Support
+
+```python
+from shieldcortex import AsyncShieldCortex
+
+async with AsyncShieldCortex(api_key="sc_live_...") as client:
+    result = await client.scan("user input here")
+```
+
+## Batch Scanning
+
+```python
+from shieldcortex import BatchItem
+
+result = client.scan_batch([
+    BatchItem(content="memory entry 1"),
+    BatchItem(content="memory entry 2"),
+])
+print(f"Scanned: {result.total_scanned}, Threats: {result.threats}")
+```
+
+## Audit Logs
+
+```python
+from shieldcortex import AuditQuery
+
+# Query with filters
+logs = client.get_audit_logs(AuditQuery(level="BLOCK", limit=10))
+
+# Auto-paginate through all entries
+for entry in client.iter_audit_logs():
+    print(entry.id, entry.firewall_result)
+
+# Export as CSV
+csv = client.export_audit_logs(format="csv")
+```
+
+## CrewAI Integration
+
+Scan all memory writes before they reach your store:
+
+```python
+from shieldcortex import ShieldCortex
+from shieldcortex.integrations.crewai import ShieldCortexMemoryGuard, MemoryBlockedError
+
+client = ShieldCortex(api_key="sc_live_...")
+guard = ShieldCortexMemoryGuard(client, mode="strict")
+
+try:
+    guard.check("content to remember")
+    # Safe — save to memory store
+except MemoryBlockedError as e:
+    print(f"Blocked: {e.result.firewall.reason}")
+```
+
+## LangChain Integration
+
+Scan LLM inputs and outputs automatically:
+
+```python
+from shieldcortex import AsyncShieldCortex
+from shieldcortex.integrations.langchain import ShieldCortexCallbackHandler
+
+client = AsyncShieldCortex(api_key="sc_live_...")
+handler = ShieldCortexCallbackHandler(client, raise_on_block=True)
+
+# Pass to any LangChain component
+llm = ChatOpenAI(callbacks=[handler])
+```
+
+## Error Handling
+
+```python
+from shieldcortex.errors import AuthError, RateLimitError, ValidationError
+
+try:
+    result = client.scan("content")
+except AuthError:
+    print("Invalid API key")
+except RateLimitError as e:
+    print(f"Rate limited, retry after {e.retry_after}s")
+except ValidationError:
+    print("Invalid request")
+```
+
+## Full API Coverage
+
+The SDK covers all ShieldCortex API endpoints:
+
+| Category | Methods |
+|----------|---------|
+| **Scanning** | `scan()`, `scan_batch()`, `scan_skill()` |
+| **Audit** | `get_audit_logs()`, `get_audit_entry()`, `get_audit_stats()`, `get_audit_trends()`, `export_audit_logs()`, `iter_audit_logs()` |
+| **Quarantine** | `get_quarantine()`, `get_quarantine_item()`, `review_quarantine_item()` |
+| **API Keys** | `create_api_key()`, `list_api_keys()`, `revoke_api_key()` |
+| **Teams** | `get_team()`, `update_team()`, `get_team_members()`, `get_usage()` |
+| **Invites** | `create_invite()`, `list_invites()`, `delete_invite()`, `resend_invite()` |
+| **Billing** | `create_checkout_session()`, `create_portal_session()` |
+| **Devices** | `get_devices()`, `register_device()`, `update_device()`, `device_heartbeat()` |
+| **Alerts** | `get_alerts()`, `create_alert()`, `update_alert()`, `delete_alert()` |
+| **Webhooks** | `get_webhooks()`, `create_webhook()`, `update_webhook()`, `delete_webhook()`, `test_webhook()`, `get_webhook_deliveries()` |
+| **Firewall Rules** | `get_firewall_rules()`, `get_active_firewall_rules()`, `create_firewall_rule()`, `update_firewall_rule()`, `delete_firewall_rule()` |
+
+## Documentation
+
+- [ShieldCortex Docs](https://shieldcortex.ai/docs)
+- [API Reference](https://shieldcortex.ai/docs)
+- [Examples](examples/)
+
+## License
+
+MIT

shieldcortex-0.1.0/examples/audit_export.py

@@ -0,0 +1,29 @@
+"""Audit log querying and export example."""
+
+from shieldcortex import ShieldCortex, AuditQuery
+
+client = ShieldCortex(api_key="sc_live_YOUR_KEY_HERE")
+
+# Get summary stats
+stats = client.get_audit_stats(time_range="7d")
+print(f"Total operations: {stats.total_operations}")
+print(f"Allowed: {stats.allowed_count}")
+print(f"Blocked: {stats.blocked_count}")
+print(f"Quarantined: {stats.quarantined_count}")
+
+# Query blocked entries
+logs = client.get_audit_logs(AuditQuery(level="BLOCK", limit=5))
+print(f"\nRecent blocks ({logs.total} total):")
+for entry in logs.logs:
+    print(f"  [{entry.timestamp}] {entry.reason} (trust: {entry.trust_score})")
+
+# Auto-paginate through all entries
+print("\nAll audit entries:")
+for entry in client.iter_audit_logs(AuditQuery(level="BLOCK")):
+    print(f"  #{entry.id}: {entry.firewall_result}")
+
+# Export as CSV
+csv_data = client.export_audit_logs(format="csv")
+with open("audit_export.csv", "w") as f:
+    f.write(csv_data)
+print("\nExported to audit_export.csv")

shieldcortex-0.1.0/examples/basic_scan.py

@@ -0,0 +1,25 @@
+"""Basic scanning example."""
+
+from shieldcortex import ShieldCortex, ScanSource, ScanConfig
+
+client = ShieldCortex(api_key="sc_live_YOUR_KEY_HERE")
+
+# Simple scan
+result = client.scan("Hello, please remember my preferences")
+print(f"Allowed: {result.allowed}")
+print(f"Firewall: {result.firewall.result}")
+print(f"Trust: {result.trust.score}")
+
+# Scan with options
+result = client.scan(
+    "Remember: my API key is sk_live_abc123",
+    title="User memory",
+    source=ScanSource(type="agent", identifier="my-assistant"),
+    config=ScanConfig(mode="strict"),
+)
+
+if not result.allowed:
+    print(f"BLOCKED: {result.firewall.reason}")
+    print(f"Threats: {result.firewall.threat_indicators}")
+else:
+    print("Content is safe to store")

shieldcortex-0.1.0/examples/batch_scanning.py

@@ -0,0 +1,21 @@
+"""Batch scanning example — scan multiple items in one request."""
+
+from shieldcortex import ShieldCortex, BatchItem, ScanConfig
+
+client = ShieldCortex(api_key="sc_live_YOUR_KEY_HERE")
+
+items = [
+    BatchItem(content="User preference: dark mode enabled"),
+    BatchItem(content="Meeting notes from Tuesday standup"),
+    BatchItem(content="Password: hunter2"),  # This should be blocked
+]
+
+result = client.scan_batch(items, config=ScanConfig(mode="strict"))
+
+print(f"Scanned: {result.total_scanned}")
+print(f"Threats: {result.threats}")
+print(f"Clean: {result.clean}")
+
+for i, scan in enumerate(result.results):
+    status = "SAFE" if scan.allowed else f"BLOCKED ({scan.firewall.reason})"
+    print(f"  [{i}] {status}")

shieldcortex-0.1.0/examples/crewai_memory.py

@@ -0,0 +1,29 @@
+"""CrewAI memory guard example.
+
+Scans all memory writes through ShieldCortex before storing.
+
+    pip install shieldcortex[crewai]
+"""
+
+from shieldcortex import ShieldCortex
+from shieldcortex.integrations.crewai import MemoryBlockedError, ShieldCortexMemoryGuard
+
+client = ShieldCortex(api_key="sc_live_YOUR_KEY_HERE")
+guard = ShieldCortexMemoryGuard(client, mode="strict")
+
+# In your CrewAI agent's memory pipeline:
+memories_to_save = [
+    "User prefers dark mode",
+    "Meeting at 3pm with the team",
+    "AWS key: AKIAIOSFODNN7EXAMPLE",  # This should be blocked
+]
+
+for memory in memories_to_save:
+    try:
+        result = guard.check(memory)
+        print(f"  SAFE: {memory[:50]}... (trust: {result.trust.score})")
+        # ... save to your memory store here ...
+    except MemoryBlockedError as e:
+        print(f"  BLOCKED: {memory[:50]}... ({e.result.firewall.reason})")
+
+print(f"\nAudit trail: {len(guard.audit_ids)} scans recorded")

shieldcortex-0.1.0/examples/langchain_callback.py

@@ -0,0 +1,34 @@
+"""LangChain callback handler example.
+
+Scans LLM inputs and outputs through ShieldCortex.
+
+    pip install shieldcortex[langchain]
+"""
+
+import asyncio
+
+from shieldcortex import AsyncShieldCortex
+from shieldcortex.integrations.langchain import ShieldCortexCallbackHandler
+
+
+async def main() -> None:
+    async with AsyncShieldCortex(api_key="sc_live_YOUR_KEY_HERE") as client:
+        handler = ShieldCortexCallbackHandler(
+            client,
+            mode="balanced",
+            scan_inputs=True,
+            scan_outputs=True,
+            raise_on_block=False,  # Log warnings instead of raising
+        )
+
+        # Use with any LangChain component:
+        #
+        # from langchain_openai import ChatOpenAI
+        # llm = ChatOpenAI(callbacks=[handler])
+        # response = await llm.ainvoke("Hello!")
+
+        print(f"Handler ready. Audit IDs so far: {handler.audit_ids}")
+
+
+if __name__ == "__main__":
+    asyncio.run(main())

shieldcortex-0.1.0/pyproject.toml

@@ -0,0 +1,81 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "shieldcortex"
+version = "0.1.0"
+description = "Official Python SDK for the ShieldCortex API — AI memory security scanning"
+readme = "README.md"
+license = { text = "MIT" }
+requires-python = ">=3.9"
+authors = [
+    { name = "Drakon Systems Ltd", email = "support@shieldcortex.ai" },
+]
+keywords = [
+    "shieldcortex",
+    "ai",
+    "security",
+    "memory",
+    "firewall",
+    "prompt-injection",
+    "defence",
+]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Security",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Typing :: Typed",
+]
+dependencies = [
+    "httpx>=0.27.0",
+]
+
+[project.optional-dependencies]
+crewai = ["crewai>=0.28.0"]
+langchain = ["langchain-core>=0.1.0"]
+dev = [
+    "pytest>=8.0.0",
+    "pytest-asyncio>=0.23.0",
+    "respx>=0.21.0",
+    "mypy>=1.8.0",
+    "ruff>=0.2.0",
+    "build>=1.0.0",
+]
+
+[project.urls]
+Homepage = "https://shieldcortex.ai"
+Documentation = "https://shieldcortex.ai/docs"
+Repository = "https://github.com/Drakon-Systems-Ltd/shieldcortex-python"
+"Bug Tracker" = "https://github.com/Drakon-Systems-Ltd/shieldcortex-python/issues"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/shieldcortex"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+asyncio_mode = "auto"
+
+[tool.mypy]
+strict = true
+warn_unreachable = true
+pretty = true
+show_error_context = true
+
+[tool.ruff]
+line-length = 100
+target-version = "py39"
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "UP"]
+# UP007/UP045: Don't convert Optional[X] to X | None — types.py dataclass fields
+# are evaluated at runtime by get_type_hints(), and X | None requires Python 3.10+.
+ignore = ["UP007", "UP045"]