canvas 0.1.1__py3-none-any.whl → 0.1.3__py3-none-any.whl

canvas-0.1.3.dist-info/METADATA

@@ -0,0 +1,285 @@
+Metadata-Version: 2.1
+Name: canvas
+Version: 0.1.3
+Summary: SDK to customize event-driven actions in your Canvas instance
+License: MIT
+Author: Canvas Team
+Author-email: engineering@canvasmedical.com
+Requires-Python: >=3.12,<4.0
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: canvas-brush (>=1.2.2,<2.0.0)
+Requires-Dist: canvas-core (>=0.84.1,<0.85.0)
+Requires-Dist: typer (>=0.9.0,<0.10.0)
+Description-Content-Type: text/markdown
+
+### Getting Started
+
+`pip install canvas`
+
+**Usage**:
+
+```console
+$ canvas [OPTIONS] COMMAND [ARGS]...
+```
+
+**Options**:
+
+- `--no-ansi`: Disable colorized output
+- `--version`
+- `--verbose`: Show extra output
+- `--install-completion`: Install completion for the current shell.
+- `--show-completion`: Show completion for the current shell, to copy it or customize the installation.
+- `--help`: Show this message and exit.
+
+**Commands**:
+
+- `auth`: Manage authenticating in Canvas instances
+- `logs`: Listens and prints log streams from the instance
+- `plugin`: Manage plugins in a Canvas instance
+- `print-config`: Print the config and exit
+
+## `canvas auth`
+
+Manage authenticating in Canvas instances
+
+**Usage**:
+
+```console
+$ canvas auth [OPTIONS] COMMAND [ARGS]...
+```
+
+**Options**:
+
+- `--help`: Show this message and exit.
+
+**Commands**:
+
+- `add-api-key`: Add a host=api-key pair to the keychain, so it can be used in other requests
+- `get-api-key`: Print the api_key for the given host
+- `remove-api-key`: Removes a host from the keychain, and as the default if it's the one
+- `set-default-host`: Set the host as the default host in the config file
+
+### `canvas auth add-api-key`
+
+Add a host=api-key pair to the keychain, so it can be used in other requests.
+Optionally set a default so `--host` isn't required everywhere
+
+**Usage**:
+
+```console
+$ canvas auth add-api-key [OPTIONS]
+```
+
+**Options**:
+
+- `--host TEXT`: [required]
+- `--api-key TEXT`: [required]
+- `--is-default / --no-is-default`: [required]
+- `--help`: Show this message and exit.
+
+### `canvas auth get-api-key`
+
+Print the api_key for the given host.
+
+**Usage**:
+
+```console
+$ canvas auth get-api-key [OPTIONS] HOST
+```
+
+**Arguments**:
+
+- `HOST`: [required]
+
+**Options**:
+
+- `--help`: Show this message and exit.
+
+### `canvas auth remove-api-key`
+
+Removes a host from the keychain, and as the default if it's the one.
+This method always succeeds, regardless of username existence.
+
+**Usage**:
+
+```console
+$ canvas auth remove-api-key [OPTIONS] HOST
+```
+
+**Arguments**:
+
+- `HOST`: [required]
+
+**Options**:
+
+- `--help`: Show this message and exit.
+
+### `canvas auth set-default-host`
+
+Set the host as the default host in the config file. Validates it exists in the keychain.
+
+**Usage**:
+
+```console
+$ canvas auth set-default-host [OPTIONS] HOST
+```
+
+**Arguments**:
+
+- `HOST`: [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
+- `--api-key TEXT`: Canvas api-key for the provided host
+- `--help`: Show this message and exit.
+
+## `canvas plugin`
+
+Manage plugins in a Canvas instance
+
+**Usage**:
+
+```console
+$ canvas plugin [OPTIONS] COMMAND [ARGS]...
+```
+
+**Options**:
+
+- `--help`: Show this message and exit.
+
+**Commands**:
+
+- `delete`: Delete a disabled plugin from an instance
+- `init`: Create a plugin from a template using Cookiecutter
+- `install`: Installs a given Python package into a running Canvas instance
+- `list`: Lists all plugins from the instance
+- `update`: Updates a plugin from an instance
+
+### `canvas plugin delete`
+
+Delete a disabled plugin from an instance.
+
+**Usage**:
+
+```console
+$ canvas plugin delete [OPTIONS] NAME
+```
+
+**Arguments**:
+
+- `NAME`: Plugin name to delete [required]
+
+**Options**:
+
+- `--host TEXT`: Canvas instance to connect to
+- `--api-key TEXT`: Canvas api-key for the provided host
+- `--help`: Show this message and exit.
+
+### `canvas plugin init`
+
+Create a plugin from a template using Cookiecutter.
+
+**Usage**:
+
+```console
+$ canvas plugin init [OPTIONS] [TEMPLATE]
+```
+
+**Arguments**:
+
+- `[TEMPLATE]`: [default: (dynamic)]
+
+**Options**:
+
+- `--no-input`: Don't prompt the user at command line
+- `--help`: Show this message and exit.
+
+### `canvas plugin install`
+
+Installs a given Python package into a running Canvas instance.
+
+**Usage**:
+
+```console
+$ canvas plugin install [OPTIONS] PACKAGE
+```
+
+**Arguments**:
+
+- `PACKAGE`: Path to either a dir or wheel or sdist file containing the python package to install [required]
+
+**Options**:
+
+- `--host TEXT`: Canvas instance to connect to
+- `--api-key TEXT`: Canvas api-key for the provided host
+- `--help`: Show this message and exit.
+
+### `canvas plugin list`
+
+Lists all plugins from the instance.
+
+**Usage**:
+
+```console
+$ canvas plugin list [OPTIONS]
+```
+
+**Options**:
+
+- `--host TEXT`: Canvas instance to connect to
+- `--api-key TEXT`: Canvas api-key for the provided host
+- `--help`: Show this message and exit.
+
+### `canvas plugin update`
+
+Updates a plugin from an instance.
+
+**Usage**:
+
+```console
+$ canvas plugin update [OPTIONS] NAME
+```
+
+**Arguments**:
+
+- `NAME`: Plugin name to update [required]
+
+**Options**:
+
+- `--package PATH`: Path to a wheel or sdist file containing the python package to install
+- `--enable / --disable`: Enable/disable the plugin
+- `--host TEXT`: Canvas instance to connect to
+- `--api-key TEXT`: Canvas api-key for the provided host
+- `--help`: Show this message and exit.
+
+## `canvas print-config`
+
+Simple command to print the config and exit.
+
+**Usage**:
+
+```console
+$ canvas print-config [OPTIONS]
+```
+
+**Options**:
+
+- `--help`: Show this message and exit.
+

canvas-0.1.3.dist-info/RECORD

@@ -0,0 +1,6 @@
+canvas/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+canvas/main.py,sha256=UPjM6iDT_aI30Ur0LHIt3tTiHlalVRn6OEquJhoZVc0,635
+canvas-0.1.3.dist-info/METADATA,sha256=ZEX0jOi9Rh66XblLuj1gNYKY7Vb0SeiCoSN2cTDD7ys,5801
+canvas-0.1.3.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
+canvas-0.1.3.dist-info/entry_points.txt,sha256=hsTDoLuwUTBak71S0KIxgSq-SVzf89Gh56UpbNwz5V8,42
+canvas-0.1.3.dist-info/RECORD,,

canvas-0.1.1.dist-info/METADATA

@@ -1,26 +0,0 @@
-Metadata-Version: 2.1
-Name: canvas
-Version: 0.1.1
-Summary: SDK to customize event-driven actions in your Canvas instance
-License: MIT
-Author: Canvas Team
-Author-email: engineering@canvasmedical.com
-Requires-Python: >=3.12,<4.0
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.12
-Requires-Dist: canvas-core (>=0.84.1,<0.85.0)
-Requires-Dist: typer (>=0.9.0,<0.10.0)
-Description-Content-Type: text/markdown
-
-### Getting Started
-
-Here's how to set up `canvas-sdk` for local development:
-
-1. Fork the `canvas-sdk` repo on GitHub.
-2. Clone your fork locally: `git clone git@github.com:canvas-medical/canvas-sdk.git`
-3. Navigate to your clone: `cd canvas-sdk`
-4. Install the dependencies: `poetry install`
-5. Activate the virtualenv: `poetry shell`
-6. Install the pre-commit hooks: `pre-commit install --install-hooks`
-

canvas-0.1.1.dist-info/RECORD

@@ -1,6 +0,0 @@
-canvas/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-canvas/main.py,sha256=UPjM6iDT_aI30Ur0LHIt3tTiHlalVRn6OEquJhoZVc0,635
-canvas-0.1.1.dist-info/METADATA,sha256=oyJvwycDo13bYN0ieGCCbi_gCm6MY6TKGiNDfA0v41Y,911
-canvas-0.1.1.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
-canvas-0.1.1.dist-info/entry_points.txt,sha256=hsTDoLuwUTBak71S0KIxgSq-SVzf89Gh56UpbNwz5V8,42
-canvas-0.1.1.dist-info/RECORD,,