rename fork package from aioquic to qh3 (#3)

.github/workflows/tests.yml

@@ -171,6 +171,9 @@ jobs:
   publish:
     runs-on: ubuntu-latest
     needs: [lint, test, package-source, package-wheel]
+    environment:
+      name: pypi
+      url: https://pypi.org/project/qh3/
     steps:
       - uses: actions/checkout@v3
       - uses: actions/download-artifact@v3
@@ -180,6 +183,3 @@ jobs:
       - name: Publish to PyPI
         if: startsWith(github.event.ref, 'refs/tags/')
         uses: pypa/gh-action-pypi-publish@master
-        with:
-          user: __token__
-          password: ${{ secrets.PYPI_TOKEN }}

MANIFEST.in

@@ -1,5 +1,4 @@
-include LICENSE
+include LICENSE src/qh3/py.typed
 recursive-include docs *.py *.rst Makefile
-recursive-include examples *.css *.html *.py *.txt
 recursive-include tests *.bin *.pem *.py
 recursive-include vendor *

README.rst

@@ -1,5 +1,5 @@
-aioquic
-=======
+qh3
+===
 
 |rtd| |pypi-v| |pypi-pyversions| |pypi-l| |tests| |codecov| |black|
 
@@ -24,8 +24,15 @@ aioquic
 .. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
     :target: https://github.com/python/black
 
-What is ``aioquic``?
---------------------
+What is ``qh3``?
+----------------
+
+``qh3`` is a fork of the awesome ``aioquic`` library pending its author return.
+Important changes / improvements are:
+- Made abi3 compatible, no need to build the wheel all over again on each interpreter version.
+- Only one dependency left! Cryptography will remain as long as Python does not ship with proper QUIC implementation.
+- Mitigated deprecated match_hostname.
+- Mimic load_default_certs ssl context.
 
 ``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.

docs/asyncio.rst

@@ -13,7 +13,7 @@ The examples can be browsed on GitHub:
 
 https://github.com/aiortc/aioquic/tree/main/examples
 
-.. automodule:: aioquic.asyncio
+.. automodule:: qh3.asyncio
 
 Client
 ------

docs/conf.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 #
-# aioquic documentation build configuration file, created by
+# qh3 documentation build configuration file, created by
 # sphinx-quickstart on Thu Feb  8 17:22:14 2018.
 #
 # This file is execfile()d with the current directory set to its
@@ -54,7 +54,7 @@
 master_doc = 'index'
 
 # General information about the project.
-project = 'aioquic'
+project = 'qh3'
 copyright = u'2019, Jeremy Lainé'
 author = u'Jeremy Lainé'
 
@@ -100,9 +100,9 @@
 html_theme_options = {
     'description': 'A library for QUIC in Python.',
     'github_button': True,
-    'github_user': 'aiortc',
-    'github_repo': 'aioquic',
-    'logo': 'aioquic.svg',
+    'github_user': 'Ousret',
+    'github_repo': 'qh3',
+    'logo': 'qh3.svg',
 }
 
 # Add any paths that contain custom static files (such as style sheets) here,
@@ -155,7 +155,7 @@
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'aioquic.tex', 'aioquic Documentation',
+    (master_doc, 'qh3.tex', 'qh3 Documentation',
      author, 'manual'),
 ]
 
@@ -165,7 +165,7 @@
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    (master_doc, 'aioquic', 'aioquic Documentation',
+    (master_doc, 'qh3', 'qh3 Documentation',
      [author], 1)
 ]
 
@@ -176,7 +176,7 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'aioquic', 'aioquic Documentation',
-     author, 'aioquic', 'One line description of project.',
+    (master_doc, 'qh3', 'qh3 Documentation',
+     author, 'qh3', 'One line description of project.',
      'Miscellaneous'),
 ]

docs/h3.rst

@@ -8,7 +8,7 @@ the concurrency model you are using.
 Connection
 ----------
 
-.. automodule:: aioquic.h3.connection
+.. automodule:: qh3.h3.connection
 
     .. autoclass:: H3Connection
         :members:
@@ -17,7 +17,7 @@ Connection
 Events
 ------
 
-.. automodule:: aioquic.h3.events
+.. automodule:: qh3.h3.events
 
     .. autoclass:: H3Event
         :members:
@@ -41,7 +41,7 @@ Events
 Exceptions
 ----------
 
-.. automodule:: aioquic.h3.exceptions
+.. automodule:: qh3.h3.exceptions
 
     .. autoclass:: H3Error
         :members:

docs/quic.rst

@@ -8,7 +8,7 @@ the concurrency model you are using.
 Connection
 ----------
 
