humanbaselines 0.1.0__tar.gz

humanbaselines-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,87 @@
+name: release
+
+# Publishes a version to PyPI via Trusted Publishing (OIDC — no stored tokens).
+# Triggered two ways:
+#   - workflow_dispatch: manual, with an explicit `version` input.
+#   - repository_dispatch (event_type: ui-version): fired by the upstream app's
+#     sync workflow when the canonical product version changes; the version is
+#     carried in client_payload.version.
+# The version is the canonical product version (the app's root package.json), so
+# the client always ships in lockstep with the UI it documents.
+
+on:
+  workflow_dispatch:
+    inputs:
+      version:
+        description: "Version to release (e.g. 0.1.0)"
+        required: true
+        type: string
+  repository_dispatch:
+    types: [ui-version]
+
+concurrency:
+  group: release
+  cancel-in-progress: false
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write   # OIDC for PyPI Trusted Publishing
+      contents: write   # commit the version bump + push the tag/release
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Resolve version
+        id: v
+        run: |
+          if [ "${{ github.event_name }}" = "repository_dispatch" ]; then
+            VERSION="${{ github.event.client_payload.version }}"
+          else
+            VERSION="${{ github.event.inputs.version }}"
+          fi
+          VERSION="${VERSION#v}"
+          if [ -z "$VERSION" ]; then echo "no version supplied" >&2; exit 1; fi
+          echo "version=$VERSION" >> "$GITHUB_OUTPUT"
+          echo "Releasing version $VERSION"
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Bump __version__ and commit
+        env:
+          VERSION: ${{ steps.v.outputs.version }}
+        run: |
+          sed -i 's/^__version__ = .*/__version__ = "'"$VERSION"'"/' src/humanbaselines/__init__.py
+          grep '^__version__' src/humanbaselines/__init__.py
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+          if git diff --quiet; then
+            echo "version already $VERSION; no bump commit"
+          else
+            git commit -am "Release v$VERSION"
+            git push
+          fi
+
+      - name: Tag and GitHub Release
+        env:
+          VERSION: ${{ steps.v.outputs.version }}
+          GH_TOKEN: ${{ github.token }}
+        run: |
+          if git ls-remote --exit-code --tags origin "refs/tags/v$VERSION" >/dev/null 2>&1; then
+            echo "tag v$VERSION already exists; skipping release creation"
+          else
+            gh release create "v$VERSION" --title "v$VERSION" --generate-notes --target "$(git rev-parse HEAD)"
+          fi
+
+      - name: Build
+        run: |
+          pip install build
+          python -m build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          skip-existing: true

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

@@ -0,0 +1,24 @@
+name: test
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.11", "3.12"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install
+        run: pip install -e '.[dev]'
+      - name: Test
+        run: pytest -q

humanbaselines-0.1.0/.gitignore

