Создание серверной части API Python Flask в контейнере .devcontainer в Visual Studio Code

Среда разработки | Удаленный | Управление конфигурацией | Снижение рисков

Если вы собираетесь начать проект, вам, вероятно, следует начать его правильно. Это означает создание повторяемого процесса, чтобы, когда следующий разработчик работает над проектом, он мог бы с легкостью вернуться к нему. Итак, как мы это сделаем? Что ж, мы можем сделать это с помощью .devcontainers. DevContainers в коде Visual Studio позволяет программам и инженерам работать и разрабатывать в рамках контейнера. Этот же контейнер можно использовать в наших процессах непрерывной интеграции и непрерывной доставки (CI / CD). Итак, приступим.

Шаг 1. Установка расширения удаленных контейнеров

Расширение «Remote-Containers» необходимо для запуска контейнера в Visual Studio Code и работы с ним. Щелкните «Расширения» и введите «удаленные контейнеры». Затем установите расширение, если оно еще не установлено.

Теперь мы можем перейти к следующему шагу - сообщить коду Visual Studio, как подготовить наш контейнер.

Шаг 2. Создайте структуру проекта.

Создайте новый проект и откройте его в Visual Studio Code. После открытия создайте папку с именем «.devcontainer». Visual Studio Code автоматически знает, как обращаться с вашим контейнером, имея все в каталоге .devcontainer.

Шаг 3. Создайте инструкции по коду Visual Studio.

Создайте файл с именем «devcontainer.json» в каталоге .devcontainer, который сообщит Visual Studio Code, как подготовить контейнер. Внутри файла добавьте следующее:

{
    "build": {
        "dockerfile": "python-env"
    }
}

Это довольно просто. Это укажет Visual Studio Code предоставить контейнер из файла докеров с именем python-env.

Шаг 4. Настройка изображения Инструкции

Теперь создайте файл с именем «python-env» и добавьте следующее:

FROM python:3.9.7
COPY requirements.txt ./
RUN pip install -r requirements.txt

Этот файл будет инструкциями, которые мы будем использовать для создания необходимой среды Python. Обратите внимание, что используется файл require.txt. Таким образом можно контролировать зависимости.

Шаг 5. Настройка дерева зависимостей

Разработчики добавляют массу новых зависимостей. Разве не было бы неплохо отслеживать их с легкостью? Что ж, теперь ты можешь. Добавьте файл requirements.txt и добавьте все необходимые зависимости. В этом случае понадобится Flask. Создайте файл с именем «requirements.txt» и добавьте следующее:

Flask>=2.0.2

По сути, это означает, что нужно найти все, что выше 2.0.2, и установить его.

Шаг 6. Работа внутри контейнера.

На этом этапе вся структура и файлы созданы для того, что необходимо. Теперь щелкните значок ›‹ в левом нижнем углу, чтобы открыть палитру команд. Теперь выберите «Открыть в контейнере».

Шаг 7. Запуск приложения Flask

Создайте файл с именем «main.py» в каталоге с именем app. Добавьте в файл main.py следующее:

from flask import Flask
from bs4 import BeautifulSoup
app = Flask(__name__)
@app.route("/")
def main():
  return "It Works!"
if __name__ == '__main__':
  app.run(debug=True)

Теперь выполните следующие команды, чтобы настроить переменные среды:

export FLASK_ENV=development
export FLASK_APP=/app/main.py

Теперь запустите серверную часть Flash API, запустив:

flask run

Теперь это настроит среду разработки и автоматически запустит flask на порту 5000 на локальном хосте.

Потрясающий! Итак, вы официально создали среду разработки для своего приложения на Python и Flask.

Создание серверной части API Python Flask в контейнере .devcontainer в Visual Studio Code