Metadata-Version: 2.1
Name: socket-cli
Version: 0.1.7
Summary: CLI for SocketIO, WebSocket, Unix-Socket. With auto-completion and syntax highlighting.
Home-page: http://pypi.python.org/pypi/PackageName/
Author: gcaaa31928
Author-email: gcaaa31928@gmail.com
License: LICENSE.txt
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: Development Status :: 3 - Alpha
Classifier: Operating System :: Unix
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Description-Content-Type: text/markdown
Requires-Dist: click (>=4.0)
Requires-Dist: prompt-toolkit (>=2.0.10)
Requires-Dist: fuzzyfinder (>=2.1.0)
Requires-Dist: python-socketio (>=4.3.1)
Requires-Dist: pygments (>=2.4.2)
Requires-Dist: halo
Requires-Dist: websockets (>=8.1)
Requires-Dist: asyncio (>=3.4.3)
Requires-Dist: requests

<h1 align="center">Welcome to socket-cli 👋</h1>
<p align="center">
  <img alt="PyPI - Downloads" src="https://img.shields.io/pypi/dw/socket-cli">
  <img alt="PyPI - Python Version" src="https://img.shields.io/pypi/pyversions/socket-cli?style=flat-square">
  <img alt="PyPI" src="https://img.shields.io/pypi/v/socket-cli">
</p>

> A command-line client for socket.io, websocket, unix-socket that has auto-completion and syntax highlighting.

## ✨ Demo

### Just take a look
[![asciicast](https://asciinema.org/a/GgXCsrUEhlY98xxlrhIQcRpNj.svg)](https://asciinema.org/a/GgXCsrUEhlY98xxlrhIQcRpNj?speed=2)

## 🚀 Usage

install *socket-cli* via pip:

```bash
pip install socket-cli
```
```bash
Usage: socket-cli [OPTIONS] [PATH]

Options:
  -t, --type TEXT  [websocket, socketio, unix]
  --help           Show this message and exit.
````

when you connect a socket.io server.
```bash
> connect
> emit --event event_name --data '{"test": "data"}'
> on --event event_name
> on --event event_name --namespace /admin
> emit --event event_name --data '{"test": "data"}' --namespace /admin
```
or a websocket server
```bash
> connect
> send --data test
> recv 
```
or a unix socket server
```bash
> connect
> send --data test
```

```bash
> connect
> send --data 
> on --event event_name
```

## 🤝 Contributing

Contributions, issues and feature requests are welcome.<br />
Feel free to check [issues page](https://github.com/gcaaa31928/socket-cli/issues) and pull-request welcome.


## TODO
- [ ] connect socket.io server with headers
- [ ] unit-testing, ci


## Author

👤 **gcaaa31928**

* Website: http://gcaaa.blogspot.tw/
* Github: [@gcaaa31928](https://github.com/gcaaa31928)

## Show your support

Give a ⭐️ if this project helped you!

***
_This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_


