canvas 0.77.0__tar.gz

canvas-0.77.0/.gitignore

@@ -0,0 +1,20 @@
+# MacOS artifacts
+.DS_Store
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+
+dist/
+
+# vim
+*.swp
+
+.env
+
+# JetBrains
+.idea/
+
+# SQLite databases
+*.sqlite3
+
+profile-imports-*.txt

canvas-0.77.0/PKG-INFO

@@ -0,0 +1,225 @@
+Metadata-Version: 2.4
+Name: canvas
+Version: 0.77.0
+Summary: SDK to customize event-driven actions in your Canvas instance
+Author-email: Canvas Team <engineering@canvasmedical.com>
+License-Expression: MIT
+Requires-Python: <3.13,>=3.11
+Requires-Dist: cookiecutter
+Requires-Dist: cron-converter<2,>=1.2.1
+Requires-Dist: cryptography>=45.0.5
+Requires-Dist: deprecation<3,>=2.1.0
+Requires-Dist: django-stubs[compatible-mypy]<6,>=5.1.1
+Requires-Dist: django-timezone-utils<0.16,>=0.15.0
+Requires-Dist: django<6,>=5.1.1
+Requires-Dist: env-tools<3,>=2.4.0
+Requires-Dist: factory-boy>=3.3.3
+Requires-Dist: frozendict>=2.4.6
+Requires-Dist: grpcio<2,>=1.60.1
+Requires-Dist: ipython<9,>=8.21.0
+Requires-Dist: jsonschema<5,>=4.21.1
+Requires-Dist: pathspec>=0.12.1
+Requires-Dist: protobuf<5,>=4.25.3
+Requires-Dist: psycopg[binary,pool]<4,>=3.2.2
+Requires-Dist: pydantic<3,>=2.6.1
+Requires-Dist: pyjwt==2.10.1
+Requires-Dist: python-dotenv<2,>=1.0.1
+Requires-Dist: rapidfuzz<4,>=3.10.1
+Requires-Dist: redis<6,>=5.0.4
+Requires-Dist: requests
+Requires-Dist: restrictedpython>=8.0
+Requires-Dist: sentry-sdk>=2.33.2
+Requires-Dist: statsd<5,>=4.0.1
+Requires-Dist: typer
+Requires-Dist: typing-extensions<4.13,>=4.8
+Requires-Dist: websocket-client<2,>=1.7.0
+Provides-Extra: test-utils
+Requires-Dist: pytest-canvas; extra == 'test-utils'
+Description-Content-Type: text/markdown
+
+[![codecov](https://codecov.io/gh/canvas-medical/canvas-plugins/graph/badge.svg?token=P8JJUOJ8FH)](https://codecov.io/gh/canvas-medical/canvas-plugins)
+
+### Getting Started
+
+Create a file `~/.canvas/credentials.ini` and add the client_id and client_secret credentials for each of your Canvas instances. You can define your default host with `is_default=true`. If no default is explicitly defined, the Canvas CLI will use the first instance in the file as the default for each of the CLI commands.
+
+**Example:**
+
+```
+[my-canvas-instance]
+client_id=myclientid
+client_secret=myclientsecret
+
+[my-dev-canvas-instance]
+client_id=devclientid
+client_secret=devclientsecret
+is_default=true
+
+[localhost]
+client_id=localclientid
+client_secret=localclientsecret
+```
+
+Next, you're ready to install canvas.
+
+`pip install canvas`
+
+**Usage**:
+
+```console
+$ canvas [OPTIONS] COMMAND [ARGS]...
+```
+
+**Options**:
+
+- `--version`
+- `--help`: Show this message and exit.
+
+**Commands**:
+
+- `init`: Create a new plugin
+- `install`: Install a plugin into a Canvas instance
+- `uninstall`: Uninstall a plugin from a Canvas instance
+- `disable`: Disable a plugin from a Canvas instance
+- `enable`: Enable a plugin from a Canvas instance
+- `list`: List all plugins from a Canvas instance
+- `validate-manifest`: Validate the Canvas Manifest json file
+- `logs`: Listen and print log streams from a Canvas instance
+
+## `canvas init`
+
+Create a new plugin.
+
+**Usage**:
+
+```console
+$ canvas init [OPTIONS]
+```
+
+**Options**:
+
+- `--help`: Show this message and exit.
+
+## `canvas install`
+
+Install a plugin into a Canvas instance.
+
+**Usage**:
+
+```console
+$ canvas install [OPTIONS] PLUGIN_NAME
+```
+
+**Arguments**:
+
+- `PLUGIN_NAME`: Path to plugin to install [required]
+
+**Options**:
+
+- `--host TEXT`: Canvas instance to connect to
+- `--help`: Show this message and exit.
+
+## `canvas uninstall`
+
+Uninstall a plugin from a Canvas instance..
+
+**Usage**:
+
+```console
+$ canvas uninstall [OPTIONS] NAME
+```
+
+**Arguments**:
+
+- `NAME`: Plugin name to delete [required]
+
+**Options**:
+
+- `--host TEXT`: Canvas instance to connect to
+- `--help`: Show this message and exit.
+
+## `canvas enable`
+
+Enable a plugin from a Canvas instance..
+
+**Usage**:
+
+```console
+$ canvas enable [OPTIONS] NAME
+```
+
+**Arguments**:
+
+- `NAME`: Plugin name to enable [required]
+
+**Options**:
+
+- `--host TEXT`: Canvas instance to connect to
+- `--help`: Show this message and exit.
+
+## `canvas disable`
+
+Disable a plugin from a Canvas instance..
+
+**Usage**:
+
+```console
+$ canvas disable [OPTIONS] NAME
+```
+
+**Arguments**:
+
+- `NAME`: Plugin name to disable [required]
+
+**Options**:
+
+- `--host TEXT`: Canvas instance to connect to
+- `--help`: Show this message and exit.
+
+## `canvas list`
+
+List all plugins from a Canvas instance.
+
+**Usage**:
+
+```console
+$ canvas list [OPTIONS]
+```
+
+**Options**:
+
+- `--host TEXT`: Canvas instance to connect to
+- `--help`: Show this message and exit.
+
+## `canvas validate-manifest`
+
+Validate the Canvas Manifest json file.
+
+**Usage**:
+
+```console
+$ canvas validate-manifest [OPTIONS] PACKAGE
+```
+
+**Arguments**:
+
+- `PLUGIN_NAME`: Path to plugin to install [required]
+
+**Options**:
+
+- `--help`: Show this message and exit.
+
+## `canvas logs`
+
+Listens and prints log streams from the instance.
+
+**Usage**:
+
+```console
+$ canvas logs [OPTIONS]
+```
+
+**Options**:
+
+- `--host TEXT`: Canvas instance to connect to
+- `--help`: Show this message and exit.

canvas-0.77.0/README.md

@@ -0,0 +1,186 @@
+[![codecov](https://codecov.io/gh/canvas-medical/canvas-plugins/graph/badge.svg?token=P8JJUOJ8FH)](https://codecov.io/gh/canvas-medical/canvas-plugins)
+
+### Getting Started
+
+Create a file `~/.canvas/credentials.ini` and add the client_id and client_secret credentials for each of your Canvas instances. You can define your default host with `is_default=true`. If no default is explicitly defined, the Canvas CLI will use the first instance in the file as the default for each of the CLI commands.
+
+**Example:**
+
+```
+[my-canvas-instance]
+client_id=myclientid
+client_secret=myclientsecret
+
+[my-dev-canvas-instance]
+client_id=devclientid
+client_secret=devclientsecret
+is_default=true
+
+[localhost]
+client_id=localclientid
+client_secret=localclientsecret
+```
+
+Next, you're ready to install canvas.
+
+`pip install canvas`
+
+**Usage**:
+
+```console
+$ canvas [OPTIONS] COMMAND [ARGS]...
+```
+
+**Options**:
+
+- `--version`
+- `--help`: Show this message and exit.
+
+**Commands**:
+
+- `init`: Create a new plugin
+- `install`: Install a plugin into a Canvas instance
+- `uninstall`: Uninstall a plugin from a Canvas instance
+- `disable`: Disable a plugin from a Canvas instance
+- `enable`: Enable a plugin from a Canvas instance
+- `list`: List all plugins from a Canvas instance
+- `validate-manifest`: Validate the Canvas Manifest json file
+- `logs`: Listen and print log streams from a Canvas instance
+
+## `canvas init`
+
+Create a new plugin.
+
+**Usage**:
+
+```console
+$ canvas init [OPTIONS]
+```
+
+**Options**:
+
+- `--help`: Show this message and exit.
+
+## `canvas install`
+
+Install a plugin into a Canvas instance.
+
+**Usage**:
+
+```console
+$ canvas install [OPTIONS] PLUGIN_NAME
+```
+
+**Arguments**:
+
+- `PLUGIN_NAME`: Path to plugin to install [required]
+
+**Options**:
+
+- `--host TEXT`: Canvas instance to connect to
+- `--help`: Show this message and exit.
+
+## `canvas uninstall`
+
+Uninstall a plugin from a Canvas instance..
+
+**Usage**:
+
+```console
+$ canvas uninstall [OPTIONS] NAME
+```
+
+**Arguments**:
+
+- `NAME`: Plugin name to delete [required]
+
+**Options**:
+
+- `--host TEXT`: Canvas instance to connect to
+- `--help`: Show this message and exit.
+
+## `canvas enable`
+
+Enable a plugin from a Canvas instance..
+
+**Usage**:
+
+```console
+$ canvas enable [OPTIONS] NAME
+```
+
+**Arguments**:
+
+- `NAME`: Plugin name to enable [required]
+
+**Options**:
+
+- `--host TEXT`: Canvas instance to connect to
+- `--help`: Show this message and exit.
+
+## `canvas disable`
+
+Disable a plugin from a Canvas instance..
+
+**Usage**:
+
+```console
+$ canvas disable [OPTIONS] NAME
+```
+
+**Arguments**:
+
+- `NAME`: Plugin name to disable [required]
+
+**Options**:
+
+- `--host TEXT`: Canvas instance to connect to
+- `--help`: Show this message and exit.
+
+## `canvas list`
+
+List all plugins from a Canvas instance.
+
+**Usage**:
+
+```console
+$ canvas list [OPTIONS]
+```
+
+**Options**:
+
+- `--host TEXT`: Canvas instance to connect to
+- `--help`: Show this message and exit.
+
+## `canvas validate-manifest`
+
+Validate the Canvas Manifest json file.
+
+**Usage**:
+
+```console
+$ canvas validate-manifest [OPTIONS] PACKAGE
+```
+
+**Arguments**:
+
+- `PLUGIN_NAME`: Path to plugin to install [required]
+
+**Options**:
+
+- `--help`: Show this message and exit.
+
+## `canvas logs`
+
+Listens and prints log streams from the instance.
+
+**Usage**:
+
+```console
+$ canvas logs [OPTIONS]
+```
+
+**Options**:
+
+- `--host TEXT`: Canvas instance to connect to
+- `--help`: Show this message and exit.

canvas-0.77.0/canvas_cli/apps/auth/__init__.py

@@ -0,0 +1,3 @@
+from canvas_cli.apps.auth.utils import get_or_request_api_token
+
+__all__ = ("get_or_request_api_token",)

canvas-0.77.0/canvas_cli/apps/auth/storage.py

@@ -0,0 +1,65 @@
+import json
+from datetime import datetime
+from pathlib import Path
+from typing import Any
+
+TOKENS_PATH = Path.home() / ".canvas" / "tokens.json"
+TOKENS_PATH.parent.mkdir(parents=True, exist_ok=True)
+
+
+def _load_tokens() -> dict:
+    if not TOKENS_PATH.exists():
+        return {}
+    with TOKENS_PATH.open("r") as f:
+        return json.load(f)
+
+
+def _save_tokens(tokens: dict) -> None:
+    with TOKENS_PATH.open("w") as f:
+        json.dump(tokens, f, indent=2)
+
+
+def _set_value(key: str, value: Any) -> None:
+    """Set a value in the token storage."""
+    tokens = _load_tokens()
+    tokens[key] = value
+    _save_tokens(tokens)
+
+
+def _get_value(key: str) -> Any | None:
+    """Get value from the token storage."""
+    tokens = _load_tokens()
+    return tokens.get(key)
+
+
+def _delete_value(key: str) -> None:
+    """Delete a value from the token storage."""
+    tokens = _load_tokens()
+    tokens.pop(key, None)
+    _save_tokens(tokens)
+
+
+def set_token(host_token_key: str, token: str, exp: datetime) -> None:
+    """Set a token with an expiry date in the token storage."""
+    _set_value(host_token_key, {"token": token, "exp_date": exp.isoformat()})
+
+
+def get_token(host_token_key: str) -> str | None:
+    """Get a token from the token storage."""
+    value = _get_value(host_token_key)
+
+    if not value:
+        return None
+    try:
+        exp = value["exp_date"]
+        if datetime.fromisoformat(exp) <= datetime.now():
+            return None
+    except ValueError:
+        return None
+
+    return value["token"]
+
+
+def delete_token(host_token_key: str) -> None:
+    """Delete a token from the token storage."""
+    _delete_value(host_token_key)

canvas-0.77.0/canvas_cli/apps/auth/utils.py

@@ -0,0 +1,127 @@
+import configparser
+from datetime import datetime, timedelta
+from pathlib import Path
+from urllib.parse import urlparse
+
+import requests
+
+from canvas_cli.apps.auth.storage import get_token, set_token
+from canvas_sdk.utils import Http
+
+CONFIG_PATH = Path.home() / ".canvas" / "credentials.ini"
+
+LOCALHOST = "http://localhost:8000"
+
+
+def get_config() -> configparser.ConfigParser:
+    """Reads the config file and returns a ConfigParser object."""
+    config = configparser.ConfigParser()
+    if not config.read(CONFIG_PATH):
+        raise Exception(
+            f"""Please add your configuration file at '{CONFIG_PATH}' with the following format:
+
+            [my-canvas-subdomain]
+            client_id=myclientid
+            client_secret=myclientsecret
+
+            [my-dev-canvas-subdomain]
+            client_id=devclientid
+            client_secret=devclientsecret
+            is_default=true
+
+            [localhost]
+            client_id=localclientid
+            client_secret=localclientsecret
+            """
+        )
+    return config
+
+
+def read_config(host: str, property: str) -> str:
+    """Reads the config file and returns the property for a given section."""
+    config = get_config()
+    if host not in config:
+        raise Exception(f"'{host}' is not found in the configuration file at '{CONFIG_PATH}'")
+    return config.get(host, property)
+
+
+def get_api_client_credentials(host: str) -> str:
+    """Either return the given api_key, or fetch it from the token storage."""
+    hostname = urlparse(host).hostname
+
+    if not hostname:
+        raise ValueError("Could not parse hostname from URL")
+
+    instance = hostname.removesuffix(".canvasmedical.com")
+
+    client_id = read_config(instance, "client_id")
+    client_secret = read_config(instance, "client_secret")
+
+    return f"client_id={client_id}&client_secret={client_secret}"
+
+
+def get_default_host(host: str | None = None) -> str:
+    """Return the explicitly stated default host, or first if none is indicated."""
+    if host:
+        if "://" in host:
+            return host
+
+        if "localhost" in host:
+            return LOCALHOST
+
+        return f"https://{host}.canvasmedical.com"
+
+    config = get_config()
+    if not (hosts := config.sections()):
+        raise Exception(f"No hosts found in the configuration file at '{CONFIG_PATH}'")
+
+    first_default_host = next(
+        (host for host in hosts if config.getboolean(host, "is_default", fallback=False) is True),
+        hosts[0],
+    )
+    if first_default_host == "localhost":
+        return LOCALHOST
+
+    return f"https://{first_default_host}.canvasmedical.com"
+
+
+def request_api_token(host: str, api_client_credentials: str) -> dict:
+    """Request an api token using the provided client_id and client_secret."""
+    grant_type = "grant_type=client_credentials"
+    scope = "scope=system/Plugins.*"
+
+    http = Http()
+    token_response = http.post(
+        f"{host}/auth/token/",
+        headers={"Content-Type": "application/x-www-form-urlencoded"},
+        data=f"{grant_type}&{scope}&{api_client_credentials}",
+    )
+    if token_response.status_code != requests.codes.ok:
+        raise Exception(f"Unable to get a valid access token from the given host '{host}'")
+    return token_response.json()
+
+
+def get_or_request_api_token(host: str | None = None) -> str:
+    """Returns an existing stored token if it has not expired, or requests a new one."""
+    if not (host := get_default_host(host)):
+        raise Exception(
+            f"Please specify a host or add one to the configuration file at '{CONFIG_PATH}'"
+        )
+
+    token = get_token(host)
+
+    if token:
+        return token
+
+    api_client_credentials = get_api_client_credentials(host)
+
+    if not (token_response := request_api_token(host, api_client_credentials)):
+        raise Exception(f"A token could not be acquired from the given host '{host}'")
+
+    token_expiration_date = datetime.now() + timedelta(seconds=token_response["expires_in"])
+    if token_expiration_date <= datetime.now():
+        raise Exception(f"A valid token could not be acquired from the given host '{host}'")
+
+    new_token = token_response["access_token"]
+    set_token(host, new_token, token_expiration_date)
+    return new_token

canvas-0.77.0/canvas_cli/apps/emit/__init__.py

@@ -0,0 +1,3 @@
+from canvas_cli.apps.emit.emit import emit
+
+__all__ = ("emit",)

canvas-0.77.0/canvas_cli/apps/emit/emit.py

@@ -0,0 +1,66 @@
+import json
+import random
+from pathlib import Path
+from typing import Annotated
+
+import grpc
+import typer
+
+from canvas_generated.messages.events_pb2 import Event as PluginRunnerEvent
+from canvas_generated.services.plugin_runner_pb2_grpc import PluginRunnerStub
+
+
+def emit(
+    event_fixture: str,
+    plugin_runner_port: Annotated[
+        str, typer.Option(help="Port of your locally running plugin runner")
+    ] = "50051",
+) -> None:
+    """
+    Send an event fixture to your locally running plugin-runner process, and print any resultant effects.
+
+    Valid fixture files are newline-delimited JSON, with each containing the keys `EventType`, `target`, and `context`. Some fixture files are included in the canvas-plugins repo.
+    """
+    # If an event fixture file exists at the specified path, use it.
+    # Otherwise, see if it represents an event that we have a Canvas-provided
+    # fixture for and use that.
+    event_fixture_path = Path(event_fixture)
+
+    if not event_fixture_path.exists():
+        candidate_built_in_fixture_path = (
+            Path(__file__).resolve().parent / "event_fixtures" / f"{event_fixture}.ndjson"
+        )
+        if candidate_built_in_fixture_path.exists():
+            event_fixture_path = candidate_built_in_fixture_path
+        else:
+            print(f"ERROR: No file found at location {event_fixture}.")
+            print(f"ERROR: No built-in fixture file found named {event_fixture}.ndjson.")
+            return
+
+    # Grab a random event from the fixture file ndjson
+    lines = event_fixture_path.read_text().splitlines()
+    myline = random.choice(lines)
+    event_data = json.loads(myline)
+    event = PluginRunnerEvent(
+        type=event_data["EventType"],
+        target=event_data["target"],
+        context=event_data["context"],
+    )
+    with grpc.insecure_channel(f"localhost:{plugin_runner_port}") as channel:
+        stub = PluginRunnerStub(channel)
+        responses = stub.HandleEvent(event)
+
+        at_least_one_effect = False
+        try:
+            for response in responses:
+                for effect in response.effects:
+                    at_least_one_effect = True
+                    print(effect)
+
+            if not at_least_one_effect:
+                print("SUCCESS: No effects returned.")
+        except grpc.RpcError as e:
+            if e.code() == grpc.StatusCode.UNAVAILABLE:
+                print(
+                    f"ERROR: Couldn't make a connection to a plugin runner process at localhost:{plugin_runner_port}. Is it running?"
+                )

canvas-0.77.0/canvas_cli/apps/emit/event_fixtures/ALLERGY_INTOLERANCE_CREATED.ndjson

@@ -0,0 +1 @@
+{"EventType": "ALLERGY_INTOLERANCE_CREATED", "target": "4bbdb87a-3f97-4374-81e6-1e8ce5d3c121", "context": ""}

canvas-0.77.0/canvas_cli/apps/emit/event_fixtures/ALLERGY_INTOLERANCE_UPDATED.ndjson

@@ -0,0 +1 @@
+{"EventType": "ALLERGY_INTOLERANCE_UPDATED", "target": "4bbdb87a-3f97-4374-81e6-1e8ce5d3c121", "context": ""}