aioquic =======
.. image:: https://img.shields.io/pypi/l/aioquic.svg :target: https://pypi.python.org/pypi/aioquic :alt: License
.. image:: https://img.shields.io/pypi/v/aioquic.svg :target: https://pypi.python.org/pypi/aioquic :alt: Version
.. image:: https://img.shields.io/pypi/pyversions/aioquic.svg :target: https://pypi.python.org/pypi/aioquic :alt: Python versions
.. image:: https://github.com/aiortc/aioquic/workflows/tests/badge.svg :target: https://github.com/aiortc/aioquic/actions :alt: Tests
.. image:: https://img.shields.io/codecov/c/github/aiortc/aioquic.svg :target: https://codecov.io/gh/aiortc/aioquic :alt: Coverage
.. image:: https://readthedocs.org/projects/aioquic/badge/?version=latest :target: https://aioquic.readthedocs.io/ :alt: Documentation
What is `aioquic?
--------------------
aioquic is a library for the QUIC network protocol in Python. It features
a minimal TLS 1.3 implementation, a QUIC stack and an HTTP/3 stack.
aioquic is used by Python opensource projects such as dnspython_,
hypercorn_, mitmproxy_ and the Web Platform Tests_ cross-browser test
suite. It has also been used extensively in research papers about QUIC.
To learn more about aioquic please read the documentation_.
Why should I use aioquic?
-----------------------------
aioquic has been designed to be embedded into Python client and server
libraries wishing to support QUIC and / or HTTP/3. The goal is to provide a
common codebase for Python libraries in the hope of avoiding duplicated effort.
Both the QUIC and the HTTP/3 APIs follow the "bring your own I/O" pattern, leaving actual I/O operations to the API user. This approach has a number of advantages including making the code testable and allowing integration with different concurrency models.
A lot of effort has gone into writing an extensive test suite for the
aioquic code to ensure best-in-class code quality, and it is regularly
tested for interoperability_ against other QUIC implementations_.
Features --------
- minimal TLS 1.3 implementation conforming with RFC 8446
_ - QUIC stack conforming with RFC 9000
_ (QUIC v1) andRFC 9369_ (QUIC v2)
_
- HTTP/3 stack conforming with
RFC 9114_ * server push support
* WebSocket bootstrapping conforming with RFC 9220_
* datagram support conforming with RFC 9297_
Installing
----------
The easiest way to install
aioquic is to run:
.. code:: bash
pip install aioquic
Building from source
--------------------
If there are no wheels for your system or if you wish to build
aioquic
from source you will need a C compiler and the Python development headers.
On Debian/Ubuntu run:
.. code-block:: console
sudo apt install python3-dev
Running the examples
--------------------
aioquic comes with a number of examples illustrating various QUIC usecases.
You can browse these examples here: https://github.com/aiortc/aioquic/tree/main/examples
License
-------
aioquic is released under the BSD license`_.
.. _read the documentation: https://aioquic.readthedocs.io/en/latest/ .. _dnspython: https://github.com/rthalley/dnspython .. _hypercorn: https://github.com/pgjones/hypercorn .. _mitmproxy: https://github.com/mitmproxy/mitmproxy .. _Web Platform Tests: https://github.com/web-platform-tests/wpt .. _tested for interoperability: https://interop.seemann.io/ .. _QUIC implementations: https://github.com/quicwg/base-drafts/wiki/Implementations .. _cryptography: https://cryptography.io/ .. _BSD license: https://aioquic.readthedocs.io/en/latest/license.html .. _RFC 8446: https://datatracker.ietf.org/doc/html/rfc8446 .. _RFC 9000: https://datatracker.ietf.org/doc/html/rfc9000 .. _RFC 9114: https://datatracker.ietf.org/doc/html/rfc9114 .. _RFC 9220: https://datatracker.ietf.org/doc/html/rfc9220 .. _RFC 9297: https://datatracker.ietf.org/doc/html/rfc9297 .. _RFC 9368: https://datatracker.ietf.org/doc/html/rfc9368 .. _RFC 9369: https://datatracker.ietf.org/doc/html/rfc9369