Skip to content

[MSUE-232] - Add typing. Apply code linters. Update documentation #117

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

Merged
merged 16 commits into from
May 5, 2025

Conversation

pecheneff
Copy link
Contributor

@pecheneff pecheneff commented Mar 24, 2025

Purpose

Make Sift's API client for Python type safe and actualize doc strings of the client's methods.

Summary

  • Deprecated support of Python versions < 3.8
  • Added typing annotations overall the library
  • Updated client methods' doc strings with actual information
  • Replaced legacy API URLs with actual API URL "https://api.sift.com"
  • Reworked library's packaging with pyproject.toml
  • Integrated pre-commit hooks with Python code linters
  • Fixed small issue when the client could send requests with invalid version in the User-Agent header

Testing

Python 3.8
Screenshot 2025-03-24 at 19 32 58

Python 3.9
Screenshot 2025-03-24 at 19 35 03

Python 3.10
Screenshot 2025-03-24 at 19 35 47

Python 3.11
Screenshot 2025-03-24 at 19 36 28

Python 3.12
Screenshot 2025-03-24 at 19 37 11

Python 3.13
Screenshot 2025-03-24 at 19 37 53

Checklist

  • The change was thoroughly tested manually
  • The change was covered with unit tests
  • The change was tested with real API calls (if applicable)
  • Necessary changes were made in the integration tests (if applicable)
  • New functionality is reflected in README

@pecheneff pecheneff changed the title Add typing. Apply code style. Update documentation WIP. Add typing. Apply code style. Update documentation Mar 24, 2025
@pecheneff pecheneff marked this pull request as draft March 25, 2025 13:26
@pecheneff pecheneff marked this pull request as ready for review March 26, 2025 09:34
@pecheneff pecheneff changed the title WIP. Add typing. Apply code style. Update documentation Add typing. Apply code linters. Update documentation Mar 26, 2025
@viaskal-sift viaskal-sift changed the title Add typing. Apply code linters. Update documentation [MSUE-232] - Add typing. Apply code linters. Update documentation May 5, 2025
Updated release date
@echumak-sift echumak-sift merged commit 243855b into SiftScience:master May 5, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants