File: index.rst

package info (click to toggle)
python-hpack 4.0.0-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 444 kB
  • sloc: python: 5,866; makefile: 25
file content (38 lines) | stat: -rw-r--r-- 1,052 bytes parent folder | download | duplicates (16)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
hpack: HTTP/2 Header Compression for Python
===========================================

hpack provides a simple Python interface to the `HPACK`_ compression algorithm,
used to compress HTTP headers in HTTP/2. Used by some of the most popular
HTTP/2 implementations in Python, HPACK offers a great Python interface as well
as optional upgrade to optimised C-based compression routines from `nghttp2`_.

Using hpack is easy:

.. code-block:: python

    from hpack import Encoder, Decoder

    e = Encoder()
    encoded_bytes = e.encode(headers)

    d = Decoder()
    decoded_headers = d.decode(encoded_bytes)

hpack will transparently use nghttp2 on CPython if it's available, gaining even
better compression efficiency and speed, but it also makes available a
pure-Python implementation that conforms strictly to `RFC 7541`_.

Contents
--------

.. toctree::
   :maxdepth: 2

   installation
   api
   security/index


.. _HPACK: https://tools.ietf.org/html/rfc7541
.. _nghttp2: https://nghttp2.org/
.. _RFC 7541: https://tools.ietf.org/html/rfc7541