Проект YaMDb

Описание

Проект YaMDb собирает отзывы (Review) пользователей на произведения (Titles).

Произведения делятся на категории: «Книги», «Фильмы», «Музыка». Список категорий (Category) может быть расширен администратором (например, можно добавить категорию «Изобразительное искусство» или «Ювелирка»).

Сами произведения в YaMDb не хранятся, здесь нельзя посмотреть фильм или послушать музыку.

В каждой категории есть произведения: книги, фильмы или музыка. Например, в категории «Книги» могут быть произведения «Винни-Пух и все-все-все» и «Марсианские хроники», а в категории «Музыка» — песня «Давеча» группы «Насекомые» и вторая сюита Баха.

Произведению может быть присвоен жанр (Genre) из списка предустановленных (например, «Сказка», «Рок» или «Артхаус»). Новые жанры может создавать только администратор.

Благодарные или возмущённые пользователи оставляют к произведениям текстовые отзывы (Review) и ставят произведению оценку в диапазоне от одного до десяти (целое число); из пользовательских оценок формируется усреднённая оценка произведения — рейтинг (целое число). На одно произведение пользователь может оставить только один отзыв.

Технологии

django-rest-framework для API
poetry для управления зависимостями
pytest для юнит тестов
flake8 линтер
drf-yasg для документации API

Запуск проекта в dev-режиме

установите и активируйте виртуальное окружение
установите зависимости из файла requirements.txt

pip install -r requirements.txt

или в poetry

poetry install

в директории с файлом manage.py выполните команду:

python manage.py migrate

python manage.py runserver

Документация

После запуска сервера документация API доступна по адресу:

swagger

/swagger/

redoc

/redoc/

Авторы