routeplane 0.1.0__tar.gz

routeplane-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,44 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+concurrency:
+  group: ci-${{ github.ref }}
+  cancel-in-progress: true
+
+permissions:
+  contents: read
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+      - run: pip install -e '.[dev]'
+      - name: ruff check
+        run: ruff check src/ tests/
+      - name: ruff format --check
+        run: ruff format --check src/ tests/
+      - name: mypy
+        run: mypy src/
+
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      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 }}
+      - run: pip install -e '.[dev]'
+      - run: pytest

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

@@ -0,0 +1,40 @@
+name: Publish to PyPI
+
+on:
+  push:
+    tags: ['v*']
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+      - run: pip install build
+      - run: python -m build
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write  # trusted publishing (OIDC) — no token secret needed
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        # Trusted publishing: configure the PyPI project to trust
+        # routeplane-core/routeplane-python via the "publish" workflow +
+        # "pypi" environment. No PYPI_TOKEN secret required.

routeplane-0.1.0/.gitignore

@@ -0,0 +1,13 @@
+__pycache__/
+*.pyc
+*.pyo
+dist/
+*.egg-info/
+.eggs/
+.ruff_cache/
+.mypy_cache/
+.pytest_cache/
+.env
+.venv/
+venv/
+build/

routeplane-0.1.0/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 2026 Routeplane
+
+   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.

routeplane-0.1.0/PKG-INFO

@@ -0,0 +1,278 @@
+Metadata-Version: 2.4
+Name: routeplane
+Version: 0.1.0
+Summary: Official Python SDK for the Routeplane AI Gateway
+Project-URL: Homepage, https://routeplane.ai
+Project-URL: Documentation, https://docs.routeplane.ai
+Project-URL: Repository, https://github.com/routeplane-core/routeplane-python
+Project-URL: Issues, https://github.com/routeplane-core/routeplane-python/issues
+Author-email: Routeplane <rp_maintainers@routeplane.ai>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: agentic-security,ai-gateway,llm,openai,proxy,routeplane
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software 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 :: Software Development :: Libraries
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Requires-Dist: httpx>=0.24.0
+Requires-Dist: openai>=1.0.0
+Provides-Extra: dev
+Requires-Dist: mypy>=1.10; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.23; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: respx>=0.21; extra == 'dev'
+Requires-Dist: ruff>=0.5; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# Routeplane Python SDK
+
+The official Python SDK for the [Routeplane](https://routeplane.ai) AI Gateway — a
+neutral, OpenAI-compatible proxy in front of 14 LLM providers with sovereign
+routing, guardrails, FinOps, and agentic security.
+
+Routeplane speaks the OpenAI wire format, so you don't have to relearn anything.
+This SDK meets you at whatever level of integration you want:
+
+1. **Change one line** — point the stock `openai` client at the gateway.
+2. **Add headers** — use `headers()` with *any* OpenAI-compatible client or framework.
+3. **Use the client** — `Routeplane` gives you auth, default routing, and typed
+   response metadata.
+
+## Install
+
+```bash
+pip install routeplane
+```
+
+## 1. Minimal — 30 seconds, just change `base_url`
+
+If you already use the OpenAI SDK, point it at Routeplane and pass your gateway
+key. Nothing else changes.
+
+```python
+import openai
+
+client = openai.OpenAI(
+    api_key="rp_your_gateway_key",
+    base_url="https://api.routeplane.ai/v1",
+    default_headers={"x-routeplane-api-key": "rp_your_gateway_key"},
+)
+
+resp = client.chat.completions.create(
+    model="gpt-4o-mini",
+    messages=[{"role": "user", "content": "Hello!"}],
+)
+print(resp.choices[0].message.content)
+```
+
+## 2. Intermediate — `headers()` with any client
+
+Routeplane is configured through `x-routeplane-*` request headers (provider
+routing, residency, strategy, budgets, and more). The `headers()` builder is a
+typed way to produce them, and it drops into *any* client's extra-headers
+escape hatch — so it works far beyond this SDK.
+
+```python
+import openai
+from routeplane import headers
+
+client = openai.OpenAI(
+    api_key="rp_your_gateway_key",
+    base_url="https://api.routeplane.ai/v1",
+    default_headers={"x-routeplane-api-key": "rp_your_gateway_key"},
+)
+
+resp = client.chat.completions.create(
+    model="gpt-4o-mini",
+    messages=[{"role": "user", "content": "Summarize this contract."}],
+    extra_headers=headers(
+        provider="anthropic,openai",   # fallback chain
+        strategy="cost",               # cheapest eligible provider first
+        residency="IN",                # keep Indian PII in-region
+        use_case="contract-summary",   # shows up in FinOps
+    ),
+)
+```
+
+`headers()` only emits the options you set, JSON-serializes dict values
+(`config`, `metadata`), and stringifies ints (`timeout_ms`). All 17 request
+headers are typed.
+
+## 3. Full — the `Routeplane` client with rich metadata
+
+`Routeplane` subclasses `openai.OpenAI`, so everything works exactly as before —
+but it wires up auth for you, lets you set default routing once, and can parse
+the gateway's response headers into a typed `RouteplaneMeta`.
+
+```python
+from routeplane import Routeplane
+
+client = Routeplane(
+    api_key="rp_your_gateway_key",
+    provider="openai,anthropic",   # client-wide default fallback chain
+    strategy="latency",
+    residency="IN",
+    use_case="support-bot",
+)
+
+# Ordinary call — same OpenAI API you already know.
+resp = client.chat.completions.create(
+    model="gpt-4o-mini",
+    messages=[{"role": "user", "content": "Hi"}],
+)
+
+# Want to know what the gateway did? Read the response headers.
+raw = client.chat.completions.with_raw_response.create(
+    model="gpt-4o-mini",
+    messages=[{"role": "user", "content": "Hi"}],
+)
+meta = client.meta_from_headers(raw.headers)
+completion = raw.parse()
+
+print(meta.provider)          # which provider actually served it
+print(meta.cache)             # "hit" | "miss" | "bypass"
+print(meta.budget_remaining)  # spend headroom
+print(meta.pii_masked)        # was PII masked on the way out?
+```
+
+Per-call `extra_headers=headers(...)` still override the client defaults, so you
+can set a house style once and deviate where you need to.
+
+### Async
+
+```python
+from routeplane import AsyncRouteplane
+
+client = AsyncRouteplane(api_key="rp_your_gateway_key", strategy="cost")
+
+resp = await client.chat.completions.create(
+    model="gpt-4o-mini",
+    messages=[{"role": "user", "content": "Hello!"}],
+)
+```
+
+## Framework examples
+
+Because `headers()` returns a plain dict of headers, it plugs into anything that
+forwards headers to the OpenAI API.
+
+### LangChain
+
+```python
+from langchain_openai import ChatOpenAI
+from routeplane import headers
+
+llm = ChatOpenAI(
+    model="gpt-4o-mini",
+    api_key="rp_your_gateway_key",
+    base_url="https://api.routeplane.ai/v1",
+    default_headers={
+        "x-routeplane-api-key": "rp_your_gateway_key",
+        **headers(provider="anthropic,openai", strategy="cost"),
+    },
+)
+```
+
+### LlamaIndex
+
+```python
+from llama_index.llms.openai import OpenAI
+from routeplane import headers
+
+llm = OpenAI(
+    model="gpt-4o-mini",
+    api_key="rp_your_gateway_key",
+    api_base="https://api.routeplane.ai/v1",
+    default_headers={
+        "x-routeplane-api-key": "rp_your_gateway_key",
+        **headers(residency="IN", use_case="rag"),
+    },
+)
+```
+
+### CrewAI
+
+```python
+from crewai import LLM
+from routeplane import headers
+
+llm = LLM(
+    model="openai/gpt-4o-mini",
+    base_url="https://api.routeplane.ai/v1",
+    api_key="rp_your_gateway_key",
+    extra_headers={
+        "x-routeplane-api-key": "rp_your_gateway_key",
+        **headers(strategy="latency", use_case="research-crew"),
+    },
+)
+```
+
+## Request headers reference
+
+All are `x-routeplane-*` and all are optional except the API key. Build them with
+`headers(...)`.
+
+| Option | Header | Notes |
+| --- | --- | --- |
+| `provider` | `x-routeplane-provider` | Provider or comma-separated fallback chain |
+| `residency` | `x-routeplane-residency` | Data-residency region (e.g. `IN`) |
+| `strategy` | `x-routeplane-strategy` | `priority` \| `weighted` \| `cost` \| `latency` |
+| `config` | `x-routeplane-config` | Inline routing config (JSON) |
+| `timeout_ms` | `x-routeplane-timeout-ms` | Upstream timeout, ms |
+| `use_case` | `x-routeplane-use-case` | Analytics/FinOps label |
+| `log_level` | `x-routeplane-log-level` | `metadata` \| `none` \| `full` |
+| `conversation_id` | `x-routeplane-conversation-id` | Groups a conversation |
+| `currency` | `x-routeplane-currency` | Cost-reporting currency |
+| `metadata` | `x-routeplane-metadata` | Arbitrary tags (JSON) |
+| `pii_mode` | `x-routeplane-pii-mode` | `tokenize` |
+| `output_mask` | `x-routeplane-output-mask` | Output masking policy |
+| `cache_control` | `x-routeplane-cache-control` | `no-store` |
+| `idempotency_key` | `x-routeplane-idempotency-key` | Safe-retry key |
+| `cohort` | `x-routeplane-cohort` | Experiment cohort |
+| `batch` | `x-routeplane-batch` | Batch id |
+| `trace_id` | `x-routeplane-trace-id` | Client trace id (echoed back) |
+
+## Response metadata
+
+`RouteplaneMeta.from_headers(response_headers)` (or `client.meta_from_headers(...)`)
+parses the gateway's `x-routeplane-*` response headers: `provider`, `trace_id`,
+`request_id`, `cache`, `guardrails`, `hedged`, `shed`, `budget_remaining`,
+`budget_warning`, `compliance_warning`, `pii_masked`, `idempotent_replayed`.
+
+## Examples
+
+Runnable scripts live in [`examples/`](examples):
+
+| File | Shows |
+| --- | --- |
+| [`basic.py`](examples/basic.py) | Minimal `Routeplane` client — a drop-in OpenAI subclass |
+| [`headers_only.py`](examples/headers_only.py) | Stock `openai` SDK + `headers()` for per-request steering |
+| [`streaming_with_meta.py`](examples/streaming_with_meta.py) | Streaming with the gateway's decision metadata |
+| [`metadata.py`](examples/metadata.py) | `create_with_meta` — completion plus typed `RouteplaneMeta` |
+| [`resources.py`](examples/resources.py) | Non-OpenAI surfaces — status, logs, FinOps, prompts, cache |
+| [`langchain_integration.py`](examples/langchain_integration.py) | LangChain (`ChatOpenAI`) |
+| [`llamaindex_integration.py`](examples/llamaindex_integration.py) | LlamaIndex (`llama-index-llms-openai`) |
+| [`crewai_integration.py`](examples/crewai_integration.py) | CrewAI (`LLM`) |
+
+See [`examples/`](examples) for more.
+
+## Development
+
+```bash
+pip install -e ".[dev]"
+pytest
+ruff check .
+mypy src
+```
+
+## License
+
+Apache-2.0. See [LICENSE](LICENSE).