Metadata-Version: 2.4
Name: alm-broadcast-server
Version: 0.1.2
Summary: WebSocket chat broadcast server CLI app implemented in python
License-Expression: MIT
License-File: LICENSE
Author: Almas Khan
Author-email: khanalmas1607@gmail.com
Requires-Python: >=3.10
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Dist: prompt-toolkit (>=3.0.52,<4.0.0)
Requires-Dist: typer (>=0.21.1,<0.22.0)
Requires-Dist: websockets (>=16.0,<17.0)
Project-URL: Repository, https://github.com/Alm-4/BroadcastServer
Description-Content-Type: text/markdown

# alm-broadcast-server
WebSocket chat broadcast server CLI app implemented in python.

## Requirements 
- Python v3.10+ (tested on v3.12)
- Pip

## Install 
Install the package from [PyPi](https://pypi.org/project/alm-broadcast-server/).

***Recommended:*** Use pip in a [virtual environment](https://docs.python.org/3/library/venv.html) `pip install alm-broadcast-server` **or** use [pipx](https://pipx.pypa.io/stable/) `pipx install alm-broadcast-server`.

## Usage
Use the help flag `alm-broadcast-server --help` `alm-broadcast-server start --help` `alm-broadcast-server connect --help` for informations about the commands and to see the available options. 

Use the start command `alm-broadcast-server start` to start a server. Use `--port` to specify the port used. Once running, type `help` to see the available commands.

Use the connect command `alm-broadcast-server connect` to connect to a running server. Use `--port` to specify the port the server is using. Once connected, type `/help` to see the available commands. 

