senzing 1.15.0

Python SDK for Senzing API

g2-sdk-python

Synopsis

Senzing Software Development Kit (SDK) for Python.

This SDK provide python access to the senzingapi

More information at github.com/Senzing/g2-sdk-python

Overview

The git repository at github.com/Senzing/g2-sdk-python contains the Senzing SDK for Python files in src/senzing.

It also contains:

• Tooling to create Python "wheel" packages
• Test suites
• Instructions for publishing to PyPi.

Contents

1. Install
2. Develop
   1. Prerequisites for development
   2. Clone repository
   3. Build python packages
   4. Local test
   5. Publish
   6. Install from test.pypi.org
   7. Test
   8. Uninstall
   9. Verify Uninstal
3. References

Install

1. Use the pip install command to install the Senzing SDK for Python. Example:

   pip install senzing
   

2. More information at github.com/Senzing/g2-sdk-python

Develop

The following instructions are used when modifying and building the Docker image.

Prerequisites for development

:thinking: The following tasks need to be complete before proceeding. These are "one-time tasks" which may already have been completed.

1. The following software programs need to be installed:

   1. git
   2. make
   3. pip

2. Install python tools. Example:

   python3 -m pip install --upgrade build
   python3 -m pip install --upgrade twine
   

Clone repository

For more information on environment variables, see Environment Variables.

1. Set these environment variable values:

   export GIT_ACCOUNT=senzing
   export GIT_REPOSITORY=g2-sdk-python
   export GIT_ACCOUNT_DIR=~/${GIT_ACCOUNT}.git
   export GIT_REPOSITORY_DIR="${GIT_ACCOUNT_DIR}/${GIT_REPOSITORY}"
   

2. Using the environment variables values just set, follow steps in clone-repository to install the Git repository.

Build python packages

1. Build pip package using python3 -m build. Example:

   cd ${GIT_REPOSITORY_DIR}
   make package
   

   Output will be in the dist directory.

Local test

Install from file

1. Install using pip. Example:

   make file-install
   

Test local package

1. Run testcases found in tests directory. Example:

   make test
   

Uninstall local package

1. Remove senzing. Example:

   pip3 uninstall senzing
   

Publish

:warning: On PyPi, pip package versions are immmutable. They cannot be deleted nor updated. Since only one instance of a version can be published, be careful on what is published.

1. Publish to https://test.pypi.org. This is a test PyPi server. Example:

   cd ${GIT_REPOSITORY_DIR}
   make test-publish
   

Install from test.pypi.org

1. Install using pip. Example:

   pip3 install \
     --index-url https://test.pypi.org/simple/ \
     --no-deps \
     senzing
   

Test

1. Run testcases found in tests directory. Example:

   make test
   

Uninstall

1. Remove Senzing SDK for Python. Example:

   pip3 uninstall senzing
   

Verify Uninstall

1. Identify python version. Example:

   export SENZING_PYTHON_VERSION=3.8
   

2. Verify deletion in user python repository. Example:

   ls ~/.local/lib/python${SENZING_PYTHON_VERSION}/site-packages | grep senzing
   

   Should return nothing.

3. Verify deletion in system repository. Example:

   ls /usr/local/lib/python${SENZING_PYTHON_VERSION}/dist-packages | grep senzing
   

   Should return nothing.

References

1. Packaging Python Projects