Python wsgi http server for windows

Время на прочтение4 мин

Количество просмотров29K

Картинка с сайта: habr.com

В данной статье будет представлена подробная инструкция по установке и настройке программ Apache, Python и PostgreSQL для обеспечения работы Django проекта в ОС MS Windows. Django уже включает в себя упрощенный сервер разработки для локального тестирования кода, но для задач, связанных с продакшен, требуется более безопасный и мощный веб-сервер. Мы настроим mod_wsgi для взаимодействия с нашим проектом и настроим Apache в качестве шлюза в внешний мир.

Стоит отметить, что установка и настройка будет производиться в ОС MS Windows 10 с 32 разрядностью. Также 32 битная реакция будет универсальна и будет работать на 64 битной архитектуре. Если вам нужна 64 битная установка повторите те же действия для 64 битных дистрибутивов программ, последовательность действий будет идентична.

В качестве Django проекта будем использовать программу Severcart. Она предназначена для управления перемещениями картриджей, учёта печатающего оборудования и договоров поставки и обслуживания. Установка всех программ и модулей будет производиться в каталог C:\severcart. Местоположение не принципиально.

Python

Первым шагом является загрузка и установка Python с веб-сайта Python. Выбираем Windows в качестве операционной системы и 32-битную версию. На момент написания статьи текущей версией является 3.9.0rc2.

Загрузив файл установки, щелкните правой кнопкой мыши файл установки и выберите «Запуск от имени администратора». Вы должны увидеть экран ниже

Картинка с сайта: habr.com

Устанавливаем галочки напротив чекбоксов «Install launcher for add user (recomended)» и «Add Python 3.9 to PATH» и нажимаем на «Customize installation».

Картинка с сайта: habr.com

Устанавливаем галочки на против «pip», «py launcher», «for all users (requires elevation)» и нажимаем «Next».

Картинка с сайта: habr.com

Выбираем все поля ввода как на картинке выше и нажимаем на «Install».

Картинка с сайта: habr.com

Чтобы убедиться, что установка прошла успешно, откройте cmd и введите python. Если установка прошла успешно, вы должны увидеть приглашение, подобный приведенному ниже

Картинка с сайта: habr.com

Устанавливаем mod_wsgi

Скачиваем скомпилированный пакет с mod_wsgi c сайта
www.lfd.uci.edu/~gohlke/pythonlibs. Модуль выполняет функции посредника межу сервером Apache и Django проектом. Самый свежий пакет будет с именем mod_wsgi-4.7.1-cp39-cp39-win32.whl. Обратите внимание, что пакет скомпилирован для 32 битной Windows CPython версии 3.9. Также стоит отметить, что очевидная установка модуля pip install mod_wsgi скорее всего завершится ошибкой, т.к. в процессе установки потребуется компилятор Visual Studio C++. Ставить компилятор целиком ради одного Python пакета в Windows считаем нецелесообразным.

Устанавливаем модуль с помощью стандартного пакетного менеджера pip в cmd или powershell:

pip install -U mod_wsgi-4.7.1-cp39-cp39-win32.whl

Картинка с сайта: habr.com

Apache

Скачиваем дистрибутив с сайта https://www.apachelounge.com/download/.
Самая свежая версия Web-сервера является Apache 2.4.46 win32 VS16. Также для работы программы понадобиться заранее установленный пакет «Visual C++ Redistributable for Visual Studio 2019 x86».

Распаковываем дистрибутив Apache в каталог C:\severcart\Apache24, далее меняем строку с номером 37 на свою

Define SRVROOT "C:/severcart/Apache24"

Проверяем работу Apache, выполнив в командной строке

C:/severcart/Apache24/bin> httpd.exe

В результате должны увидеть в браузере по адресу 127.0.0.1 строку «It works!».

Картинка с сайта: habr.com

Устанавливаем службу Apache, для этого выполним в командной строке от имени Администратора инструкцию:

C:\severcart\Apache24\bin>httpd.exe -k install -n "Apache24"

Далее подключим модуль mod_wsgi к Apache. Для этого выполним в командной строке инструкцию

C:\Windows\system32>mod_wsgi-express module-config

В результате в стандартный вывод будет распечатаны строки:

