🏠 Housing Market Analysis API

🧑‍💻 Участники проекта

• pul_stack
• Ilya_Sleptsov

Роль Student 2 выполнял: nanashi

📝 Описание работы

Данный проект реализует RESTful API для анализа данных жилищного рынка в соответствии со спецификацией v1.1. Разработка велась с использованием современных подходов к обработке табличных данных и построению легковесных аналитических сервисов.

🛠️ Используемые технологии и инструменты

• Язык: Python 3.9+
• Библиотеки:
  pandas
  (анализ данных),
  flask
  (веб-сервер),
  json
  (сериализация)
• Формат данных: CSV (с поддержкой пропущенных значений и неоднородного форматирования)
• Архитектура: Модульная, с четким разделением логики загрузки, обработки и API-слоя

🧪 Процесс разработки

Работа выполнялась совместно с применением парного программирования и итеративного тестирования.
Для генерации и верификации логики использовались подсказки от AI-ассистентов (включая LLM-модели, такие как Gemini и Llama), однако вся бизнес-логика, обработка ошибок, оптимизация и финальная реализация выполнены участниками вручную.

Специальное внимание уделено:

• Обработке реальных "грязных" данных (разный регистр, пропуски, несогласованные форматы)
• Соблюдению требований к точности (округление до 2 знаков)
• Строгой валидации входных параметров
• Читаемости и сопровождаемости кода

📂 Структура репозитория

housing-market-api/
├── README.md                 # Основное описание проекта (этот файл)
├── dev/
│   ├── README.md             # Описание реализации для Pull Request
│   ├── solution.py           # Основная реализация API и аналитики
│   └── requirements.txt      # Зависимости проекта
├── data/
│   └── sample_housing.csv    # Пример данных (опционально)
├─── tests/
│    └── test_solution.py      # Модульные тесты (если реализованы)
├──demo/
    ├──📄 feature-stats.json                    # Статистика корреляций признаков с ценой
    ├── 📄 housing_api_results_20241201_143022.json  # Полные результаты анализа жилищного рынка
    ├── 📄 housing_metrics_20241201143022.csv    # Метрики по городам в табличном формате  
    ├── 📄 location-stats_city_Seattle.json      # Детальная статистика по Сиэтлу
    └── 📄 price-distribution_city_Austin_state_TX.json  # Распределение цен в Остине, Техас   

🚀 Запуск и использование

1. Установите зависимости:

2. Запустите сервер:

3. Примеры запросов:

✅ Готовность к интеграции

Решение:

• Полностью соответствует спецификации v1.1
• Проходит все критерии приемки
• Содержит обработку граничных случаев и ошибок
• Оптимизировано для работы с датасетами до 10k записей
• Готово к включению в CI/CD и дальнейшему масштабированию

🎯 Проект завершён и готов к ревью!