Deprecate Python bindings

This commit is contained in:
Tatsuhiro Tsujikawa 2022-07-05 18:54:55 +09:00
parent 78cb0008d3
commit 97a5ca584b
2 changed files with 8 additions and 4 deletions

View File

@ -11,9 +11,6 @@ HTTP/2.
An HPACK encoder and decoder are available as a public API. An HPACK encoder and decoder are available as a public API.
We have Python bindings of this library, but we do not have full
code coverage yet.
Development Status Development Status
------------------ ------------------
@ -110,7 +107,7 @@ packages:
* libboost-dev >= 1.54.0 * libboost-dev >= 1.54.0
* libboost-thread-dev >= 1.54.0 * libboost-thread-dev >= 1.54.0
The Python bindings require the following packages: The Python bindings (deprecated) require the following packages:
* cython >= 0.19 * cython >= 0.19
* python >= 3.8 * python >= 3.8
@ -1532,6 +1529,8 @@ For more details, see the documentation of libnghttp2_asio.
Python bindings Python bindings
--------------- ---------------
Python bindings have been deprecated.
The ``python`` directory contains nghttp2 Python bindings. The The ``python`` directory contains nghttp2 Python bindings. The
bindings currently provide HPACK compressor and decompressor classes bindings currently provide HPACK compressor and decompressor classes
and an HTTP/2 server. and an HTTP/2 server.

View File

@ -1,6 +1,11 @@
Python API Reference Python API Reference
==================== ====================
.. warning::
Python bindings have been deprecated due to maintenance issue. It
will not get any updates. It will be removed at the end of 2022.
.. py:module:: nghttp2 .. py:module:: nghttp2
nghttp2 offers some high level Python API to C library. The bindings nghttp2 offers some high level Python API to C library. The bindings