Проект API YamDB 📃

Оглавление

• Проект API YamDB
  • Используемые технологии
  • Структура проекта
  • Описание проекта
  • Алгоритм регистрации пользователей
  • Пользовательские роли
  • Запуск проекта

---

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

🐍 Python 3.8, 🖥️ Django 2.2.19, 🔃 Django Rest Framework 3.12.4, 🗃️ SQlite3, 🔑 Simple JWT, 🧼 Django Filters

---

Структура проекта

yamdb_api
 ├── api_yamdb/
     ├── api/
     ├── api_yamdb/
     ├── reviews/
         ├── management/
             ├── commands/
                 ...
             ...
     ├── static/
     ├── templates/
     └── manage.py
 ├── .gitignore
 ├── tests/
 ├── pytest.ini
 ├── README.md
 ├── requirements.txt
 └── setup.cfg

---

Описание проекта

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

• Книги
• Фильмы
• Музыка
• Искусство и многое другое

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

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

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

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

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

🔝 Вернуться к оглавлению

---

Более подробная информация о проекте:

Алгоритм регистрации пользователей

Пользователь отправляет POST-запрос на добавление нового пользователя с параметрами email и username на эндпоинт /api/v1/auth/signup/.

YaMDB отправляет письмо с кодом подтверждения (confirmation_code) на адрес email. Пользователь отправляет POST-запрос с параметрами username и confirmation_code на эндпоинт /api/v1/auth/token/, в ответе на запрос ему приходит Token (JWT-токен). При желании пользователь отправляет PATCH-запрос на эндпоинт /api/v1/users/me/ и заполняет поля в своём профайле.

---

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

Аноним — может просматривать описания произведений, читать отзывы и комментарии.

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

Модератор (moderator) — те же права, что и у Аутентифицированного пользователя плюс право удалять любые отзывы и комментарии.

Администратор (admin) — полные права на управление всем контентом проекта. Может создавать и удалять произведения, категории и жанры. Может назначать роли пользователям.

Суперюзер Django — обладет правами администратора (admin).

🔝 Вернуться к оглавлению

---

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

Чтобы локально развернуть проект необходимо:

1. Клонировать репозиторий:

git clone https://github.com/simatheone/yamdb-api.git

2. Создать виртуальное окружение:

python3 -m venv venv

3. Активировать виртуальное окружение:

bash/zsh:
source venv/bin/activate

Windows:
venv\Scripts\activate.bat

4. Обновить pip и установить зависимости из requirements.txt:

python3 -m pip install --upgrade pip
pip install -r requirements.txt

5. Выполнить миграции и запустить проект:

python3 manage.py migrate
python3 manage.py runserver

🔝 Вернуться к оглавлению