-.. automodule:: aioquic.quic.connection
+.. automodule:: qh3.quic.connection
 
     .. autoclass:: QuicConnection
         :members:
@@ -17,20 +17,20 @@ Connection
 Configuration
 -------------
 
-.. automodule:: aioquic.quic.configuration
+.. automodule:: qh3.quic.configuration
 
     .. autoclass:: QuicConfiguration
         :members:
 
-.. automodule:: aioquic.quic.logger
+.. automodule:: qh3.quic.logger
 
     .. autoclass:: QuicLogger
         :members:
 
 Events
 ------
 
-.. automodule:: aioquic.quic.events
+.. automodule:: qh3.quic.events
 
     .. autoclass:: QuicEvent
         :members:

examples/doq_client.py

@@ -6,12 +6,12 @@
 import struct
 from typing import Optional, cast
 
-from aioquic.asyncio.client import connect
-from aioquic.asyncio.protocol import QuicConnectionProtocol
-from aioquic.quic.configuration import QuicConfiguration
-from aioquic.quic.events import QuicEvent, StreamDataReceived
-from aioquic.quic.logger import QuicFileLogger
 from dnslib.dns import QTYPE, DNSHeader, DNSQuestion, DNSRecord
+from qh3.asyncio.client import connect
+from qh3.asyncio.protocol import QuicConnectionProtocol
+from qh3.quic.configuration import QuicConfiguration
+from qh3.quic.events import QuicEvent, StreamDataReceived
+from qh3.quic.logger import QuicFileLogger
 
 logger = logging.getLogger("client")
 

examples/doq_server.py

@@ -4,12 +4,12 @@
 import struct
 from typing import Dict, Optional
 
-from aioquic.asyncio import QuicConnectionProtocol, serve
-from aioquic.quic.configuration import QuicConfiguration
-from aioquic.quic.events import QuicEvent, StreamDataReceived
-from aioquic.quic.logger import QuicFileLogger
-from aioquic.tls import SessionTicket
 from dnslib.dns import DNSRecord
+from qh3.asyncio import QuicConnectionProtocol, serve
+from qh3.quic.configuration import QuicConfiguration
+from qh3.quic.events import QuicEvent, StreamDataReceived
+from qh3.quic.logger import QuicFileLogger
+from qh3.tls import SessionTicket
 
 
 class DnsServerProtocol(QuicConnectionProtocol):

examples/http3_client.py

@@ -9,23 +9,23 @@
 from typing import BinaryIO, Callable, Deque, Dict, List, Optional, Union, cast
 from urllib.parse import urlparse
 
-import aioquic
+import qh3
 import wsproto
 import wsproto.events
