plotwork 0.1.0__tar.gz → 0.2.0__tar.gz

{plotwork-0.1.0 → plotwork-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: plotwork
-Version: 0.1.0
+Version: 0.2.0
 Summary: The Plotwork API from Python: validate, draw, render, import and publish diagrams, on the standard library alone.
 Project-URL: Homepage, https://plotwork.dev
 Project-URL: Documentation, https://docs.plotwork.dev/sdks
@@ -54,7 +54,7 @@ The hosted Plotwork API from Python. Every `/v1` operation (validate, draw, rend
 |---|---|
 | What does it install? | Nothing else. |
 | Where do the types come from? | The API's OpenAPI document, kept in the SDK repository as [`spec/openapi.json`](https://github.com/plotwork-official/plotwork-sdk/blob/main/spec/openapi.json). Every request and answer is a `TypedDict`. |
-| How do I sign in? | An API key from the Plotwork portal (`api_key`), or an OAuth access token (`access_token`). |
+| How do I sign in? | An API key from the Plotwork portal (`api_key`), sent as `X-API-Key`. |
 | Does a mistake in a diagram raise? | No. It is part of the answer, with a line, a column and a hint. Only a failed request raises, as `PlotworkApiError` with a stable `error_code`. |
 | Does it retry? | A safe call is retried twice on 429 and 503, after the API's `Retry-After`. Publishing is never retried. |
 | Is there a TypeScript client? | Yes, [`@plotwork.official/sdk`](https://www.npmjs.com/package/@plotwork.official/sdk), with the same calls in camelCase. |
@@ -121,7 +121,6 @@ except PlotworkApiError as error:
 | Option | Default |
 |---|---|
 | `api_key` | none |
-| `access_token` | none |
 | `base_url` | `https://api.plotwork.dev` (`https://api-preview.plotwork.dev` for preview, or a self-hosted engine) |
 | `timeout` | `60` seconds |
 | `max_retries` | `2` |

{plotwork-0.1.0 → plotwork-0.2.0}/README.md

@@ -25,7 +25,7 @@ The hosted Plotwork API from Python. Every `/v1` operation (validate, draw, rend
 |---|---|
 | What does it install? | Nothing else. |
 | Where do the types come from? | The API's OpenAPI document, kept in the SDK repository as [`spec/openapi.json`](https://github.com/plotwork-official/plotwork-sdk/blob/main/spec/openapi.json). Every request and answer is a `TypedDict`. |
-| How do I sign in? | An API key from the Plotwork portal (`api_key`), or an OAuth access token (`access_token`). |
+| How do I sign in? | An API key from the Plotwork portal (`api_key`), sent as `X-API-Key`. |
 | Does a mistake in a diagram raise? | No. It is part of the answer, with a line, a column and a hint. Only a failed request raises, as `PlotworkApiError` with a stable `error_code`. |
 | Does it retry? | A safe call is retried twice on 429 and 503, after the API's `Retry-After`. Publishing is never retried. |
 | Is there a TypeScript client? | Yes, [`@plotwork.official/sdk`](https://www.npmjs.com/package/@plotwork.official/sdk), with the same calls in camelCase. |
@@ -92,7 +92,6 @@ except PlotworkApiError as error:
 | Option | Default |
 |---|---|
 | `api_key` | none |
-| `access_token` | none |
 | `base_url` | `https://api.plotwork.dev` (`https://api-preview.plotwork.dev` for preview, or a self-hosted engine) |
 | `timeout` | `60` seconds |
 | `max_retries` | `2` |

{plotwork-0.1.0 → plotwork-0.2.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "plotwork"
-version = "0.1.0"
+version = "0.2.0"
 description = "The Plotwork API from Python: validate, draw, render, import and publish diagrams, on the standard library alone."
 readme = "README.md"
 requires-python = ">=3.10"

{plotwork-0.1.0 → plotwork-0.2.0}/src/plotwork/__init__.py

@@ -30,7 +30,6 @@ class Plotwork(Operations):
     """The Plotwork API client.
 
     :param api_key: An account or organisation API key, sent as ``X-API-Key``. Keep it in an environment variable or a secret store.
-    :param access_token: An OAuth access token, sent as ``Authorization: Bearer``, in place of a key.
     :param base_url: The API's address: production by default, ``https://api-preview.plotwork.dev`` for preview, or a self-hosted engine.
     :param timeout: Seconds before a call counts as failed: 60 by default.
     :param max_retries: How many times a safe call is tried again on 429 or 503: 2 by default, 0 to never retry.
@@ -42,7 +41,6 @@ class Plotwork(Operations):
         self,
         *,
         api_key: Optional[str] = None,
-        access_token: Optional[str] = None,
         base_url: Optional[str] = None,
         timeout: float = 60.0,
         max_retries: int = 2,
@@ -52,11 +50,8 @@ class Plotwork(Operations):
         headers: Dict[str, str] = {}
         if api_key:
             headers["X-API-Key"] = api_key
-        if access_token:
-            headers["Authorization"] = f"Bearer {access_token}"
         self._options: Dict[str, Any] = {
             "api_key": api_key,
-            "access_token": access_token,
             "base_url": base_url,
             "timeout": timeout,
             "max_retries": max_retries,

{plotwork-0.1.0 → plotwork-0.2.0}/src/plotwork/_version.py

@@ -1,3 +1,3 @@
 """The version of the ``plotwork`` package; ``pyproject.toml`` names the same one, and a test holds them equal."""
 
-__version__ = "0.1.0"
+__version__ = "0.2.0"

{plotwork-0.1.0 → plotwork-0.2.0}/tests/test_request.py

@@ -41,12 +41,12 @@ def test_sends_camel_case_keys_as_the_api_names_them(api: FakeApi) -> None:
     assert api.seen[0].json() == {"source": SOURCE, "embedSource": True, "idPrefix": "a"}
 
 
-def test_puts_a_get_input_in_the_query_and_uses_a_bearer_token(api: FakeApi) -> None:
+def test_puts_a_get_input_in_the_query_and_sends_no_key_when_there_is_none(api: FakeApi) -> None:
     api.answer(Answer(body={"results": []}))
-    client(api, [], access_token="tok").icons.search(q="token exchange", limit=5)
+    client(api, []).icons.search(q="token exchange", limit=5)
     seen = api.seen[0]
     assert (seen.method, seen.path) == ("GET", "/v1/icons?q=token+exchange&limit=5")
-    assert seen.headers["authorization"] == "Bearer tok"
+    assert "authorization" not in seen.headers
     assert "x-api-key" not in seen.headers
     assert "content-type" not in seen.headers
     assert seen.body is None