Log reader

[nwittler]

What

Updated and added example for the log reader CLI. Added the option to specify a wait interval when watching a log file.

Why

Addresses #17

Remarks

This is a minor addition for documentation and changes no functionality.

Checklist

Please include and complete the following checklist. Your Pull Request is (in most cases) not ready for review until the following have been completed. You can create a draft PR while you are still completing the checklist. Check the Contribution Guidelines for more details. You can mark an item as complete with the - [x] prefix

• Tests - Added unit tests for new code, regression tests for bugs and updated the integration tests if required
• Formatting & Linting - black and flake8 have been used to ensure styling guidelines are met
• Type Annotations - All new code has been type annotated in the function signatures using type hints
• Docstrings - Docstrings have been provided for functions in the numpydoc style
• Documentation - The tutorial style documentation has been updated to explain changes & new features
• Notebooks - Example notebooks have been updated to incorporate changes and new features
• Changelog - A short note on this PR has been added to the Upcoming Release section

[codecov]

Codecov Report

Merging #137 (a2771fa) into dev (dcdb2be) will increase coverage by 0.61%.
The diff coverage is 23.80%.

@@            Coverage Diff             @@
##              dev     #137      +/-   ##
==========================================
+ Coverage   70.81%   71.43%   +0.61%     
==========================================
  Files          36       36              
  Lines        5222     5219       -3     
==========================================
+ Hits         3698     3728      +30     
+ Misses       1524     1491      -33     

Impacted Files	Coverage Δ
c3/utils/log_reader.py	63.82% <23.80%> (+63.82%)	⬆️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update dcdb2be...a2771fa. Read the comment docs.