Skip to content

IamEvrik/api_yamdb

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

45 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Проект YaMDb

Технологии

  • Python
  • Django
  • Django-restframework

Описание

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

Ресурсы API YaMDb

  • Ресурс auth: аутентификация.
  • Ресурс users: пользователи.
  • Ресурс titles: произведения, к которым пишут отзывы (определённый фильм, книга или песенка).
  • Ресурс categories: категории (типы) произведений («Фильмы», «Книги», «Музыка»). Одно произведение может быть привязано только к одной категории.
  • Ресурс genres: жанры произведений. Одно произведение может быть привязано к нескольким жанрам.
  • Ресурс reviews: отзывы на произведения. Отзыв привязан к определённому произведению.
  • Ресурс comments: комментарии к отзывам. Комментарий привязан к определённому отзыву.

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

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

Как запустить проект в dev-режиме

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

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

Создать и активировать виртуальное окружение для Linux или MacOS:

python3 -m venv venv
source venv/bin/activate

для Windows:

python -m venv venv
source venv/Script/activate

Установить зависимости из файла requirements.txt: pip install -r requirements.txt Перейти в папку api_yamdb, и выполнить миграции:

cd api_yamdb
python3 manage.py migrate

Запустить проект: python3 manage.py runserver

в Windows вместо команды "python3" использовать "python"

после запуска проекта, по адресу http://127.0.0.1:8000/redoc/ будет доступна документация для API Yatube.В ней описаны возможные запросы к API и структура ожидаемых ответов. Для каждого запроса указаны уровни прав доступа: пользовательские роли, которым разрешён запрос.

заполнить тестовые данные:

python manage.py load_csv

About

api_yamdb

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors