inferrail 0.1.0__tar.gz

inferrail-0.1.0/.env.example

@@ -0,0 +1,11 @@
+# Copy this file to .env and fill in real values.
+# .env is gitignored — never commit real credentials.
+
+OPENAI_API_KEY=sk-replace-with-your-key
+
+# Optional: require callers of the gateway to present this exact value as
+# `Authorization: Bearer <token>`. Unset by default (localhost-dev mode).
+# Strongly recommended if this gateway is reachable by anything other than
+# your own machine, since anyone who can reach it can otherwise consume
+# your configured provider credentials. See README.md's "Security" section.
+# INFERRAIL_GATEWAY_TOKEN=replace-with-a-long-random-value

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

@@ -0,0 +1,46 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.11", "3.12"]
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install package with dev dependencies
+        run: pip install -e ".[dev,mcp]"
+
+      - name: Lint (ruff)
+        run: ruff check .
+
+      - name: Type-check (mypy)
+        run: mypy
+
+      - name: Test (pytest, no external credentials required)
+        run: pytest
+
+      - name: Check openapi.json is up to date
+        run: |
+          python scripts/generate_openapi.py
+          git diff --exit-code openapi.json
+
+      - name: Check config.schema.json is up to date
+        run: |
+          python scripts/generate_config_schema.py
+          git diff --exit-code config.schema.json
+
+      - name: Check ERRORS.md is up to date
+        run: |
+          python scripts/generate_errors_md.py
+          git diff --exit-code ERRORS.md

inferrail-0.1.0/.gitignore

@@ -0,0 +1,38 @@
+# Secrets / local config
+.env
+inferrail.yaml
+*.local.yaml
+
+# Telemetry output
+*.jsonl
+
+# Python
+__pycache__/
+*.py[cod]
+*.egg-info/
+.eggs/
+build/
+dist/
+.venv/
+venv/
+
+# Test / type-check caches
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+.coverage
+htmlcov/
+
+# Editors / OS
+.vscode/
+.idea/
+.DS_Store
+
+# Local AI-assistant tooling state (session-specific, not part of the project)
+.claude/
+
+# Private local agent pointer (points at the private strategy repo; never commit)
+CLAUDE.local.md
+
+# Local-only scratch outputs (never commit — may contain private/strategy content)
+local/

inferrail-0.1.0/CLAUDE.md

@@ -0,0 +1,62 @@
+# Inferrail — Agent Context
+
+Inferrail is an open inference control plane: an OpenAI-compatible
+gateway that sits between an application and the model providers it
+calls. **v0.1 today is the gateway only.** See `docs/PRODUCT.md` for
+exact current scope and `docs/ARCHITECTURE.md` for how it's built.
+
+## Before major feature work, read
+
+- `docs/PRODUCT.md` — authoritative source for exact current scope: what
+  works, what's explicitly not supported yet
+- `docs/ARCHITECTURE.md` — package layout, request lifecycle, and the
+  boundaries (provider, routing, telemetry, data-plane/control-plane)
+  that keep the codebase easy to extend
+- `docs/PRINCIPLES.md` — the durable engineering principles behind this
+  project
+- `docs/adr/` — architecture decision records for specific structural
+  choices
+
+## Before implementing something substantial, ask
+
+1. Which problem does this change solve?
+2. Does it match a principle in `docs/PRINCIPLES.md`, or does it conflict
+   with one?
+3. Is there a smaller implementation?
+4. Does `docs/PRODUCT.md` need to change alongside the code, so scope
+   stays accurate?
+5. What test proves this works?
+
+## Engineering rules
+
+- Exact current scope must match the code. If a feature ships or a
+  non-goal changes, update `docs/PRODUCT.md` in the same change.
+- No prompt/response payload persistence in telemetry by default — this
+  is a schema-level guarantee, not a runtime flag.
+- No secret or silent telemetry — nothing leaves the machine unless a
+  sink is explicitly configured to do that, and it must be documented.
+- No fabricated metrics. Values that can't be measured trustworthily
+  (cost, time-to-first-token, etc.) stay `null` — never estimated or
+  guessed.
+- The OSS data plane must keep working with zero dependency on any
+  Inferrail-operated service.
+- Prefer deterministic, testable behavior — keep the core engine
+  independent of the web framework so it can be tested without an HTTP
+  server.
+- Keep the hot request-execution path small; avoid unnecessary
+  dependencies and speculative complexity.
+- Clearly distinguish shipped features from future work — a missing
+  capability is a documented non-goal, not a silent gap.
+
+## Repo-level conventions
+
+- Python 3.11+, FastAPI, pydantic, strict mypy, ruff. `pytest` runs fully
+  mocked — no network/API key required except the one skipped integration
+  test.
+- Package layout and request lifecycle: `docs/ARCHITECTURE.md`.
+- Run lint, type-check, and the test suite before considering work
+  complete.
+- Money-related code (anything cost/pricing/budget) is held to a higher
+  correctness bar than the rest of the codebase: never silently
+  double-count, lose, or fabricate a cost value, and represent
+  uncertainty explicitly rather than collapsing it into a guess.

