vocabCLI package#
Subpackages#
- vocabCLI.modules package
- Submodules
- vocabCLI.modules.About module
- vocabCLI.modules.Banner module
- vocabCLI.modules.Carousel module
- vocabCLI.modules.Database module
- vocabCLI.modules.Dictionary module
- vocabCLI.modules.Exceptions module
AudioUnavailableExceptionNoDataFoundExceptionNoQuotesExceptionNoRSSFeedsExceptionNoSuchCollectionExceptionNoSuchTagExceptionNoWordsInDBExceptionNoWordsInFavoriteListExceptionNoWordsInLearningListExceptionNoWordsInMasteredListExceptionNotEnoughWordsForQuizExceptionWordNeverSearchedException
- vocabCLI.modules.Flashcard module
- vocabCLI.modules.Graph module
viz_learning_vs_mastered()viz_top_tags_bar()viz_top_tags_pie()viz_top_words_bar()viz_top_words_pie()viz_word_distribution_category()viz_word_distribution_month()viz_word_distribution_week()viz_word_distribution_year()word_distribution_month_util()word_distribution_year_util()words_distribution_week_util()
- vocabCLI.modules.ImportExport module
- vocabCLI.modules.NLP module
- vocabCLI.modules.Quotes module
- vocabCLI.modules.RSS module
- vocabCLI.modules.Report module
- vocabCLI.modules.Spelling module
- vocabCLI.modules.Study module
- vocabCLI.modules.Thesaurus module
- vocabCLI.modules.Utils module
add_tag()check_learning()check_mastered()check_word_exists()clear_all_words_from_tag()clear_favorite()clear_learning()clear_mastered()count_all_words()count_favorite()count_learning()count_mastered()count_tag()delete_all()delete_favorite()delete_learning()delete_mastered()delete_word()delete_words_from_tag()fetch_word_history()get_consecutive_dates()get_lookup_rate()get_random_word_definition_from_api()get_random_word_from_favorite_set()get_random_word_from_learning_set()get_random_word_from_mastered_set()get_random_word_from_tag()predict_milestone()remove_tag()set_favorite()set_learning()set_mastered()set_unfavorite()set_unlearning()set_unmastered()show_list()show_streak()
- vocabCLI.modules.WordCollections module
- Module contents
Submodules#
vocabCLI.vocabCLI module#
- vocabCLI.vocabCLI.ListCMD(favorite: bool = <typer.models.OptionInfo object>, learning: bool = <typer.models.OptionInfo object>, mastered: bool = <typer.models.OptionInfo object>, tag: str = <typer.models.OptionInfo object>, days: int = <typer.models.OptionInfo object>, date: bool = <typer.models.OptionInfo object>, last: int = <typer.models.OptionInfo object>, most: int = <typer.models.OptionInfo object>, tags: bool = <typer.models.OptionInfo object>, collection: str = <typer.models.OptionInfo object>, collections: bool = <typer.models.OptionInfo object>)[source]#
Lists all the words looked up by the user.
- Args:
favorite (bool, optional): If True, prints the list of favorite words. Defaults to False. learning (bool, optional): If True, prints the list of words in learning list. Defaults to False. mastered (bool, optional): If True, prints the list of words in mastered list. Defaults to False. tag (str, optional): If True, prints the list of words with a particular tag. Defaults to None. days (str, optional): If True, prints the list of words from last n number of days. Defaults to None. date (str, optional): If True, prints the list of words from a particular date. Defaults to None. last (str, optional): If True, prints the list of last searched words. Defaults to None. most (str, optional): If True, prints the list of most searched words. Defaults to None. tagnames (bool, optional): If True, prints the list of all the tags. Defaults to False. collection (Optional[str], optional): If True, prints the list of words from a collection. Defaults to None. collections (Optional[bool], optional): If True, prints the list of all the collections. Defaults to False.
- vocabCLI.vocabCLI.antonym(words: ~typing.List[str] = <typer.models.ArgumentInfo object>)[source]#
Find antonyms for a word.
- Args:
words (List[str]): Word to search antonyms for.
- vocabCLI.vocabCLI.clean(content: str = <typer.models.ArgumentInfo object>, strict: bool = <typer.models.OptionInfo object>)[source]#
- vocabCLI.vocabCLI.clear(learning: bool = <typer.models.OptionInfo object>, master: bool = <typer.models.OptionInfo object>, favorite: bool = <typer.models.OptionInfo object>, tag: str = <typer.models.OptionInfo object>)[source]#
Clears all the words from the lists.
- Args:
learning (bool, optional): If True, clears all the words from the learning list. Defaults to False. master (bool, optional): If True, clears all the words from the mastered list. Defaults to False. favorite (bool, optional): If True, clears all the words from the favorite list. Defaults to False. tag (str, optional): If True, clears all the words with a particular tag. Defaults to None.
- vocabCLI.vocabCLI.define(words: ~typing.List[str] = <typer.models.ArgumentInfo object>, short: bool = <typer.models.OptionInfo object>, pronounce: bool = <typer.models.OptionInfo object>)[source]#
Looks up a word in the dictionary.
- Args:
words (List[str]): Word which is to be defined. short (bool, optional): If True, prints the short definition of the word. Defaults to False. pronounce (bool, optional): If True, plays the pronunciation of the word. Defaults to False.
- vocabCLI.vocabCLI.delete(words: ~typing.List[str] = <typer.models.ArgumentInfo object>, mastered: bool = <typer.models.OptionInfo object>, learning: bool = <typer.models.OptionInfo object>, favorite: bool = <typer.models.OptionInfo object>, tag: str = <typer.models.OptionInfo object>)[source]#
Deletes the word from the database.
- Args:
mastered (bool, optional): Deletes all mastered words. Defaults to False. learning (bool, optional): Deletes all learning words. Defaults to False. favorite (bool, optional): Deletes all favorite words. Defaults to False. tag (str, optional): Tag of words to be deleted. Defaults to None. words (List[str], optional): Word to be deleted. Defaults to None.
- vocabCLI.vocabCLI.export(pdf: bool = <typer.models.OptionInfo object>)[source]#
Exports a list of all your looked up words.
- Args:
pdf (bool, optional): If True, exports a list of your looked up words in PDF format. Defaults to False.
- vocabCLI.vocabCLI.favorite(words: ~typing.List[str] = <typer.models.ArgumentInfo object>)[source]#
Adds a word to the favorite list.
- Args:
words (List[str]): Word which is to be added to the favorite list.
- vocabCLI.vocabCLI.flashcard(all: bool = <typer.models.OptionInfo object>, learning: bool = <typer.models.OptionInfo object>, mastered: bool = <typer.models.OptionInfo object>, favorite: bool = <typer.models.OptionInfo object>, tag: str = <typer.models.OptionInfo object>)[source]#
Create flashcards for words in your learning list.
- vocabCLI.vocabCLI.graph(topWordsBar: int = <typer.models.OptionInfo object>, topTagsBar: int = <typer.models.OptionInfo object>, topWordsPie: bool = <typer.models.OptionInfo object>, topTagsPie: bool = <typer.models.OptionInfo object>, lookupWeek: bool = <typer.models.OptionInfo object>, lookupMonth: bool = <typer.models.OptionInfo object>, lookupYear: bool = <typer.models.OptionInfo object>, learnVSmaster: bool = <typer.models.OptionInfo object>, wordCountByCollection: bool = <typer.models.OptionInfo object>)[source]#
Generate Graphical Charts based on your vocabulary.
- Args:
topWordsBar (Optional[int], optional): Visualizes the top N most looked up words. Defaults to None. topTagsBar (int, optional): Visualizes the top N tags with the most words. Defaults to None. topWordsPie (Optional[int], optional): Visualizes the top N most looked up words. Defaults to None. topTagsPie (Optional[int], optional): Visualizes the top N tags with the most words. Defaults to None. lookupWeek (Optional[bool], optional): Visualizes the word count distribution for days in the past week. Defaults to False. lookupMonth (Optional[bool], optional): Visualizes the word count distribution for days in the past month. Defaults to False. lookupYear (Optional[bool], optional): Visualizes the word count distribution for days in the past year. Defaults to False. learnVSmaster (Optional[bool], optional): Visualizes the number of words in your learning list vs. your mastered list. Defaults to False. slider (Optional[bool], optional): Shows all graphs one by one in a slider. Defaults to False.
- vocabCLI.vocabCLI.history(words: ~typing.List[str] = <typer.models.ArgumentInfo object>)[source]#
Get a lookup history of a word.
- Args:
words (List[str]): Word to get lookup history for.
- vocabCLI.vocabCLI.learn(words: ~typing.List[str] = <typer.models.ArgumentInfo object>)[source]#
Adds a word to the learning list.
- Args:
words (List[str]): Word which is to be added to the learning list.
- vocabCLI.vocabCLI.master(words: ~typing.List[str] = <typer.models.ArgumentInfo object>)[source]#
Adds a word to the mastered list.
- Args:
words (List[str]): Word which is to be added to the mastered list.
- vocabCLI.vocabCLI.quiz(number: int = <typer.models.OptionInfo object>, tag: str = <typer.models.OptionInfo object>, learning: bool = <typer.models.OptionInfo object>, mastered: bool = <typer.models.OptionInfo object>, favorite: bool = <typer.models.OptionInfo object>, collection: str = <typer.models.OptionInfo object>, history: bool = <typer.models.OptionInfo object>)[source]#
Take a quiz on words in your learning list.
- Args:
number (int, optional): Number of words to quiz on. Defaults to 10. tag (str, optional): Tag of words to quiz on. Defaults to None. learning (Optional[bool], optional): Take a quiz on words in your learning list. Defaults to False. mastered (Optional[bool], optional): Take a quiz on words in your mastered list. Defaults to False. favorite (Optional[bool], optional): Take a quiz on words in your favorite list. Defaults to False. collection (Optional[str], optional): Take a quiz on words in a particular collection. Defaults to None.
- vocabCLI.vocabCLI.quote(random: bool = <typer.models.OptionInfo object>, list: bool = <typer.models.OptionInfo object>, delete: bool = <typer.models.OptionInfo object>, add: bool = <typer.models.OptionInfo object>, search: str = <typer.models.OptionInfo object>, delete_all: bool = <typer.models.OptionInfo object>)[source]#
- vocabCLI.vocabCLI.random(learning: bool = <typer.models.OptionInfo object>, mastered: bool = <typer.models.OptionInfo object>, favorite: bool = <typer.models.OptionInfo object>, tag: str = <typer.models.OptionInfo object>, collection: str = <typer.models.OptionInfo object>)[source]#
Gets a random word.
- Args:
learning (bool, optional): Get a random learning word. Defaults to False. mastered (bool, optional): Get a random mastered word. Defaults to False. favorite (Optional[bool], optional): Get a random favorite word. Defaults to False. tag (Optional[str], optional): Get a random word from a particular tag. Defaults to None. collection (Optional[str], optional): Get a random word from a particular collection. Defaults to None.
- vocabCLI.vocabCLI.rate(today: bool = <typer.models.OptionInfo object>, week: bool = <typer.models.OptionInfo object>, month: bool = <typer.models.OptionInfo object>, year: bool = <typer.models.OptionInfo object>)[source]#
Gives the number of words you have learned in a particular time period with a comparison of a previous time period.
- Args:
today (bool, optional): If True, get learning rate today. Defaults to False. week (bool, optional): If True, get learning rate this week. Defaults to False. month (bool, optional): If True, get learning rate this month. Defaults to False. year (bool, optional): If True, get learning rate this year. Defaults to False.
- vocabCLI.vocabCLI.revise(number: int = <typer.models.OptionInfo object>, tag: str = <typer.models.OptionInfo object>, learning: bool = <typer.models.OptionInfo object>, mastered: bool = <typer.models.OptionInfo object>, favorite: bool = <typer.models.OptionInfo object>, collection: str = <typer.models.OptionInfo object>)[source]#
Revise words from your learning list.
- Args:
number (int, optional): Number of words to revise. Defaults to None. tag (str, optional): Tag of words to revise. Defaults to None. learning (Optional[bool], optional): Revise words in your learning list. Defaults to False. mastered (Optional[bool], optional): Revise words in your mastered list. Defaults to False. favorite (Optional[bool], optional): Revise words in your favorite list. Defaults to False. collection (Optional[str], optional): Revise words in a particular collection. Defaults to None.
- vocabCLI.vocabCLI.rss(add: str = <typer.models.OptionInfo object>, list: bool = <typer.models.OptionInfo object>, delete: bool = <typer.models.OptionInfo object>, read: str = <typer.models.OptionInfo object>)[source]#
- vocabCLI.vocabCLI.spellcheck(text: str = <typer.models.ArgumentInfo object>)[source]#
Spell check a word.
- vocabCLI.vocabCLI.summary(content: str = <typer.models.ArgumentInfo object>, file: bool = <typer.models.OptionInfo object>)[source]#
- vocabCLI.vocabCLI.synonym(words: ~typing.List[str] = <typer.models.ArgumentInfo object>)[source]#
Find synonyms for a word.
- Args:
words (List[str]): Word to search synonyms for.
- vocabCLI.vocabCLI.tag(words: ~typing.List[str] = <typer.models.ArgumentInfo object>, tag: str = <typer.models.OptionInfo object>)[source]#
Tags a word.
- Args:
words (List[str]): Words to tagged. tag (str): Tag to add to the words.
- vocabCLI.vocabCLI.unfavorite(words: ~typing.List[str] = <typer.models.ArgumentInfo object>)[source]#
Removes a word from the favorite list.
- Args:
words (List[str]): Word which is to be removed from the favorite list.
- vocabCLI.vocabCLI.unlearn(words: ~typing.List[str] = <typer.models.ArgumentInfo object>)[source]#
Removes a word from the learning list.
- Args:
words (List[str]): Word which is to be removed from the learning list.