Code Monkey home page Code Monkey logo

hastred45 / yamdb_final Goto Github PK

View Code? Open in Web Editor NEW
3.0 1.0 0.0 1.12 MB

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

Shell 0.06% Python 16.54% Dockerfile 0.08% HTML 0.24% CSS 39.68% JavaScript 43.41%
django docker gunicorn jwt ngnix postgresql python

yamdb_final's Introduction

Python Django Django REST Framework JWT Nginx gunicorn PostgreSQL Docker Docker-compose Docker Hub GitHub%20Actions Yandex.Cloud

CI/CD для проекта API YAMDB

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

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

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

В проекте реализован API-сервис для аутентификации пользователей и работы со всеми вышеперечисленными ресурсами. Подробнее в разделе примеров запросов и ответов. Аутентификация пользователей реализована по стандарту JWT.

Работа с API

Доступные запросы

Запрос Эндпоинт Метод
Регистрация нового пользователя .../api/v1/auth/signup/ POST
Получение JWT-токена .../api/v1/auth/token/ POST
Получение списка всех категорий .../api/v1/categories/ GET
Добавление новой категории .../api/v1/categories/ POST
Удаление категории .../api/v1/categories/{slug}/ DELETE
Получение списка всех жанров .../api/v1/genres/ GET
Добавление жанра .../api/v1/genres/ POST
Удаление жанра .../api/v1/genres/{slug}/ DELETE
Получение списка всех произведений .../api/v1/titles/ GET
Добавление произведения .../api/v1/titles/ POST
Получение информации о произведении .../api/v1/titles/{title_id}/ GET
Частичное обновление информации о произведении .../api/v1/titles/{title_id}/ PATCH
Удаление произведения .../api/v1/titles/{title_id}/ DELETE
Получение списка всех отзывов .../api/v1/titles/{title_id}/reviews/ GET
Добавление нового отзыва .../api/v1/titles/{title_id}/reviews/ POST
Получение отзыва по id .../api/v1/titles/{title_id}/reviews/{review_id}/ GET
Частичное обновление отзыва по id .../api/v1/titles/{title_id}/reviews/{review_id}/ PATCH
Удаление отзыва по id .../api/v1/titles/{title_id}/reviews/{review_id}/ DELETE
Получение списка всех комментариев к отзыву .../api/v1/titles/{title_id}/reviews/{review_id}/comments/ GET
Добавление комментария к отзыву .../api/v1/titles/{title_id}/reviews/{review_id}/comments/ POST
Получение комментария к отзыву .../api/v1/titles/{title_id}/reviews/{review_id}/comments/{comment_id}/ GET
Частичное обновление комментария к отзыву .../api/v1/titles/{title_id}/reviews/{review_id}/comments/{comment_id}/ PATCH
Удаление комментария к отзыву .../api/v1/titles/{title_id}/reviews/{review_id}/comments/{comment_id}/ DELETE
Получение списка всех пользователей .../api/v1/users/ GET
Добавление пользователя .../api/v1/users/ POST
Получение пользователя по username .../api/v1/users/{username}/ GET
Изменение данных пользователя по username .../api/v1/users/{username}/ PATCH
Удаление пользователя по username .../api/v1/users/{username}/ DELETE
Получение данных своей учетной записи .../api/v1/users/me/ GET
Изменение данных своей учетной записи .../api/v1/users/me/ PATCH

Аутентификация

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

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

Пример запроса:
POST .../api/v1/auth/signup/

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

Пример ответа (200):

{
  "email": "string",
  "username": "string"
}
  1. YaMDB отправляет письмо с кодом подтверждения (confirmation_code) на адрес email.
  2. Пользователь отправляет POST-запрос с параметрами username и confirmation_code на эндпоинт /api/v1/auth/token/, в ответе на запрос ему приходит token (JWT-токен).

Пример запроса:
POST .../api/v1/auth/token/

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

Пример ответа (200):

{
  "token": "string"
}
  1. При желании пользователь отправляет PATCH-запрос на эндпоинт /api/v1/users/me/ и заполняет поля в своём профайле.

Пример запроса:
POST .../api/v1/users/me/

{
  "username": "string",
  "email": "[email protected]",
  "first_name": "string",
  "last_name": "string",
  "bio": "string"
}

Пример ответа (200):

{
  "username": "string",
  "email": "[email protected]",
  "first_name": "string",
  "last_name": "string",
  "bio": "string"
  "role": "user"
}

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

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

Разворачивание

Workflow

  • tests - Проверка кода на соответствие стандарту PEP8 (с помощью пакета flake8) и запуск pytest. Дальнейшие шаги выполнятся только если push был в ветку master или main.
  • build_and_push_to_docker_hub - Сборка и доставка докер-образов на Docker Hub
  • deploy - Автоматический деплой проекта на боевой сервер. Выполняется копирование файлов из репозитория на сервер:
  • send_message - Отправка уведомления в Telegram

Подготовка для запуска workflow

Создайте и активируйте виртуальное окружение, обновите pip:

python3 -m venv venv
. venv/bin/activate
python3 -m pip install --upgrade pip

Запустите автотесты:

pytest

В репозитории на Гитхабе добавьте данные в Settings - Secrets - Actions secrets:

DOCKER_USERNAME - имя пользователя в DockerHub
DOCKER_PASSWORD - пароль пользователя в DockerHub
HOST - ip-адрес сервера
USER - пользователь
SSH_KEY - приватный ssh-ключ
PASSPHRASE - кодовая фраза для ssh-ключа
SECRET_KEY - секретный ключ приложения django
ALLOWED_HOSTS - список разрешённых адресов
TELEGRAM_TO - id своего телеграм-аккаунта
TELEGRAM_TOKEN - токен бота
DB_NAME - postgres (по умолчанию)
DB_ENGINE - django.db.backends.postgresql
DB_HOST - db (по умолчанию)
DB_PORT - 5432 (по умолчанию)
POSTGRES_USER - postgres (по умолчанию)
POSTGRES_PASSWORD - postgres (по умолчанию)

Подготовка сервера

Остановите службу nginx:

sudo systemctl stop nginx 

Установите docker и docker-compose:

sudo apt install docker.io
sudo apt install curl
curl -fsSL https://get.docker.com -o get-docker.sh
sh get-docker.sh 
sudo apt install \
  apt-transport-https \
  ca-certificates \
  curl \
  gnupg-agent \
  software-properties-common -y
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -
sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable" 
sudo apt install docker-ce docker-compose -y

Community Edition (CE) — бесплатная и общедоступная версия - Она идеально подходит для решения базовых задач по контейнеризации

Скопируйте файлы docker-compose.yaml и nginx/default.conf из вашего проекта на сервер в home/<ваш_username>/docker-compose.yaml и home/<ваш_username>/nginx/default.conf соответственно.

После успешного деплоя последовательно выполнить:

a) sudo docker-compose exec web python manage.py migrate b) sudo docker-compose exec web python manage.py createsuperuser с) sudo docker-compose exec web python manage.py collectstatic --no-input

Работа с fixture:

Для создания дампа (резервной копии) необходимо выполнить команду:

  • docker-compose exec web python manage.py dumpdata > fixtures.json

Для загрузки:

  • docker-compose exec web python manage.py loaddata fixtures.json

Авторы:

Сергей - https://github.com/Hastred45

Глеб - https://github.com/Gleb-K9

Влад - https://github.com/Alpha-jpg-beep

yamdb_final's People

Contributors

hastred45 avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar

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.