LoadFile "c:/severcart/python/python39.dll"
LoadModule wsgi_module "c:/severcart/python/lib/site-packages/mod_wsgi/server/mod_wsgi.cp39-win32.pyd"
WSGIPythonHome "c:/severcart/python"

Создаем файл C:\severcart\Apache24\conf\extra\httpd-wsgi.conf и копипастим туда распечатанные строки выше.

Подключаем новую конфигурацию к основному файлу httpd.conf
Include conf/extra/httpd-wsgi.conf

Сохраняем изменения, перезагружаем службы Apache

Net stop Apache24
Net start Apache24

PostgreSQL

Устанавливаем PostgreSQL взятый с сайта https://postgrespro.ru/windows. Текущая версия программного продукта – 12. Преимущества Российского дистрибутива от канонического представлены на том же сайте.

Картинка с сайта: habr.com

Картинка с сайта: habr.com

Картинка с сайта: habr.com

Картинка с сайта: habr.com

Картинка с сайта: habr.com

Картинка с сайта: habr.com

Картинка с сайта: habr.com

Картинка с сайта: habr.com

Картинка с сайта: habr.com

Действия по установке представлены выше и комментариях не нуждаются. Установка крайне проста.

Создаем БД в postgres, где потом будут храниться структуры данных Django проекта

C:\severcart\postgresql\bin>psql -h 127.0.0.1 -U postgres -W

CREATE DATABASE severcart WITH ENCODING='UTF8' OWNER=postgres CONNECTION LIMIT=-1 template=template0;

Картинка с сайта: habr.com

БД создана. Теперь разворачиваем Django проект.

Устанавливаем web приложение

Для этого скачиваем zip архив с сайта https://www.severcart.ru/downloads/ и распаковываем в каталог C:\severcart\app\

Картинка с сайта: habr.com

Вносим изменения в главный конфигурационный файл C:\severcart\app\conf\settings_prod.py для указания реквизитов подключения к БД

Картинка с сайта: habr.com

Python словарь DATABASES содержит в себе реквизиты подключения к БД. Подробности по настройке читайте здесь https://docs.djangoproject.com/en/3.1/ref/databases/#connecting-to-the-database

Устанавливаем Python пакеты значимостей для работы приложений внутри Django проекта

C:\severcart\app\tkinstaller>python install.py

Картинка с сайта: habr.com

В процессе работы скрипта будет произведена инициализация БД таблицами, констрейтами, индексами и прочим, а будет предложено создать пользователя, от имени которого будет производиться работа в программе.

Подключаем Django приложение к серверу Apache для этого дополняем конфигурационный файл
httpd-wsgi.conf следующим текстом

Alias /static "c:/severcart/app/static"

Alias /media "c:/severcart/app/media"

<Directory "c:/severcart/app/static">
    # for Apache 2.4
    Options Indexes FollowSymLinks
    AllowOverride None
    Require all granted
</Directory>

<Directory "c:/severcart/app/media">
    # for Apache 2.4
    Options Indexes FollowSymLinks
    AllowOverride None
    Require all granted
</Directory>


WSGIScriptAlias / "c:/severcart/app/conf/wsgi_prod.py"
WSGIPythonPath "c:/severcart/python/"

<Directory "c:/severcart/app/conf/">
<Files wsgi_prod.py>
    Require all granted
</Files>   
</Directory>

Перезагружаем службу Apache и проверяем работу приложения

Картинка с сайта: habr.com

На этом все. Спасибо что дочитали.

В следующей статье будем создавать установочный самораспаковывающийся архив в InnoSetup для быстрого развертывания Django проекта на компьютере заказчика. Для тех кто хочет повторить все действия на Яндекс.Диск загружены все используемые дистрибутивы.

Introduction

WSGI is the standard for running Python web applications.
Gunicorn and uWSGI are great options for running WSGI apps, but they only have limited support in Windows or no support at all.
Waitress is another option for running WSGI applications and it really shines in Windows because it is written purely in Python with no other dependencies. I will show you how to use Waitress to serve web application using Python WSGI.

Selling points for Waitress:

• Production quality
• Well documented
• Easy to install
• Portable, with no dependencies except Python standard library so it runs in Windows
• Part of the trusted Pylons project
• Licensed for Freedom with Zope Public License

Setup

