ЯП - Спринт 10 - Проект YaMDb (групповой проект). Python-разработчик (бекенд) (Яндекс.Практикум)

Описание

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

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

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

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

Полная документация к API находится по эндпоинту /redoc

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

• Python 3.7
• Django 2.2.28
• DRF
• JWT

Запуск проекта в docker-контейнере

• Клонировать репозиторий и перейти в него в командной строке.
• Создать в каталоге проекта файл .env в соответствии со следующим шаблоном (необязательно, если не хотите задать свой пароль для базы данных):

DB_ENGINE=django.db.backends.postgresql
DB_NAME=postgres
POSTGRES_USER=postgres
POSTGRES_PASSWORD=<ваш пароль>
DB_HOST=db
DB_PORT=5432

• Перейти в каталог infra.
• Собрать контейнеры (в ОС должен быть установлен Docker)

docker-compose up

• Выполнить миграции

docker-compose exec web python manage.py migrate

• Создать суперпользователя

docker-compose exec web python manage.py createsuperuser

• Собрать статику

docker-compose exec web python manage.py collectstatic --no-input

• Если есть необходимость, заполняем базу тестовыми данными командой:

docker-compose exec web python manage.py load_data -a

• Если есть необходимость, очистить базу от данных можно командой:

docker-compose exec web python manage.py load_data -с

Проект запущен и доступен по адресу: localhost

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

• Клонировать репозиторий и перейти в него в командной строке.
• Установите и активируйте виртуальное окружение c учетом версии Python 3.7 (выбираем python не ниже 3.7):

py -3.7 -m venv venv

source venv/Scripts/activate

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

python -m pip install --upgrade pip

pip install -r requirements.txt

• Выполняем миграции:

python manage.py migrate --run-syncdb

Если есть необходимость, заполняем базу тестовыми данными командой:

python manage.py load_data -a

Если есть необходимость, очиcтить базу от данных командой:

python manage.py load_data -с

Создаем суперпользователя, после меняем в админ панели роль с user на admin:

python manage.py createsuperuser

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

python manage.py runserver

Проект запущен и доступен по адресу: localhost:8000

Примеры работы с API для всех пользователей

Подробная документация доступна по эндпоинту /redoc/

Для неавторизованных пользователей работа с API доступна в режиме чтения, что-либо изменить или создать не получится.

Права доступа: Доступно без токена.
GET /api/v1/categories/ - Получение списка всех категорий
GET /api/v1/genres/ - Получение списка всех жанров
GET /api/v1/titles/ - Получение списка всех произведений
GET /api/v1/titles/{title_id}/reviews/ - Получение списка всех отзывов
GET /api/v1/titles/{title_id}/reviews/{review_id}/comments/ - Получение списка всех комментариев к отзыву
Права доступа: Администратор
GET /api/v1/users/ - Получение списка всех пользователей

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

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

Регистрация нового пользователя

Получить код подтверждения на переданный email. Права доступа: Доступно без токена. Использовать имя 'me' в качестве username запрещено. Поля email и username должны быть уникальными.

Регистрация нового пользователя:

POST /api/v1/auth/signup/

{
  "email": "string",
  "username": "string"
}

Получение JWT-токена:

POST /api/v1/auth/token/

{
  "username": "string",
  "confirmation_code": "string"
}

Примеры работы с API для авторизованных пользователей

Добавление категории:

Права доступа: Администратор.
POST /api/v1/categories/

{
  "name": "string",
  "slug": "string"
}

Удаление категории:

Права доступа: Администратор.
DELETE /api/v1/categories/{slug}/

Добавление жанра:

Права доступа: Администратор.
POST /api/v1/genres/

{
  "name": "string",
  "slug": "string"
}

Удаление жанра:

Права доступа: Администратор.
DELETE /api/v1/genres/{slug}/

Обновление публикации:

PUT /api/v1/posts/{id}/

{
"text": "string",
"image": "string",
"group": 0
}

Добавление произведения:

Права доступа: Администратор. 
Нельзя добавлять произведения, которые еще не вышли (год выпуска не может быть больше текущего).
POST /api/v1/titles/

{
  "name": "string",
  "year": 0,
  "description": "string",
  "genre": [
    "string"
  ],
  "category": "string"
}

Добавление произведения:

Права доступа: Доступно без токена
GET /api/v1/titles/{titles_id}/

{
  "id": 0,
  "name": "string",
  "year": 0,
  "rating": 0,
  "description": "string",
  "genre": [
    {
      "name": "string",
      "slug": "string"
    }
  ],
  "category": {
    "name": "string",
    "slug": "string"
  }
}

Частичное обновление информации о произведении:

Права доступа: Администратор
PATCH /api/v1/titles/{titles_id}/

{
  "name": "string",
  "year": 0,
  "description": "string",
  "genre": [
    "string"
  ],
  "category": "string"
}

Частичное обновление информации о произведении:

Права доступа: Администратор
DEL /api/v1/titles/{titles_id}/

По TITLES, REVIEWS и COMMENTS аналогично, более подробно по эндпоинту /redoc/

Работа с пользователями:

Для работы с пользователя есть некоторые ограничения для работы с ними. Получение списка всех пользователей.

Права доступа: Администратор
GET /api/v1/users/ - Получение списка всех пользователей

Добавление пользователя:

Права доступа: Администратор
Поля email и username должны быть уникальными.
POST /api/v1/users/ - Добавление пользователя

{
"username": "string",
"email": "user@example.com",
"first_name": "string",
"last_name": "string",
"bio": "string",
"role": "user"
}

Получение пользователя по username:

Права доступа: Администратор
GET /api/v1/users/{username}/ - Получение пользователя по username

Изменение данных пользователя по username:

Права доступа: Администратор
PATCH /api/v1/users/{username}/ - Изменение данных пользователя по username

{
  "username": "string",
  "email": "user@example.com",
  "first_name": "string",
  "last_name": "string",
  "bio": "string",
  "role": "user"
}

Удаление пользователя по username:

Права доступа: Администратор
DELETE /api/v1/users/{username}/ - Удаление пользователя по username

Получение данных своей учетной записи:

Права доступа: Любой авторизованный пользователь
GET /api/v1/users/me/ - Получение данных своей учетной записи

Изменение данных своей учетной записи:

• Права доступа: Любой авторизованный пользователь

PATCH /api/v1/users/me/ # Изменение данных своей учетной записи

Проект сделан в рамках учебного процесса по специализации Python-разработчик (back-end) Яндекс.Практикум.

Авторы в рамках учебного курса ЯП Python - разработчик бекенда:

• ✅ avpech (в роли Python-разработчика - разработчик 1) Разработал всю часть, касающуюся управления пользователями (Auth и Users): систему регистрации и аутентификации, права доступа, работу с токеном, систему подтверждения через e-mail.
• ✅ Vlad540700 (в роли Python-разработчика Тимлид - разработчик 2) Описал категории (Categories), жанры (Genres) и произведения (Titles): модели, представления и эндпойнты для них, реализовал механизм ипорта данных из csv файлов.
• ✅ AnastasiyaGuchek (в роли Python-разработчика - разработчик 3) Создал отзывы (Review) и комментарии (Comments): описал модели, представления, настроил эндпойнты, определил права доступа для запросов.