spdylay

mirror of https://github.com/moparisthebest/spdylay synced 2024-12-21 07:08:52 -05:00

History

Tatsuhiro Tsujikawa a4c7f17aa2 python: Escape '\' in server example code		2012-09-13 23:10:47 +09:00
..
cspdylay.pxd	python: add get_npn_protocols() function	2012-08-27 23:32:27 +09:00
Makefile.am	Add python wrapper to distribution	2012-08-28 22:07:43 +09:00
MANIFEST.in	python: add MANIFEST.in and README.rst	2012-08-25 00:18:17 +09:00
README.rst	python: update README.rst	2012-08-28 01:53:25 +09:00
setup.py	python: Escape '\' in server example code	2012-09-13 23:10:47 +09:00
spdyclient.py	python: document urlfetch	2012-08-28 01:47:21 +09:00
spdylay_tests.py	python: Don't raise exception from Session.resume_data()	2012-09-10 22:10:54 +09:00
spdylay.pyx	python: Bump up version number to 0.1.2	2012-09-12 22:38:10 +09:00
spdyserv.py	python: fix typo	2012-08-24 21:17:53 +09:00

README.rst

Python-spdylay is a Python SPDY library on top of Spdylay C
library. It supports SPDY/2 and SPDY/3 protocol.

It does not perform any I/O operations. When the library needs them,
it calls the callback functions provided by the application. It also
does not include any event polling mechanism, so the application can
freely choose the way of handling events.

It provides almost all API Spdylay provides with Pythonic fashion.

The core library API works with Python 2 and 3.  But
``ThreadedSPDYServer`` requires Python 3.3 because it uses TLS NPN
extension.

Installation
============

First install Spdylay library. You can grab a source distribution from
`sf.net download page
<http://sourceforge.net/projects/spdylay/files/stable/>`_
or `clone git repository <https://github.com/tatsuhiro-t/spdylay>`_.

See `Spdylay documentation
<http://spdylay.sourceforge.net/package_README.html>`_ for the
required packages and how to build Spdylay from git repository.

After Spdylay is installed, run ``build_ext`` command to build
extension module::

    $ python setup.py build_ext

If you installed Spdylay library in other than standard location, use
``--include-dirs`` and ``--library-dirs`` to specify header file and
library locations respectively.

Documentation
=============

See `python-spdylay documentation
<http://spdylay.sourceforge.net/python.html>`_.

Samples
=======

Here is a simple SPDY server::

    #!/usr/bin/env python

    # The example SPDY server. Python 3.3 or later is required because TLS
    # NPN is used in spdylay.ThreadedSPDYServer. Put private key and
    # certificate file in the current working directory.

    import spdylay

    # private key file
    KEY_FILE='server.key'
    # certificate file
    CERT_FILE='server.crt'

    class MySPDYRequestHandler(spdylay.BaseSPDYRequestHandler):

        def do_GET(self):
            self.send_response(200)
            self.send_header('content-type', 'text/html; charset=UTF-8')

            content = '''\
    <html>
    <head><title>SPDY FTW</title></head>
    <body>
    <h1>SPDY FTW</h1>
    <p>The age of HTTP/1.1 is over. The time of SPDY has come.</p>
    </body>
    </html>'''.encode('UTF-8')

            self.wfile.write(content)

    if __name__ == "__main__":
        HOST, PORT = "localhost", 3000

        server = spdylay.ThreadedSPDYServer((HOST, PORT),
                                            MySPDYRequestHandler,
                                            cert_file=CERT_FILE,
                                            key_file=KEY_FILE)
        server.start()

Here is a simple SPDY client::

    #!/usr/bin/env python

    # The example SPDY client.  You need Python 3.3 or later because we
    # use TLS NPN.
    #
    # Usage: spdyclient.py URL...
    #
    import sys
    import spdylay

    class MyStreamHandler(spdylay.BaseSPDYStreamHandler):
        def on_header(self, nv):
            sys.stdout.write('Stream#{}\n'.format(self.stream_id))
            for k, v in nv:
                sys.stdout.write('{}: {}\n'.format(k, v))

        def on_data(self, data):
            sys.stdout.write('Stream#{}\n'.format(self.stream_id))
            sys.stdout.buffer.write(data)

        def on_close(self, status_code):
            sys.stdout.write('Stream#{} closed\n'.format(self.stream_id))

    if __name__ == '__main__':
        uris = sys.argv[1:]
        spdylay.urlfetch(uris, MyStreamHandler)