@@ -0,0 +1,9 @@
+# Generated by the example scripts (bound_config.py / from_file.py).
+examples/*.json
+
+# Build artifacts
+dist/
+*.egg-info/
+__pycache__/
+*.pyc
+.pytest_cache/

humanbaselines-0.1.0/LICENSE

@@ -0,0 +1,184 @@
+                                 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 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 transformations
+      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, as submitted to the 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 designated in writing by the copyright owner as "Not a
+      Contribution."
+
+      "Contributor" shall mean Licensor and any Legal Entity on behalf of
+      whom a Contribution has been received by the Licensor and included
+      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 the 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, You must include a readable copy of the
+          attribution notices contained within such NOTICE file, 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 license statement for Your modifications and
+      may provide additional grant of rights to use, copy, modify, merge,
+      publish, distribute, sublicense, and/or sell copies of the
+      Derivative Works, and to permit persons to whom the Derivative Works
+      is furnished to do so, subject to the following conditions:
+
+   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 reproducing 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 exemplary 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 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 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 offer such obligations
+      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 Valgorithmic, Inc. (d.b.a. Valgo)
+
+   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.

humanbaselines-0.1.0/PKG-INFO

@@ -0,0 +1,217 @@
+Metadata-Version: 2.4
+Name: humanbaselines
+Version: 0.1.0
+Summary: Python client for the Human Crash Baselines API — human-driver crash-rate baselines by region, route, and filter.
+Project-URL: Homepage, https://humanbaselines.com
+Project-URL: Documentation, https://human-baseline-api-yz2u5f75wa-uc.a.run.app/docs
+Project-URL: Repository, https://github.com/valgorithmic/humanbaselines
+Project-URL: Issues, https://github.com/valgorithmic/humanbaselines/issues
+Author: Valgorithmic, Inc.
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: api-client,autonomous-vehicles,baseline,crash,safety
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.10
+Requires-Dist: pydantic>=2.9
+Requires-Dist: requests>=2.31
+Provides-Extra: dev
+Requires-Dist: black; extra == 'dev'
+Requires-Dist: datamodel-code-generator>=0.25; extra == 'dev'
+Requires-Dist: isort; extra == 'dev'
+Requires-Dist: pytest>=7; extra == 'dev'
+Requires-Dist: responses>=0.25; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# humanbaselines
+
+Python client for the **Human Crash Baselines API** — typed access to human-driver
+crash-rate baselines by region, route, and filter.
+
+It wraps the `/v1` REST API: construct a client with your key, call typed methods,
+get typed results back (no hand-built JSON, no remembering the auth header).
+
+## Install
+
+```bash
+pip install humanbaselines
+```
+
+Or install the latest from source:
+
+```bash
+pip install "git+https://github.com/valgorithmic/humanbaselines.git"
+# or, from a checkout:
+pip install .
+```
+
+## Quickstart
+
+```python
+from humanbaselines import HumanBaselines
+
+hb = HumanBaselines(api_key="hbk_...")          # or set HUMANBASELINES_API_KEY
+
+# Geofence crash rate (kwargs are validated client-side):
+r = hb.compute(county="travis", outcome="police_reported", ego_vehicle=["cars", "light_trucks"])
+print(r.rate, r.rate_low, r.rate_high)          # 4.055 4.0 4.1
+print(r.N, r.D_miles, len(r.cells))             # 24617.0 6.07e9 1795
+
+# Discover valid filters + defaults at runtime:
+for f in hb.filters().modes["geofence"]:
+    print(f.id, "→", [o.id for o in f.options], "default:", f.default)
+
+# Which regions / modes are available:
+hb.regions()
+```
+
+### Filters
+
+Pass filters three ways — keyword args (simplest), a typed `Selections` model,
+or a plain dict. All are validated **before** the request, so a bad value fails
+fast locally:
+
+```python
+from humanbaselines import GeofenceSelections, Outcome
+
+hb.compute(outcome="fatal", road_type=["interstate"])           # kwargs
+hb.compute(selections=GeofenceSelections(outcome=Outcome.fatal)) # typed model
+hb.compute(selections={"outcome": "fatal"})                      # dict
+```
+
+Omitted filters fall back to the API's defaults (these reproduce the web UI's
+headline numbers).
+
+### Binding a baseline definition
+
+The filter selections are really a *methodological definition* — what counts as
+a crash and what you're baselining against. Bind that definition to the client
+once and every call inherits it; per-call args override individual fields:
+
+```python
+hb = HumanBaselines(api_key="hbk_...", config={
+    "county": "travis",
+    "outcome": "fatal",
+    "ego_vehicle": ["cars", "light_trucks"],
+})
+
+hb.compute().rate                  # uses the bound definition
+hb.compute(weather=["rain"]).rate  # override just one field for this call
+
+hb.config()                        # full effective config (bound + every default)
+hb.changes()                       # only the settings that differ from the defaults
+```
+
+`config(mode="geofence")` and `changes(mode="geofence")` take an optional mode
+(each mode exposes different fields). `config()` is the complete definition a
+compute call would use; `changes()` is just your deviations from the defaults.
+
+The bound config is validated when you create the client (unknown fields or bad
+values raise immediately). It applies to **all modes** — each compute mode uses
+the subset of fields it understands (e.g. `road_type` only affects geofence,
+`ci_method` only affects route/depot), so you can keep one definition across
+modes.
+
+Derive variants immutably, and version definitions as JSON:
+
+```python
+strict = hb.with_config(under_reporting="adjusted")   # new client; hb is unchanged
+
+hb.save_config("odd_fatal_cars.json")        # full config snapshot (check into a repo, share, diff)
+
+# Load it back — pass the path straight to the constructor:
+hb2 = HumanBaselines(api_key="hbk_...", config="odd_fatal_cars.json")
+# (HumanBaselines.from_config(path, api_key=...) is an equivalent, explicit alias.)
+```
+
+### Route & depot modes
+
+Available for route/depot-capable regions — `travis`, `ca_interstates`, and
+`sw_interstates` (check `hb.regions()`). Route/depot count Class-8 combination
+trucks, so `ego_vehicle` defaults to `["combination"]` in these modes.
+
+```python
+hb.compute_route(segment_ids=[("I-35", 250), ("I-35", 251)], ego_vehicle=["combination"])
+
+hb.compute_depot_route(
+    depot_a=(30.25, -97.75),     # (lat, lon)
+    depot_b=(30.40, -97.70),
+    ci_method="fay_feuer",
+)
+```
+
+## Errors
+
+Non-2xx responses raise typed exceptions you can catch:
+
+```python
+from humanbaselines import AuthenticationError, ValidationError, ServiceUnavailableError
+
+try:
+    hb.compute(outcome="fatal")
+except AuthenticationError:        # 401 — bad/missing key
+    ...
+except ValidationError as e:       # 422 — e.errors has the field-level detail
+    print(e.errors)
+except ServiceUnavailableError:    # 503 — service warming up (auto-retried first)
+    ...
+```
+
+All inherit from `HumanBaselinesError`. The base `APIError` carries `.status_code`
+and `.body`.
+
+## Configuration
+
+| arg | default | notes |
+|---|---|---|
+| `api_key` | `$HUMANBASELINES_API_KEY` | sent as `X-API-Key` |
+| `base_url` | `https://humanbaselines.com` | proxies `/v1/*`; use the Cloud Run URL for `/health` |
+| `timeout` | `30` | seconds per request |
+| `max_retries` | `2` | exponential backoff on 502/503/504 (handles cold-start warm-up) |
+
+`HumanBaselines` is also a context manager (`with HumanBaselines(...) as hb:`).
+
+## Notes
+
+- The typed models in `_generated.py` are **generated from the server's OpenAPI
+  schema** — the server's Pydantic models are the single source of truth, so the
+  client can't drift from the API. `GET /v1/filters` is the authoritative
+  runtime source for valid values and defaults.
+- Interactive API docs: the `/docs` page on the API host.
+
+## Development
+
+```bash
+pip install -e '.[dev]'
+pytest -q                                  # mocked tests
+HUMANBASELINES_API_KEY=hbk_... pytest -q    # also runs the live smoke test
+python -m build                            # build wheel + sdist into dist/
+```
+
+### Regenerating models after an API change
+
+`src/humanbaselines/_generated.py` is generated — never hand-edit it. When the
+API contract changes, regenerate from the live OpenAPI schema:
+
+```bash
+python scripts/regenerate_models.py
+# point at a different host (e.g. local dev server):
+python scripts/regenerate_models.py --url http://localhost:8000
+```
+
+This fetches `<host>/openapi.json` (default `https://humanbaselines.com`) and runs
+`datamodel-code-generator`. Output is deterministic (no timestamps), so a clean
+`git diff` means the client is in sync with the API.
+
+> Releases are automated: a version bump in the upstream app dispatches a release
+> here, which tags `v<version>` and publishes to PyPI via Trusted Publishing.
+
+## License
+
+Apache-2.0 © Valgorithmic, Inc.