senzing-grpc 0.0.3

Python SDK for Senzing API over gRPC

g2-sdk-python-grpc

:warning: WARNING: g2-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 g2-sdk-python-grpc package provides a Python Software Development Kit adhering to the abstract classes of g2-sdk-python-abstract that communicates with a Senzing gRPC server.

Overview

The Senzing g2-sdk-python-grpc packages enable Python programs to call Senzing library functions across a network to a Senzing gRPC server.

The g2-sdk-python-grpc package implements the following g2-sdk-python-abstract interfaces:

1. G2ConfigAbstract
2. G2ConfigMgrAbstract
3. G2DiagnosticAbstract
4. G2EngineAbstract
5. G2ProductAbstract

Other implementations of the g2-sdk-python-abstract interface include:

• g2-sdk-python-next - 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. Install the senzing-grpc Python package. If the senzing-grpc Python package is already installed, this step is not necessary. Example:

   python3 -m pip install --upgrade senzing-grpc
   

2. Run a Senzing gRPC service using Docker. Example:

   docker run \
     --env SENZING_TOOLS_COMMAND=serve-grpc \
     --env SENZING_TOOLS_DATABASE_URL=sqlite3://na:na@/tmp/sqlite/G2C.db \
     --env SENZING_TOOLS_ENABLE_ALL=true \
     --name senzing-tools-serve-grpc \
     --publish 8261:8261 \
     --rm \
     senzing/senzing-tools
   

   Note: In this example, SENZING_TOOLS_DATABASE_URL specifies a file inside the container. Thus the database is temporal and will be deleted when the container is killed.

3. In a separate window, start an interactive Python session. Example:

   python3
   

4. Paste the following into the interactive Python session. Example:

   import grpc
   from senzing_grpc import G2ProductGrpc
   g2_product = G2ProductGrpc(grpc_channel=grpc.insecure_channel("localhost:8261"))
   print(g2_product.version())
   

More can be seen in Examples.

References

1. Development
2. Errors
3. Examples
4. g2-sdk-python-abstract package reference