WSGI server implemented in Rust.
Reason this release was yanked:
outdated release - please use the latest version
Project description
Pyruvate WSGI server
Pyruvate is a reasonably fast, multithreaded, non-blocking WSGI server implemented in Rust.
Features
Non-blocking read/write using mio
Request parsing using httparse
rust-cpython based Python interface
Worker pool based on threadpool
PasteDeploy entry point
Development Installation
Install Rust
Install and activate a Python 3 (> 3.5) virtualenv
Install setuptools_rust using pip:
$ pip install setuptools_rust
Install pyruvate, e.g. using pip:
$ pip install -e git+https://gitlab.com/tschorr/pyruvate.git#egg=pyruvate[test]
Using Pyruvate in your WSGI application
From Python
A hello world WSGI application using pyruvate listening on 127.0.0.1:7878 and using 2 worker threads looks like this:
import pyruvate
def application(environ, start_response):
"""Simplest possible application object"""
status = '200 OK'
response_headers = [('Content-type', 'text/plain')]
start_response(status, response_headers, None)
return [b"Hello world!\n"]
pyruvate.serve(application, "127.0.0.1:7878", 2)
Using PasteDeploy
Again listening on 127.0.0.1:7878 and using 2 worker threads:
[server:main] use = egg:pyruvate#main socket = 127.0.0.1:7878 workers = 2
Configuration Options
- socket
Required: The TCP socket Pyruvate should bind to. pyruvate also supports systemd socket activation If you specify None as the socket value, pyruvate will try to acquire a socket bound by systemd.
- workers
Required: Number of worker threads to use.
- write_blocking
Optional: Use a blocking connection for writing. Pyruvate currently supports two types of workers: The default worker will write in a non-blocking manner, registering WSGI responses for later processing if the socket isn’t available for writing immediately. By setting this option to True you can enable a worker that will instead set the connection into blocking mode for writing. Defaults to False.
- max_number_headers
Optional: Maximum number of request headers that will be parsed. If a request contains more headers than configured, request processing will stop with an error indicating an incomplete request. The default is 24 headers
- async_logging
Optional: Log asynchronously using a dedicated thread. Defaults to True.
Logging
Pyruvate uses the standard Python logging facility. The logger name is pyruvate. See the Python documentation (logging, logging.config) for configuration options.
Example Configurations
Django 2
After installing Pyruvate in your Django virtualenv, create or modify your wsgi.py file (one worker listening on 127.0.0.1:8000):
import os
import pyruvate
from django.core.wsgi import get_wsgi_application
os.environ.setdefault("DJANGO_SETTINGS_MODULE", "your_django_application.settings")
application = get_wsgi_application()
pyruvate.serve(application, "127.0.0.1:8000", 1)
You can now start Django + Pyruvate with:
$ python wsgi.py
Override settings by using the DJANGO_SETTINGS_MODULE environment variable when appropriate. Tested with Django 2.2.x.
MapProxy
First create a basic WSGI configuration following the MapProxy deployment documentation. Then modify config.py so it is using Pyruvate (2 workers listening on 127.0.0.1:8005):
from logging.config import fileConfig
import os.path
import pyruvate
fileConfig(r'/path/to/mapproxy/log.ini', {'here': os.path.dirname(__file__)})
from mapproxy.wsgiapp import make_wsgi_app
application = make_wsgi_app(r'/path/to/mapproxy/mapproxy.yml')
pyruvate.serve(application, "127.0.0.1:8005", 2)
Start from your virtualenv:
$ python config.py
Tested with Mapproxy 1.12.x.
Plone 5.2
Using zc.buildout and plone.recipe.zope2instance you can define an instance part using Pyruvate’s PasteDeploy <https://pastedeploy.readthedocs.io/en/latest/> _entry point:
[instance]
recipe = plone.recipe.zope2instance
http-address = 127.0.0.1:8080
eggs =
Plone
pyruvate
wsgi-ini-template = ${buildout:directory}/templates/pyruvate.ini.in
The server section of the template provided with the wsgi-ini-template option should look like this (3 workers listening on http-address as specified in the buildout [instance] part):
[server:main] use = egg:pyruvate#main socket = %(http_address)s workers = 3
Tested with Plone 5.2.x.
Pyramid
Install Pyruvate in your Pyramid virtualenv using pip:
$ pip install pyruvate
Modify the server section in your .ini file to use Pyruvate’s PasteDeploy <https://pastedeploy.readthedocs.io/en/latest/> _entry point (listening on 127.0.0.1:7878 and using 5 workers):
[server:main] use = egg:pyruvate#main socket = 127.0.0.1:7878 workers = 5
Start your application as usual using pserve:
$ pserve path/to/your/configfile.ini
Tested with Pyramid 1.10.x.
Nginx settings
Like other WSGI servers pyruvate should be used behind a reverse proxy, e.g. Nginx:
....
location / {
proxy_pass http://localhost:7878;
...
}
...
Changelog
0.8.2 (2020-11-17)
Fix blocksize handling for sendfile case
Format unix stream peer address
Use latest mio
0.8.1 (2020-11-10)
Receiver in non-blocking worker must not block when channel is empty
0.8.0 (2020-11-07)
Logging overhaul
New async_logging option
Some performance improvements
Support Python 3.9
Switch to manylinux2010 platform tag
0.7.1 (2020-09-16)
Raise Python exception when socket is unavailable
Add Pyramid configuration example in readme
0.7.0 (2020-08-30)
Use Python logging
Display server info on startup
Fix socket activation for unix domain sockets
0.6.2 (2020-08-12)
Improved logging
PasteDeploy entry point now also uses at most 24 headers by default
0.6.1 (2020-08-10)
Improve request parsing
Increase default maximum number of headers to 24
0.6.0 (2020-07-29)
Support unix domain sockets
Improve sendfile usage
0.5.3 (2020-07-15)
Fix testing for completed sendfile call in case of EAGAIN
0.5.2 (2020-07-15)
Fix testing for completed response in case of EAGAIN
Cargo update
0.5.1 (2020-07-07)
Fix handling of read events
Fix changelog
Cargo update
‘Interrupted’ error is not a todo
Remove unused code
0.5.0 (2020-06-07)
Add support for systemd socket activation
0.4.0 (2020-06-29)
Add a new worker that does nonblocking write
Add default arguments
Add option to configure maximum number of request headers
Add Via header
0.3.0 (2020-06-16)
Switch to rust-cpython
Fix passing of tcp connections to worker threads
0.2.0 (2020-03-10)
Added some Python tests (using py.test and tox)
Improve handling of HTTP headers
Respect content length header when using sendfile
0.1.0 (2020-02-10)
Initial release
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distributions
File details
Details for the file pyruvate-0.8.2.tar.gz.
File metadata
- Download URL: pyruvate-0.8.2.tar.gz
- Upload date:
- Size: 46.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.9.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 56a3bfdda064d70af3a24f09e7b85b7bef70c3f884be69121e227cdf9adf744d |
|
| MD5 | 4fa8216a60a54032aec893ee1124631c |
|
| BLAKE2b-256 | 47785fa966e84d499d09d6d3a06d502cb920bca1b2dae74d44751dca14807bc1 |
File details
Details for the file pyruvate-0.8.2-cp39-cp39-manylinux2010_x86_64.whl.
File metadata
- Download URL: pyruvate-0.8.2-cp39-cp39-manylinux2010_x86_64.whl
- Upload date:
- Size: 4.1 MB
- Tags: CPython 3.9, manylinux: glibc 2.12+ x86-64
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.9.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 9602f9dd7e081e780433cd4cd8b9348d594c0ea1e8b5fd8c4a5117beabbaa49a |
|
| MD5 | 2df3de7c09926ce39bbcb45794c44c22 |
|
| BLAKE2b-256 | b595a4130e247c0a5de83b0bf4856a15041dc5da8b7d2191e2712304d5c40b62 |
File details
Details for the file pyruvate-0.8.2-cp38-cp38-manylinux2010_x86_64.whl.
File metadata
- Download URL: pyruvate-0.8.2-cp38-cp38-manylinux2010_x86_64.whl
- Upload date:
- Size: 3.1 MB
- Tags: CPython 3.8, manylinux: glibc 2.12+ x86-64
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.9.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 2e8275fb250894cae7c830760e8c9607cfab5cdf88002fe709fc8b4f38832e42 |
|
| MD5 | 9de4a03853ec36bd48a4daedba5b8737 |
|
| BLAKE2b-256 | 5bacd334831474f7b64b23559b1ac7c84b98f1fa3a25ab772b6ca0145a8b2a24 |
File details
Details for the file pyruvate-0.8.2-cp37-cp37m-manylinux2010_x86_64.whl.
File metadata
- Download URL: pyruvate-0.8.2-cp37-cp37m-manylinux2010_x86_64.whl
- Upload date:
- Size: 1.0 MB
- Tags: CPython 3.7m, manylinux: glibc 2.12+ x86-64
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.9.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 014fe85db05648073834515d18b019b740501b8dfd49f1f904a1081e15fefb7f |
|
| MD5 | 5e718ba809d62793044c111f36d3a3d3 |
|
| BLAKE2b-256 | 3fe1195db7b735419fbe6c7679b73b37807f2c47f7a234674500b5a445457256 |
File details
Details for the file pyruvate-0.8.2-cp36-cp36m-manylinux2010_x86_64.whl.
File metadata
- Download URL: pyruvate-0.8.2-cp36-cp36m-manylinux2010_x86_64.whl
- Upload date:
- Size: 2.1 MB
- Tags: CPython 3.6m, manylinux: glibc 2.12+ x86-64
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.9.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 12620d188f266f32a6cc883c7db647bbb0df230bbfa16d129f2e67943e231ec2 |
|
| MD5 | 5b6b32d3fe239f86694f36cab2e15402 |
|
| BLAKE2b-256 | df59241470fe1d091fdce8abf49e47360ad8a895349ea3d2566591e1fc7a6370 |
