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.

Install
Develop
References

Install

Use the pip install command to install the Senzing SDK for Python. Example:
```
pip install senzing
```
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.

The following software programs need to be installed:
1. git
2. make
3. pip

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.

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}"

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

Build python packages

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

Install using pip. Example:
```
make file-install
```

Test local package

Run testcases found in tests directory. Example:
```
make test
```

Uninstall local package

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.

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

Install using pip. Example:

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

Test

Run testcases found in tests directory. Example:
```
make test
```

Uninstall

Remove Senzing SDK for Python. Example:
```
pip3 uninstall senzing
```

Verify Uninstall

Identify python version. Example:
```
export SENZING_PYTHON_VERSION=3.8
```

Verify deletion in user python repository. Example:

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

Should return nothing.

Verify deletion in system repository. Example:

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

Should return nothing.

References

Packaging Python Projects

License
- OSI Approved :: Apache Software License
Operating System
- OS Independent
Programming Language
- Python :: 3

Metadata

License
- OSI Approved :: Apache Software License
Operating System
- OS Independent
Programming Language
- Python :: 3

Release files for senzing 1.12.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for senzing 1.12.2
File	Size	Uploaded
senzing-1.12.2.tar.gz	23.0 kB	Dec 2, 2021	Details

Built distribution (wheel)

Table of built distributions (wheels) for senzing 1.12.2
File	Interpreter	ABI	Platform	Reset
senzing-1.12.2-py3-none-any.whl 34.0 kB Dec 2, 2021	Python 3	none	any	Details

Total release size: 57.0 kB

Release files / senzing-1.12.2.tar.gz

Download URL	senzing-1.12.2.tar.gz
Size	23.0 kB
Tags	Source
SHA-256 checksum How to use checksums	`514c915759ec854bfef270ea8581995b1f9c591aeb1f22e6075c37338278f898`
BLAKE2b-256 checksum How to use checksums	`cb522b5adc004b9db735e6a761d599a355e656393b2ecf76fc94df005678d157`
Upload date	Dec 2, 2021
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/3.6.0 importlib_metadata/4.8.2 pkginfo/1.8.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.6.8`

Release files / senzing-1.12.2-py3-none-any.whl

Download URL	senzing-1.12.2-py3-none-any.whl
Size	34.0 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`cf02b085c469be6a81a4da9ec15b9def37bdbfe57ea718fc3c045fcc7508b56a`
BLAKE2b-256 checksum How to use checksums	`b7f54cb1a8442e4d5aea46bea5cbb42ba8dfaf258f5ea2d8661c47e8f59ccce8`
Upload date	Dec 2, 2021
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/3.6.0 importlib_metadata/4.8.2 pkginfo/1.8.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.6.8`