Foogle

Поисковый движок над локальными файлами (с построением индекса).

Usage

Installation

1. Clone the repository: git clone https://github.com/your_username/foogle.git
2. cd foogle
3. pip install -r requirements.txt
4. To perform a search, run the main.py script from the terminal: python main.py <directory> [--save-dir <directory>] [--debug] [--include-hidden] [--regex <regex>] [--search-regex <regex>]

Optional Arguments

• --save-dir: Path to the directory where index file will be saved
• --debug: Enable debug mode
• --include-hidden: Include hidden files in indexing
• --regex: Regular expression for file filtering
• --search-regex: Regular expression for search filtering

Example

python main.py C:\ --save-dir C:\Users\Me\indexes --debug --regex _\d+\.txt

Структура:

foogle/
│
├── README.md
├── main.py
├── requirements.txt
├── foogle/
│   ├── __init__.py
│   ├── indexer.py
│   ├── searcher.py
│   ├── utils.py
│   └── tests/
│       ├── __init__.py
│       ├── test_indexer.py
│       └── test_searcher.py
└── examples/
    ├── example_usage.py
    └── sample_files/

Описание структуры:

1. README.md: Файл с описанием проекта, его использованием и установкой.
2. main.py: Файл для установки проекта с помощью pip.
3. requirements.txt: Файл со списком зависимостей для установки проекта.
4. foogle/: Основной пакет проекта.
5. __init__.py: Пустой файл, указывающий Python, что это пакет.
6. indexer.py: Модуль для индексации файлов в указанной директории.
7. searcher.py: Модуль для поиска по индексам и возвращения результатов.
8. utils.py: Вспомогательные функции и классы.
9. tests/: Папка с модулями тестов.
10. __init__.py: Пустой файл, указывающий Python, что это пакет с тестами.
11. test_indexer.py: Модуль с тестами для функционала индексации файлов.
12. test_searcher.py: Модуль с тестами для функционала поиска по индексам.
13. examples/: Примеры использования проекта.
14. example_usage.py: Пример использования поискового движка в коде.
15. sample_files/: Папка с образцами файлов для тестирования проекта.