xippios-core 0.1.0__tar.gz

xippios_core-0.1.0/.gitignore

@@ -0,0 +1,21 @@
+# environments and caches
+.venv/
+__pycache__/
+*.py[cod]
+.mypy_cache/
+.ruff_cache/
+.pytest_cache/
+.hypothesis/
+
+# build artefacts
+dist/
+build/
+*.egg-info/
+
+# local secrets are never files, but belt and braces
+.env
+.envrc
+
+# editors
+.idea/
+.vscode/

xippios_core-0.1.0/CHANGELOG.md

@@ -0,0 +1,53 @@
+# Changelog
+
+All notable changes to this project are documented here. The format follows
+[Keep a Changelog](https://keepachangelog.com/en/1.1.0/) and the project uses
+[Semantic Versioning](https://semver.org/) (pre-1.0: breaking changes bump the minor).
+
+## [Unreleased]
+
+## [0.1.0] - 2026-10-22
+
+First release, cut after the first source package (sdk-usda-nass) had exercised it.
+
+### Added
+
+- `xippios.core.errors`: the family error taxonomy (`XippiosError` and seven
+  subclasses), `error_from_response`, `raise_for_status`, `parse_retry_after`.
+- `xippios.core.models`: `UpstreamModel`, `ResultMeta`, `Result[T]`, `parse`.
+- `xippios.core.config`: `SourceSettings` base and `resolve_api_key`.
+- `xippios.core.sync`: derive a sync function from an async one on a shared
+  background event loop.
+- `xippios.core.client`: `AsyncClient` and `Client` with `ClientConfig`, `Timeouts`,
+  `RetryPolicy`, `RateLimit`, `MemoryCache` and the `CacheBackend` protocol.
+- `xippios.core.client.auth`: `QueryKeyAuth`, `HeaderKeyAuth`, `BearerAuth`,
+  `BasicKeyAuth` and the `EnvKeyAuth` base, resolving the key from the environment on
+  the first request. Re-exported from `xippios.core`.
+- `ResultMeta` redacts credential-like keys in `request` at construction (ADR-0005).
+- `resolve_api_key` is typed to return `SecretStr` when the key is required.
+- `xippios.core.pagination`: `paginate_offset`, `paginate_pages`, `paginate_cursor`,
+  `collect`.
+- `xippios.core.reference`: `load_csv`, `load_json`, `load_table`.
+- `xippios.core.mcp` (extra `mcp`): `build_server`, `register_tasks`, `cap_result`,
+  `error_to_text`, `main`.
+- `xippios.core.http` (extra `http`): `router_from_tasks`, `problem_response`,
+  `install_error_handlers`.
+- `xippios.core.testing` (extra `testing`): pytest plugin with the `live` gate,
+  fixture format, `record`, `replay`, scrubbing helpers.
+- CI on Python 3.12, 3.13 and 3.14; trusted publishing on `v*` tags.
+- `UpstreamModel` serialises `Decimal` fields as JSON numbers in both adapters
+  (ADR-0008); `UpstreamModel.project` builds projections; `parse_decimal` reads
+  published figures with separators or suppression codes.
+- `ClientConfig.classify`: a source's error mapping, called on every response before
+  the default status mapping.
+- `xippios.core.reference.render_str_enums` and `enum_member_name`: generated
+  `StrEnum` source for packaged value lists.
+- `xippios.core.testing.assert_projection` and `mcp_call`.
+- `InvalidRequestError` in the taxonomy (ADR-0007): a request refused before it is
+  sent; HTTP 422, MCP text. Re-exported from `xippios.core`.
+- `xippios.core.http.is_scalar`.
+
+### Changed
+
+- `router_from_tasks`: a task with any non-scalar parameter becomes a `POST` route whose
+  JSON body is an object keyed by parameter name; scalar-only tasks stay `GET`.

xippios_core-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 [yyyy] [name of copyright owner]
+
+   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.

xippios_core-0.1.0/PKG-INFO

@@ -0,0 +1,230 @@
+Metadata-Version: 2.5
+Name: xippios-core
+Version: 0.1.0
+Summary: Shared core for the xippios Python SDK family: HTTP client, models, errors, MCP/HTTP adapters
+Project-URL: Homepage, https://github.com/xippios/sdk-core
+Project-URL: Changelog, https://github.com/xippios/sdk-core/blob/main/CHANGELOG.md
+Project-URL: Issues, https://github.com/xippios/sdk-core/issues
+Author: XIPPIOS GmbH
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: fastapi,httpx,mcp,pydantic,sdk
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Typing :: Typed
+Requires-Python: >=3.12
+Requires-Dist: httpx>=0.28
+Requires-Dist: pydantic-settings>=2.7
+Requires-Dist: pydantic>=2.11
+Provides-Extra: http
+Requires-Dist: fastapi>=0.115; extra == 'http'
+Provides-Extra: mcp
+Requires-Dist: mcp>=2.0; extra == 'mcp'
+Provides-Extra: testing
+Requires-Dist: anyio>=4; extra == 'testing'
+Requires-Dist: pytest>=8; extra == 'testing'
+Requires-Dist: respx>=0.22; extra == 'testing'
+Description-Content-Type: text/markdown
+
+# xippios-core
+
+Shared foundation of the [xippios](https://github.com/xippios) Python SDK family. Every
+`xippios-<source>` package depends on it; nothing in it knows about any particular
+upstream API.
+
+It gives a source package the things that should be identical across the family:
+
+- **HTTP client** on `httpx` with retries, a per-source rate limiter, an optional
+  response cache (off by default; the in-memory one is bounded by TTL and size),
+  explicit timeouts and one `User-Agent`. Async at the core, a sync facade on top.
+- **Auth helpers** that read the key from the environment on the first request:
+  query parameter, header, bearer token or basic auth. A source's documented error
+  shapes go into `ClientConfig.classify`, consulted on every response.
+- **Error taxonomy**: `ConfigError`, `AuthError`, `RateLimitError`, `NotFoundError`,
+  `ValidationError`, `UpstreamError`, `TransportError` and `InvalidRequestError` (a
+  request refused before it is sent), all under `XippiosError`.
+- **Result envelope**: every task function returns `Result[T]` with `ResultMeta`
+  (source, endpoint, retrieved_at, published_at, vintage, request). `Decimal` fields
+  of upstream models arrive as JSON numbers in both adapters; `UpstreamModel.project`
+  builds a projection of a record under upstream names, `parse_decimal` reads a
+  published figure.
+- **Reference-data loader** for code lists shipped inside a package.
+- **Adapters** that turn task functions into MCP tools (`xippios.core.mcp`) and FastAPI
+  routes (`xippios.core.http`) without any logic of their own.
+- **Test support**: a live-test gate, fixture recording with secrets scrubbed, and
+  replay through `respx` (`xippios.core.testing`).
+
+## Install
+
+```bash
+uv add xippios-core                 # client, models, errors, reference, pagination
+uv add "xippios-core[mcp]"          # + MCP server helpers (official mcp SDK 2.x)
+uv add "xippios-core[http]"         # + FastAPI router helpers
+uv add "xippios-core[testing]"      # + pytest plugin, respx replay, fixture recording
+```
+
+Python 3.12 or later.
+
+## 30-second example
+
+A source package writes its task function once, async, and derives the sync one:
+
+```python
+from pydantic import Field
+
+from xippios.core import (
+    AsyncClient,
+    ClientConfig,
+    QueryKeyAuth,
+    RateLimit,
+    Result,
+    ResultMeta,
+    UpstreamModel,
+    parse,
+    sync,
+)
+
+client = AsyncClient(
+    ClientConfig(
+        source="example",
+        version="0.1.0",
+        base_url="https://api.example.org",
+        rate_limit=RateLimit(per_minute=60),
+    ),
+    auth=QueryKeyAuth("key", "EXAMPLE_API_KEY", source="example"),  # read on first request
+)
+
+
+class Series(UpstreamModel):
+    series_id: str = Field(alias="seriesId")
+    value: float
+
+
+async def get_series_async(series_id: str, year: int = 2024) -> Result[list[Series]]:
+    """Fetch one series for a year.
+
+    Args:
+        series_id: Upstream identifier, e.g. ``"CORN_YIELD"``.
+        year: Four-digit year, e.g. ``2024``.
+    """
+    params = {"id": series_id, "year": year}
+    raw = await client.get_json("/v1/series", params=params)
+    rows = parse(list[Series], raw["data"], source="example", endpoint="series")
+    meta = ResultMeta(source="example", endpoint="series", request=params)
+    return Result(data=rows, meta=meta)
+
+
+get_series = sync(get_series_async)  # same signature, same docstring, blocks until done
+```
+
+```python
+>>> result = get_series("CORN_YIELD", year=2024)
+>>> result.data[0].value, result.meta.retrieved_at
+(177.3, datetime.datetime(2026, 10, 20, 12, 0, tzinfo=datetime.timezone.utc))
+```
+
+`meta.request` is provenance, not a copy of the call: `ResultMeta` redacts any key that
+looks like a credential (`key`, `token`, `secret`, ...) so an envelope is safe to hand
+to an agent or return over HTTP.
+
+Upstream failures arrive as taxonomy errors, never as raw `httpx` exceptions:
+
+```python
+from xippios.core import NotFoundError, RateLimitError
+
+try:
+    get_series("NOPE")
+except NotFoundError as exc:
+    print(exc)  # 404 from GET api.example.org/v1/series: ...
+except RateLimitError as exc:
+    print(exc.retry_after)
+```
+
+## MCP server in five lines
+
+```python
+# xippios/example/mcp.py
+from xippios.core.mcp import build_server, main
+from xippios.example import tasks
+
+server = build_server("example", [tasks.get_series, tasks.list_commodities])
+
+
+def run() -> None:  # entry point: xippios-example-mcp = "xippios.example.mcp:run"
+    main(server)
+```
+
+Tool names are `<source>_<function>` (`example_get_series`), the docstring is the tool
+description, the signature is the input schema. Results are capped at 200 rows or
+64 KB with a note on how to narrow the query; errors come back as
+`error: <Class>: <message>`. `--http` serves streamable HTTP instead of stdio.
+
+Client configuration, for Claude Desktop or any MCP client:
+
+```json
+{
+  "mcpServers": {
+    "example": {
+      "command": "uvx",
+      "args": ["--from", "xippios-example[mcp]", "xippios-example-mcp"],
+      "env": { "EXAMPLE_API_KEY": "..." }
+    }
+  }
+}
+```
+
+## HTTP routes in two lines
+
+```python
+from xippios.core.http import router_from_tasks
+
+router = router_from_tasks("example", [tasks.get_series])  # GET /example/get_series?series_id=...
+```
+
+Mount it on your FastAPI app. A task whose parameters are all scalars is a `GET` with
+query parameters; a task with a mapping, list or model parameter is a `POST` whose JSON
+body is keyed by parameter name. Responses are the `Result[T]` envelope; errors are
+RFC 9457 problem details (`application/problem+json`), `InvalidRequestError` as 422.
+
+## Testing a source package
+
+```python
+# tests/conftest.py
+pytest_plugins = ["xippios.core.testing.plugin"]
+```
+
+- `@pytest.mark.live` tests are skipped unless `XIPPIOS_LIVE_TESTS=1`.
+- `replay_fixture("api_GET", "corn_2024")` mounts `tests/fixtures/api_GET/corn_2024.json`.
+- `record(client, "/v1/series", fixture_path(...), params=...)` records a live response
+  with credentials scrubbed. Never hand-write a fixture.
+
+## Status
+
+| Module | What | Status |
+| --- | --- | --- |
+| `xippios.core.client` | httpx client, retries, rate limit, cache, sync facade | alpha |
+| `xippios.core.errors` | taxonomy and response classification | alpha |
+| `xippios.core.models` | `UpstreamModel`, `Result`, `ResultMeta`, `parse` | alpha |
+| `xippios.core.config` | `SourceSettings`, `resolve_api_key` | alpha |
+| `xippios.core.reference` | packaged CSV/JSON loaders | alpha |
+| `xippios.core.pagination` | offset, page and cursor iterators | alpha |
+| `xippios.core.mcp` | tool registration, result caps, error text, CLI | alpha |
+| `xippios.core.http` | router factory, problem details | alpha |
+| `xippios.core.testing` | live gate, record, replay, scrub | alpha |
+
+Alpha: the public surface may change in a minor version until the first source
+package, `sdk-usda-nass`, has exercised it.
+
+## Conventions
+
+The rules this package implements live in [docs/conventions.md](docs/conventions.md)
+and the decisions behind them in [docs/adr/](docs/adr/). Changes to a convention are
+their own PR plus an ADR.
+
+## Licence
+
+Apache-2.0. See [LICENSE](LICENSE).