Develop

[jwilles]

This pull request includes several updates to the project configuration, documentation, and codebase. The most important changes include updating GitHub Actions workflows, improving documentation, and adding new examples for using the Python API.

GitHub Actions Workflows:

• Updated the actions/setup-python version in multiple workflow files to ensure compatibility with the latest Python setup action. (.github/workflows/code_checks.yml, .github/workflows/docs_build.yml, .github/workflows/docs_deploy.yml, .github/workflows/publish.yml, .github/workflows/unit_tests.yml) [1] [2] [3] [4] [5]

Documentation Improvements:

• Updated references to configuration files in README.md and docs/source/index.md to reflect the new locations in the shared directory. [1] [2]
• Added new sections and files to the documentation to provide detailed information about the Python API, including usage examples and module documentation.

Codebase Enhancements:

• Added new examples for using the Python API, including basic and advanced usage scripts. (examples/README.md, examples/api/basic_usage.py) [1] [2]
• Updated the pyproject.toml to include new dependencies and configuration for building the project. [1] [2]
• Improved the test imports by adding pytest for better error reporting and including additional client module imports. (tests/test_imports.py)

Pre-commit Configuration:

• Updated the ruff-pre-commit hook version in the .pre-commit-config.yaml file to ensure the latest linting rules are applied.

[codecov-commenter]

Codecov Report

Attention: Patch coverage is 80.72670% with 122 lines in your changes missing coverage. Please review.

Project coverage is 82.88%. Comparing base (4933fa6) to head (9c3a166).
Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
vec_inf/client/_helper.py	79.50%	50 Missing ⚠️
vec_inf/cli/_cli.py	60.31%	25 Missing ⚠️
vec_inf/cli/_helper.py	73.68%	20 Missing ⚠️
vec_inf/client/_utils.py	82.02%	16 Missing ⚠️
vec_inf/client/api.py	78.43%	11 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main      #86      +/-   ##
==========================================
+ Coverage   79.06%   82.88%   +3.82%     
==========================================
  Files           4       11       +7     
  Lines         554      777     +223     
==========================================
+ Hits          438      644     +206     
- Misses        116      133      +17     

Files with missing lines	Coverage Δ
vec_inf/cli/_models.py	100.00% <100.00%> (ø)
vec_inf/cli/_utils.py	100.00% <ø> (+11.49%)	⬆️
vec_inf/client/_config.py	100.00% <ø> (ø)
vec_inf/client/_exceptions.py	100.00% <100.00%> (ø)
vec_inf/client/_models.py	100.00% <100.00%> (ø)
vec_inf/client/_vars.py	100.00% <100.00%> (ø)
vec_inf/client/api.py	78.43% <78.43%> (ø)
vec_inf/client/_utils.py	82.02% <82.02%> (ø)
vec_inf/cli/_helper.py	77.34% <73.68%> (+3.58%)	⬆️
vec_inf/cli/_cli.py	77.50% <60.31%> (-5.66%)	⬇️
... and 1 more

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.