inferrail-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,55 @@
+# Contributing to Inferrail
+
+Inferrail is early, pre-1.0 software (see [README.md](README.md) and
+[docs/PRODUCT.md](docs/PRODUCT.md) for exact scope). Contributions are
+welcome, but please open an issue before starting anything larger than a
+small fix — especially anything touching routing, the provider protocol,
+or the telemetry schema, since those are deliberate architectural
+boundaries (see `docs/adr/`).
+
+## Development setup
+
+```bash
+git clone https://github.com/domondi1/inferrail.git
+cd inferrail
+pip install -e ".[dev]"
+```
+
+## Before opening a PR
+
+Run the same checks CI runs:
+
+```bash
+ruff check .
+mypy src
+pytest
+```
+
+All of these must pass. `pytest` alone requires no API key or network
+access — the one real-provider integration test in `tests/integration/` is
+automatically skipped unless `OPENAI_API_KEY` is set, and it should stay
+that way; don't make the default test suite depend on real credentials.
+
+## Design principles this project holds to
+
+- **No prompt/response payload persistence by default** — the telemetry
+  schema structurally has no field for it (see
+  `docs/adr/0003-no-payload-persistence-by-default.md`). Don't add one
+  without a deliberate, separately-reviewed decision.
+- **The OSS data plane requires no Inferrail-hosted service** (see
+  `docs/adr/0004-data-plane-control-plane-boundary.md`). Don't add a code
+  path that calls out to an Inferrail-operated backend.
+- **Unsupported request features fail loudly, never silently** (e.g.
+  `stream=true` today). If you add a feature, either implement it fully or
+  keep rejecting it explicitly — don't let a client believe a parameter
+  worked when it was ignored.
+- Keep routing static and explicit for now — see
+  `docs/adr/0002-static-deterministic-routing.md` for why, and don't build
+  cost/latency-aware routing without a separate design discussion.
+
+## Reporting bugs vs. security issues
+
+Regular bugs: open a GitHub issue. Anything security- or privacy-sensitive
+(credential handling, auth bypass, telemetry leaking payload data): see
+[SECURITY.md](SECURITY.md) instead — please don't file those as public
+issues first.

inferrail-0.1.0/ERRORS.md

@@ -0,0 +1,32 @@
+# Inferrail — Error Codes
+
+Generated from `src/inferrail/errors/codes.py` by
+`scripts/generate_errors_md.py` — do not edit this file directly.
+
+Every error the gateway returns carries one of these codes in its JSON
+body's `error.code` field, alongside `error.remediation` (what to do
+about it) and `error.docs_url` (this file, anchored to the code):
+
+```json
+{
+  "error": {
+    "message": "...",
+    "type": "RoutingError",
+    "code": "INFERRAIL_E007",
+    "remediation": "Use one of the route names under inferrail.yaml's routes: section.",
+    "docs_url": "https://github.com/domondi1/inferrail/blob/main/ERRORS.md#inferrail_e007"
+  }
+}
+```
+
+| Code | Exception type | Meaning | Remediation |
+|---|---|---|---|
+| <a id="inferrail_e001"></a>`INFERRAIL_E001` | `GatewayAuthenticationError` | Missing or invalid Inferrail gateway credentials. | Set the 'Authorization: Bearer <token>' header to match INFERRAIL_GATEWAY_TOKEN. |
+| <a id="inferrail_e002"></a>`INFERRAIL_E002` | `AuthenticationError` | The upstream provider rejected Inferrail's own credentials. | Check the API key referenced by the provider's api_key_env in inferrail.yaml. |
+| <a id="inferrail_e003"></a>`INFERRAIL_E003` | `RateLimitError` | The upstream provider is rate-limiting requests. | Safe to retry with backoff; Inferrail already retries this automatically up to the route's max_retries. |
+| <a id="inferrail_e004"></a>`INFERRAIL_E004` | `ProviderTimeoutError` | The request to the upstream provider timed out. | Safe to retry; consider raising the route's timeout_seconds if this recurs. |
+| <a id="inferrail_e005"></a>`INFERRAIL_E005` | `InvalidRequestError` | The upstream provider rejected the request as malformed. | Not retryable as-is; check the request body against the provider's own API docs. |
+| <a id="inferrail_e006"></a>`INFERRAIL_E006` | `UnsupportedFeatureError` | The request used a feature Inferrail doesn't support yet. | Remove the unsupported field (e.g. stream, n != 1) — see docs/PRODUCT.md's current scope. |
+| <a id="inferrail_e007"></a>`INFERRAIL_E007` | `RoutingError` | The request's model field didn't match a configured route. | Use one of the route names under inferrail.yaml's routes: section, not a provider model id. |
+| <a id="inferrail_e008"></a>`INFERRAIL_E008` | `ConfigurationError` | Inferrail's own configuration is missing, invalid, or unusable. | Run 'inferrail config check' for the specific validation error. |
+| <a id="inferrail_e009"></a>`INFERRAIL_E009` | `ProviderError` | The upstream provider request failed for an unrecognized reason. | Check provider status; Inferrail retries automatically if the failure looks transient (5xx). |

inferrail-0.1.0/LICENSE

@@ -0,0 +1,190 @@
+                                 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
+
+   Copyright 2026 Inferrail contributors
+
+   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.