trafficmorph 0.3.0__tar.gz

trafficmorph-0.3.0/.gitignore

@@ -0,0 +1,15 @@
+# Python venvs (created by `make install` / `make regen-client`).
+.venv/
+.venv-tools/
+
+# Build artifacts.
+dist/
+build/
+*.egg-info/
+
+# Bytecode + caches.
+__pycache__/
+*.pyc
+.pytest_cache/
+
+.DS_Store

trafficmorph-0.3.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 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 accept and charge a
+      fee for accepting 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.

trafficmorph-0.3.0/PKG-INFO

@@ -0,0 +1,278 @@
+Metadata-Version: 2.4
+Name: trafficmorph
+Version: 0.3.0
+Summary: TrafficMorph Python SDK — typed client for the /api/v1 API.
+Project-URL: Homepage, https://github.com/trafficmorph-gif/tm-python
+Project-URL: Documentation, https://github.com/trafficmorph-gif/tm-python#readme
+Project-URL: Repository, https://github.com/trafficmorph-gif/tm-python
+Project-URL: Issues, https://github.com/trafficmorph-gif/tm-python/issues
+Author-email: TrafficMorph <support@trafficmorph.io>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: ci,load-testing,regression-testing,trafficmorph
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+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: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: attrs>=22.2.0
+Requires-Dist: httpx<1.0,>=0.25
+Requires-Dist: python-dateutil>=2.8.0
+Provides-Extra: dev
+Requires-Dist: pytest-asyncio>=0.23; extra == 'dev'
+Requires-Dist: pytest>=7; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# trafficmorph — TrafficMorph Python SDK
+
+```
+████████╗██████╗  █████╗ ███████╗███████╗██╗ ██████╗
+╚══██╔══╝██╔══██╗██╔══██╗██╔════╝██╔════╝██║██╔════╝
+   ██║   ██████╔╝███████║█████╗  █████╗  ██║██║
+   ██║   ██╔══██╗██╔══██║██╔══╝  ██╔══╝  ██║██║
+   ██║   ██║  ██║██║  ██║██║     ██║     ██║╚██████╗
+   ╚═╝   ╚═╝  ╚═╝╚═╝  ╚═╝╚═╝     ╚═╝     ╚═╝ ╚═════╝
+        ███╗   ███╗ ██████╗ ██████╗ ██████╗ ██╗  ██╗
+        ████╗ ████║██╔═══██╗██╔══██╗██╔══██╗██║  ██║
+        ██╔████╔██║██║   ██║██████╔╝██████╔╝███████║
+        ██║╚██╔╝██║██║   ██║██╔══██╗██╔═══╝ ██╔══██║
+        ██║ ╚═╝ ██║╚██████╔╝██║  ██║██║     ██║  ██║
+        ╚═╝     ╚═╝ ╚═════╝ ╚═╝  ╚═╝╚═╝     ╚═╝  ╚═╝
+```
+
+[![PyPI](https://img.shields.io/pypi/v/trafficmorph)](https://pypi.org/project/trafficmorph/)
+[![Python versions](https://img.shields.io/pypi/pyversions/trafficmorph)](https://pypi.org/project/trafficmorph/)
+[![License](https://img.shields.io/pypi/l/trafficmorph)](LICENSE)
+[![Downloads](https://img.shields.io/pypi/dm/trafficmorph)](https://pypi.org/project/trafficmorph/)
+
+Typed Python client for the TrafficMorph `/api/v1` API. Request
+and response shapes are typed `attrs` classes; endpoint methods
+expose both sync and async call styles.
+
+## Install
+
+```bash
+# Quick start — always picks up the latest release.
+pip install trafficmorph
+
+# Reproducible builds (CI / production) — pin to an exact version.
+pip install 'trafficmorph==0.3.0'
+```
+
+## Prerequisites
+
+- **Python 3.10 or newer** — declared minimum in [`pyproject.toml`](pyproject.toml). Required for PEP 604 union syntax (`str | None`).
+- **A TrafficMorph API key** in the form `tm_…`. Provision one from the in-app **Settings → API keys** page.
+- **A reachable TrafficMorph install.** The examples below assume `http://localhost:8080` for local development; swap for your hosted URL otherwise. There is no built-in default — the SDK requires the base URL to be set explicitly.
+
+## Quickstart
+
+Export the two required values before running the program, so the snippet works as a single copy-paste:
+
+```bash
+export TM_API_KEY="tm_your_key_here"
+export TM_BASE_URL="http://localhost:8080"   # or your hosted TrafficMorph URL
+```
+
+Then:
+
+```python
+import json
+import os
+
+from trafficmorph import Client
+from trafficmorph.api.profiles import list_profiles
+
+c = Client(
+    api_key=os.environ["TM_API_KEY"],
+    base_url=os.environ["TM_BASE_URL"],
+    timeout=15.0,
+)
+
+resp = list_profiles.sync_detailed(client=c.api)
+print(f"status: {resp.status_code}, {len(resp.content)} bytes")
+```
+
+### First successful call checklist
+
+- [ ] `tm_…` API key exported as `TM_API_KEY` (or passed as the `api_key=` kwarg).
+- [ ] `TM_BASE_URL` points at a reachable TrafficMorph server (`http://localhost:8080` for local dev).
+- [ ] Program prints `status: 200, N bytes` — an empty profile list is `[]`, so N is typically ≥ 2.
+- [ ] `resp.content` holds the JSON payload (bytes). Decode it per [Decoding responses](#decoding-responses) below.
+
+If the program errored before reaching the first line, jump to [Common errors](#common-errors).
+
+## Decoding responses
+
+`resp.content` is the raw HTTP response body as `bytes`. Decode with `json` and the typed classes from `trafficmorph.models` — replace the `print(...)` line in the Quickstart with:
+
+```python
+from trafficmorph.models import TrafficProfileSummaryResponse
+
+if resp.status_code == 200:
+    profiles = [
+        TrafficProfileSummaryResponse.from_dict(p)
+        for p in json.loads(resp.content)
+    ]
+    for p in profiles:
+        print(p.id, p.name)
+elif resp.status_code in (400, 401, 403, 404):
+    err = json.loads(resp.content)
+    raise SystemExit(f"server returned {resp.status_code}: {err.get('error')}")
+else:
+    raise SystemExit(f"unexpected status {resp.status_code}: {resp.content!r}")
+```
+
+The `*.from_dict` classmethod on every model handles the OpenAPI optional-field semantics — missing fields become `attrs.NOTHING` so you don't get surprise `KeyError`s.
+
+For status-code branching alone (without decoding), use `resp.status_code`. `resp.content` is the raw bytes; `resp.headers` is the response headers.
+
+## Next steps
+
+Three common flows after `list_profiles`:
+
+### Create a profile
+
+```python
+from trafficmorph.api.profiles import create_profile
+from trafficmorph.models import ApiProfileRequest, TrafficProfilePointRequest
+
+body = ApiProfileRequest(
+    name="smoke-test",
+    target_url="https://api.example.com/health",
+    http_method="GET",
+    duration=60,
+    points=[
+        TrafficProfilePointRequest(x=0, y=10),
+        TrafficProfilePointRequest(x=60, y=10),
+    ],
+)
+resp = create_profile.sync_detailed(client=c.api, body=body)
+```
+
+### Start a run
+
+```python
+from trafficmorph.api.runs import start
+
+# profile_id from list_profiles or create_profile
+resp = start.sync_detailed(client=c.api, id=profile_id)
+# resp.status_code == 200 → run started; poll get_profile for status.
+```
+
+### View recent history
+
+```python
+from trafficmorph.api.history import list_history
+
+resp = list_history.sync_detailed(
+    client=c.api,
+    size=20,
+    # Other optional filters: profile_id, triggered_by, region, auto_verdict, tag.
+)
+```
+
+Every endpoint function exposes four call styles:
+
+| Form | Returns |
+|---|---|
+| `endpoint.sync(client=…)` | Parsed body (currently `None` — see [Decoding responses](#decoding-responses)) |
+| `endpoint.sync_detailed(client=…)` | `Response` with `.status_code`, `.content`, `.headers` |
+| `endpoint.asyncio(client=…)` | Awaitable form of `sync` |
+| `endpoint.asyncio_detailed(client=…)` | Awaitable form of `sync_detailed` |
+
+For most cases, prefer `sync_detailed` / `asyncio_detailed` — they give you status code branching and the raw bytes for decoding.
+
+## Common errors
+
+All errors below come from `Client(...)` — they surface at construction time, before any network call, so you don't need to set up the rest of your app to hit them.
+
+| Error fragment | Cause | Fix |
+|---|---|---|
+| `api_key must not be empty` | First arg to `Client` is `""` — usually a missing `TM_API_KEY` env var. | Pass the literal key or `export TM_API_KEY=...` before running. |
+| `api_key: value contains a carriage return …` (or newline, NUL, DEL, other control byte) | API key has stray whitespace / control chars (a common copy-paste artifact). | Only the literal `tm_…` characters belong in the value; strip surrounding whitespace. |
+| `base_url is required: pass base_url='http://…'` | No `base_url=` kwarg AND no `$TM_BASE_URL` env var. | Pass `base_url="http://..."` or export `TM_BASE_URL`. |
+| `base URL "…" must include http:// or https:// scheme` | Base URL is missing the protocol (e.g. `localhost:8080`). | Add the scheme: `http://localhost:8080`. |
+| `base URL "…" has scheme "…"; must be http or https` | Non-`http`/`https` scheme (e.g. `ftp://…`). | Use `http://` or `https://`. |
+| `base URL "…" must not contain a query string` | Base URL has `?key=value` appended. | Strip the query — attach per-request params at the endpoint call site instead. |
+| `base URL "…" must not contain a fragment` | Base URL has `#foo` appended. | Strip the fragment — fragments are client-side only and meaningless to the server. |
+| `$TM_BASE_URL: …` (any of the above) | Env-supplied base URL fails the same checks. | Same fixes; the prefix names the source so you know whether the kwarg or the env var was at fault. |
+
+## Configuration
+
+| Source | Precedence |
+|--------|------------|
+| Constructor kwargs (`base_url=`, `timeout=`, …) | Highest |
+| Environment variables (`TM_BASE_URL`) | Middle |
+| Built-in defaults | Lowest |
+
+| Kwarg | Env var | Default | Notes |
+|---|---|---|---|
+| `api_key` | — | _(required)_ | Full `tm_…` value. Empty string and header-invalid characters rejected upfront. |
+| `base_url` | `TM_BASE_URL` | none — required | Points at your TrafficMorph install. See [Base URL rules](#base-url-rules) for accepted/rejected shapes. |
+| `timeout` | — | `30.0` | Per-call timeout in seconds. Applied via `httpx.Timeout` on every request. |
+| `user_agent` | — | `tm-python-sdk/<spec-version>` | Override to tag app traffic in HTTP logs (e.g. `"my-app/1.2.3 (tm-python-sdk/v1)"`). |
+| `httpx_args` | — | `{}` | Extra kwargs forwarded to the underlying `httpx.Client` (proxies, mTLS, custom transports). |
+
+### Base URL rules
+
+Kwarg and env values are validated and normalized the same way, so they produce identical results for the same logical input. The kwarg wins on conflict.
+
+**Accepted shapes** — any absolute `http://` or `https://` URL with a non-empty host:
+
+- `http://localhost:8080` — typical local dev.
+- `https://app.example.com` — hosted deployment.
+- `https://host/proxy-prefix` — reverse-proxy mount; the prefix is preserved during URL resolution.
+- `https://host/a%2Fb` — percent-encoded path segments stay verbatim. Per RFC 3986, `/a%2Fb` (one segment, containing a literal slash) and `/a/b` (two segments) are semantically different paths — the SDK never collapses one into the other.
+
+The SDK appends a trailing slash if missing, so both spellings (with or without) produce the same final value.
+
+**Rejected at construction time** — clear error from `Client(...)`, not a late transport failure:
+
+| Bad input | Error fragment |
+|---|---|
+| `""` or whitespace-only | `must not be empty` |
+| `localhost:8080` (no scheme) | `must include … scheme` |
+| `ftp://x` (wrong scheme) | `must be http or https` |
+| `https://` (no host) | `must include a host` |
+| `https://x/?q=1` (query) | `must not contain a query string` |
+| `https://x/#frag` (fragment) | `must not contain a fragment` |
+
+Query strings and fragments are refused because they belong on per-request URLs, not the deployment root.
+
+## Authentication
+
+The SDK sends every request with `X-Api-Key: tm_…`. The API also accepts `Authorization: Bearer tm_…`, but the SDK uses `X-Api-Key`.
+
+## What's in the box
+
+```
+trafficmorph                 ← public package (Client, env names, constants)
+trafficmorph.api.<tag>       ← endpoint modules, one per OpenAPI tag
+trafficmorph.models          ← typed request/response attrs classes
+trafficmorph.errors          ← UnexpectedStatus exception
+```
+
+Endpoint coverage matches the server's `/api/v1` endpoints 1:1:
+
+| Module | Endpoints |
+|---|---|
+| `trafficmorph.api.profiles` | `list_profiles`, `create_profile`, `get_profile`, `update_profile`, `delete_profile` |
+| `trafficmorph.api.runs` | `start`, `stop`, `pause`, `resume` |
+| `trafficmorph.api.history` | `list_history`, `get_history_item` |
+| `trafficmorph.api.domains` | `list_`, `add`, `verify_dns`, `verify_http`, `remove` |
+| `trafficmorph.api.captures` | `analyse`, `import_capture` |
+| `trafficmorph.api.variables_sets` | `list_variables_sets`, `create`, `get`, `rename`, `change_mode`, `delete` |
+
+## Versioning
+
+| | Symbol | Meaning |
+|---|---|---|
+| SDK release | PyPI version (`pip install trafficmorph==X.Y.Z`) | Pin in your `requirements.txt` or `pyproject.toml` |
+| API version | `trafficmorph.SPEC_VERSION` (currently `"v1"`) | The `/api/v1` revision this SDK targets |
+
+Each SDK release targets one specific server `/api/v1` revision. The server preserves backwards compatibility within `/api/v1`, so SDK and server versions move independently — any released SDK version works against any TrafficMorph server still exposing `/api/v1`.