pavelermeev / ymdb_api

API for YMDb

Проект YMDb

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

Как запустить проект

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

python -m venv venv

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

  source venv/bin/activate
  

• Если у вас Windows

  .\venv\Scripts\activate
  

Установить зависимости из файла requirements.txt:

pip install -r requirements.txt

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

python manage.py migrate

Запустить первоначальную загрузку данных:

python manage.py loadcsv

Запустить проект:

python manage.py runserver

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

Полный список запросов и эндпоинтов описан в документации ReDoc, доступна после запуска проекта по адресу:

http://127.0.0.1:8000/redoc/

Авторы проекта

Павел Ермеев https://github.com/bytplokhim Джавид Агвердиев https://github.com/AG-Javid Никита Безкровный https://github.com/kilzzze