Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Python SDK - next version #77

Open
docktermj opened this issue Oct 19, 2023 · 0 comments
Open

Python SDK - next version #77

docktermj opened this issue Oct 19, 2023 · 0 comments
Assignees

Comments

@docktermj
Copy link
Contributor

docktermj commented Oct 19, 2023

This is an "updo" of the Senzing SDK for python. It will introduce backward-breaking changes from the existing
g2-sdk-python.

Some of the aspects incorporated into this Python SDK:

External improvements

  1. PEP 8 compliance
    1. Proper module, class, and method naming
  2. Returned values (i.e. no mutable method parameters)
  3. Enhanced Exceptions
  4. Convenience methods
  5. JSON error messages for easier error parsing
  6. Type hinting
  7. Type checking
  8. Improved constuctor/destructor
  9. Support arguments as either JSON string or dict

Internal improvements

  1. pylint compliant code
  2. Flake8 code style enforcement
  3. black code formatting
  4. pytest unit testing for tests and examples
  5. mypy static type checking
  6. sphinx documentation generation
@github-actions github-actions bot added the triage Need to triage label Oct 19, 2023
@docktermj docktermj removed the triage Need to triage label Oct 19, 2023
@github-project-automation github-project-automation bot moved this to In progress in community-roadmap Aug 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: In progress
Development

No branches or pull requests

2 participants