Metadata-Version: 2.4
Name: ondewo-csi-client
Version: 5.6.2
Summary: ONDEWO Communication System Integration (CSI) Client library for Python
Author-email: ONDEWO GmbH <office@ondewo.com>
License-Expression: Apache-2.0
Project-URL: Homepage, https://github.com/ondewo/ondewo-csi-client-python
Project-URL: Repository, https://github.com/ondewo/ondewo-csi-client-python
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
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: Programming Language :: Python :: 3.14
Classifier: Topic :: Software Development :: Libraries
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: aiohttp
Requires-Dist: dataclasses-json
Requires-Dist: google-api-core
Requires-Dist: googleapis-common-protos
Requires-Dist: grpcio
Requires-Dist: grpcio-reflection
Requires-Dist: grpcio-tools
Requires-Dist: loguru
Requires-Dist: numpy
Requires-Dist: ondewo-client-utils>=4.1.1; python_version >= "3.12"
Requires-Dist: ondewo-client-utils>=3.2.0; python_version < "3.12"
Requires-Dist: ondewo-nlu-client<7.2.0,>=7.1.1
Requires-Dist: ondewo-s2t-client<7.6.0,>=7.5.0
Requires-Dist: ondewo-t2s-client<6.7.0,>=6.6.3
Requires-Dist: requests
Requires-Dist: setuptools
Provides-Extra: dev
Requires-Dist: jupyter; extra == "dev"
Requires-Dist: mypy; extra == "dev"
Requires-Dist: mypy-protobuf; extra == "dev"
Requires-Dist: pre-commit; extra == "dev"
Requires-Dist: pytest; extra == "dev"
Requires-Dist: ruff; extra == "dev"
Requires-Dist: SoundFile>=0.10.3.post1; extra == "dev"
Requires-Dist: pyaudio>=0.2.12; extra == "dev"
Requires-Dist: pysoundio>=1.1.0; extra == "dev"
Requires-Dist: python-dotenv; extra == "dev"
Requires-Dist: setuptools; extra == "dev"
Requires-Dist: typing_extensions; extra == "dev"
Requires-Dist: types-requests; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"
Requires-Dist: pytest-asyncio; extra == "dev"
Dynamic: license-file

<div align="center">
  <table>
    <tr>
      <td>
        <a href="https://ondewo.com/en/products/natural-language-understanding/">
            <img width="400px" src="https://raw.githubusercontent.com/ondewo/ondewo-logos/master/ondewo_we_automate_your_phone_calls.png"/>
        </a>
      </td>
    </tr>
    <tr>
        <td align="center">
          <a href="https://www.linkedin.com/company/ondewo "><img width="40px" src="https://cdn-icons-png.flaticon.com/512/3536/3536505.png"></a>
          <a href="https://www.facebook.com/ondewo"><img width="40px" src="https://cdn-icons-png.flaticon.com/512/733/733547.png"></a>
          <a href="https://twitter.com/ondewo"><img width="40px" src="https://cdn-icons-png.flaticon.com/512/733/733579.png"> </a>
          <a href="https://www.instagram.com/ondewo.ai/"><img width="40px" src="https://cdn-icons-png.flaticon.com/512/174/174855.png"></a>
        </td>
    </tr>
  </table>
  <h1>
  Ondewo CSI Client Python Library
  </h1>
</div>

This library facilitates the interaction between a user and a CAI server. It achieves this by providing a higher-level interface mediator.

