Switch from print to logging

nfelt14 commented 2 weeks ago

Proposed changes

This switches TekHSI to use logging instead of normal printing. A new function, configure_logging() is provided so that users can configure what is being logged where. The default behavior keeps the stdout output very similar and adds a file log that contains all logging output.

Types of changes

What types of changes does your code introduce? Put an x in the boxes that apply

[ ] Bug fix (non-breaking change which fixes an issue)
[x] New feature (non-breaking change which adds functionality)
[x] Functionality update (non-breaking change which updates or changes existing functionality)
[x] Breaking change (fix or feature that would cause existing functionality to not work as expected)
[ ] CI/CD update (an update to the CI/CD workflows, scripts, and/or configurations)
[ ] Documentation update (an update to enhance the user experience when reading through the docs)

Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.

[x] I have followed the guidelines in the CONTRIBUTING document
[x] I have signed the CLA
[x] I have checked to ensure there aren't other open Pull Requests for the same update/change
[ ] I have created (or updated) an Issue to track the status of this update/change and updated the link in this PR description (see above in the Proposed changes section) using the wording Addresses #<issue_number>
[x] I have performed a self-review of my code
[x] My code follows the style guidelines of this project
[x] I have commented my code, particularly in hard-to-understand areas
[x] Basic linting passes locally with my changes
[x] I have added tests that prove my fix is effective or that my feature works
[x] New and existing unit tests pass locally with my changes
[x] I have added necessary documentation (if appropriate)
[x] I have updated the Changelog with a brief description of my changes

codecov[bot] commented 2 weeks ago

Codecov Report

Attention: Patch coverage is 96.29630% with 4 lines in your changes missing coverage. Please review.

Project coverage is 80.72%. Comparing base (a0694c8) to head (d4c250c). Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
src/tekhsi/tek_hsi_connect.py	92.00%	4 Missing :warning:

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #46 +/- ## ========================================== + Coverage 77.66% 80.72% +3.06% ========================================== Files 3 3 Lines 488 524 +36 Branches 106 94 -12 ========================================== + Hits 379 423 +44 + Misses 89 82 -7 + Partials 20 19 -1 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

🚨 Try these New Features:

Flaky Tests Detection - Detect and resolve failed and flaky tests

github-actions[bot] commented 2 weeks ago

Breaking API Changes

src/tekhsi/helpers/__init__.py:0: print_with_timestamp:
Public object was removed

src/tekhsi/helpers/functions.py:0: <module>:
Public object was removed

Link to workflow run

github-actions[bot] commented 2 weeks ago