ДОПИСАТЬ РЕДМИ И ИСПРАВИТЬ БАГИ! Не позднее 10.10.2022

ЯП - Спринт 16 - CI и CD проекта api_yamdb. Python-разработчик (бекенд) (Яндекс.Практикум)

Проект развернут по адресу: http://localhost:8000/redoc/

Описание

Проект YaMDb собирает отзывы пользователей на произведения. Произведения делятся на категории:«Книги», «Фильмы», «Музыка». Список категорий может быть расширен (например, можно добавить категорию «Изобразительное искусство» или «Ювелирка»). Настроика для приложения Continuous Integration и Continuous Deployment, реализация:

автоматический запуск тестов,
обновление образов на Docker Hub,
автоматический деплой на боевой сервер при пуше в главную ветку main.

Стек:

Django 4.1.1
DRF 3.14.0
djangorestframework-simplejwt 5.2.1
psycopg2-binary 2.9.3
PyJWT 2.5.0

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

Все описанное ниже относится к ОС Linux.

Клонируем репозиторий и и переходим в него:

git clone git@github.com:themasterid/yamdb_final.git

cd yamdb_final

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

python3 -m venv venv

Windows:

source venv/Scripts/activate

Linux:

source venv/bin/activate

Обновим pip:

python -m pip install --upgrade pip

Ставим зависимости из requirements.txt:

pip install -r api_yamdb/requirements.txt

Переходим в папку с файлом docker-compose.yaml:

cd infra

Предварительно установим Docker на ПК под управлением Linux (Ubuntu 22.10), для Windows немного иная установка, тут не рассматриваем:

sudo apt update && apt upgrade -y

Удаляем старый Docker:

sudo apt remove docker

Устанавливаем Docker:

sudo apt install docker.io

Смотрим версию Docker (должно выдать Docker version 20.10.16, build 20.10.16-0ubuntu1):

docker --version

Активируем Docker в системе, что бы при перезагрузке запускался автоматом:

sudo systemctl enable docker

Запускаем Docker:

sudo systemctl start docker

Смотрим статус (выдаст статус, много букв):

sudo systemctl status docker

Проверим:

sudo docker run hello-world

Не будет лишнем установить PostgreSQL:

sudo apt install postgresql postgresql-contrib -y

Предварительно в папке infra создаем файл .env с следующим содержимом:

DB_ENGINE=django.db.backends.postgresql 
DB_NAME=postgres 
POSTGRES_USER=postgres 
POSTGRES_PASSWORD=postgres 
DB_HOST=db 
DB_PORT=5432

Так как требование ТЗ и тестов использовать postgresql, то создадим в системе бд, установив локаль:

sudo dpkg-reconfigure locales

Выбираем ru_RU.UTF-8 нажав пробел и ждем сообщения Generation complete.

Generating locales (this might take a while)...
...
  ru_RU.UTF-8... done
...
Generation complete.

Перезапустим систему:

sudo reboot

Установка PostgreSQL:

sudo apt install postgresql postgresql-contrib -y

Управляем БД:

Остановить

sudo systemctl stop postgresql

- Запустить
```bash
sudo systemctl start postgresql

Перезапустить

sudo systemctl restart postgresql

Узнать статус, текущее состояние

sudo systemctl status postgresql

Создаем бд и пользователя:

sudo -u postgres psql

Создаем базу:

CREATE DATABASE test_base;

Создаем пользователя:

CREATE USER test_user WITH ENCRYPTED PASSWORD 'test_pass';

Даем права для пользователя:

GRANT ALL PRIVILEGES ON DATABASE test_base TO test_user;

Не забываем про установку, что мы сделали ранее, активировав venv:

pip install psycopg2-binary

pip install python-dotenv

В settings.py добавляем следующее:

from dotenv import load_dotenv

load_dotenv()

...

DATABASES = {
    'default': {
        'ENGINE': os.getenv('DB_ENGINE', 'django.db.backends.postgresql'),
        'NAME': os.getenv('DB_NAME'),
        'USER': os.getenv('POSTGRES_USER'),
        'PASSWORD': os.getenv('POSTGRES_PASSWORD'),
        'HOST': os.getenv('DB_HOST'),
        'PORT': os.getenv('DB_PORT')
    }
}

Далее в папке где у нас находится файл settings.py создаем файл .env:

touch .env

nano .env

DB_ENGINE=django.db.backends.postgresql
DB_NAME=test_base
POSTGRES_USER=test_user
POSTGRES_PASSWORD=test_pass
DB_HOST=127.0.0.1
DB_PORT=5432

Не забываем про миграции (виртуальное окружение активировано):

python manage.py migrate

ДОПИСАТЬ!!! 03.10.2022

Так же исправить settings.py с .env для секретов!

Поднимаем контейнеры ( infra_db - база, infra_web - веб, nfra_nginx - nginx сервер возможно пригодится команда sudo systemctl stop nginx если запускаете в DEV режиме на ПК):

sudo docker-compose up -d --build

Выполняем миграции в контейнере infra_web:

sudo docker-compose exec web python manage.py makemigrations reviews

sudo docker-compose exec web python manage.py migrate --run-syncdb

Создаем суперпользователя:

docker-compose exec web python manage.py createsuperuser

Собираем статику:

docker-compose exec web python manage.py collectstatic --no-input

Создаем дамп базы данных (нет в текущем репозитории):

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

Останавливаем контейнеры:

docker-compose down -v

Шаблон наполнения .env (не включен в текущий репозиторий) расположенный по пути infra/.env

DB_ENGINE=django.db.backends.postgresql 
DB_NAME=postgres 
POSTGRES_USER=postgres 
POSTGRES_PASSWORD=postgres 
DB_HOST=db 
DB_PORT=5432

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

Документация доступна по эндпойнту: http://localhost:8000/redoc/

themasterid/yamdb_final