Проект «Проект YaMDb»

Проект YaMDb

Описание

Проект YaMDb собирает отзывы пользователей на произведения. Сами произведения в YaMDb не хранятся, здесь нельзя посмотреть фильм или послушать музыку. Произведения делятся на категории, такие как «Книги», «Фильмы», «Музыка». Например, в категории «Книги» могут быть произведения «Винни-Пух и все-все-все» и «Марсианские хроники», а в категории «Музыка» — песня «Давеча» группы «Жуки» и вторая сюита Баха. Список категорий может быть расширен (например, можно добавить категорию «Изобразительное искусство» или «Ювелирка»). Произведению может быть присвоен жанр из списка предустановленных (например, «Сказка», «Рок» или «Артхаус»). Добавлять произведения, категории и жанры может только администратор. Благодарные или возмущённые пользователи оставляют к произведениям текстовые отзывы и ставят произведению оценку в диапазоне от одного до десяти (целое число); из пользовательских оценок формируется усреднённая оценка произведения — рейтинг (целое число). На одно произведение пользователь может оставить только один отзыв. Пользователи могут оставлять комментарии к отзывам. Добавлять отзывы, комментарии и ставить оценки могут только аутентифицированные пользователи.

Стек использованных технологий

• Django 3.2
• JWT
• Python 3.9
• DRF

Запуск проекта

• Клонируйте репозиторий и перейдите в него с помощью командной строки:

git clone git@github.com:Elithabeth2003/api_yamdb.git
cd api_yamdb

• Установите и активируйте виртуальное окружение c учетом версии Python 3.9:

• Если у вас Linux/macOS

  python3 -m venv env
  source env/bin/activate
  

• Если у вас Windows

  python -m venv venv
  source venv/Scripts/activate
  

• Обновите менеджер пакетов pip:

python -m pip install --upgrade pip

• Затем установите зависимости из файла requirements.txt:

pip install -r requirements.txt

• Переходим в репозиторий с manage.py и выполняем миграции:

cd api_yamdb
python manage.py migrate

• Наполнение базы данных из CSV-файлов:

В папке data расположены шаблоны таблиц, которые используются для наполнения базы данных информацией. В первой строке через запятую указаны названия столбцов, в которые будут записаны данные. Разделение столбцов осуществляется с помощью запятой(","). Поэтому её использование возможно только для разделения данных. Использование других знаков препинания допускается. Начиная со второй строки, осуществите внесение информации в таблицу. Сохраните файл. Перед выполнением команды импорта, требуется выполнить миграции базы данных, описанные пунктом выше. В случае их успешного применения, в консоли следует выполнить команду:

python manage.py import-csv

После успешного импорта каждой таблицы в консоль будет выведено сообщение "finish download"

• Запускаем проект:

python manage.py runserver

Пользовательские роли

• Аноним — может просматривать описания произведений, читать отзывы и комментарии.
• Аутентифицированный пользователь (user) — может, как и Аноним, читать всё, дополнительно он может публиковать отзывы и ставить оценку произведениям (фильмам/книгам/песенкам), может комментировать чужие отзывы; может редактировать и удалять свои отзывы и комментарии. Эта роль присваивается по умолчанию каждому новому пользователю.
• Модератор (moderator) — те же права, что и у Аутентифицированного пользователя плюс право удалять любые отзывы и комментарии.
• Администратор (admin) — полные права на управление всем контентом проекта. Может создавать и удалять произведения, категории и жанры. Может назначать роли пользователям.
• Суперюзер Django — обладет правами администратора (admin)

Пример работы с API

К проекту подключена документация API YaMDb. В ней описаны возможные запросы к API и структура ожидаемых ответов. Для каждого запроса указаны уровни прав доступа: пользовательские роли, которым разрешён запрос. Ниже преведено несколько примеров ответов.

В браузере или программе для взаимодействия с API (например, Postman), можно выполнить запрос к корневому адресу API проекта для получения информации о маршрутах.

Авторы

• Александр Непочатых - управление пользователями: систему регистрации и аутентификации, права доступа, работа с токеном, система подтверждения через e-mail.
• Сиволапова Елизавета - создание модели, view и эндпойнтов для произведений, категорий, жанров.
• Николай Круглов - создание модели, view и эндпойнтов для отзывов, комментариев, рейтингов произведений.