diff --git a/README.md b/README.md index e69de29..26f35bc 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,56 @@ +### Документация к Сканеру расширению файлов + +#### Обзор +Скрипт предназначен для сканирования сетевых компьютеров и поиска медиафайлов с заданными расширениями. Основные функции: +- Поиск файлов на удалённых ПК по сетевым путям +- Форматирование размера файлов +- Сохранение результатов в CSV +- Отслеживание недоступных хостов + +#### Константы +- `SEARCH_DIRS`: Директории для поиска (Рабочий стол, Загрузки и т.д.) +- `EXTENSIONS`: Расширения искомых файлов (.mov, .mp4 и др.) +- `EXCLUDE_FOLDERS`: Системные папки для исключения из поиска + +#### Основные функции +1. `format_size()`: Конвертирует размер файла в читаемый формат +2. `get_users_from_folders()`: Получает список пользователей ПК +3. `scan_host()`: Основная функция сканирования хоста +4. `main()`: Управляющая функция выполнения скрипта + +--- +### Список зависимостей +Используются только стандартные библиотеки Python: +```python:requirements.txt +import os +import csv +import time +import pathlib +from datetime import datetime +``` + +--- +### Инструкция по развёртыванию +1. Установите Python 3.8+: +```bash +brew install python +``` + +2. Создайте файл с хостами: +```bash +echo "PC-NAME-1" >> hosts.txt +echo "PC-NAME-2" >> hosts.txt +``` + +3. Запустите скрипт: +```bash +python3 main.py +``` + +--- +### Полезные ресурсы +1. +2. +3. +4. + \ No newline at end of file