70 lines
1.8 KiB
Markdown
70 lines
1.8 KiB
Markdown
# komAI - локальный AI-ассистент
|
||
|
||
Репозиторий: https://git.komisar.gin.by/komisar/komAI
|
||
|
||
## Требования
|
||
|
||
- Python >3.10
|
||
|
||
## Установка
|
||
|
||
```bash
|
||
git clone https://git.komisar.gin.by/komisar/komAI.git
|
||
cd komAI
|
||
pip install -r requirements.txt
|
||
```
|
||
|
||
## Быстрый старт
|
||
|
||
```bash
|
||
python -m app.komAI
|
||
```
|
||
|
||
## Структура
|
||
|
||
- `app/` - точка входа приложения
|
||
- `src/` - исходный код
|
||
- `config/` - YAML конфигурация
|
||
- `modules/` - подключаемые модули
|
||
- `tests/` - юнит-тесты
|
||
- `log/` - файлы логов
|
||
- `doc/` - документация
|
||
|
||
## Конфигурация
|
||
|
||
Модуль `config_manager` управляет конфигурацией с регистрацией параметров.
|
||
|
||
```python
|
||
import src.utils.config_manager as config
|
||
config = config.config
|
||
|
||
config.register(name="app_name", val="komAI", desc="Наименование проекта", cat="app")
|
||
config.get("app_name", cat="app")
|
||
config.save()
|
||
```
|
||
|
||
См. [doc/src.utils.config_manager.md](doc/src.utils.config_manager.md) для подробной документации.
|
||
|
||
## Логирование
|
||
|
||
Модуль `log_manager` обеспечивает логирование с выводом в консоль и файл.
|
||
|
||
```python
|
||
import src.utils.log_manager as log
|
||
|
||
log.register_global_params()
|
||
log.register(module="app", log_console=True, log_file="app.log")
|
||
log.setup()
|
||
|
||
logger = log.get_logger("app")
|
||
logger.print("Сообщение") # вместо print()
|
||
```
|
||
|
||
См. [doc/src.utils.log_manager.md](doc/src.utils.log_manager.md) для подробной документации.
|
||
|
||
## Тесты
|
||
|
||
```bash
|
||
python -m tests.test_config_manager
|
||
python -m tests.test_log_manager
|
||
``` |