Skip to main content

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

🤔 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

⚠️ 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

Metadata

Release files for senzing 2.3.3

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 2.3.3
File Size Uploaded Provenance Actions
senzing-2.3.3.tar.gz 24.8 kB Without provenance Details for senzing-2.3.3.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for senzing 2.3.3
File Interpreter ABI Platform Actions
senzing-2.3.3-py3-none-any.whl Python 3 none any Details for senzing-2.3.3-py3-none-any.whl

Total release size: 56.3 kB

Release files / senzing-2.3.3.tar.gz

Download URL senzing-2.3.3.tar.gz
Size 24.8 kB
Tags Source
SHA-256 checksum
How to use checksums
c862498033e2107beaf0825bdc7a2cec8935c743b4e96840bff913bdc191526c
BLAKE2b-256 checksum
How to use checksums
62e057dc864dcc18e108fa59b91e65d73d424124694253f46eca6f14ad665633
Upload date
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-2.3.3-py3-none-any.whl

Download URL senzing-2.3.3-py3-none-any.whl
Size 31.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
3e667773dfaf3224d2d2cb69b222aac87baeff135f72c87279e61313812a71f3
BLAKE2b-256 checksum
How to use checksums
20561275845992465facb74da7a27e2af67f4d5dd55ec49e30441c55b87d32a3
Upload date
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

Security for senzing 2.3.3

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

2.3.3 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page