Socket
Socket
Sign inDemoInstall

sanic_compress

Package Overview
Dependencies
0
Maintainers
1
Alerts
File Explorer

Install Socket

Detect and block malicious and high-risk dependencies

Install

sanic_compress

An extension which allows you to easily gzip your Sanic responses.

    0.1.1

Maintainers
1

Readme

sanic_compress

sanic_compress is an extension which allows you to easily gzip your Sanic responses. It is a port of the Flask-Compress <https://github.com/libwilliam/flask-compress>__ extension.

Installation

Install with pip:

pip install sanic_compress

Usage

Usage is simple. Simply pass in the Sanic app object to the Compress class, and responses will be gzipped.

.. code:: python

from sanic import Sanic
from sanic_compress import Compress

app = Sanic(__name__)
Compress(app)

Alternatively, if you want to initialize the Compress class later, you can do so with the init_app method;

.. code:: python

compress = Compress()
app = Flask(__name__)
compress.init_app(app)

Options

Within the Sanic application config you can provide the following settings to control the behavior of sanic_compress. None of the settings are required.

COMPRESS_MIMETYPES: Set the list of mimetypes to compress here. - Default: ['text/html','text/css','text/xml','application/json','application/javascript']

COMPRESS_LEVEL: Specifies the gzip compression level (1-9). - Default: 6

COMPRESS_MIN_SIZE: Specifies the minimum size (in bytes) threshold for compressing responses. - Default: 500

A higher COMPRESS_LEVEL will result in a gzipped response that is smaller, but the compression will take longer.

Example of using custom configuration:

.. code:: python

from sanic import Sanic
from sanic_compress import Compress

app = Sanic(__name__)
app.config['COMPRESS_MIMETYPES'] = set(['text/html', 'application/json'])
app.config['COMPRESS_LEVEL'] = 4
app.config['COMPRESS_MIN_SIZE'] = 300
Compress(app)

Note about gzipping static files:


Sanic is not at heart a file server. You should consider serving static
files with nginx or on a separate file server.

Keywords

FAQs


Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc