README на русском и английском, скриншоты, CI и сборка .exe в релиз

- README: факты курсовой сверены с кодом (пять таблиц, 930 строк датасета → 914 моделей), ссылка клонирования — на настоящий репозиторий вместо шаблонной, инструкция без Docker исправлена (скрипт схемы сам создаёт базу и выполняется под postgres); - CI: ruff, создание схемы и импорт датасета в PostgreSQL; - по тегу v* GitHub Actions собирает MobileDevices.exe (PyInstaller) и кладёт в релиз.
2026-10-07 20:49:44 +03:00 · 2026-10-05 17:36:36 +00:00 · 2026-10-05 17:36:36 +00:00 · 2daa52a238
commit 2daa52a238
parent 3be7052b0a
7 changed files with 200 additions and 266 deletions
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@ -0,0 +1,36 @@
 name: CI
 on:
  push:
    branches: [main]
  pull_request:
 jobs:
  check:
    runs-on: ubuntu-latest
    services:
      postgres:
        image: postgres:15-alpine
        env:
          POSTGRES_USER: postgres
          POSTGRES_PASSWORD: postgres
        ports: ["5432:5432"]
        options: >-
          --health-cmd "pg_isready -U postgres" --health-interval 5s --health-retries 10
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-python@v5
        with:
          python-version: "3.11"
      - run: pip install ruff==0.14.0 psycopg2-binary==2.9.9 pandas==2.1.4 numpy==1.26.2
      - name: Ruff (синтаксис и ошибки)
        run: ruff check --select E9,F .
      - name: Схема и импорт датасета
        env:
          PGPASSWORD: postgres
          DB_USER: postgres
          DB_PASSWORD: postgres
        run: |
          psql -h localhost -U postgres -f sql/create_schema.sql
          python scripts/import_data.py
          test "$(psql -h localhost -U postgres -d mobile_devices_db -tAc 'select count(*) from models')" -gt 900
--- a/.github/workflows/release.yml
+++ b/.github/workflows/release.yml
@ -0,0 +1,23 @@
 name: Release
 on:
  push:
    tags: ["v*"]
 jobs:
  exe:
    runs-on: windows-latest
    permissions:
      contents: write
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-python@v5
        with:
          python-version: "3.11"
      - run: pip install pyinstaller psycopg2-binary==2.9.9 PyQt6==6.6.1
      - name: Сборка .exe из однофайловой версии
        run: pyinstaller --onefile --windowed --name MobileDevices scripts/exe/mobile_devices.py
      - name: Файл в релиз
        env:
          GH_TOKEN: ${{ github.token }}
        run: gh release upload "${{ github.ref_name }}" dist/MobileDevices.exe --clobber
