Code Monkey home page Code Monkey logo

yamdb's Introduction

Проект YaMDb

Технологии

Python Django Django REST Framework

Линтеры

Flake8

Полный список модулей, используемых в проекте, доступен в api_yamdb/requirements.txt

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

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

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

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

Пользователи могут оставлять комментарии к отзывам.

Добавлять отзывы, комментарии и ставить оценки могут только аутентифицированные пользователи.

Установка и настройки

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

python -m venv venv

Запуск виртуального окружения:

source venv/Scripts/activate - команда для Windows
source venv/bin/activate - команда для Linux и macOS

Установка зависимостей:

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

Применение миграций:

cd api_yamdb/
python manage.py migrate 

Запуск django сервера:

python manage.py runserver 

Структура базы данных

Диаграмма

Заполнение базы данных из CSV:

Заполнение базы из тестовых подготовленных таблиц располагающихся api_yamdb/api_yamdb/static/data/

python manage.py getdata

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

Полная документация к API доступна по http://<localhost>/redoc/

Примеры запросов к API:

запросы к API начинаются с /api/v1/

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

POST auth/signup/

Request

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

Response

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

Получение списка всех произведений

GET /titles/

Response

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

Частичное обновление отзыва по id:

PATCH titles/{title_id}/reviews/{review_id}/

Request

{
  "text": "string",
  "score": 1
}

Response

{
  "id": 0,
  "text": "string",
  "author": "string",
  "score": 1,
  "pub_date": "2019-08-24T14:15:22Z"
}

Разработчики:

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.