Django - создание проекта в Visual Studio

Веб-приложение Django в Visual Studio

Django — популярный серверный фреймворк на Python для быстрой разработки безопасных и полнофункциональных сайтов. Django создан опытными разработчиками и берет на себя большую часть низкоуровневой работы по веб-разработке. Это позволяет сосредоточиться над логикой своего веб-приложения освобождаясь от написания значительного объема рутинного кода.

MS Visual Studio предоставляет развитую поддержку языка Python в операционной системе Windows. Организует единое окно для управления глобальными и виртуальными средами Python. Упрощает установку требуемых пакетов Python и создание виртуальных сред.

Данная статья подробно описывает установку и настройку проекта фреймворка Django на базе универсального шаблона веб-приложений на языке Python в интегрированной среде программирования Visual Studio. Для подтверждения теоретического описания к странице прикреплен архив исходного кода описываемого веб-проекта Django.

Для создания проекта требуется глобально установленный в Windows интерпретатор Python. Установка интерпретатора подробно описывается на странице Программирование на Python в Visual Studio.

Выбор и создание веб-проекта Python в Visual Studio

Для создания веб-проекта Django в Visual Studio выбирается шаблон пустого универсального проекта для веб-приложений Python. Выбор пустого шаблона для веб-проекта (вместо шаблона с готовым каркасом для веб-приложения Django) позволяет пройти и изучить нетрудные, но познавательные стадии создания веб-приложения Django.

Создание виртуальной среды

При создании Python проекта, по умолчанию создается глобальная виртуальная среда на последней версии глобального Python. Для независимости проекта от глобальных настроек рекомендуется создать изолированную виртуальную среду на уровне веб-приложения.

Для создания виртуальной среды, в окне Обозревателя решений, требуется щелкнуть правой кнопкой на строку Окружения Python и нажать на пункт контекстного меню Добавить среду. В появившемся окне выбрать базовый интерпретатор Python для установки среды, нажать кнопку Создать.

После этих процедур, в проект добавляется папка с названием виртуальной среды, в которую дополнительно устанавливаются пакеты pip (система управления пакетами на языке Python) и setuptools (библиотека для программистов, создающих и распространяющих пакеты Python).

Установка пакетов Django

Visual Studio облегчает установку пакетов Python в виртуальные среды, предоставляя визуальный интерфейс. Для этого в Обозревателе решений надо щелкнуть правой кнопкой мыши на строку с названием виртуальной среды и в контекстном меню выбрать пункт Открыть пакеты Python.

Открывшаяся вкладка имеет строку команд (окно редактирования) для системы pip, в которую для установки файлов последней стабильной версии Django печатается команда:
django.
Для загрузки желаемой версии необходимо ввести команду, без пробелов:
django==4.1
После этих команд установятся пакеты Django указанной версии. Дополнительно вместе с Django устанавливаются пакеты необходимые для функционирования фреймворка.

В это же окне появляются рекомендации к обновлению пакетов до последних версий. Нужно щелкнуть на номер версии и указанный пакет обновится до последней версии.

Файл требований requirements.txt

Для необходимости поддерживать или восстанавливать данную конфигурацию пакетов в виртуальной среде можно создать файл требований requirements.txt. Для этого в окне Обозревателя решений щелкнуть правой кнопкой мыши на строку с названием виртуальной среды и выбрать пункт меню Создать requirements.txt.

В результате создастся файл с командами установки всех пакетов данной виртуальной среды. И в дальнейшем, при необходимости вы можете щелкнуть уже по пункту контекстного меню выбранной виртуальной среды Установить из requirements.txt и указанные пакеты в требованиях будут установлены в папку выбранной виртуалки. Такое может пригодиться при создании новых подобных веб-приложений на языке Питон.

Можно также сначала создать файл требований, а затем на основе его команд заполнить виртуальную среду желаемыми пакетами.

Проверка установки Django

Успешную установку пакетов Django можно проверить в интерактивном окне Python также в среде программирования Visual Studio. Интерактивное окно открывается щелчком правой кнопки мыши по названию проекта или активированной виртуальной среды (если среда одна, она активируется автоматически) и выбором пункта Открыть интерактивное окно.

