122 lines
3.8 KiB
Plaintext
122 lines
3.8 KiB
Plaintext
Metadata-Version: 2.1
|
|
Name: Hypercorn
|
|
Version: 0.6.0
|
|
Summary: A ASGI Server based on Hyper libraries and inspired by Gunicorn.
|
|
Home-page: https://gitlab.com/pgjones/hypercorn/
|
|
Author: P G Jones
|
|
Author-email: philip.graham.jones@googlemail.com
|
|
License: MIT
|
|
Platform: UNKNOWN
|
|
Classifier: Development Status :: 3 - Alpha
|
|
Classifier: Environment :: Web Environment
|
|
Classifier: Intended Audience :: Developers
|
|
Classifier: License :: OSI Approved :: MIT License
|
|
Classifier: Operating System :: OS Independent
|
|
Classifier: Programming Language :: Python
|
|
Classifier: Programming Language :: Python :: 3
|
|
Classifier: Programming Language :: Python :: 3.7
|
|
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
|
|
Classifier: Topic :: Software Development :: Libraries :: Python Modules
|
|
Requires-Python: >=3.7
|
|
Requires-Dist: h11
|
|
Requires-Dist: h2 (>=3.1.0)
|
|
Requires-Dist: pytoml
|
|
Requires-Dist: typing-extensions
|
|
Requires-Dist: wsproto (>=0.14.0)
|
|
Provides-Extra: trio
|
|
Requires-Dist: trio (>=0.9.0) ; extra == 'trio'
|
|
Provides-Extra: uvloop
|
|
Requires-Dist: uvloop ; extra == 'uvloop'
|
|
|
|
Hypercorn
|
|
=========
|
|
|
|
.. image:: https://assets.gitlab-static.net/pgjones/hypercorn/raw/master/artwork/logo.png
|
|
:alt: Hypercorn logo
|
|
|
|
|Build Status| |docs| |pypi| |http| |python| |license|
|
|
|
|
Hypercorn is an `ASGI
|
|
<https://github.com/django/asgiref/blob/master/specs/asgi.rst>`_ web
|
|
server based on the sans-io hyper, `h11
|
|
<https://github.com/python-hyper/h11>`_, `h2
|
|
<https://github.com/python-hyper/hyper-h2>`_, and `wsproto
|
|
<https://github.com/python-hyper/wsproto>`_ libraries and inspired by
|
|
Gunicorn. Hypercorn supports HTTP/1, HTTP/2, WebSockets (over HTTP/1
|
|
and HTTP/2), ASGI/2, and ASGI/3 specifications. Hypercorn can utilise
|
|
asyncio, uvloop, or trio worker types.
|
|
|
|
Hypercorn was initially part of `Quart
|
|
<https://gitlab.com/pgjones/quart>`_ before being separated out into a
|
|
standalone ASGI server. Hypercorn forked from version 0.5.0 of Quart.
|
|
|
|
Quickstart
|
|
----------
|
|
|
|
Hypercorn can be installed via `pipenv
|
|
<https://docs.pipenv.org/install/#installing-packages-for-your-project>`_ or
|
|
`pip <https://docs.python.org/3/installing/index.html>`_,
|
|
|
|
.. code-block:: console
|
|
|
|
$ pipenv install hypercorn
|
|
$ pip install hypercorn
|
|
|
|
and requires Python 3.7.0 or higher.
|
|
|
|
With hypercorn installed ASGI frameworks (or apps) can be served via
|
|
Hypercorn via the command line,
|
|
|
|
.. code-block:: console
|
|
|
|
$ hypercorn module:app
|
|
|
|
Contributing
|
|
------------
|
|
|
|
Hypercorn is developed on `GitLab
|
|
<https://gitlab.com/pgjones/hypercorn>`_. You are very welcome to open
|
|
`issues <https://gitlab.com/pgjones/hypercorn/issues>`_ or propose
|
|
`merge requests
|
|
<https://gitlab.com/pgjones/hypercorn/merge_requests>`_.
|
|
|
|
Testing
|
|
~~~~~~~
|
|
|
|
The best way to test Hypercorn is with Tox,
|
|
|
|
.. code-block:: console
|
|
|
|
$ pipenv install tox
|
|
$ tox
|
|
|
|
this will check the code style and run the tests.
|
|
|
|
Help
|
|
----
|
|
|
|
The Hypercorn `documentation <https://pgjones.gitlab.io/hypercorn/>`_
|
|
is the best place to start, after that try opening an `issue
|
|
<https://gitlab.com/pgjones/hypercorn/issues>`_.
|
|
|
|
|
|
.. |Build Status| image:: https://gitlab.com/pgjones/hypercorn/badges/master/build.svg
|
|
:target: https://gitlab.com/pgjones/hypercorn/commits/master
|
|
|
|
.. |docs| image:: https://img.shields.io/badge/docs-passing-brightgreen.svg
|
|
:target: https://pgjones.gitlab.io/hypercorn/
|
|
|
|
.. |pypi| image:: https://img.shields.io/pypi/v/hypercorn.svg
|
|
:target: https://pypi.python.org/pypi/Hypercorn/
|
|
|
|
.. |http| image:: https://img.shields.io/badge/http-1.0,1.1,2-orange.svg
|
|
:target: https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol
|
|
|
|
.. |python| image:: https://img.shields.io/pypi/pyversions/hypercorn.svg
|
|
:target: https://pypi.python.org/pypi/Hypercorn/
|
|
|
|
.. |license| image:: https://img.shields.io/badge/license-MIT-blue.svg
|
|
:target: https://gitlab.com/pgjones/hypercorn/blob/master/LICENSE
|
|
|
|
|