pyspell 0.0.6

A simple spelling tool

PySpell

PySpell provides functionality for spell checking and sentence correction. It uses a dictionary of words and the Levenshtein distance algorithm to suggest corrections.

Functions

load_dictionary(file_path)

This function loads a dictionary from a text file. Each line in the file should contain a single word.

get_difference(word1, word2)

This function calculates the Levenshtein distance between two words. The Levenshtein distance is a measure of the difference between two sequences of words.

spell_check(word, amount: int, show_distance=False)

This function checks the spelling of a word and suggests corrections. The number of suggestions is determined by the amount parameter. If show_distance is set to True, the function will also return the Levenshtein distance for each suggestion.

correct_word(word)

This function returns the most likely correction for a word.

correct_sentence(sentence)

This function corrects all the words in a sentence and returns the corrected sentence.

Usage

First, load the dictionary:

# Import the library
import pyspell

# Load words from text file
dictionary = pyspell.load_dictionary("words.txt")

# Get top 5 closest words to helo
print(pyspell.spell_check("heelo", 5, dictionary))

# Get top suggestion to helo
print(pyspell.correct_word("heelo", dictionary))

# Correct all words in a sentance
print(pyspell.correct_sentence("heelo wrold", dictionary))