File: PKG-INFO

package info (click to toggle)
python-websockets 7.0-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, buster, sid
  • size: 332 kB
  • sloc: python: 2,396; ansic: 85; makefile: 6
file content (159 lines) | stat: -rw-r--r-- 7,039 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
Metadata-Version: 1.2
Name: websockets
Version: 7.0
Summary: An implementation of the WebSocket Protocol (RFC 6455 & 7692)
Home-page: https://github.com/aaugustin/websockets
Author: Aymeric Augustin
Author-email: aymeric.augustin@m4x.org
License: BSD
Description: WebSockets
        ==========
        
        |rtd| |pypi-v| |pypi-pyversions| |pypi-l| |pypi-wheel| |circleci| |codecov|
        
        .. |rtd| image:: https://readthedocs.org/projects/websockets/badge/?version=latest
           :target: https://websockets.readthedocs.io/
        
        .. |pypi-v| image:: https://img.shields.io/pypi/v/websockets.svg
            :target: https://pypi.python.org/pypi/websockets
        
        .. |pypi-pyversions| image:: https://img.shields.io/pypi/pyversions/websockets.svg
            :target: https://pypi.python.org/pypi/websockets
        
        .. |pypi-l| image:: https://img.shields.io/pypi/l/websockets.svg
            :target: https://pypi.python.org/pypi/websockets
        
        .. |pypi-wheel| image:: https://img.shields.io/pypi/wheel/websockets.svg
            :target: https://pypi.python.org/pypi/websockets
        
        .. |circleci| image:: https://img.shields.io/circleci/project/github/aaugustin/websockets.svg
           :target: https://circleci.com/gh/aaugustin/websockets
        
        .. |codecov| image:: https://codecov.io/gh/aaugustin/websockets/branch/master/graph/badge.svg
            :target: https://codecov.io/gh/aaugustin/websockets
        
        What is ``websockets``?
        -----------------------
        
        ``websockets`` is a library for building WebSocket servers_ and clients_ in
        Python with a focus on correctness and simplicity.
        
        .. _servers: https://github.com/aaugustin/websockets/blob/master/example/server.py
        .. _clients: https://github.com/aaugustin/websockets/blob/master/example/client.py
        
        Built on top of ``asyncio``, Python's standard asynchronous I/O framework, it
        provides an elegant coroutine-based API.
        
        Here's a client that says "Hello world!":
        
        .. copy-pasted because GitHub doesn't support the include directive
        
        .. code:: python
        
            #!/usr/bin/env python
        
            import asyncio
            import websockets
        
            async def hello(uri):
                async with websockets.connect(uri) as websocket:
                    await websocket.send("Hello world!")
        
            asyncio.get_event_loop().run_until_complete(
                hello('ws://localhost:8765'))
        
        And here's an echo server (for Python ≥ 3.6):
        
        .. code:: python
        
            #!/usr/bin/env python
        
            import asyncio
            import websockets
        
            async def echo(websocket, path):
                async for message in websocket:
                    await websocket.send(message)
        
            asyncio.get_event_loop().run_until_complete(
                websockets.serve(echo, 'localhost', 8765))
            asyncio.get_event_loop().run_forever()
        
        Does that look good? `Start here`_.
        
        .. _Start here: https://websockets.readthedocs.io/en/stable/intro.html
        
        Why should I use ``websockets``?
        --------------------------------
        
        The development of ``websockets`` is shaped by four principles:
        
        1. **Simplicity**: all you need to understand is ``msg = await ws.recv()`` and
           ``await ws.send(msg)``; ``websockets`` takes care of managing connections
           so you can focus on your application.
        
        2. **Robustness**: ``websockets`` is built for production; for example it was
           the only library to `handle backpressure correctly`_ before the issue
           became widely known in the Python community.
        
        3. **Quality**: ``websockets`` is heavily tested. Continuous integration fails
           under 100% branch coverage. Also it passes the industry-standard `Autobahn
           Testsuite`_.
        
        4. **Performance**: memory use is configurable. An extension written in C
           accelerates expensive operations. It's pre-compiled for Linux, macOS and
           Windows and packaged in the wheel format for each system and Python version.
        
        Documentation is a first class concern in the project. Head over to `Read the
        Docs`_ and see for yourself.
        
        Professional support is available if you — or your company — are so inclined.
        `Get in touch`_.
        
        (If you contribute to ``websockets`` and would like to become an official
        support provider, let me know.)
        
        .. _Read the Docs: https://websockets.readthedocs.io/
        .. _handle backpressure correctly: https://vorpus.org/blog/some-thoughts-on-asynchronous-api-design-in-a-post-asyncawait-world/#websocket-servers
        .. _Autobahn Testsuite: https://github.com/aaugustin/websockets/blob/master/compliance/README.rst
        .. _Get in touch: https://fractalideas.com/
        
        Why shouldn't I use ``websockets``?
        -----------------------------------
        
        * If you prefer callbacks over coroutines: ``websockets`` was created to
          provide the best coroutine-based API to manage WebSocket connections in
          Python. Pick another library for a callback-based API.
        * If you're looking for a mixed HTTP / WebSocket library: ``websockets`` aims
          at being an excellent implementation of :rfc:`6455`: The WebSocket Protocol
          and :rfc:`7692`: Compression Extensions for WebSocket. Its support for HTTP
          is minimal — just enough for a HTTP health check.
        * If you want to use Python 2: ``websockets`` builds upon ``asyncio`` which
          only works on Python 3. ``websockets`` requires Python ≥ 3.4.
        
        What else?
        ----------
        
        Bug reports, patches and suggestions welcome! Just open an issue_ or send a
        `pull request`_.
        
        .. _issue: https://github.com/aaugustin/websockets/issues/new
        .. _pull request: https://github.com/aaugustin/websockets/compare/
        
        ``websockets`` is released under the `BSD license`_.
        
        .. _BSD license: https://websockets.readthedocs.io/en/stable/license.html
        
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Requires-Python: >=3.4