docs: note hunspell requirement

Author: xfenix

README.md

@@ -65,6 +65,7 @@ You cand find it here https://github.com/xfenix/spellcheck-microservice/releases
 ### Quickstart
 * Clone this repo
 * For MacOS X `brew install enchant`
+* For Debian/Ubuntu `apt-get install -y enchant-2 hunspell-ru`
 * `uv sync --group dev`
 * `source .venv/bin/activate`
 * Run `touch .git/hooks/pre-commit && chmod +x .git/hooks/pre-commit`

pyproject.toml

@@ -11,7 +11,7 @@ dependencies = [
     "uvicorn",
     "pyenchant",
     "toml",
-    "pylru",
+    "cachebox",
     "anyio>=4",
     "sentry-sdk",
     "pydantic-settings",

uv.lock

@@ -1,16 +1,20 @@
 import re
 import typing
 
-import pylru
+import cachebox
 import urlextract
 from enchant.checker import SpellChecker
 
 from . import models
 from .settings import SETTINGS
 
 
-_MISSPELED_CACHE: typing.Final[dict[str, list[str]]] = (
-    pylru.lrucache(SETTINGS.cache_size) if SETTINGS.cache_size > 0 else {}
+_MISSPELED_CACHE: typing.Final[
+    cachebox.LRUCache[str, list[str]] | dict[str, list[str]]
+] = (
+    cachebox.LRUCache[str, list[str]](SETTINGS.cache_size)
+    if SETTINGS.cache_size > 0
+    else typing.cast("dict[str, list[str]]", {})
 )
 
 SEPARATORS_TO_SPLIT_URL_BY_WORDS: typing.Final[re.Pattern[str]] = re.compile(r"\.|\:|\/\/|\/|\?|\&|\=|\+|\#|\-")