--- a/README.en.md
+++ b/README.en.md
@ -0,0 +1,76 @@
 # Mobile Devices Database
 [Русский](README.md) · **English**
 [![CI](https://github.com/EDeev/mobiles_dataset/actions/workflows/ci.yml/badge.svg)](https://github.com/EDeev/mobiles_dataset/actions/workflows/ci.yml)
 [![Release](https://img.shields.io/github/v/release/EDeev/mobiles_dataset)](https://github.com/EDeev/mobiles_dataset/releases)
 Database design coursework: the 2025 mobile devices dataset split into a normalized PostgreSQL database,
 a PyQt6 desktop app to work with it, and a measurement of index gains with `EXPLAIN ANALYZE`.
 **Status:** coursework ("Database Design and Administration", Moscow Polytechnic University, 2025), completed
 ![Models tab](docs/screenshots/models.png)
 **Stack:** Python 3.11 · PostgreSQL 15 · psycopg2 · PyQt6 · pandas · Docker
 ## Features
 - 3NF schema of five tables (companies, processors, models, regions, prices) with foreign keys and
  cascading actions
 - Import of the [Kaggle dataset](https://www.kaggle.com/datasets/abdulmalik1518/mobiles-dataset-2025)
  (930 rows; 914 models and 4569 prices after cleaning) split into reference tables
 - App: companies and models with create, edit and delete, prices in five regions (Pakistan, India,
  China, UAE, USA) with currency symbols, search by name, company and RAM, a price statistics tab
 - Index experiment: `EXPLAIN ANALYZE` queries before and after, plans saved in `sql/explain_results/`
 | Metric | No indexes | With indexes | Difference |
 |---|---|---|---|
 | Search | 0.234 ms | 0.089 ms | 62% faster |
 | Four-table JOIN | 18.6 ms | 0.95 ms | 95% faster |
 | Planner cost | 44.76 | 12.45 | 72% lower |
 | Rows scanned | 914 | 18 | 98% fewer |
 Measured on this dataset (hundreds of rows), so absolute times are fractions of a millisecond.
 ## Quick start
 ```bash
 git clone https://github.com/EDeev/mobiles_dataset.git && cd mobiles_dataset
 docker compose up -d                  # PostgreSQL 15 with the schema from sql/create_schema.sql
 pip install -r requirements.txt
 python scripts/import_data.py         # load the dataset
 python main.py                        # the app
 ```
 A ready-made Windows build (`.exe`) is in the [releases](https://github.com/EDeev/mobiles_dataset/releases).
 ## Without Docker
 1. Run `sql/create_schema.sql` in psql or pgAdmin as `postgres` — the script creates the
   `mobile_devices_db` database itself.
 2. Set the connection with `DB_HOST`, `DB_PORT`, `DB_NAME`, `DB_USER`, `DB_PASSWORD`
   (defaults: `localhost:5432`, `mobile_devices_db`, `admin` / `password`).
 3. `python scripts/import_data.py`, then `python main.py`.
 ## Screenshots
 | Companies | Analytics |
 |---|---|
 | ![Companies](docs/screenshots/companies.png) | ![Analytics](docs/screenshots/analytics.png) |
 ## License
 Coursework (Database Design and Administration, Moscow Polytechnic University, 2025). The code is open
 for study; there is no separate license. The dataset comes from Kaggle under its author's terms.
 ## Author
 **Egor Deev** — [GitHub](https://github.com/EDeev) · [Telegram](https://t.me/DeevEgor) · [egor@deev.space](mailto:egor@deev.space)
 ---
 <div align="center">
  <sub>⭐ If you find this project useful, give it a star on GitHub!</sub>
  <p><sub>Made with ❤️ — <a href="https://deev.space">deev.space</a></sub></p>
 </div>
--- a/README.md
+++ b/README.md
@ -1,290 +1,89 @@
-# 📱 Mobile Devices Database Management System
+# Mobile Devices Database
-**Комплексная система управления каталогом мобильных устройств с GUI-интерфейсом**
+**Русский** · [English](README.en.md)
-[![Python](https://img.shields.io/badge/Python-3.11+-blue.svg)](https://python.org)
+[![CI](https://github.com/EDeev/mobiles_dataset/actions/workflows/ci.yml/badge.svg)](https://github.com/EDeev/mobiles_dataset/actions/workflows/ci.yml)
-[![PostgreSQL](https://img.shields.io/badge/PostgreSQL-15.x-blue.svg)](https://postgresql.org)
+[![Release](https://img.shields.io/github/v/release/EDeev/mobiles_dataset)](https://github.com/EDeev/mobiles_dataset/releases)
 [![PyQt6](https://img.shields.io/badge/PyQt6-6.6+-green.svg)](https://pypi.org/project/PyQt6/)
 [![License](https://img.shields.io/badge/License-Academic-orange.svg)](#)
-## 🎯 Назначение проекта
+Курсовая по проектированию баз данных: датасет мобильных устройств 2025 года, разложенный в
 нормализованную базу PostgreSQL, десктопное приложение на PyQt6 для работы с ним и измерение
 выигрыша от индексов через `EXPLAIN ANALYZE`.
-Курсовая работа по дисциплине "Проектирование и администрирование баз данных", представляющая собой полнофункциональную информационную систему для управления данными о мобильных устройствах. Проект демонстрирует практическое применение принципов реляционного моделирования, оптимизации производительности СУБД и создания современных desktop-приложений.
+**Статус:** учебный проект (курсовая «Проектирование и администрирование баз данных», Московский
 Политех, 2025), завершён
-## 🏗️ Архитектура системы
+![Вкладка «Модели»](docs/screenshots/models.png)
-### Компонентная структура
+**Стек:** Python 3.11 · PostgreSQL 15 · psycopg2 · PyQt6 · pandas · Docker
-```
+
-📦 mobile-devices-db/
+## Возможности
-├── database.py                   # Слой доступа к данным (DAO)
+
-├── main_window.py                # GUI-интерфейс на PyQt6
+- Схема в 3НФ из пяти таблиц (компании, процессоры, модели, регионы, цены) с внешними ключами и
-├── main.py                       # Запускаемый файл
+  каскадными операциями
-├── Mobiles Dataset 2025.csv      # Дата-сет данных
+- Импорт [датасета с Kaggle](https://www.kaggle.com/datasets/abdulmalik1518/mobiles-dataset-2025)
-├── 🗃️ sql/                      # SQL-скрипты и схема БД
+  (930 строк, после очистки 914 моделей и 4569 цен) с разнесением по справочникам
-│   ├── create_schema.sql         # Создание нормализованной структуры
+- Приложение: компании и модели с добавлением, правкой и удалением, цены по пяти регионам (Пакистан,
-│   └── performance_analysis.sql  # Тестовые запросы для анализа
+  Индия, Китай, ОАЭ, США) с символами валют, поиск по названию, компании и RAM, вкладка статистики цен
-├── 🐍 scripts/                  # Python-модули системы
+- Эксперимент с индексами: запросы `EXPLAIN ANALYZE` до и после, планы сохранены в `sql/explain_results/`
-│   └── import_data.py           # Система импорта и нормализации
+
-├── 📊 docs/                     # Техническая документация
+| Метрика | Без индексов | С индексами | Разница |
-└── 📋 requirements.txt          # Зависимости проекта
+|---|---|---|---|
 | Поиск | 0,234 мс | 0,089 мс | быстрее на 62 % |
 | JOIN четырёх таблиц | 18,6 мс | 0,95 мс | быстрее на 95 % |
 | Стоимость по планировщику | 44,76 | 12,45 | ниже на 72 % |
 | Просмотренные строки | 914 | 18 | меньше на 98 % |
 Измерено на этом датасете (сотни строк), поэтому абсолютные времена — доли миллисекунды.
 ## Быстрый старт
 ```bash
 git clone https://github.com/EDeev/mobiles_dataset.git && cd mobiles_dataset
 docker compose up -d                  # PostgreSQL 15 со схемой из sql/create_schema.sql
 pip install -r requirements.txt
 python scripts/import_data.py         # загрузка датасета
 python main.py                        # приложение
 ```
-### Технологический стек
+Готовая сборка для Windows (`.exe`) — в [релизах](https://github.com/EDeev/mobiles_dataset/releases).
 - **СУБД**: PostgreSQL 15.x с расширенными возможностями индексирования
 - **Backend**: Python 3.11+ с паттерном Singleton для управления соединениями
 - **Frontend**: PyQt6 с архитектурой Model-View-Controller
 - **Интеграция**: psycopg2 для типобезопасного взаимодействия с БД
-## ⚡ Ключевые особенности
+## Без Docker
-### 🔧 Техническая реализация
+1. Выполните `sql/create_schema.sql` в psql или pgAdmin под пользователем `postgres` — скрипт сам
- **Нормализация до 3НФ**: Декомпозиция исходного CSV в 5 взаимосвязанных таблиц
+   создаёт базу `mobile_devices_db`.
- **Референциальная целостность**: Система FK с каскадными операциями
+2. Задайте подключение переменными `DB_HOST`, `DB_PORT`, `DB_NAME`, `DB_USER`, `DB_PASSWORD`
- **Оптимизация производительности**: Стратегическое индексирование с 62-95% улучшением
+   (по умолчанию `localhost:5432`, `mobile_devices_db`, `admin` / `password`).
- **CRUD-функционал**: Полный спектр операций через интуитивный GUI
+3. `python scripts/import_data.py`, затем `python main.py`.
-### 📈 Результаты оптимизации
+## Как выглядит
 | Метрика | До оптимизации | После оптимизации | Улучшение |
 |---------|----------------|-------------------|-----------|
 | Время выполнения поиска | 0.234 мс | 0.089 мс | **62% быстрее** |
 | JOIN-запросы (4 таблицы) | 18.6 мс | 0.95 мс | **95% быстрее** |
 | Стоимость по планировщику | 44.76 ед. | 12.45 ед. | **72% снижение** |
 | Обработанные строки | 914 (фильтрация) | 18 (прямой доступ) | **98% сокращение** |
-### 🌍 Функциональные возможности
+| Компании | Аналитика |
- **Интеллектуальный поиск** по множественным атрибутам устройств
+|---|---|
- **Валютная локализация** ценовой информации (5 регионов)
+| ![Компании](docs/screenshots/companies.png) | ![Аналитика](docs/screenshots/analytics.png) |
 - **Автоматический импорт** данных с нормализацией на лету
 - **Аналитические отчеты** с региональной статистикой
-## 📊 Источники данных
+## Структура
-Проект использует актуальный датасет мобильных устройств 2025 года:
+```
- **Источник**: [Kaggle - Mobiles Dataset 2025](https://www.kaggle.com/datasets/abdulmalik1518/mobiles-dataset-2025)
+database.py               доступ к БД (синглтон, параметризованные запросы)
- **Размер**: 1000+ записей устройств
+main_window.py, main.py   приложение на PyQt6
- **Охват**: Основные производители (Apple, Samsung, Xiaomi, OnePlus, etc.)
+scripts/import_data.py    импорт и нормализация датасета
- **Регионы**: Пакистан, Индия, Китай, США, ОАЭ
+scripts/exe/              однофайловая версия приложения для сборки .exe
-
+sql/                      схема, запросы для анализа производительности, ERD, результаты EXPLAIN
-## 🚀 Быстрый старт
+docs/report.*             отчёт по курсовой (md, docx, pdf)
 ### Системные требования
 - **Python 3.11+** с поддержкой venv
 - **PostgreSQL 15.x** с административными правами
 - **4GB RAM** (рекомендуется 8GB для больших наборов данных)
 ### Установка и настройка
 1. **Клонирование репозитория**
   ```bash
   git clone https://github.com/username/mobile-devices-db.git
   cd mobile-devices-db
   ```
 2. **Создание виртуального окружения**
   ```bash
   python -m venv venv
   source venv/bin/activate  # Linux/macOS
   # или
   venv\Scripts\activate     # Windows
   ```
 3. **Установка зависимостей**
   ```bash
   pip install -r requirements.txt
   ```
 4. **Настройка PostgreSQL**
   ```sql
   -- Создание пользователя и БД
   CREATE USER admin WITH PASSWORD 'your_password';
   CREATE DATABASE mobile_devices_db OWNER admin;
   GRANT ALL PRIVILEGES ON DATABASE mobile_devices_db TO admin;
   ```
 5. **Развертывание схемы данных**
   ```bash
   psql -U admin -d mobile_devices_db -f sql/create_schema.sql
   ```
 6. **Импорт тестовых данных**
   ```bash
   python scripts/import_data.py
   ```
 7. **Запуск приложения**
   ```bash
   python scripts/main_window.py
   ```
 ## 📊 Структура базы данных
 ### Реляционная модель (3НФ)
 ```mermaid
 erDiagram
    COMPANIES ||--o{ MODELS : manufactures
    PROCESSORS ||--o{ MODELS : uses
    MODELS ||--o{ PRICES : "has prices in"
    REGIONS ||--o{ PRICES : "contains prices"
    COMPANIES {
        int company_id PK
        varchar company_name UK
    }
    MODELS {
        int model_id PK
        varchar model_name
        int company_id FK
        int processor_id FK
        varchar ram
        varchar battery_capacity
        int launched_year
    }
    PRICES {
        int price_id PK
        int model_id FK
        int region_id FK
        decimal price
        varchar currency
    }
 ```
-### Ключевые таблицы
+## Лицензия
 - **Companies**: Справочник производителей (19 уникальных компаний)
 - **Models**: Каталог устройств (914 моделей с техническими характеристиками)
 - **Processors**: Справочник процессоров (217 уникальных чипсетов)
 - **Regions**: Географические регионы ценообразования (5 регионов)
 - **Prices**: Региональная ценовая информация (4,569 записей)
-## 🎨 Пользовательский интерфейс
+Учебный проект (Проектирование и администрирование баз данных, Московский Политех, 2025). Код открыт
 для изучения, отдельной лицензии нет. Датасет — с Kaggle, на условиях его автора.
-### Основные компоненты
+## Автор
 - **📋 Каталог компаний**: Обзор производителей с количеством моделей
 - **📱 Управление моделями**: CRUD-операции с техническими характеристиками
 - **💰 Ценовое управление**: Редактирование цен с валютной локализацией
 - **📊 Аналитическая панель**: Региональная статистика и отчеты
-### Функциональные возможности
+**Деев Егор Викторович** — [GitHub](https://github.com/EDeev) · [Telegram](https://t.me/DeevEgor) · [egor@deev.space](mailto:egor@deev.space)
 ```python
 # Пример поискового запроса
 def search_models(self, search_text: str):
    """Интеллектуальный поиск по множественным атрибутам"""
    return self.db.search_models(search_text)
 # Валютная локализация
 CURRENCY_MAP = {
    'Pakistan': ('PKR', '₨'),
    'India': ('INR', '₹'),
    'China': ('CNY', '¥'),
    'USA': ('USD', '$'),
    'Dubai': ('AED', 'د.إ')
 }
 ```
 ## 🔍 Анализ производительности
 ### Методология тестирования
 Комплексный анализ производительности выполнен с использованием PostgreSQL EXPLAIN ANALYZE:
 #### Тестовые сценарии
 1. **Простые селективные запросы** - поиск по названию компании
 2. **Многотабличные JOIN** - получение полной информации об устройствах
 3. **Агрегирующие операции** - статистические запросы с группировкой
 4. **Поиск по характеристикам** - фильтрация по техническим параметрам
 #### Стратегия оптимизации
 ```sql
 -- Базовые B-tree индексы
 CREATE INDEX idx_companies_name ON companies(company_name);
 CREATE INDEX idx_models_company_id ON models(company_id);
 -- Составные индексы для комплексных запросов
 CREATE INDEX idx_models_ram_battery ON models(ram, battery_capacity);
 -- Функциональные индексы для LIKE-операций
 CREATE INDEX idx_companies_name_pattern ON companies(company_name varchar_pattern_ops);
 ```
 ## 📈 Практические результаты
 ### Количественные показатели
 - **Импорт данных**: 930 записей устройств с 100% целостностью
 - **Нормализация**: 60% сокращение избыточности данных
 - **Производительность**: 95% улучшение для сложных JOIN-запросов
 - **Индексирование**: 72% снижение стоимости по планировщику
 ### Качественные достижения
 - Полная автоматизация процесса нормализации данных
 - Интуитивный GUI с поддержкой валютной локализации
 - Масштабируемая архитектура для enterprise-развертывания
 - Комплексная система мониторинга производительности
 ## 🔧 Документация
 - **[Техническая документация](docs/README.md)** - Подробное описание архитектуры и API
 - **[Отчет по курсовой работе](docs/report.md)** - Полный академический отчет
 - **[SQL-скрипты](sql/)** - Схемы БД и запросы для анализа производительности
 ### Конфигурация базы данных
 ```python
 # Параметры подключения
 DATABASE_CONFIG = {
    'host': 'localhost',
    'port': 5432,
    'database': 'mobile_devices_db',
    'user': 'admin',
    'password': 'your_password'
 }
 ```
 ### Основные зависимости
 ```
 psycopg2-binary==2.9.9    # PostgreSQL adapter
 PyQt6==6.6.1              # GUI framework  
 pandas==2.1.4             # Data processing
 numpy==1.26.2             # Numerical computing
 ```
 ## 🚀 Перспективы развития
 ### Краткосрочные цели
 - **Веб-интерфейс**: Реализация REST API на FastAPI
 - **Автоматизация**: Интеграция с внешними API для обновления каталога
 - **Мониторинг**: Real-time дашборды производительности
 ### Долгосрочная стратегия
 - **Machine Learning**: Прогнозирование ценовых тенденций
 - **Микросервисы**: Архитектурная модернизация для cloud-deployment
 - **Аналитика**: Интеграция с Apache Kafka для stream-processing
 ## 📚 Академическая ценность
 Проект демонстрирует практическое применение ключевых концепций:
 ### Теоретические основы
 - **Нормализация реляционных данных** до третьей нормальной формы
 - **Оптимизация производительности СУБД** через стратегическое индексирование
 - **Архитектурные паттерны** для desktop-приложений с базами данных
 ### Практические навыки
 - Проектирование и реализация нормализованных схем данных
 - Анализ и оптимизация производительности SQL-запросов
 - Создание многокомпонентных приложений с GUI-интерфейсом
 ## 📄 Лицензия
 Этот проект создан в учебных целях как курсовая работа по дисциплине "Проектирование и администрирование баз данных" в Московском Политехническом Университете, 2024-2025 учебный год.
 ## 👨‍💻 Автор
 **Деев Егор Викторович** - Backend Developer  
 - GitHub: [@EDeev](https://github.com/EDeev)
 - Email: egor@deev.space
 - Telegram: [@Egor_Deev](https://t.me/Egor_Deev)
 ---
 <div align="center">
-  <p><sub>Создано с ❤️ от вашего дорогого - deev.space ©</sub></p>
+  <sub>⭐ Если проект оказался полезным, поставьте звёздочку на GitHub!</sub>
  <p><sub>Сделано с ❤️ — <a href="https://deev.space">deev.space</a></sub></p>
 </div>
--- a/docs/screenshots/analytics.png
+++ b/docs/screenshots/analytics.png
--- a/docs/screenshots/companies.png
+++ b/docs/screenshots/companies.png
--- a/docs/screenshots/models.png
+++ b/docs/screenshots/models.png