This higher-level interface mediator is structured around a series of python files generated from protobuf files. These protobuf files specify the details of the interface, and can be used to generate code in 10+ high-level languages. They are found in the [ONDEWO CSI API](https://github.com/ondewo/ondewo-csi-api) along with the older Google protobufs from Dialogueflow that were used at the start. The [ONDEWO PROTO-COMPILER](https://github.com/ondewo/ondewo-proto-compiler) will generate the needed files directly in this library.

## Python Installation

You can install the library by installing it directly from the PyPi:

```bash
pip install ondewo-csi-client
```

Or, you could clone it and install the requirements:

```bash
git clone git@github.com:ondewo/ondewo-csi-client-python.git
cd ondewo-csi-client-python
make setup_developer_environment_locally
```

## Repository Structure

```
.
├── examples                                  <----- Helpful for implementation of code
│   ├── audiofiles
│   │   ├── config_basic_en_LJ_female_en.wav
│   │   ├── config_basic_kerstin_itsupport.wav
│   │   ├── config_basic_thorsten_german_medical.wav
│   │   └── pizza_de.wav
│   ├── convert_files.py
│   ├── healthcheck_example.py
│   ├── multi_client_example.py
│   ├── s2s_pipelines_example.py
│   ├── s2s_streaming_example.py
│   ├── speech2speech_example.py
│   ├── speech2speech_with_hangup_example.py
│   └── streamer.py
├── ondewo
│   ├── csi
│   │   ├── client
│   │   │   ├── core
│   │   │   ├── services
│   │   │   │   ├── async_conversations.py
│   │   │   │   ├── conversations.py
│   │   │   │   └── __init__.py
│   │   │   ├── utils
│   │   │   ├── async_client.py
│   │   │   ├── async_services_container.py
│   │   │   ├── client_config.py
│   │   │   ├── client.py
│   │   │   ├── __init__.py
│   │   │   └── services_container.py
│   │   ├── conversation_pb2_grpc.py
│   │   ├── conversation_pb2.py
│   │   ├── conversation_pb2.pyi
│   │   └── __init__.py
│   └── __init__.py
├── ondewo-csi-api                           <----- @ https://github.com/ondewo/ondewo-csi-api
├── ondewo-proto-compiler                    <----- @ https://github.com/ondewo/ondewo-proto-compiler
├── tests
├── tutorials                                <----- Helpful for implementation of code
│   ├── s2t_examples
│   │   └── audiofiles
│   │       ├── sample_1.wav
│   │       └── sample_2.wav
│   ├── Jupyter_demo_helper.ipynb
│   └── Jupyter_demo.ipynb
├── CONTRIBUTING.md
├── Dockerfile.utils
├── LICENSE
├── Makefile
├── MANIFEST.in
├── pyproject.toml
├── README.md
├── RELEASE.md
└── uv.lock
```

## Build

The `make build` command is dependent on 2 `repositories` and their speciefied `version`:

- [ondewo-csi-api](https://github.com/ondewo/ondewo-csi-api) -- `ONDEWO_CSI_API_GIT_BRANCH` in `Makefile`
- [ondewo-proto-compiler](https://github.com/ondewo/ondewo-proto-compiler) -- `ONDEWO_PROTO_COMPILER_GIT_BRANCH` in `Makefile`

It will generate a `_pb2.py`, `_pb2.pyi` and `_pb2_grpc.py` file for every `.proto` in the api submodule.

> :warning: All Files in the `ondewo` folder that dont have `pb2` in their name are handwritten, and therefor need to be manually adjusted to any changes in the proto-code.

## Examples

The `/examples` folder provides a possible implementation of this library. To run an example, simply execute it like any other python file. Most examples load a JSON `ClientConfig` (see `examples/configs/`); `keycloak_auth_example.py` instead builds the config inline from environment variables. Authentication uses the Keycloak headless offline-token flow: the client logs in once and sends the auto-refreshed access token as `Authorization: Bearer <jwt>` on every RPC (the legacy `http_token` / `cai-token` HTTP-Basic login has been removed). The config fields are:

- host `// The hostname of the Server - e.g. 127.0.0.1`
- port `// Port of the Server - e.g. 6600`
- grpc_cert `// gRPC Certificate of the server (optional; omit for an insecure channel)`
- keycloak_url `// Base URL of the Keycloak server - e.g. https://keycloak.ondewo.com/auth`
- realm `// Keycloak realm that owns the SDK client and the user`
- client_id `// Public Keycloak client id used for the ROPC grant (no client secret)`
- username `// Username (email) of the 2FA-exempt technical user; user_name is accepted as a legacy alias`
- password `// Password of the technical user`
- token_expiration_in_s `// Optional upper bound (seconds) on how long auto-refresh keeps renewing the token`

## Automatic Release Process

The entire process is automated to make development easier. The actual steps are simple:

TODO after Pull Request was merged in:

- Checkout master:

  ```shell
  git checkout master
  ```

- Pull the new stuff:

  ```shell
  git pull
  ```

- (If not already, run the `setup_developer_environment_locally` command):

  ```shell
  make setup_developer_environment_locally
  ```

- Update the `ONDEWO_CSI_VERSION` in the `Makefile`
- Add the new Release Notes in `RELEASE.md` in the format:

  ```
  ## Release ONDEWO CSI Python Client X.X.X       <---- Beginning of Notes

     ...<NOTES>...

  *****************                      <---- End of Notes
  ```

- Release:

  ```shell
  make ondewo_release
  ```

---

`make ondewo_release` runs these steps, in this order, and stops at the first one that fails. The order is pinned by
`tests/unit/test_release_runs_in_a_fresh_clone.py` and is the same in every `ondewo-csi-client-<language>`
repository, so `ondewo-csi-api`'s release driver treats them alike.

1. `spc` (read-only, no credentials): the branch `release/<version>` and the tag `<version>` are not on origin
   (`git ls-remote --exit-code`, exact refs), PyPI does not serve `ondewo-csi-client <version>` yet, and `RELEASE.md`
   carries exactly one `## Release ONDEWO CSI Python Client <version>` heading (matched anchored, dots escaped) with
   a non-empty body.
2. Load `GITHUB_GH_TOKEN`, `PYPI_USERNAME` and `PYPI_PASSWORD` from `ondewo-devops-accounts`, then **delete that
   clone** before anything else runs, and also when the clone or the release fails. The clone lives in a `mktemp`
   directory, never in this repository. When `DEVOPS_ACCOUNT_DIR` points at an existing clone (the driver clones once
   for all clients), it is used and not cloned again.
3. `release_preflight` (read-only): the host tools exist, `spc` again, and both credentials are VALID:
   - GitHub: `gh api repos/ondewo/ondewo-csi-client-python --jq .permissions.push` prints `true`.
   - PyPI has no read-only identity call, so the probe re-uploads the newest file that is already on PyPI. PyPI checks
     the credential and the upload permission on this project first (`403` when either fails) and only then refuses
     the existing file (`400 File already exists`). A pass therefore proves the credential may upload to
     `ondewo-csi-client`, and it cannot publish anything new.
4. `build` (regenerates the code from `ondewo-csi-api` with the `ondewo-proto-compiler` tag
   `ONDEWO_PROTO_COMPILER_GIT_BRANCH`), the pre-commit hooks, `check_build` and `make test` (ruff, mypy and the unit
   suite with the coverage gate). These steps run with the credentials removed from their environment.
5. Commit locally (only when something changed), upload to PyPI, and wait until the PyPI JSON API serves the version.
   PyPI comes first because it is the one step that cannot be undone.
6. Push, create and push `release/<version>` and the tag `<version>`, create the GitHub release from the `RELEASE.md`
   section (an empty body is refused).
7. `release_verify` (read-only, also run by the driver afterwards): the tag is on origin, the GitHub release has a
   non-empty body, and PyPI serves the version (polled 20 x 30 s; `VERIFY_ATTEMPTS` / `VERIFY_INTERVAL_S` override).

`release_preflight` and `release_verify` also run standalone: with only an absolute `DEVOPS_ACCOUNT_DIR` set they read
the credentials from that clone, e.g. `make release_verify DEVOPS_ACCOUNT_DIR=/abs/path/ondewo-devops-accounts`.

When a step after the PyPI upload fails, the version stays on PyPI and `spc` refuses a re-run; run the remaining steps
by hand (`git push`, `make create_release_branch`, `make create_release_tag`, `make release_to_github_via_docker`,
`make release_verify`).

Host requirements: `docker`, `git`, `make`, `perl`, `curl` and `uv`. `gh`, `twine` and the package build run in the
pinned `Dockerfile.utils` image (exact uv, twine and gh versions, base images by digest), and gh reads the token from
`GH_TOKEN` per call, so nothing is stored in `~/.config/gh`. No credential is ever put on a command line.
