senzing 0.0.3

Python SDK to Senzing API

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

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
   

Publish

1. Publish to https://test.pypi.org. Example:

   cd ${GIT_REPOSITORY_DIR}
   make test-package
   

Install

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. Example:

   pip3 uninstall senzing
   

2. Verify. Example:

   ls ~/.local/lib/python3.8/site-packages
   

   ls /usr/local/lib/python3.8/dist-packages
   

References

1. Packaging Python Projects