All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
- Breaking: Drop support for python3.7. Add support for python 3.12
- Breaking: Changed return types of methods from
Response
toDict[str,Any]
- Breaking: Change
submit_job
method signature for bothWebApi
andIDApi
.WebApi
andIDApi
will no longer supportuse_validation_api
parameter. Migration guide available here
- Added Enhanced Document Verification to the WebApi class.
- Remove
id_type
from required inputid_info
params for document verfication
- Ignore
use_validation_api
insubmit_job
, method deprecated and will be removed - Ignore
use_validation_api
andsid_server
inUtilities.validate_id_params
, methods deprecated and will be removed
- Add git commit hook with pre-commit
- Set minimum typing-extensions version instead of exact version.
- Add ruff for linting.
- Downgrade dependencies versions where possible to increase compatibility with other python packages.
- Configure optional dependency groups for development dependencies. Requires fewer dependencies to be installed when installing the package.
- Improved the documentation
- Added smile-id constants
- Added custom types
- Added Business verification
- Added runnable examples for products
- Increased test coverage to 99%
- Resolved image-upload bug in handling image types
- Drop support for 3.6
- Configure optional dependency groups for development dependencies. Requires fewer dependencies to be installed when installing the package.
- Add coverage reports.
- Added github action to release the package.
- improved the documentation.
- Added types to IdApi, ServerError, Utilities, and WebApi classes.
- Renamed WebApi get_job_status param from sec_params to signature_params
- Renamed WebApi poll_job_status param from sec_params to signature_params
- Remove sec key
- Python 3.11 support.
- Package version now available via
__version__
attribute.
- Project is now built with Poetry.
- Moved information of python version to the class initialization.
- Lint codebase using black.
- Fixed a bug with optional
job_type
parameter for job status endpoint.
- Do not require
job_type
to be set for job status endpoint.
- Added support for image files ending with
.jpeg
.
- make
return_images
andreturn_history
optional arguments for job status endpoint.
- Added support for Document Verification job type.
- Created changelog.
- Fixed job status error string format.
- Added black for code formatting.
- Fixed python semantics.
- Moved zipfile out from webapi class.