-from aioquic.asyncio.client import connect
-from aioquic.asyncio.protocol import QuicConnectionProtocol
-from aioquic.h0.connection import H0_ALPN, H0Connection
-from aioquic.h3.connection import H3_ALPN, ErrorCode, H3Connection
-from aioquic.h3.events import (
+from qh3.asyncio.client import connect
+from qh3.asyncio.protocol import QuicConnectionProtocol
+from qh3.h0.connection import H0_ALPN, H0Connection
+from qh3.h3.connection import H3_ALPN, ErrorCode, H3Connection
+from qh3.h3.events import (
     DataReceived,
     H3Event,
     HeadersReceived,
     PushPromiseReceived,
 )
-from aioquic.quic.configuration import QuicConfiguration
-from aioquic.quic.events import QuicEvent
-from aioquic.quic.logger import QuicFileLogger
-from aioquic.tls import CipherSuite, SessionTicket
+from qh3.quic.configuration import QuicConfiguration
+from qh3.quic.events import QuicEvent
+from qh3.quic.logger import QuicFileLogger
+from qh3.tls import CipherSuite, SessionTicket
 
 try:
     import uvloop
@@ -36,7 +36,7 @@
 
 HttpConnection = Union[H0Connection, H3Connection]
 
-USER_AGENT = "aioquic/" + aioquic.__version__
+USER_AGENT = "qh3/" + qh3.__version__
 
 
 class URL:

examples/http3_server.py

@@ -7,24 +7,24 @@
 from email.utils import formatdate
 from typing import Callable, Deque, Dict, List, Optional, Union, cast
 
-import aioquic
+import qh3
 import wsproto
 import wsproto.events
-from aioquic.asyncio import QuicConnectionProtocol, serve
-from aioquic.h0.connection import H0_ALPN, H0Connection
-from aioquic.h3.connection import H3_ALPN, H3Connection
-from aioquic.h3.events import (
+from qh3.asyncio import QuicConnectionProtocol, serve
+from qh3.h0.connection import H0_ALPN, H0Connection
+from qh3.h3.connection import H3_ALPN, H3Connection
+from qh3.h3.events import (
     DatagramReceived,
     DataReceived,
     H3Event,
     HeadersReceived,
     WebTransportStreamDataReceived,
 )
-from aioquic.h3.exceptions import NoAvailablePushIDError
-from aioquic.quic.configuration import QuicConfiguration
-from aioquic.quic.events import DatagramFrameReceived, ProtocolNegotiated, QuicEvent
-from aioquic.quic.logger import QuicFileLogger
-from aioquic.tls import SessionTicket
+from qh3.h3.exceptions import NoAvailablePushIDError
+from qh3.quic.configuration import QuicConfiguration
+from qh3.quic.events import DatagramFrameReceived, ProtocolNegotiated, QuicEvent
+from qh3.quic.logger import QuicFileLogger
+from qh3.tls import SessionTicket
 
 try:
     import uvloop
@@ -34,7 +34,7 @@
 AsgiApplication = Callable
 HttpConnection = Union[H0Connection, H3Connection]
 
-SERVER_NAME = "aioquic/" + aioquic.__version__
+SERVER_NAME = "qh3/" + qh3.__version__
 
 
 class HttpRequestHandler:

examples/httpx_client.py

@@ -10,13 +10,13 @@
 from urllib.parse import urlparse
 
 import httpx
-from aioquic.asyncio.client import connect
-from aioquic.asyncio.protocol import QuicConnectionProtocol
-from aioquic.h3.connection import H3_ALPN, H3Connection
-from aioquic.h3.events import DataReceived, H3Event, Headers, HeadersReceived
-from aioquic.quic.configuration import QuicConfiguration
-from aioquic.quic.events import QuicEvent
-from aioquic.quic.logger import QuicFileLogger
+from qh3.asyncio.client import connect
+from qh3.asyncio.protocol import QuicConnectionProtocol
+from qh3.h3.connection import H3_ALPN, H3Connection
+from qh3.h3.events import DataReceived, H3Event, Headers, HeadersReceived
+from qh3.quic.configuration import QuicConfiguration
+from qh3.quic.events import QuicEvent
+from qh3.quic.logger import QuicFileLogger
 
 logger = logging.getLogger("client")
 

examples/interop.py

@@ -14,13 +14,13 @@
 from typing import Optional, cast
 
 import httpx
-from aioquic.asyncio import connect
-from aioquic.h0.connection import H0_ALPN
-from aioquic.h3.connection import H3_ALPN, H3Connection
-from aioquic.h3.events import DataReceived, HeadersReceived, PushPromiseReceived
-from aioquic.quic.configuration import QuicConfiguration
-from aioquic.quic.logger import QuicFileLogger, QuicLogger
 from http3_client import HttpClient
+from qh3.asyncio import connect
+from qh3.h0.connection import H0_ALPN
+from qh3.h3.connection import H3_ALPN, H3Connection
+from qh3.h3.events import DataReceived, HeadersReceived, PushPromiseReceived
+from qh3.quic.configuration import QuicConfiguration
+from qh3.quic.logger import QuicFileLogger, QuicLogger
 
 
 class Result(Flag):
@@ -82,9 +82,7 @@ class Server:
 
 SERVERS = [
     Server("akamaiquic", "ietf.akaquic.com", port=443, verify_mode=ssl.CERT_NONE),
-    Server(
-        "aioquic", "quic.aiortc.org", port=443, push_path="/", structured_logging=True
-    ),
+    Server("qh3", "quic.aiortc.org", port=443, push_path="/", structured_logging=True),
     Server("ats", "quic.ogre.com"),
     Server("f5", "f5quic.com", retry_port=4433, throughput_path=None),
     Server(

examples/siduck_client.py

@@ -4,11 +4,11 @@
 import ssl
 from typing import Optional, cast
 
-from aioquic.asyncio.client import connect
-from aioquic.asyncio.protocol import QuicConnectionProtocol
-from aioquic.quic.configuration import QuicConfiguration
-from aioquic.quic.events import DatagramFrameReceived, QuicEvent
-from aioquic.quic.logger import QuicFileLogger
+from qh3.asyncio.client import connect
+from qh3.asyncio.protocol import QuicConnectionProtocol
+from qh3.quic.configuration import QuicConfiguration
+from qh3.quic.events import DatagramFrameReceived, QuicEvent
+from qh3.quic.logger import QuicFileLogger
 
 logger = logging.getLogger("client")