diff --git a/README.md b/README.md index 52f5c46..1f8b5e7 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,46 @@ # Text Analyzer CLI -CLI-инструмент на Python для анализа текстовых файлов (подсчёт строк, слов, символов и топ-N популярных слов). +CLI-инструмент на Python для анализа текстовых файлов (подсчёт строк, слов, символов и популярных слов). ## Установка -1. Клонируйте репозиторий и перейдите в папку проекта: +1. Перейдите в папку проекта и активируйте виртуальное окружение: ```bash -cd lb_1 +python3 -m venv .venv +source .venv/bin/activate + +pip install -e . +pip install -r requirements.txt +``` +## Использование + +Обычный запуск анализа файла: + +```Bash +text-analyzer sample.txt +``` +Вывод результата в формате JSON: + +```Bash +text-analyzer sample.txt --format json +``` + +Показать топ-5 частых слов: + +```Bash +text-analyzer sample.txt --top 5 +``` +### Тестирование и проверка качества + +Запуск авто-тестов с проверкой покрытия: + +```Bash +pytest --cov=src/text_analyzer +``` + +Проверка типов и стиля кода: + +```Bash +mypy src +ruff check . +```