usage: __main__.py [-h] [--search_category] [--no_synonyms]
[--regenerate_help_files] [--processes NBR]
[-v [{DEBUG,INFO,WARNING,ERROR}]]
expressions [expressions ...]
Search through all SCILPY scripts and their docstrings to find matches for the
provided keywords.
The search will be performed across script names, docstrings, help files,
keywords, and optionally synonyms.
The output will list the matching filenames along with the occurrences of each
keyword, and their total score.
- By default, the search includes synonyms for the keywords.
- Use --no_synonyms to exclude synonyms from the search.
- Use --search_category to limit the search to a specific category of scripts.
- Words enclosed in quotes will be searched as phrases, ensuring the words
appear next to each other in the text.
Verbosity Options:
- If the `-v` option is provided, the script will display the first sentence
of the docstring for each matching script.
- If the `-v DEBUG` option is provided, the script will display the full
docstring for each matching script.
Keywords Highlighting:
- When displaying the docstrings, the script highlights the found keywords in
red.
Examples:
- scil_search_keywords tractogram filtering
- scil_search_keywords "Spherical Harmonics"
- scil_search_keywords --no_synonyms "Spherical Harmonics"
- scil_search_keywords --search_category tractogram
- scil_search_keywords -v sh
- scil_search_keywords -v DEBUG sh
positional arguments:
expressions Search the provided list of expressions.
Use quotes to search for phrases.
options:
-h, --help show this help message and exit
--search_category Search within a specific category of scripts.
--no_synonyms Search without using synonyms.
--regenerate_help_files
Regenerate help files for all scripts.
--processes NBR Number of sub-processes to start.
Default: [1]
-v [{DEBUG,INFO,WARNING,ERROR}]
Produces verbose output depending on the provided level.
Default level is warning, default when using -v is info.
2.2.2