# sz-sdk-python-grpc
If you are beginning your journey with [Senzing],
please start with [Senzing Quick Start guides].
You are in the [Senzing Garage] where projects are "tinkered" on.
Although this GitHub repository may help you understand an approach to using Senzing,
it's not considered to be "production ready" and is not considered to be part of the Senzing product.
Heck, it may not even be appropriate for your application of Senzing!
## :warning: WARNING: sz-sdk-python-grpc is still in development :warning: _
At the moment, this is "work-in-progress" with Semantic Versions of `0.n.x`.
Although it can be reviewed and commented on,
the recommendation is not to use it yet.
## Synopsis
The Senzing `sz-sdk-python-grpc` package provides a [Python] Software Development Kit
adhering to the abstract classes of [sz-sdk-python]
that communicates with a [Senzing gRPC server].
[![Python 3.11 Badge]][Python 3.11]
[![PEP8 Badge]][PEP8]
[![PyPI version Badge]][PyPi version]
[![Downloads Badge]][Downloads]
[![License Badge]][License]
[![Coverage Badge]][Coverage]
## Overview
The Senzing `sz-sdk-python-grpc` packages enable Python programs to call Senzing library functions
across a network to a [Senzing gRPC server].
The `sz-sdk-python-grpc` package implements the following [sz-sdk-python] interfaces:
1. [SzConfig]
1. [SzConfigMgr]
1. [SzDiagnostic]
1. [SzEngine]
1. [SzProduct]
Other implementations of the [sz-sdk-python] interface include:
- [sz-sdk-python-core] - for calling Senzing SDK APIs natively
## Use
The following example shows how to start a Senzing gRPC server Docker container
and access it using the `senzing_grpc` Python package.
1. Run a Senzing gRPC service using Docker.
```console
docker run -it --name senzing-serve-grpc -p 8261:8261 --pull always --read-only --rm senzing/serve-grpc
```
1. In a separate window, install the `senzing-grpc` Python package.
```console
python3 -m pip install --upgrade senzing-grpc
```
1. Start an interactive Python session.
```console
python3
```
1. Paste the following into the interactive Python session.
```python
import grpc
from senzing_grpc import SzAbstractFactoryGrpc
sz_abstract_factory = SzAbstractFactoryGrpc(grpc_channel=grpc.insecure_channel("localhost:8261"))
sz_product = sz_abstract_factory.create_product()
print(sz_product.get_version())
```
More can be seen in [Examples].
## References
1. [Development]
1. [Errors]
1. [Examples]
1. Related artifacts:
1. [DockerHub]
1. [sz-sdk-python package reference]
[Coverage badge]: https://img.shields.io/badge/dynamic/json?color=brightgreen&label=coverage&query=%24.message&url=https%3A%2F%2Fraw.githubusercontent.com%2Fsenzing-garage%2Fsz-sdk-python%2Fpython-coverage-comment-action-data%2Fendpoint.json
[Coverage]: https://htmlpreview.github.io/?https://github.com/senzing-garage/sz-sdk-python-grpc/blob/python-coverage-comment-action-data/htmlcov/index.html
[Development]: docs/development.md
[DockerHub]: https://hub.docker.com/r/senzing/sz-sdk-python-grpc
[Downloads Badge]: https://static.pepy.tech/badge/senzing-grpc
[Downloads]: https://pepy.tech/project/senzing-grpc
[Errors]: docs/errors.md
[Examples]: docs/examples.md
[License Badge]: https://img.shields.io/badge/License-Apache2-brightgreen.svg
[License]: https://github.com/senzing-garage/sz-sdk-python-grpc/blob/main/LICENSE
[PEP8 Badge]: https://img.shields.io/badge/code%20style-pep8-orange.svg
[PEP8]: https://www.python.org/dev/peps/pep-0008/
[PyPI version Badge]: https://badge.fury.io/py/senzing-grpc.svg
[PyPi version]: https://badge.fury.io/py/senzing-grpc
[Python 3.11 Badge]: https://img.shields.io/badge/python-3.11-blue.svg
[Python 3.11]: https://www.python.org/downloads/release/python-3110/
[Python]: https://www.python.org/
[Senzing Garage]: https://github.com/senzing-garage
[Senzing gRPC server]: https://github.com/senzing-garage/serve-grpc
[Senzing Quick Start guides]: https://docs.senzing.com/quickstart/
[Senzing]: https://senzing.com/
[sz-sdk-python package reference]: https://hub.senzing.com/sz-sdk-python/
[sz-sdk-python-core]: https://github.com/senzing-garage/sz-sdk-python-core
[sz-sdk-python]: https://github.com/senzing-garage/sz-sdk-python/tree/main/src/senzing
[SzConfig]: https://github.com/senzing-garage/sz-sdk-python/blob/main/src/senzing/szconfig.py
[SzConfigMgr]: https://github.com/senzing-garage/sz-sdk-python/blob/main/src/senzing/szconfigmanager.py
[SzDiagnostic]: https://github.com/senzing-garage/sz-sdk-python/blob/main/src/senzing/szdiagnostic.py
[SzEngine]: https://github.com/senzing-garage/sz-sdk-python/blob/main/src/senzing/szengine.py
[SzProduct]: https://github.com/senzing-garage/sz-sdk-python/blob/main/src/senzing/szproduct.py
Raw data
{
"_id": null,
"home_page": "https://github.com/senzing-garage/sz-sdk-python-grpc",
"name": "senzing-grpc",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": null,
"author": "senzing",
"author_email": "support@senzing.com",
"download_url": "https://files.pythonhosted.org/packages/b2/71/310831c631a0832882c92de6f9652f7b826572afc101a3dcc99e59747adb/senzing_grpc-0.5.11.tar.gz",
"platform": null,
"description": "# sz-sdk-python-grpc\n\nIf you are beginning your journey with [Senzing],\nplease start with [Senzing Quick Start guides].\n\nYou are in the [Senzing Garage] where projects are \"tinkered\" on.\nAlthough this GitHub repository may help you understand an approach to using Senzing,\nit's not considered to be \"production ready\" and is not considered to be part of the Senzing product.\nHeck, it may not even be appropriate for your application of Senzing!\n\n## :warning: WARNING: sz-sdk-python-grpc is still in development :warning: _\n\nAt the moment, this is \"work-in-progress\" with Semantic Versions of `0.n.x`.\nAlthough it can be reviewed and commented on,\nthe recommendation is not to use it yet.\n\n## Synopsis\n\nThe Senzing `sz-sdk-python-grpc` package provides a [Python] Software Development Kit\nadhering to the abstract classes of [sz-sdk-python]\nthat communicates with a [Senzing gRPC server].\n\n[![Python 3.11 Badge]][Python 3.11]\n[![PEP8 Badge]][PEP8]\n[![PyPI version Badge]][PyPi version]\n[![Downloads Badge]][Downloads]\n[![License Badge]][License]\n[![Coverage Badge]][Coverage]\n\n## Overview\n\nThe Senzing `sz-sdk-python-grpc` packages enable Python programs to call Senzing library functions\nacross a network to a [Senzing gRPC server].\n\nThe `sz-sdk-python-grpc` package implements the following [sz-sdk-python] interfaces:\n\n1. [SzConfig]\n1. [SzConfigMgr]\n1. [SzDiagnostic]\n1. [SzEngine]\n1. [SzProduct]\n\nOther implementations of the [sz-sdk-python] interface include:\n\n- [sz-sdk-python-core] - for calling Senzing SDK APIs natively\n\n## Use\n\nThe following example shows how to start a Senzing gRPC server Docker container\nand access it using the `senzing_grpc` Python package.\n\n1. Run a Senzing gRPC service using Docker.\n\n ```console\n docker run -it --name senzing-serve-grpc -p 8261:8261 --pull always --read-only --rm senzing/serve-grpc\n ```\n\n1. In a separate window, install the `senzing-grpc` Python package.\n\n ```console\n python3 -m pip install --upgrade senzing-grpc\n ```\n\n1. Start an interactive Python session.\n\n ```console\n python3\n ```\n\n1. Paste the following into the interactive Python session.\n\n ```python\n import grpc\n from senzing_grpc import SzAbstractFactoryGrpc\n sz_abstract_factory = SzAbstractFactoryGrpc(grpc_channel=grpc.insecure_channel(\"localhost:8261\"))\n sz_product = sz_abstract_factory.create_product()\n print(sz_product.get_version())\n ```\n\nMore can be seen in [Examples].\n\n## References\n\n1. [Development]\n1. [Errors]\n1. [Examples]\n1. Related artifacts:\n 1. [DockerHub]\n1. [sz-sdk-python package reference]\n\n[Coverage badge]: https://img.shields.io/badge/dynamic/json?color=brightgreen&label=coverage&query=%24.message&url=https%3A%2F%2Fraw.githubusercontent.com%2Fsenzing-garage%2Fsz-sdk-python%2Fpython-coverage-comment-action-data%2Fendpoint.json\n[Coverage]: https://htmlpreview.github.io/?https://github.com/senzing-garage/sz-sdk-python-grpc/blob/python-coverage-comment-action-data/htmlcov/index.html\n[Development]: docs/development.md\n[DockerHub]: https://hub.docker.com/r/senzing/sz-sdk-python-grpc\n[Downloads Badge]: https://static.pepy.tech/badge/senzing-grpc\n[Downloads]: https://pepy.tech/project/senzing-grpc\n[Errors]: docs/errors.md\n[Examples]: docs/examples.md\n[License Badge]: https://img.shields.io/badge/License-Apache2-brightgreen.svg\n[License]: https://github.com/senzing-garage/sz-sdk-python-grpc/blob/main/LICENSE\n[PEP8 Badge]: https://img.shields.io/badge/code%20style-pep8-orange.svg\n[PEP8]: https://www.python.org/dev/peps/pep-0008/\n[PyPI version Badge]: https://badge.fury.io/py/senzing-grpc.svg\n[PyPi version]: https://badge.fury.io/py/senzing-grpc\n[Python 3.11 Badge]: https://img.shields.io/badge/python-3.11-blue.svg\n[Python 3.11]: https://www.python.org/downloads/release/python-3110/\n[Python]: https://www.python.org/\n[Senzing Garage]: https://github.com/senzing-garage\n[Senzing gRPC server]: https://github.com/senzing-garage/serve-grpc\n[Senzing Quick Start guides]: https://docs.senzing.com/quickstart/\n[Senzing]: https://senzing.com/\n[sz-sdk-python package reference]: https://hub.senzing.com/sz-sdk-python/\n[sz-sdk-python-core]: https://github.com/senzing-garage/sz-sdk-python-core\n[sz-sdk-python]: https://github.com/senzing-garage/sz-sdk-python/tree/main/src/senzing\n[SzConfig]: https://github.com/senzing-garage/sz-sdk-python/blob/main/src/senzing/szconfig.py\n[SzConfigMgr]: https://github.com/senzing-garage/sz-sdk-python/blob/main/src/senzing/szconfigmanager.py\n[SzDiagnostic]: https://github.com/senzing-garage/sz-sdk-python/blob/main/src/senzing/szdiagnostic.py\n[SzEngine]: https://github.com/senzing-garage/sz-sdk-python/blob/main/src/senzing/szengine.py\n[SzProduct]: https://github.com/senzing-garage/sz-sdk-python/blob/main/src/senzing/szproduct.py\n",
"bugtrack_url": null,
"license": "Apache 2",
"summary": "Senzing Python SDK over gRPC",
"version": "0.5.11",
"project_urls": {
"Bug Tracker": "https://github.com/senzing-garage/sz-sdk-python-grpc/issues",
"Homepage": "https://github.com/senzing-garage/sz-sdk-python-grpc"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "ebae306928b3ee38cba9cbb40af0d63053a71c55dc78a78e1e30b3b54a766909",
"md5": "c270906d4b14377202adb877205c7760",
"sha256": "75b674a34cd5875ef7ca243c569555e004a18fd51f12978dd105968c56905dd4"
},
"downloads": -1,
"filename": "senzing_grpc-0.5.11-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c270906d4b14377202adb877205c7760",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 19232,
"upload_time": "2025-07-16T18:27:04",
"upload_time_iso_8601": "2025-07-16T18:27:04.781608Z",
"url": "https://files.pythonhosted.org/packages/eb/ae/306928b3ee38cba9cbb40af0d63053a71c55dc78a78e1e30b3b54a766909/senzing_grpc-0.5.11-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "b271310831c631a0832882c92de6f9652f7b826572afc101a3dcc99e59747adb",
"md5": "8503d8504120ecd2eee59670f0fa8cc8",
"sha256": "3191f392b79d9c51ee9609fa2ffe92b0cb08dbbf9b52d2f9d10ac1a01be880a4"
},
"downloads": -1,
"filename": "senzing_grpc-0.5.11.tar.gz",
"has_sig": false,
"md5_digest": "8503d8504120ecd2eee59670f0fa8cc8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 15456,
"upload_time": "2025-07-16T18:27:07",
"upload_time_iso_8601": "2025-07-16T18:27:07.149139Z",
"url": "https://files.pythonhosted.org/packages/b2/71/310831c631a0832882c92de6f9652f7b826572afc101a3dcc99e59747adb/senzing_grpc-0.5.11.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-16 18:27:07",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "senzing-garage",
"github_project": "sz-sdk-python-grpc",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [
{
"name": "grpcio",
"specs": [
[
"==",
"1.73.1"
]
]
},
{
"name": "protobuf",
"specs": [
[
"==",
"6.31.1"
]
]
},
{
"name": "senzing",
"specs": [
[
"==",
"0.2.19"
]
]
},
{
"name": "senzing_grpc_protobuf",
"specs": [
[
"==",
"0.0.3"
]
]
}
],
"lcname": "senzing-grpc"
}
JSON