You will need Python installed.
I recommend using a virtual environment. If you don’t know how to create and use
Python virtual environments, check out my tutorial
Python Virtual Environments Tutorial.

You will need to install the Waitress package for Python which is easily done with pip:

python -m pip install waitress

If you want to install manually, get the source code from https://github.com/Pylons/waitress and run setup.py from the root directory:

python setup.py install

Running

You have two primary options for running Waitress. You can use the command-line tool waitress-serve
or you can import Waitress in to a Python script and run it from there. They are essentially the
same and you can pick the option that works best for your project.

Full usage information can be found in the official documentation but I will demonstrate the most common example from my experience.

Waitress supports using a UNIX sockets, although the examples here use TCP.

Command line

After installing the Waitress package, it will create a command-line sript named waitress-serve.
The full options for running can be reviewed if you run waitress-serve with no options.

# Print usage
waitress-serve

Waitress is packaged well and also has a __main__.py in the source code, so you
can also execute the same CLI tool using python3 -m waitress like this:

# Equivalent to `waitress-serve`
python3 -m waitress
# Or from a specific virtual environment
/path/to/venv/bin/python -m waitress

In this next example, it pretends
there is a file named my_wsgi_project.py with an object named app like
a typical Flask web application. The URL prefix is optional, but is useful
when you are serving the application on a sub-directory like behind a reverse-proxy.
It will listen on localhost port 8001.

waitress-serve --url-prefix=/my-app --listen=127.0.0.1:8001 my_wsgi_project:app 

In Python

This example will change the current working directory to the directory
that the Python script resides in. In this example, it pretends
there is a file named my_wsgi_project.py with an object named app like
a typical Flask web application.

It will serve on IPv4 for localhost only on port 8001.

# run.py
import os
from waitress import serve
from my_wsgi_project import app  # Import your app

# Run from the same directory as this script
this_files_dir = os.path.dirname(os.path.abspath(__file__))
os.chdir(this_files_dir)

# `url_prefix` is optional, but useful if you are serving app on a sub-dir
# behind a reverse-proxy.
serve(app, host='127.0.0.1', port=8001, url_prefix='/my-app')

As a Service

If you want to run your application so it runs when the computer restarts and always stays up, you
need to create a service.

Linux Service

For Linux users, check out my tutorial Creating Systemd Service Files.

Here is a simple example:

# /etc/systemd/system/my_app.service
[Unit]
Description=My WSGI app
After=network.target

[Service]
Type=simple
User=nanodano
WorkingDirectory=/home/nanodano
ExecStart=/path/to/venv/bin/waitress-serve --listen=127.0.0.1:8001 app.wsgi:application
Restart=always

[Install]
WantedBy=multi-user.target

Windows Service

For Windows users, check out my tutorial Run Python Script as Windows Service.

Here is a simple example of registering your app as a Windows service using nssm.

nssm.exe install "MyCustomService" "C:\opt\venv\Scripts\python.exe" "C:\opt\run.py"

Behind Nginx reverse-proxy

Frequently you need to serve multiple web applications on a single server using the same port.
The solution is to use a reverse-proxy like Nginx.
This allows you to create virtual hosts, serve static files, and serve multiple WSGI applications at once.

To learn how to setup Nginx as a reverse-proxy to serve WSGI applications and handle other things like redirection, SSL, authentication, and more, check out my Nginx Tutorial.

Here is a simple example of a reverse proxy with Nginx using SSL:

http {
    server {
        listen 443 ssl;

        ssl_certificate /path/to/cert.pem
        ssl_certificate_key /path/to/private-key.pem
        ssl_ciphers  HIGH:!aNULL:!MD5;

        server_name example.com;

        location /static/ {
            alias /var/www/static-content/;
        }

        location / {
            proxy_pass http://localhost:9999/;
            proxy_set_header X-Real-IP $remote_addr;
        }
    }
}

Conclusion

After reading this you should understand how to run a Python WSGI application using Waitress and when Waitress would be a good option over Gunicorn or uWSGI.
You should understand how to do it from within Python and from the command-line.

References

• Python
• Waitress Documentation
• Waitress source code
• Zope Public License
• Gunicorn
• uWSGI
• Python Virtual Environments Tutorial
• Creating Linux Systemd Service Files.
• Run Python Script as Windows Service
• nssm
• Nginx
• Nginx Tutorial