/chrome_history_definitions

Primary LanguagePythonMIT LicenseMIT

1. Functionality

This script extracts the words after any define search query (see the regex def_re) from chrome history.
Then you can save those words, trim them, remove duplicates and even look up for their definitions (see Options)

2. To save results

Change OUTPUT_* options.

3. Options

usage: extract_define.py [-h] [-t] [-sp] [-as] [-np] [-s] [-ad] [-alpha]
                         [--user USER] [-db DB_PATH] [-l LIMIT]
                         [-cf CACHE_FILE] [-csv CSV_EXPORT]

optional arguments:
  -h, --help            show this help message and exit
  -t, --trim            trim words from spaces, tabs and common delimiters
                        such as "
  -sp, --spell-check    check if words are spelled correctly (requires
                        pyenchant)
  -as, --accept-sent    accept entries if history consisting from multiple
                        words
  -np, --no-duplicates  remove duplicates
  -s, --stats           print status at the end of execution
  -ad, --add-def        request for definitions as json and save them in
                        OUTPUT_DEF_JSON
  -alpha, --alpha-sort  sort result alphabetically (default chronological
                        order)
  --user USER           User name for DB_PATH
  -db DB_PATH, --db-path DB_PATH
                        path of the history file (the database)
  -l LIMIT, --limit LIMIT
                        limit number of words
  -cf CACHE_FILE, --cache-file CACHE_FILE
                        cache file path
  -csv CSV_EXPORT, --csv-export CSV_EXPORT
                        export words to csv field with different fields
                        (requires --add-definitions)

Recommended options:

> python3 extract_define.py --trim --spell-check --no-duplicates --stats

4. TODOs

  1. add definitions to exports (through the option ADD_DEFINITIONS with get calls to api.pearson.com)
  2. spell check (done with pyenchant, controlled with the option SPELL_CHECK)
  3. trim words (option TRIM)
  4. sort according to search date (done through using lists instead of sets)
  5. remove duplicates (using more_itertools.unique_everseen)
  6. arg parser for option toggles and
  7. arg parser for option constants (not all yet)
  8. add help for CLI
  9. cache calls for definitions (using decorators and json dump)
  10. right now OUTPUT_DEF_JSON == CACHE_FILE since two are the same json dumps, add options for formating OUTPUT_DEF_JSON
  11. separated file for meta data (such as args options/help)
  12. regex to match any word after def*
  13. binary distributions (continuous integration, see pyinstaller)
  14. csv export
  15. make csv (and the separator) fields customizable
  16. quiz mode (e.x. given the definition choose the word)
  17. CLI quiz mode
  18. progress bar while fetching words from API (see tqdm)
  19. export as anki-compatible format with the option to export different fields (such as definition, synonym, etc)