>>> import django
>>> print(django.get_version())
4.2.2

Теперь все необходимые пакеты установлены, переходим к формированию проекта Django, содержащего все настройки, специфичные для фреймворка.

Создание проекта Django

Здесь надо объяснить небольшой каламбур двух смыслов слова «проект» такой структурой: проект Visual Studio содержит проект Django.

Создание проекта Django предполагает создание набора настроек, параметров и конфигурации базы данных для веб-приложения Django.

Для этого в Обозревателе решений, из контекстного меню названия проекта Visual Studio открываем окно командной строки через пункт Открыть командную строку здесь и набираем команду:
django-admin startproject название_проекта_Django [каталог_назначения]
Для нашего проекта так:
django-admin startproject mydjango .
Точка в конце указывает на установку в текущий каталог проекта Visual Studio. При необходимости, узнать все опции команды создания проекта Django можно строкой:
django-admin help startproject

В результате в каталоге проекта Visual Studio создается папка mydjango с файлами и файл manage.py для целей управления веб-приложением Django.

Первоначально созданные папка mydjango и файл manage.py не включены в проект Visual Studio и не отображаются в Обозревателе решений, увидеть их можно только после нажатия кнопки меню Обозреватель решений->Показать все файлы. Для дальнейшей работы папку и файл следует включить в проект Visual Studio при помощи их контекстных меню.

Запуск проекта Django

Теперь можно испытать проект Django запуском. Для этого в окне Обозревателя решений, в контекстном меню названия проекта нажать Открыть командную строку здесь. В командном окне печатаем и выполняем:
manage.py runserver
В результате запустится отладочный сервер по адресу http://127.0.0.1:8000/, об успехе запуска сообщится в окне командной строки. Данный адрес надо вставить в адресную строку браузера и запустить сайт.

Настройка проекта Django

Поскольку мы работаем в интегрированной среде программирования, не очень солидно запускать проект через командную строку. Гораздо комфортнее и привычнее запускать проект кнопкой с зеленым треугольником в выбранном браузере.

Для этого в свойствах проекта Visual Studio (вызов из контекстного меню проекта), на вкладке Общее указать загрузочный файл:
manage.py
и на вкладке Отладка выбрать режим запуска Веб-средство запуска Django. Далее, на этой же вкладке добавить в аргументы для Команды сервера отладки строку:
runserver %SERVER_PORT%
Запуск сервера на указанном номере порта.
runserver - команда запуска отладочного сервера,
%SERVER_PORT% - переменная сервера содержащее номер порта. Сервер выбирает свободный случайный порт и присваивает номер этой переменной. Такое действие позволяет осуществить гарантированный запуск веб-приложения. В случае указания фиксированного номера порта есть вероятность, что во время запуска сайта данный порт может быть занят.

Для разработок на локальном компьютере можно зафиксировать номер порта запуска веб-приложения. Делается это в свойствах же проекта Visual Studio на вкладке Отладка в строке URL-адрес запуска указанием номера порта после адреса: http://localhost:5000
Теперь сайт будет запускаться всегда на номере порта 5000, смотрите скриншот ниже.

Вот теперь можно запускать проект стандартной кнопкой запуска Visual Studio Веб-сервер (выбранный_браузер) с зеленым треугольником. Веб-приложения Django еще нет, но служебная страничка в браузере сообщит об успешной установке и настройке проекта Django. Далее предстоит еще работа над полноценным веб-сайтом.

Несмотря на такое объемное описание, созданный каркас проекта Visual Studio можно легко и быстро копировать для других экземпляров создаваемых веб-приложений Django. Пустой проект Django используется для создания веб-приложения, которое можно наполнить любыми желаемыми javascript и css компонентами.

Исходник веб-проекта Django

Для наглядного и быстрого тестирования данного веб-проекта на фреймворке Django ниже прикреплен архивный файл с его исходным кодом и необходимыми программными пакетами. Исходник проекта написан в MS Visual Studio 2022 на языке Python.

home = G:\MyProjects\Programming\Pythons\Python310_7
include-system-site-packages = false
version = 3.10.7