О проекте

Заметки

• Используется самореферентные отношения (self-referential relationship) «многие ко многим» для отслеживания подписчиков.
• flask-moment (Moment.js) - для решения задачи отображения даты и времени в нужной time zone для пользователя на клиенте
• Полнотекстовый поиск на основе elasticsearch

Стек технологий

• Flask (pytho web framework)
• Poetry (python packaging and dependency manager)
• postgreSQL (database)
• Elasticsearch (search engine)
• Gunicorn (HTTP server)
• Heroku (web hosting)
• Docker (container virtualization)
• Redis (background task queue)

elasticsearch

Весь код, который взаимодействует с индексом Elasticsearch в модуле app/search.py. Идея состоит в том, чтобы сохранить весь код Elasticsearch в этом модуле. Остальная часть приложения будет использовать функции в этом новом модуле для доступа к индексу и не будет иметь прямого доступа к Elasticsearch. Это важно, потому что если однажды я решу, что мне больше не нравится Elasticsearch и соберусь переключиться на другой движок, все, что мне нужно сделать, это перезаписать функции в этом одном модуле, и приложение будет продолжать работать по-прежнему.

Настройка приложения (переменные окружения)

Общие настройки:

SECRET_KEY=""
FLASK_ENV="development" / "production"
APP_SETTINGS="config.DevelopmentConfig" / "config.ProductionConfig"
FLASK_DEBUG= "1" / "0"

БД:

DATABASE_URL="postgresql://localhost/flask_app"

Для получения сообщений о сбоях на email:

MAIL_SERVER="smtp.googlemail.com"
MAIL_PORT="587"
MAIL_USE_TLS="1"
MAIL_USERNAME="email@gmail.com"
MAIL_PASSWORD="pass"

Elasticsearch

ELASTICSEARCH_URL=http://localhost:9200

Redis

REDIS_URL=redis://

deployment

Готовый образ в Docker Hub

Docker

Развертывание контейнера:

# Создание образа
docker build -t flask_app:latest .

# Создание и запук контейнера
# --name <name>                создать контейнер с именем
# -d                           фоновый режим
# -p                           проброс порта
# -e <VAR_NAME>=<VAR_VALUE>    задать переменную окружения
# название образа
docker run --name flask_app_container -d -p 8000:5000 -e SECRET_KEY="1234" -e APP_SETTINGS="config.DevelopmentConfig" -e FLASK_DEBUG="1" -e  flask_app:latest

Логи flask_app приложения

# docker logs <container_name>
docker logs flask_app_flask_app_1

docker-compose

docker-compose up --build -d

Для подключения к БД, например, для отладки:

docker exec -it flask_app_db_1 bash

psql -U postgres

REST API

HTTP Method Resource URL Notes GET /api/users/ Возвращает пользователя. GET /api/users Возвращает коллекцию всех пользователей. GET /api/users//followers Вернет подписчиков этого пользователя. GET /api/users//followed Вернет пользователей, на которых подписан этот пользователь. POST /api/users Регистрирует новую учетную запись пользователя. PUT /api/users/ Изменяет пользователя.

Отладка через httpie

Пакет httpie позволяет проводить тестирование REST API.

POST api/tokens

(venv) $ http POST http://localhost:5000/api/tokens
HTTP/1.0 401 UNAUTHORIZED
(...)

(venv) $ http --auth <username>:<password> POST http://localhost:5000/api/tokens
HTTP/1.0 200 OK
(...)

DELETE /api/tokens

(venv) $ http DELETE http://localhost:5000/api/tokens    Authorization:"Bearer pC1Nu9wwyNt8VCj1trWilFdFI276AcbS"

GET /api/users/

(venv) $ http GET http://localhost:5000/api/users/1    "Authorization:Bearer pC1Nu9wwyNt8VCj1trWilFdFI276AcbS"
HTTP/1.0 200 OK
Content-Length: 457
Content-Type: application/json
Date: Mon, 27 Nov 2017 20:19:01 GMT
Server: Werkzeug/0.12.2 Python/3.6.3

{
    "_links": {
        "avatar": "https://www.gravatar.com/avatar/9b2c5cb3245ebeadf7a67dd4e7f62a9e?d=identicon&s=128",
        "followed": "/api/users/1/followed",
        "followers": "/api/users/1/followers",
        "self": "/api/users/1"
    },
    "about_me": "About me",
    "followed_count": 0,
    "follower_count": 1,
    "id": 1,
    "last_seen": "2022-05-17T10:31:38.909834Z",
    "post_count": 10,
    "username": "test_user"
}

POST /api/users

(venv) $ http POST http://localhost:5000/api/users username=alice password=dog     "Authorization:Bearer pC1Nu9wwyNt8VCj1trWilFdFI276AcbS"
    email=alice@example.com "about_me=Hello, my name is Alice!"

PUT /api/users/

(venv) $ http PUT http://localhost:5000/api/users/2 "about_me=Hi, I am Miguel"     "Authorization:Bearer pC1Nu9wwyNt8VCj1trWilFdFI276AcbS"

Остальное

• для добавления в индекс elasticsearch. Выполнить Posts.reindex(). Возможно перед этим потребуется вручную создать индекс post.
• Для работы через flask shell нужно определить в виртуальном окружении FLASK_APP=flask_app.py
• psql. для запроса данных из таблицы пользователей нужно взять название таблицы в "": select * from "user"; Без кавычек получится запрос к таблице с пользователями postgres.
• Запуск redis воркера rq worker flask_app-tasks

Cсылки

Flask курс

elasticsearch docker-compose official doc

elasticsearch docker-compose

flask + postgres docker-compose

redis docker run