WIP Scilpy bot v2

[frheault]

Quick description

This version has some duplicated code removed, some edge cases fixed, highlighting now keeps the formatting.
This must be tested, also the vocabulary file could be cleaned and improved during a hackathon (when is the next one?)
...

Type of change

Check the relevant options.

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• This change requires a documentation update

Provide data, screenshots, command line to test (if relevant)

...

Checklist

• My code follows the style guidelines of this project (run autopep8)
• I added relevant citations to scripts, modules and functions docstrings and descriptions
• I have performed a self-review of my code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• My changes generate no new warnings
• I moved all functions from the script file (except the argparser and main) to scilpy modules
• I have added tests that prove my fix is effective or that my feature works
• New and existing unit tests pass locally with my changes

[pep8speaks]

Hello @frheault, Thank you for updating !

• In the file scilpy/utils/scilpy_bot.py:

Line 61:80: E501 line too long (80 > 79 characters)
Line 299:80: E501 line too long (81 > 79 characters)

• In the file scripts/scil_search_keywords.py:

Line 160:80: E501 line too long (81 > 79 characters)
Line 173:80: E501 line too long (81 > 79 characters)

• In the file scripts/tests/test_search_keywords.py:

Line 11:80: E501 line too long (81 > 79 characters)
Line 23:80: E501 line too long (81 > 79 characters)

Comment last updated at 2024-10-11 15:14:13 UTC

[codecov]

Codecov Report

Attention: Patch coverage is 86.93694% with 29 lines in your changes missing coverage. Please review.

Project coverage is 68.88%. Comparing base (8b67a06) to head (bf138ae).
Report is 5 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #1033      +/-   ##
==========================================
+ Coverage   68.84%   68.88%   +0.03%     
==========================================
  Files         431      432       +1     
  Lines       22332    22517     +185     
  Branches     3332     3049     -283     
==========================================
+ Hits        15375    15511     +136     
- Misses       5670     5709      +39     
- Partials     1287     1297      +10     

Components	Coverage Δ
Scripts	69.65% <83.72%> (-0.06%)	⬇️
Library	67.81% <88.97%> (+0.18%)	⬆️

[frheault]

@mdesco Could you test this and imagine being Laurent / Sami trying to find a script (or information).

Is it better than before? Is it intuitive?