Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: rename to waylay-sdk-core, update version #52

Merged
merged 1 commit into from
Apr 8, 2024
Merged

feat: rename to waylay-sdk-core, update version #52

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,15 +59,15 @@ clean-caches:
dist-clean:
rm -fr dist build

exec-dev-install-pkg: ## Install waylay-sdk with development dependency constraints as specified in the package.
exec-dev-install-pkg: ## Install waylay-sdk-core with development dependency constraints as specified in the package.
pip install -e ".[dev]"
pip install -e test/plugin

exec-dev-install: ### Install a development environment with frozen dependencies'
make exec-dev-dependencies
make exec-dev-install-pkg

exec-install-pkg: ### Install waylay-sdk with dependency constraints as specified in the package. (e.g. for notebook tests)
exec-install-pkg: ### Install waylay-sdk-core with dependency constraints as specified in the package. (e.g. for notebook tests)
pip install -e .

exec-dist:
Expand Down Expand Up @@ -228,7 +228,7 @@ pdoc: # TODO
test-publish:
${VENV_ACTIVATE} && pip install twine
${VENV_ACTIVATE} && python -m twine upload --repository testpypi dist/*
open https://test.pypi.org/project/waylay-sdk
open https://test.pypi.org/project/waylay-sdk-core

_assert_tagged:
@ ${VENV_ACTIVATE} && export _PKG_VERSION_SCRIPT='from importlib.metadata import version; print(version("waylay.sdk"))' && \
Expand All @@ -243,4 +243,4 @@ _assert_tagged:
publish: _assert_tagged
${VENV_ACTIVATE} && pip install twine
${VENV_ACTIVATE} && python -m twine upload dist/*
open https://pypi.org/project/waylay-sdk
open https://pypi.org/project/waylay-sdk-core
140 changes: 7 additions & 133 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Python SDK for the Waylay Platform.

This `waylay-sdk` package provides a basic SDK client for the [Waylay REST apis](https://docs.waylay.io/#/api/?id=openapi-docs).
This `waylay-sdk-core` package provides a basic SDK client for the [Waylay REST apis](https://docs.waylay.io/#/api/?id=openapi-docs).

See [Waylay Docs](https://docs.waylay.io/#/api/sdk/python) for documentation.

Expand All @@ -12,40 +12,21 @@ This package requires a python runtime `3.9` or higher.

The basic client can be installed with
```bash
pip install waylay-sdk
pip install waylay-sdk-core
```

This client provides basic configuration, authorization and plugin features for the SDK.
This client provides configuration, authorization and plugin features for the SDK.

It includes a generic http client to make authenticated calls to the services available on your _Waylay_ gateway endpoint.

Support for specific Waylay services or tools is provided by separate [service](#service-packages) and [tool](#tool-packages) packages.
Support for specific Waylay services or tools is provided by separate extension packages.

## Basic usage

### In webscripts and plugins

The SDK client can be used in the _python_ webscripts and plugins of the Waylay platform.

In that case, the webscript or plugin _runtime_ will configure and authenticate a client, and
provide it as a `waylay` parameter to the _webscript_ or _plugin_ callback function.

You just need to state the required SDK package dependencies when authoring the _webscript_ or _plugin_.

```python
async def execute(request: Request, waylay: WaylayClient):
# list templates with the query as specified in the request body
template_query = request.json()

# with only the 'waylay-sdk' package:
templates = await waylay.api_client('GET', '/rules/v1/templates', query=template_query)
See [`waylay-sdk`](https://pypi.org/project/waylay-sdk) to install a client that includes the recommended extensions.

# with the 'waylay-sdk-rules' service plugin package
# templates = await waylay.rules.templates.list(query=template_query)
return templates
```
## Basic usage

### Interactive Authentication

When used outside the Waylay platform (e.g. in a _python notebook_) the client requires you to provide
* the gateway endpoint: `api.waylay.io` for Enterprise users,
* an API key-secret pair: see [Waylay Console](console.waylay.io) at _>Settings>Authentication keys_.
Expand All @@ -66,110 +47,3 @@ resp = await client.api_client.request('GET', '/registry/v2')
Credentials and endpoints are stored in a local _profile_ file (you can have multiple such profiles).
Other authentication methods are available (JWToken, pass apiKey/Secret directly)

## Service packages

Support for a specific Waylay REST api comes as a separate _service package_.
Each _service_ provides two packages:
* an _api_ package `waylay-<service>-sdk` that describes all resources and actions for that service. JSON request and responses are represented as basic python data (_dict_, _list_, primitives)
* a _types_ package `waylay-<service>-sdk-types` that provides [pydantic](https://docs.pydantic.dev/) models to represent JSON request and responses.

The _types_ package is optional. When installed, its _pydantic_ models are used to serialize requests and deserialize responses. When used in a python IDE, code completion will help you navigate the attributes of request and responses.
This makes it easier to interact with the API as a developer.
But as the underlying REST api evolves, the _types_ package might require regular dependency updates.

Use the _types_ package for interactive cases (python notebooks), or solutions that are regularly tested and maintained.

When not installed, the SDK client does not interfere with the json representations of requests and responses, and you should check the [API documentation](https://docs.waylay.io/#/api/?id=openapi-docs) of the service for exact specifications.

The Service plugs are _generated_ from their [openapi description](https://docs.waylay.io/#/api/?id=openapi-docs).

### `waylay-sdk-alarms` _Alarms_ api package

The [waylay-sdk-alarms](https://pypi.org/project/waylay-sdk-alarms) package provides the client bindings for the [Alarms](https://docs.waylay.io/#/api/alarms/) service, based on its [openapi](https://docs.waylay.io/openapi/public/redocly/alarms.html) specification.

```bash
## with types
pip install waylay-sdk-alarms[types]

## without types
pip install waylay-sdk-alarms
```

### `waylay-sdk-data` _Data_ (broker) api package

The [waylay-sdk-data](https://pypi.org/project/waylay-sdk-data) package provides the client bindings for the `data` api of the [broker](https://docs.waylay.io/#/api/broker/) service, based on its [openapi](https://docs.waylay.io/openapi/public/redocly/broker.html) specification.

```bash
## with types
pip install waylay-sdk-data[types]

## without types
pip install waylay-sdk-data
```

### `waylay-sdk-resources` _Resources_ (digital twin) api package

The [waylay-sdk-resources](https://pypi.org/project/waylay-sdk-resources) package provides the client bindings for the [resources](https://docs.waylay.io/#/api/resources/) service, based on its [openapi](https://docs.waylay.io/openapi/public/redocly/resources.html) specification.

```bash
## with types
pip install waylay-sdk-resources[types]

## without types
pip install waylay-sdk-resources
```

### `waylay-sdk-rules` _Rules_ (rules engine) api package

The [waylay-sdk-rules](https://pypi.org/project/waylay-sdk-rules) package provides the client bindings for the [rules](https://docs.waylay.io/#/api/rules/) service, based on its [openapi](https://docs.waylay.io/openapi/public/redocly/rules.html) specification.

```bash
## with types
pip install waylay-sdk-rules[types]

## without types
pip install waylay-sdk-rules
```

### `waylay-sdk-storage` _Storage_ (file object storage) api package

The [waylay-sdk-storage](https://pypi.org/project/waylay-sdk-storage) package provides the client bindings for the [storage](https://docs.waylay.io/#/api/storage/) service, based on its [openapi](https://docs.waylay.io/openapi/public/redocly/storage.html) specification.

```bash
## with types
pip install waylay-sdk-storage[types]

## without types
pip install waylay-sdk-storage
```

### `waylay-sdk-registry` _Function Registry V2_ api package

The [waylay-sdk-registry](https://pypi.org/project/waylay-sdk-registry) package provides the client bindings for the [registry v2](https://docs.waylay.io/#/api/registry/) service, based on its [openapi](https://docs.waylay.io/openapi/public/redocly/registry.html) specification.

```bash
## with types
pip install waylay-sdk-registry[types]

## without types
pip install waylay-sdk-registry
```


## Tool packages

Tool packages provide SDK extensions for specific use cases.


### `waylay-sdk-ml-adapter` _ML Adapter_ tool package

The [waylay-sdk-ml-adapter](https://pypi.org/project/waylay-sdk-ml-adapter) package provides utilities for using and deploying Machine Learning models in plugs and webscripts.

```bash
## basic install
pip install waylay-sdk-ml-adapter

## install with support for pytorch models
pip install waylay-sdk-ml-adapter[pytorch]

```
12 changes: 2 additions & 10 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ requires = ["setuptools"]
build-backend = "setuptools.build_meta"

[project]
name = "waylay-sdk"
version = "0.0.6"
name = "waylay-sdk-core"
version = "0.1.0"
description = "Waylay Python SDK."
requires-python = ">=3.9"
keywords = ["waylay", "sdk"]
Expand All @@ -21,14 +21,6 @@ dependencies = [
"jsonpath-ng",
"pydantic >= 2.6.0",
"eval-type-backport ~= 0.1.3; python_version < '3.10'",

# waylay services
"waylay-sdk-alarms",
"waylay-sdk-data",
"waylay-sdk-registry",
"waylay-sdk-resources",
"waylay-sdk-rules",
"waylay-sdk-storage",
]

[project.urls]
Expand Down
4 changes: 2 additions & 2 deletions src/waylay/sdk/_version.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
"""Release version of waylay-sdk."""
"""Release version of waylay-sdk-core."""

__version__ = "0.0.6"
__version__ = "0.1.0"
2 changes: 1 addition & 1 deletion test/plugin/pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ description = "Test Plugins for the Waylay Python SDK."
requires-python = ">=3.9"
authors = [{name = "Waylay", email = "[email protected]"}]
dependencies = [
"waylay-sdk",
"waylay-sdk-core",
]

[project.entry-points.dynamic]
Expand Down