Metadata-Version: 2.0
Name: pocketsocket
Version: 0.4.1
Summary: Websocket server
Home-page: https://github.com/Strangemother/pocketsocket
Author: Jay Jagpal
Author-email: jay@strangemother.com
License: MIT
Keywords: websocket
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Environment :: Web Environment
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 2.7
Provides-Extra: test
Requires-Dist: coverage; extra == 'test'
Requires-Dist: nosetests; extra == 'test'
Requires-Dist: smpq; extra == 'test'
Requires-Dist: websocket-client; extra == 'test'

# Pocket Socket

Websockets in python is boring and hard. Using websockets is all the fun. Pocket Socket provides a base for websocket development. Designed for clarity and portability.

This project was designed in extension of `SimpleWebsocketServer` (_A supplied Vendor_). It's an excellent port to python. `pocketsocket` provides an abstraction for super easy integration

## Getting started

Install Pocket Socket using `pip`

```py
pip install pocketsocket
```

Pocket Socket is built for ease with no dependencies and no setup.

The quickest method to boot an echo server doesn't need any code

```bash
$>python -m pocketsocket.echo --port 9001
```

An echo server repeats a message to all connected clients. If you're building a simple chat server, this is a great start.

## Requirements

It's lighweight with no dependencies and should run on any python ready platform. Current implementations are:

+ Rasberry Pi
+ Window
+ Linux (Debian, Ubuntu, BusyBox, AB.IO ...)


